AWSConnect

Objective-C

@interface AWSConnect

Swift

class AWSConnect

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.

There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
       AWSServiceManager.default().defaultServiceConfiguration = configuration
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                         identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                              credentialsProvider:credentialsProvider];
         [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;
    
         return YES;
     }
    

    Then call the following to get the default service client:

    Swift

    let Connect = AWSConnect.default()
    

    Objective-C

    AWSConnect *Connect = [AWSConnect defaultConnect];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultConnect;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSConnect.register(with: configuration!, forKey: "USWest2Connect")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSConnect registerConnectWithConfiguration:configuration forKey:@"USWest2Connect"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let Connect = AWSConnect(forKey: "USWest2Connect")
    

    Objective-C

    AWSConnect *Connect = [AWSConnect ConnectForKey:@"USWest2Connect"];
    

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerConnectWithConfiguration:(id)configuration
                                      forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerConnectWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSConnect.register(with: configuration!, forKey: "USWest2Connect")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSConnect registerConnectWithConfiguration:configuration forKey:@"USWest2Connect"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let Connect = AWSConnect(forKey: "USWest2Connect")
    

    Objective-C

    AWSConnect *Connect = [AWSConnect ConnectForKey:@"USWest2Connect"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)ConnectForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeConnectForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Creates a user account for the specified Amazon Connect instance.

    For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

    See

    AWSConnectCreateUserRequest

    See

    AWSConnectCreateUserResponse

    Declaration

    Objective-C

    - (id)createUser:(nonnull AWSConnectCreateUserRequest *)request;

    Swift

    func createUser(_ request: AWSConnectCreateUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectCreateUserResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorLimitExceeded, AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Creates a user account for the specified Amazon Connect instance.

    For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

    See

    AWSConnectCreateUserRequest

    See

    AWSConnectCreateUserResponse

    Declaration

    Objective-C

    - (void)createUser:(nonnull AWSConnectCreateUserRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectCreateUserResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createUser(_ request: AWSConnectCreateUserRequest, completionHandler: ((AWSConnectCreateUserResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateUser service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorLimitExceeded, AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Deletes a user account from the specified Amazon Connect instance.

    For information about what happens to a user’s data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

    See

    AWSConnectDeleteUserRequest

    Declaration

    Objective-C

    - (id)deleteUser:(nonnull AWSConnectDeleteUserRequest *)request;

    Swift

    func deleteUser(_ request: AWSConnectDeleteUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Deletes a user account from the specified Amazon Connect instance.

    For information about what happens to a user’s data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

    See

    AWSConnectDeleteUserRequest

    Declaration

    Objective-C

    - (void)deleteUser:(nonnull AWSConnectDeleteUserRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteUser(_ request: AWSConnectDeleteUserRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteUser service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

    See

    AWSConnectDescribeUserRequest

    See

    AWSConnectDescribeUserResponse

    Declaration

    Objective-C

    - (id)describeUser:(nonnull AWSConnectDescribeUserRequest *)request;

    Swift

    func describeUser(_ request: AWSConnectDescribeUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectDescribeUserResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

    See

    AWSConnectDescribeUserRequest

    See

    AWSConnectDescribeUserResponse

    Declaration

    Objective-C

    - (void)describeUser:(nonnull AWSConnectDescribeUserRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectDescribeUserResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeUser(_ request: AWSConnectDescribeUserRequest, completionHandler: ((AWSConnectDescribeUserResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeUser service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the specified hierarchy group.

    See

    AWSConnectDescribeUserHierarchyGroupRequest

    See

    AWSConnectDescribeUserHierarchyGroupResponse

    Declaration

    Objective-C

    - (id)describeUserHierarchyGroup:
        (nonnull AWSConnectDescribeUserHierarchyGroupRequest *)request;

    Swift

    func describeUserHierarchyGroup(_ request: AWSConnectDescribeUserHierarchyGroupRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeUserHierarchyGroup service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectDescribeUserHierarchyGroupResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the specified hierarchy group.

    See

    AWSConnectDescribeUserHierarchyGroupRequest

    See

    AWSConnectDescribeUserHierarchyGroupResponse

    Declaration

    Objective-C

    - (void)
        describeUserHierarchyGroup:
            (nonnull AWSConnectDescribeUserHierarchyGroupRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSConnectDescribeUserHierarchyGroupResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func describeUserHierarchyGroup(_ request: AWSConnectDescribeUserHierarchyGroupRequest, completionHandler: ((AWSConnectDescribeUserHierarchyGroupResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeUserHierarchyGroup service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the hierarchy structure of the specified Amazon Connect instance.

    See

    AWSConnectDescribeUserHierarchyStructureRequest

    See

    AWSConnectDescribeUserHierarchyStructureResponse

    Declaration

    Objective-C

    - (id)describeUserHierarchyStructure:
        (nonnull AWSConnectDescribeUserHierarchyStructureRequest *)request;

    Swift

    func describeUserHierarchyStructure(_ request: AWSConnectDescribeUserHierarchyStructureRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeUserHierarchyStructure service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectDescribeUserHierarchyStructureResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the hierarchy structure of the specified Amazon Connect instance.

    See

    AWSConnectDescribeUserHierarchyStructureRequest

    See

    AWSConnectDescribeUserHierarchyStructureResponse

    Declaration

    Objective-C

    - (void)describeUserHierarchyStructure:
                (nonnull AWSConnectDescribeUserHierarchyStructureRequest *)request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSConnectDescribeUserHierarchyStructureResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeUserHierarchyStructure(_ request: AWSConnectDescribeUserHierarchyStructureRequest, completionHandler: ((AWSConnectDescribeUserHierarchyStructureResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeUserHierarchyStructure service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Retrieves the contact attributes for the specified contact.

    See

    AWSConnectGetContactAttributesRequest

    See

    AWSConnectGetContactAttributesResponse

    Declaration

    Objective-C

    - (id)getContactAttributes:
        (nonnull AWSConnectGetContactAttributesRequest *)request;

    Swift

    func getContactAttributes(_ request: AWSConnectGetContactAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetContactAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectGetContactAttributesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Retrieves the contact attributes for the specified contact.

    See

    AWSConnectGetContactAttributesRequest

    See

    AWSConnectGetContactAttributesResponse

    Declaration

    Objective-C

    - (void)
        getContactAttributes:
            (nonnull AWSConnectGetContactAttributesRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectGetContactAttributesResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getContactAttributes(_ request: AWSConnectGetContactAttributesRequest, completionHandler: ((AWSConnectGetContactAttributesResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetContactAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Gets the real-time metric data from the specified Amazon Connect instance.

    For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

    See

    AWSConnectGetCurrentMetricDataRequest

    See

    AWSConnectGetCurrentMetricDataResponse

    Declaration

    Objective-C

    - (id)getCurrentMetricData:
        (nonnull AWSConnectGetCurrentMetricDataRequest *)request;

    Swift

    func getCurrentMetricData(_ request: AWSConnectGetCurrentMetricDataRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetCurrentMetricData service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectGetCurrentMetricDataResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorThrottling, AWSConnectErrorResourceNotFound.

  • Gets the real-time metric data from the specified Amazon Connect instance.

    For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

    See

    AWSConnectGetCurrentMetricDataRequest

    See

    AWSConnectGetCurrentMetricDataResponse

    Declaration

    Objective-C

    - (void)
        getCurrentMetricData:
            (nonnull AWSConnectGetCurrentMetricDataRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectGetCurrentMetricDataResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func getCurrentMetricData(_ request: AWSConnectGetCurrentMetricDataRequest, completionHandler: ((AWSConnectGetCurrentMetricDataResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetCurrentMetricData service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorThrottling, AWSConnectErrorResourceNotFound.

  • Retrieves a token for federation.

    See

    AWSConnectGetFederationTokenRequest

    See

    AWSConnectGetFederationTokenResponse

    Declaration

    Objective-C

    - (id)getFederationToken:(nonnull AWSConnectGetFederationTokenRequest *)request;

    Swift

    func getFederationToken(_ request: AWSConnectGetFederationTokenRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetFederationToken service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectGetFederationTokenResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorUserNotFound, AWSConnectErrorInternalService, AWSConnectErrorDuplicateResource.

  • Retrieves a token for federation.

    See

    AWSConnectGetFederationTokenRequest

    See

    AWSConnectGetFederationTokenResponse

    Declaration

    Objective-C

    - (void)getFederationToken:
                (nonnull AWSConnectGetFederationTokenRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSConnectGetFederationTokenResponse *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func getFederationToken(_ request: AWSConnectGetFederationTokenRequest, completionHandler: ((AWSConnectGetFederationTokenResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetFederationToken service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorUserNotFound, AWSConnectErrorInternalService, AWSConnectErrorDuplicateResource.

  • Gets historical metric data from the specified Amazon Connect instance.

    For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

    See

    AWSConnectGetMetricDataRequest

    See

    AWSConnectGetMetricDataResponse

    Declaration

    Objective-C

    - (id)getMetricData:(nonnull AWSConnectGetMetricDataRequest *)request;

    Swift

    func getMetricData(_ request: AWSConnectGetMetricDataRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMetricData service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectGetMetricDataResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorThrottling, AWSConnectErrorResourceNotFound.

  • Gets historical metric data from the specified Amazon Connect instance.

    For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

    See

    AWSConnectGetMetricDataRequest

    See

    AWSConnectGetMetricDataResponse

    Declaration

    Objective-C

    - (void)getMetricData:(nonnull AWSConnectGetMetricDataRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectGetMetricDataResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func getMetricData(_ request: AWSConnectGetMetricDataRequest, completionHandler: ((AWSConnectGetMetricDataResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetMetricData service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorThrottling, AWSConnectErrorResourceNotFound.

  • Provides information about the contact flows for the specified Amazon Connect instance.

    For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

    See

    AWSConnectListContactFlowsRequest

    See

    AWSConnectListContactFlowsResponse

    Declaration

    Objective-C

    - (id)listContactFlows:(nonnull AWSConnectListContactFlowsRequest *)request;

    Swift

    func listContactFlows(_ request: AWSConnectListContactFlowsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListContactFlows service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListContactFlowsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the contact flows for the specified Amazon Connect instance.

    For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

    See

    AWSConnectListContactFlowsRequest

    See

    AWSConnectListContactFlowsResponse

    Declaration

    Objective-C

    - (void)listContactFlows:(nonnull AWSConnectListContactFlowsRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectListContactFlowsResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listContactFlows(_ request: AWSConnectListContactFlowsRequest, completionHandler: ((AWSConnectListContactFlowsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListContactFlows service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the hours of operation for the specified Amazon Connect instance.

    For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

    See

    AWSConnectListHoursOfOperationsRequest

    See

    AWSConnectListHoursOfOperationsResponse

    Declaration

    Objective-C

    - (id)listHoursOfOperations:
        (nonnull AWSConnectListHoursOfOperationsRequest *)request;

    Swift

    func listHours(ofOperations request: AWSConnectListHoursOfOperationsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListHoursOfOperations service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListHoursOfOperationsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the hours of operation for the specified Amazon Connect instance.

    For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

    See

    AWSConnectListHoursOfOperationsRequest

    See

    AWSConnectListHoursOfOperationsResponse

    Declaration

    Objective-C

    - (void)listHoursOfOperations:
                (nonnull AWSConnectListHoursOfOperationsRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSConnectListHoursOfOperationsResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listHours(ofOperations request: AWSConnectListHoursOfOperationsRequest, completionHandler: ((AWSConnectListHoursOfOperationsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListHoursOfOperations service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the phone numbers for the specified Amazon Connect instance.

    For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

    See

    AWSConnectListPhoneNumbersRequest

    See

    AWSConnectListPhoneNumbersResponse

    Declaration

    Objective-C

    - (id)listPhoneNumbers:(nonnull AWSConnectListPhoneNumbersRequest *)request;

    Swift

    func listPhoneNumbers(_ request: AWSConnectListPhoneNumbersRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListPhoneNumbers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListPhoneNumbersResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the phone numbers for the specified Amazon Connect instance.

    For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

    See

    AWSConnectListPhoneNumbersRequest

    See

    AWSConnectListPhoneNumbersResponse

    Declaration

    Objective-C

    - (void)listPhoneNumbers:(nonnull AWSConnectListPhoneNumbersRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectListPhoneNumbersResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listPhoneNumbers(_ request: AWSConnectListPhoneNumbersRequest, completionHandler: ((AWSConnectListPhoneNumbersResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListPhoneNumbers service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the queues for the specified Amazon Connect instance.

    For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

    See

    AWSConnectListQueuesRequest

    See

    AWSConnectListQueuesResponse

    Declaration

    Objective-C

    - (id)listQueues:(nonnull AWSConnectListQueuesRequest *)request;

    Swift

    func listQueues(_ request: AWSConnectListQueuesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListQueues service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListQueuesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the queues for the specified Amazon Connect instance.

    For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

    See

    AWSConnectListQueuesRequest

    See

    AWSConnectListQueuesResponse

    Declaration

    Objective-C

    - (void)listQueues:(nonnull AWSConnectListQueuesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectListQueuesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listQueues(_ request: AWSConnectListQueuesRequest, completionHandler: ((AWSConnectListQueuesResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListQueues service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides summary information about the routing profiles for the specified Amazon Connect instance.

    For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

    See

    AWSConnectListRoutingProfilesRequest

    See

    AWSConnectListRoutingProfilesResponse

    Declaration

    Objective-C

    - (id)listRoutingProfiles:
        (nonnull AWSConnectListRoutingProfilesRequest *)request;

    Swift

    func listRoutingProfiles(_ request: AWSConnectListRoutingProfilesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListRoutingProfiles service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListRoutingProfilesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides summary information about the routing profiles for the specified Amazon Connect instance.

    For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

    See

    AWSConnectListRoutingProfilesRequest

    See

    AWSConnectListRoutingProfilesResponse

    Declaration

    Objective-C

    - (void)
        listRoutingProfiles:(nonnull AWSConnectListRoutingProfilesRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSConnectListRoutingProfilesResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listRoutingProfiles(_ request: AWSConnectListRoutingProfilesRequest, completionHandler: ((AWSConnectListRoutingProfilesResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListRoutingProfiles service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides summary information about the security profiles for the specified Amazon Connect instance.

    For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

    See

    AWSConnectListSecurityProfilesRequest

    See

    AWSConnectListSecurityProfilesResponse

    Declaration

    Objective-C

    - (id)listSecurityProfiles:
        (nonnull AWSConnectListSecurityProfilesRequest *)request;

    Swift

    func listSecurityProfiles(_ request: AWSConnectListSecurityProfilesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListSecurityProfiles service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListSecurityProfilesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides summary information about the security profiles for the specified Amazon Connect instance.

    For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

    See

    AWSConnectListSecurityProfilesRequest

    See

    AWSConnectListSecurityProfilesResponse

    Declaration

    Objective-C

    - (void)
        listSecurityProfiles:
            (nonnull AWSConnectListSecurityProfilesRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectListSecurityProfilesResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listSecurityProfiles(_ request: AWSConnectListSecurityProfilesRequest, completionHandler: ((AWSConnectListSecurityProfilesResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListSecurityProfiles service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Lists the tags for the specified resource.

    For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

    See

    AWSConnectListTagsForResourceRequest

    See

    AWSConnectListTagsForResourceResponse

    Declaration

    Objective-C

    - (id)listTagsForResource:
        (nonnull AWSConnectListTagsForResourceRequest *)request;

    Swift

    func listTags(forResource request: AWSConnectListTagsForResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling.

  • Lists the tags for the specified resource.

    For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

    See

    AWSConnectListTagsForResourceRequest

    See

    AWSConnectListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)
        listTagsForResource:(nonnull AWSConnectListTagsForResourceRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSConnectListTagsForResourceResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSConnectListTagsForResourceRequest, completionHandler: ((AWSConnectListTagsForResourceResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling.

  • Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

    For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

    See

    AWSConnectListUserHierarchyGroupsRequest

    See

    AWSConnectListUserHierarchyGroupsResponse

    Declaration

    Objective-C

    - (id)listUserHierarchyGroups:
        (nonnull AWSConnectListUserHierarchyGroupsRequest *)request;

    Swift

    func listUserHierarchyGroups(_ request: AWSConnectListUserHierarchyGroupsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListUserHierarchyGroups service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListUserHierarchyGroupsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

    For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

    See

    AWSConnectListUserHierarchyGroupsRequest

    See

    AWSConnectListUserHierarchyGroupsResponse

    Declaration

    Objective-C

    - (void)listUserHierarchyGroups:
                (nonnull AWSConnectListUserHierarchyGroupsRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectListUserHierarchyGroupsResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func listUserHierarchyGroups(_ request: AWSConnectListUserHierarchyGroupsRequest, completionHandler: ((AWSConnectListUserHierarchyGroupsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListUserHierarchyGroups service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides summary information about the users for the specified Amazon Connect instance.

    See

    AWSConnectListUsersRequest

    See

    AWSConnectListUsersResponse

    Declaration

    Objective-C

    - (id)listUsers:(nonnull AWSConnectListUsersRequest *)request;

    Swift

    func listUsers(_ request: AWSConnectListUsersRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListUsers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListUsersResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides summary information about the users for the specified Amazon Connect instance.

    See

    AWSConnectListUsersRequest

    See

    AWSConnectListUsersResponse

    Declaration

    Objective-C

    - (void)listUsers:(nonnull AWSConnectListUsersRequest *)request
        completionHandler:(void (^_Nullable)(AWSConnectListUsersResponse *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listUsers(_ request: AWSConnectListUsersRequest, completionHandler: ((AWSConnectListUsersResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListUsers service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

    When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

    A 429 error occurs in two situations:

    • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.

    • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

    For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

    See

    AWSConnectStartChatContactRequest

    See

    AWSConnectStartChatContactResponse

    Declaration

    Objective-C

    - (id)startChatContact:(nonnull AWSConnectStartChatContactRequest *)request;

    Swift

    func startChatContact(_ request: AWSConnectStartChatContactRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StartChatContact service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectStartChatContactResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorLimitExceeded.

  • Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

    When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

    A 429 error occurs in two situations:

    • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.

    • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

    For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

    See

    AWSConnectStartChatContactRequest

    See

    AWSConnectStartChatContactResponse

    Declaration

    Objective-C

    - (void)startChatContact:(nonnull AWSConnectStartChatContactRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectStartChatContactResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func startChatContact(_ request: AWSConnectStartChatContactRequest, completionHandler: ((AWSConnectStartChatContactResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the StartChatContact service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorLimitExceeded.

  • This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that’s specified (in ContactFlowId).

    Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that’s when the call is routed to the agent, like any other inbound case.

    There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

    UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

    See

    AWSConnectStartOutboundVoiceContactRequest

    See

    AWSConnectStartOutboundVoiceContactResponse

    Declaration

    Objective-C

    - (id)startOutboundVoiceContact:
        (nonnull AWSConnectStartOutboundVoiceContactRequest *)request;

    Swift

    func startOutboundVoiceContact(_ request: AWSConnectStartOutboundVoiceContactRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StartOutboundVoiceContact service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectStartOutboundVoiceContactResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorLimitExceeded, AWSConnectErrorDestinationNotAllowed, AWSConnectErrorOutboundContactNotPermitted.

  • This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that’s specified (in ContactFlowId).

    Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that’s when the call is routed to the agent, like any other inbound case.

    There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

    UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

    See

    AWSConnectStartOutboundVoiceContactRequest

    See

    AWSConnectStartOutboundVoiceContactResponse

    Declaration

    Objective-C

    - (void)startOutboundVoiceContact:
                (nonnull AWSConnectStartOutboundVoiceContactRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSConnectStartOutboundVoiceContactResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func startOutboundVoiceContact(_ request: AWSConnectStartOutboundVoiceContactRequest, completionHandler: ((AWSConnectStartOutboundVoiceContactResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the StartOutboundVoiceContact service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorLimitExceeded, AWSConnectErrorDestinationNotAllowed, AWSConnectErrorOutboundContactNotPermitted.

  • Ends the specified contact.

    See

    AWSConnectStopContactRequest

    See

    AWSConnectStopContactResponse

    Declaration

    Objective-C

    - (id)stopContact:(nonnull AWSConnectStopContactRequest *)request;

    Swift

    func stopContact(_ request: AWSConnectStopContactRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StopContact service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectStopContactResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorContactNotFound, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Ends the specified contact.

    See

    AWSConnectStopContactRequest

    See

    AWSConnectStopContactResponse

    Declaration

    Objective-C

    - (void)stopContact:(nonnull AWSConnectStopContactRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectStopContactResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func stopContact(_ request: AWSConnectStopContactRequest, completionHandler: ((AWSConnectStopContactResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the StopContact service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorContactNotFound, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Adds the specified tags to the specified resource.

    The supported resource type is users.

    For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

    See

    AWSConnectTagResourceRequest

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSConnectTagResourceRequest *)request;

    Swift

    func tagResource(_ request: AWSConnectTagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling.

  • Adds the specified tags to the specified resource.

    The supported resource type is users.

    For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

    See

    AWSConnectTagResourceRequest

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSConnectTagResourceRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSConnectTagResourceRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling.

  • Removes the specified tags from the specified resource.

    See

    AWSConnectUntagResourceRequest

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSConnectUntagResourceRequest *)request;

    Swift

    func untagResource(_ request: AWSConnectUntagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling.

  • Removes the specified tags from the specified resource.

    See

    AWSConnectUntagResourceRequest

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSConnectUntagResourceRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSConnectUntagResourceRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorInternalService, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling.

  • Creates or updates the contact attributes associated with the specified contact.

    You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer’s name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

    Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

    Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

    See

    AWSConnectUpdateContactAttributesRequest

    See

    AWSConnectUpdateContactAttributesResponse

    Declaration

    Objective-C

    - (id)updateContactAttributes:
        (nonnull AWSConnectUpdateContactAttributesRequest *)request;

    Swift

    func updateContactAttributes(_ request: AWSConnectUpdateContactAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateContactAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectUpdateContactAttributesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Creates or updates the contact attributes associated with the specified contact.

    You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer’s name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

    Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

    Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

    See

    AWSConnectUpdateContactAttributesRequest

    See

    AWSConnectUpdateContactAttributesResponse

    Declaration

    Objective-C

    - (void)updateContactAttributes:
                (nonnull AWSConnectUpdateContactAttributesRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectUpdateContactAttributesResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func updateContactAttributes(_ request: AWSConnectUpdateContactAttributesRequest, completionHandler: ((AWSConnectUpdateContactAttributesResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateContactAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Assigns the specified hierarchy group to the specified user.

    See

    AWSConnectUpdateUserHierarchyRequest

    Declaration

    Objective-C

    - (id)updateUserHierarchy:
        (nonnull AWSConnectUpdateUserHierarchyRequest *)request;

    Swift

    func updateUserHierarchy(_ request: AWSConnectUpdateUserHierarchyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserHierarchy service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Assigns the specified hierarchy group to the specified user.

    See

    AWSConnectUpdateUserHierarchyRequest

    Declaration

    Objective-C

    - (void)updateUserHierarchy:
                (nonnull AWSConnectUpdateUserHierarchyRequest *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserHierarchy(_ request: AWSConnectUpdateUserHierarchyRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserHierarchy service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates the identity information for the specified user.

    Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker’s email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

    See

    AWSConnectUpdateUserIdentityInfoRequest

    Declaration

    Objective-C

    - (id)updateUserIdentityInfo:
        (nonnull AWSConnectUpdateUserIdentityInfoRequest *)request;

    Swift

    func updateUserIdentityInfo(_ request: AWSConnectUpdateUserIdentityInfoRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserIdentityInfo service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates the identity information for the specified user.

    Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker’s email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

    See

    AWSConnectUpdateUserIdentityInfoRequest

    Declaration

    Objective-C

    - (void)updateUserIdentityInfo:
                (nonnull AWSConnectUpdateUserIdentityInfoRequest *)request
                 completionHandler:
                     (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserIdentityInfo(_ request: AWSConnectUpdateUserIdentityInfoRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserIdentityInfo service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates the phone configuration settings for the specified user.

    See

    AWSConnectUpdateUserPhoneConfigRequest

    Declaration

    Objective-C

    - (id)updateUserPhoneConfig:
        (nonnull AWSConnectUpdateUserPhoneConfigRequest *)request;

    Swift

    func updateUserPhoneConfig(_ request: AWSConnectUpdateUserPhoneConfigRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserPhoneConfig service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates the phone configuration settings for the specified user.

    See

    AWSConnectUpdateUserPhoneConfigRequest

    Declaration

    Objective-C

    - (void)updateUserPhoneConfig:
                (nonnull AWSConnectUpdateUserPhoneConfigRequest *)request
                completionHandler:
                    (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserPhoneConfig(_ request: AWSConnectUpdateUserPhoneConfigRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserPhoneConfig service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Assigns the specified routing profile to the specified user.

    See

    AWSConnectUpdateUserRoutingProfileRequest

    Declaration

    Objective-C

    - (id)updateUserRoutingProfile:
        (nonnull AWSConnectUpdateUserRoutingProfileRequest *)request;

    Swift

    func updateUserRoutingProfile(_ request: AWSConnectUpdateUserRoutingProfileRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserRoutingProfile service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Assigns the specified routing profile to the specified user.

    See

    AWSConnectUpdateUserRoutingProfileRequest

    Declaration

    Objective-C

    - (void)updateUserRoutingProfile:
                (nonnull AWSConnectUpdateUserRoutingProfileRequest *)request
                   completionHandler:
                       (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserRoutingProfile(_ request: AWSConnectUpdateUserRoutingProfileRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserRoutingProfile service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Assigns the specified security profiles to the specified user.

    See

    AWSConnectUpdateUserSecurityProfilesRequest

    Declaration

    Objective-C

    - (id)updateUserSecurityProfiles:
        (nonnull AWSConnectUpdateUserSecurityProfilesRequest *)request;

    Swift

    func updateUserSecurityProfiles(_ request: AWSConnectUpdateUserSecurityProfilesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserSecurityProfiles service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Assigns the specified security profiles to the specified user.

    See

    AWSConnectUpdateUserSecurityProfilesRequest

    Declaration

    Objective-C

    - (void)updateUserSecurityProfiles:
                (nonnull AWSConnectUpdateUserSecurityProfilesRequest *)request
                     completionHandler:
                         (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserSecurityProfiles(_ request: AWSConnectUpdateUserSecurityProfilesRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserSecurityProfiles service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.