AWSConnect Class Reference

Inherits from AWSService : NSObject
Declared in AWSConnectService.h
AWSConnectService.m

Overview

The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. 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.

Throttling limits for the Amazon Connect API operations:

For the GetMetricData and GetCurrentMetricData operations, a RateLimit of 5 per second, and a BurstLimit of 8 per second.

For all other operations, a RateLimit of 2 per second, and a BurstLimit of 5 per second.

You can request an increase to the throttling limits by submitting a Amazon Connect service limits increase form. You must be signed in to your AWS account to access the form.

Other Methods

+ defaultConnect

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.

+ (instancetype)defaultConnect

Return Value

The default service client.

Discussion

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];

Declared In

AWSConnectService.h

+ registerConnectWithConfiguration:forKey:

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

+ (void)registerConnectWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

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.

Declared In

AWSConnectService.h

+ ConnectForKey:

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

+ (instancetype)ConnectForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

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"];

Declared In

AWSConnectService.h

+ removeConnectForKey:

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

+ (void)removeConnectForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

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

Declared In

AWSConnectService.h

– createUser:

Creates a new user account in your Amazon Connect instance.

- (AWSTask<AWSConnectCreateUserResponse*> *)createUser:(AWSConnectCreateUserRequest *)request

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.

Declared In

AWSConnectService.h

– createUser:completionHandler:

Creates a new user account in your Amazon Connect instance.

- (void)createUser:(AWSConnectCreateUserRequest *)request completionHandler:(void ( ^ ) ( AWSConnectCreateUserResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– deleteUser:

Deletes a user account from Amazon Connect.

- (AWSTask *)deleteUser:(AWSConnectDeleteUserRequest *)request

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.

Declared In

AWSConnectService.h

– deleteUser:completionHandler:

Deletes a user account from Amazon Connect.

- (void)deleteUser:(AWSConnectDeleteUserRequest *)request completionHandler:(void ( ^ ) ( NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– describeUser:

Returns a User object that contains information about the user account specified by the UserId.

- (AWSTask<AWSConnectDescribeUserResponse*> *)describeUser:(AWSConnectDescribeUserRequest *)request

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.

Declared In

AWSConnectService.h

– describeUser:completionHandler:

Returns a User object that contains information about the user account specified by the UserId.

- (void)describeUser:(AWSConnectDescribeUserRequest *)request completionHandler:(void ( ^ ) ( AWSConnectDescribeUserResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– describeUserHierarchyGroup:

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

- (AWSTask<AWSConnectDescribeUserHierarchyGroupResponse*> *)describeUserHierarchyGroup:(AWSConnectDescribeUserHierarchyGroupRequest *)request

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.

Declared In

AWSConnectService.h

– describeUserHierarchyGroup:completionHandler:

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

- (void)describeUserHierarchyGroup:(AWSConnectDescribeUserHierarchyGroupRequest *)request completionHandler:(void ( ^ ) ( AWSConnectDescribeUserHierarchyGroupResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– describeUserHierarchyStructure:

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

- (AWSTask<AWSConnectDescribeUserHierarchyStructureResponse*> *)describeUserHierarchyStructure:(AWSConnectDescribeUserHierarchyStructureRequest *)request

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.

Declared In

AWSConnectService.h

– describeUserHierarchyStructure:completionHandler:

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

- (void)describeUserHierarchyStructure:(AWSConnectDescribeUserHierarchyStructureRequest *)request completionHandler:(void ( ^ ) ( AWSConnectDescribeUserHierarchyStructureResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– getContactAttributes:

Retrieves the contact attributes associated with a contact.

- (AWSTask<AWSConnectGetContactAttributesResponse*> *)getContactAttributes:(AWSConnectGetContactAttributesRequest *)request

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.

Declared In

AWSConnectService.h

– getContactAttributes:completionHandler:

Retrieves the contact attributes associated with a contact.

- (void)getContactAttributes:(AWSConnectGetContactAttributesRequest *)request completionHandler:(void ( ^ ) ( AWSConnectGetContactAttributesResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– getCurrentMetricData:

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

- (AWSTask<AWSConnectGetCurrentMetricDataResponse*> *)getCurrentMetricData:(AWSConnectGetCurrentMetricDataRequest *)request

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.

Declared In

AWSConnectService.h

– getCurrentMetricData:completionHandler:

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

- (void)getCurrentMetricData:(AWSConnectGetCurrentMetricDataRequest *)request completionHandler:(void ( ^ ) ( AWSConnectGetCurrentMetricDataResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– getFederationToken:

Retrieves a token for federation.

- (AWSTask<AWSConnectGetFederationTokenResponse*> *)getFederationToken:(AWSConnectGetFederationTokenRequest *)request

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.

Declared In

AWSConnectService.h

– getFederationToken:completionHandler:

Retrieves a token for federation.

- (void)getFederationToken:(AWSConnectGetFederationTokenRequest *)request completionHandler:(void ( ^ ) ( AWSConnectGetFederationTokenResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– getMetricData:

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

- (AWSTask<AWSConnectGetMetricDataResponse*> *)getMetricData:(AWSConnectGetMetricDataRequest *)request

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.

Declared In

AWSConnectService.h

– getMetricData:completionHandler:

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

- (void)getMetricData:(AWSConnectGetMetricDataRequest *)request completionHandler:(void ( ^ ) ( AWSConnectGetMetricDataResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– listRoutingProfiles:

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

- (AWSTask<AWSConnectListRoutingProfilesResponse*> *)listRoutingProfiles:(AWSConnectListRoutingProfilesRequest *)request

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.

Declared In

AWSConnectService.h

– listRoutingProfiles:completionHandler:

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

- (void)listRoutingProfiles:(AWSConnectListRoutingProfilesRequest *)request completionHandler:(void ( ^ ) ( AWSConnectListRoutingProfilesResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– listSecurityProfiles:

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

- (AWSTask<AWSConnectListSecurityProfilesResponse*> *)listSecurityProfiles:(AWSConnectListSecurityProfilesRequest *)request

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.

Declared In

AWSConnectService.h

– listSecurityProfiles:completionHandler:

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

- (void)listSecurityProfiles:(AWSConnectListSecurityProfilesRequest *)request completionHandler:(void ( ^ ) ( AWSConnectListSecurityProfilesResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– listUserHierarchyGroups:

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

- (AWSTask<AWSConnectListUserHierarchyGroupsResponse*> *)listUserHierarchyGroups:(AWSConnectListUserHierarchyGroupsRequest *)request

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.

Declared In

AWSConnectService.h

– listUserHierarchyGroups:completionHandler:

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

- (void)listUserHierarchyGroups:(AWSConnectListUserHierarchyGroupsRequest *)request completionHandler:(void ( ^ ) ( AWSConnectListUserHierarchyGroupsResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– listUsers:

Returns a UserSummaryList, which is an array of UserSummary objects.

- (AWSTask<AWSConnectListUsersResponse*> *)listUsers:(AWSConnectListUsersRequest *)request

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.

Declared In

AWSConnectService.h

– listUsers:completionHandler:

Returns a UserSummaryList, which is an array of UserSummary objects.

- (void)listUsers:(AWSConnectListUsersRequest *)request completionHandler:(void ( ^ ) ( AWSConnectListUsersResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– startOutboundVoiceContact:

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

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

- (AWSTask<AWSConnectStartOutboundVoiceContactResponse*> *)startOutboundVoiceContact:(AWSConnectStartOutboundVoiceContactRequest *)request

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.

Declared In

AWSConnectService.h

– startOutboundVoiceContact:completionHandler:

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

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

- (void)startOutboundVoiceContact:(AWSConnectStartOutboundVoiceContactRequest *)request completionHandler:(void ( ^ ) ( AWSConnectStartOutboundVoiceContactResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– stopContact:

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

- (AWSTask<AWSConnectStopContactResponse*> *)stopContact:(AWSConnectStopContactRequest *)request

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.

Declared In

AWSConnectService.h

– stopContact:completionHandler:

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

- (void)stopContact:(AWSConnectStopContactRequest *)request completionHandler:(void ( ^ ) ( AWSConnectStopContactResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– updateContactAttributes:

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes operation to 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.

- (AWSTask<AWSConnectUpdateContactAttributesResponse*> *)updateContactAttributes:(AWSConnectUpdateContactAttributesRequest *)request

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.

Declared In

AWSConnectService.h

– updateContactAttributes:completionHandler:

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes operation to 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.

- (void)updateContactAttributes:(AWSConnectUpdateContactAttributesRequest *)request completionHandler:(void ( ^ ) ( AWSConnectUpdateContactAttributesResponse *response , NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– updateUserHierarchy:

Assigns the specified hierarchy group to the user.

- (AWSTask *)updateUserHierarchy:(AWSConnectUpdateUserHierarchyRequest *)request

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.

Declared In

AWSConnectService.h

– updateUserHierarchy:completionHandler:

Assigns the specified hierarchy group to the user.

- (void)updateUserHierarchy:(AWSConnectUpdateUserHierarchyRequest *)request completionHandler:(void ( ^ ) ( NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– updateUserIdentityInfo:

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

- (AWSTask *)updateUserIdentityInfo:(AWSConnectUpdateUserIdentityInfoRequest *)request

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.

Declared In

AWSConnectService.h

– updateUserIdentityInfo:completionHandler:

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

- (void)updateUserIdentityInfo:(AWSConnectUpdateUserIdentityInfoRequest *)request completionHandler:(void ( ^ ) ( NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– updateUserPhoneConfig:

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

- (AWSTask *)updateUserPhoneConfig:(AWSConnectUpdateUserPhoneConfigRequest *)request

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.

Declared In

AWSConnectService.h

– updateUserPhoneConfig:completionHandler:

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

- (void)updateUserPhoneConfig:(AWSConnectUpdateUserPhoneConfigRequest *)request completionHandler:(void ( ^ ) ( NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– updateUserRoutingProfile:

Assigns the specified routing profile to a user.

- (AWSTask *)updateUserRoutingProfile:(AWSConnectUpdateUserRoutingProfileRequest *)request

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.

Declared In

AWSConnectService.h

– updateUserRoutingProfile:completionHandler:

Assigns the specified routing profile to a user.

- (void)updateUserRoutingProfile:(AWSConnectUpdateUserRoutingProfileRequest *)request completionHandler:(void ( ^ ) ( NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

– updateUserSecurityProfiles:

Updates the security profiles assigned to the user.

- (AWSTask *)updateUserSecurityProfiles:(AWSConnectUpdateUserSecurityProfilesRequest *)request

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.

Declared In

AWSConnectService.h

– updateUserSecurityProfiles:completionHandler:

Updates the security profiles assigned to the user.

- (void)updateUserSecurityProfiles:(AWSConnectUpdateUserSecurityProfilesRequest *)request completionHandler:(void ( ^ ) ( NSError *error ))completionHandler

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.

Declared In

AWSConnectService.h

Other Methods

  configuration

The service configuration used to instantiate this service client.

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

Discussion

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

Declared In

AWSConnectService.h