AWSConnect
Objective-C
@interface AWSConnect
Swift
class AWSConnect
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also 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.
You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Working with contact flows? Check out the Amazon Connect Flow language.
-
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.
-
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
See
AWSConnectAssociateApprovedOriginRequest
Declaration
Objective-C
- (id)associateApprovedOrigin: (nonnull AWSConnectAssociateApprovedOriginRequest *)request;
Swift
func associateApprovedOrigin(_ request: AWSConnectAssociateApprovedOriginRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateApprovedOrigin service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
See
AWSConnectAssociateApprovedOriginRequest
Declaration
Objective-C
- (void)associateApprovedOrigin: (nonnull AWSConnectAssociateApprovedOriginRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func associateApprovedOrigin(_ request: AWSConnectAssociateApprovedOriginRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AssociateApprovedOrigin service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can’t define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn’t exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
See
AWSConnectAssociateInstanceStorageConfigRequest
See
AWSConnectAssociateInstanceStorageConfigResponse
Declaration
Objective-C
- (id)associateInstanceStorageConfig: (nonnull AWSConnectAssociateInstanceStorageConfigRequest *)request;
Swift
func associateInstanceStorageConfig(_ request: AWSConnectAssociateInstanceStorageConfigRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateInstanceStorageConfig service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectAssociateInstanceStorageConfigResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can’t define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn’t exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
See
AWSConnectAssociateInstanceStorageConfigRequest
See
AWSConnectAssociateInstanceStorageConfigResponse
Declaration
Objective-C
- (void)associateInstanceStorageConfig: (nonnull AWSConnectAssociateInstanceStorageConfigRequest *)request completionHandler: (void (^_Nullable)( AWSConnectAssociateInstanceStorageConfigResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateInstanceStorageConfig(_ request: AWSConnectAssociateInstanceStorageConfigRequest, completionHandler: ((AWSConnectAssociateInstanceStorageConfigResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AssociateInstanceStorageConfig service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
See
AWSConnectAssociateLambdaFunctionRequest
Declaration
Objective-C
- (id)associateLambdaFunction: (nonnull AWSConnectAssociateLambdaFunctionRequest *)request;
Swift
func associateLambdaFunction(_ request: AWSConnectAssociateLambdaFunctionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateLambdaFunction service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
See
AWSConnectAssociateLambdaFunctionRequest
Declaration
Objective-C
- (void)associateLambdaFunction: (nonnull AWSConnectAssociateLambdaFunctionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func associateLambdaFunction(_ request: AWSConnectAssociateLambdaFunctionRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AssociateLambdaFunction service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.
See
AWSConnectAssociateLexBotRequest
Declaration
Objective-C
- (id)associateLexBot:(nonnull AWSConnectAssociateLexBotRequest *)request;
Swift
func associateLexBot(_ request: AWSConnectAssociateLexBotRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateLexBot service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.
See
AWSConnectAssociateLexBotRequest
Declaration
Objective-C
- (void)associateLexBot:(nonnull AWSConnectAssociateLexBotRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func associateLexBot(_ request: AWSConnectAssociateLexBotRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AssociateLexBot service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
See
AWSConnectAssociateQueueQuickConnectsRequest
Declaration
Objective-C
- (id)associateQueueQuickConnects: (nonnull AWSConnectAssociateQueueQuickConnectsRequest *)request;
Swift
func associateQueueQuickConnects(_ request: AWSConnectAssociateQueueQuickConnectsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateQueueQuickConnects service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
See
AWSConnectAssociateQueueQuickConnectsRequest
Declaration
Objective-C
- (void)associateQueueQuickConnects: (nonnull AWSConnectAssociateQueueQuickConnectsRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func associateQueueQuickConnects(_ request: AWSConnectAssociateQueueQuickConnectsRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AssociateQueueQuickConnects service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Associates a set of queues with a routing profile.
See
AWSConnectAssociateRoutingProfileQueuesRequest
Declaration
Objective-C
- (id)associateRoutingProfileQueues: (nonnull AWSConnectAssociateRoutingProfileQueuesRequest *)request;
Swift
func associateRoutingProfileQueues(_ request: AWSConnectAssociateRoutingProfileQueuesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateRoutingProfileQueues service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Associates a set of queues with a routing profile.
See
AWSConnectAssociateRoutingProfileQueuesRequest
Declaration
Objective-C
- (void)associateRoutingProfileQueues: (nonnull AWSConnectAssociateRoutingProfileQueuesRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func associateRoutingProfileQueues(_ request: AWSConnectAssociateRoutingProfileQueuesRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AssociateRoutingProfileQueues service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
See
AWSConnectAssociateSecurityKeyRequest
See
AWSConnectAssociateSecurityKeyResponse
Declaration
Objective-C
- (id)associateSecurityKey: (nonnull AWSConnectAssociateSecurityKeyRequest *)request;
Swift
func associateSecurityKey(_ request: AWSConnectAssociateSecurityKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateSecurityKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectAssociateSecurityKeyResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
See
AWSConnectAssociateSecurityKeyRequest
See
AWSConnectAssociateSecurityKeyResponse
Declaration
Objective-C
- (void) associateSecurityKey: (nonnull AWSConnectAssociateSecurityKeyRequest *)request completionHandler: (void (^_Nullable)(AWSConnectAssociateSecurityKeyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateSecurityKey(_ request: AWSConnectAssociateSecurityKeyRequest, completionHandler: ((AWSConnectAssociateSecurityKeyResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AssociateSecurityKey service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceConflict
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
. -
Creates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectCreateContactFlowRequest
See
AWSConnectCreateContactFlowResponse
Declaration
Objective-C
- (id)createContactFlow:(nonnull AWSConnectCreateContactFlowRequest *)request;
Swift
func createContactFlow(_ request: AWSConnectCreateContactFlowRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateContactFlow service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateContactFlowResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidContactFlow
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorLimitExceeded
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Creates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectCreateContactFlowRequest
See
AWSConnectCreateContactFlowResponse
Declaration
Objective-C
- (void)createContactFlow:(nonnull AWSConnectCreateContactFlowRequest *)request completionHandler: (void (^_Nullable)(AWSConnectCreateContactFlowResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createContactFlow(_ request: AWSConnectCreateContactFlowRequest, completionHandler: ((AWSConnectCreateContactFlowResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateContactFlow service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidContactFlow
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorLimitExceeded
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
See
AWSConnectCreateInstanceRequest
See
AWSConnectCreateInstanceResponse
Declaration
Objective-C
- (id)createInstance:(nonnull AWSConnectCreateInstanceRequest *)request;
Swift
func createInstance(_ request: AWSConnectCreateInstanceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateInstance service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateInstanceResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
See
AWSConnectCreateInstanceRequest
See
AWSConnectCreateInstanceResponse
Declaration
Objective-C
- (void)createInstance:(nonnull AWSConnectCreateInstanceRequest *)request completionHandler: (void (^_Nullable)(AWSConnectCreateInstanceResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createInstance(_ request: AWSConnectCreateInstanceRequest, completionHandler: ((AWSConnectCreateInstanceResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateInstance service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Create an AppIntegration association with an Amazon Connect instance.
See
AWSConnectCreateIntegrationAssociationRequest
See
AWSConnectCreateIntegrationAssociationResponse
Declaration
Objective-C
- (id)createIntegrationAssociation: (nonnull AWSConnectCreateIntegrationAssociationRequest *)request;
Swift
func createIntegrationAssociation(_ request: AWSConnectCreateIntegrationAssociationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateIntegrationAssociation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateIntegrationAssociationResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Create an AppIntegration association with an Amazon Connect instance.
See
AWSConnectCreateIntegrationAssociationRequest
See
AWSConnectCreateIntegrationAssociationResponse
Declaration
Objective-C
- (void)createIntegrationAssociation: (nonnull AWSConnectCreateIntegrationAssociationRequest *)request completionHandler: (void (^_Nullable)( AWSConnectCreateIntegrationAssociationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createIntegrationAssociation(_ request: AWSConnectCreateIntegrationAssociationRequest, completionHandler: ((AWSConnectCreateIntegrationAssociationResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateIntegrationAssociation service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
See
AWSConnectCreateQueueRequest
See
AWSConnectCreateQueueResponse
Declaration
Objective-C
- (id)createQueue:(nonnull AWSConnectCreateQueueRequest *)request;
Swift
func createQueue(_ request: AWSConnectCreateQueueRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateQueue service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateQueueResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
See
AWSConnectCreateQueueRequest
See
AWSConnectCreateQueueResponse
Declaration
Objective-C
- (void)createQueue:(nonnull AWSConnectCreateQueueRequest *)request completionHandler: (void (^_Nullable)(AWSConnectCreateQueueResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createQueue(_ request: AWSConnectCreateQueueRequest, completionHandler: ((AWSConnectCreateQueueResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateQueue service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Creates a quick connect for the specified Amazon Connect instance.
See
AWSConnectCreateQuickConnectRequest
See
AWSConnectCreateQuickConnectResponse
Declaration
Objective-C
- (id)createQuickConnect:(nonnull AWSConnectCreateQuickConnectRequest *)request;
Swift
func createQuickConnect(_ request: AWSConnectCreateQuickConnectRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateQuickConnect service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateQuickConnectResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Creates a quick connect for the specified Amazon Connect instance.
See
AWSConnectCreateQuickConnectRequest
See
AWSConnectCreateQuickConnectResponse
Declaration
Objective-C
- (void)createQuickConnect: (nonnull AWSConnectCreateQuickConnectRequest *)request completionHandler: (void (^_Nullable)(AWSConnectCreateQuickConnectResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createQuickConnect(_ request: AWSConnectCreateQuickConnectRequest, completionHandler: ((AWSConnectCreateQuickConnectResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateQuickConnect service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Creates a new routing profile.
See
AWSConnectCreateRoutingProfileRequest
See
AWSConnectCreateRoutingProfileResponse
Declaration
Objective-C
- (id)createRoutingProfile: (nonnull AWSConnectCreateRoutingProfileRequest *)request;
Swift
func createRoutingProfile(_ request: AWSConnectCreateRoutingProfileRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateRoutingProfile service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateRoutingProfileResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Creates a new routing profile.
See
AWSConnectCreateRoutingProfileRequest
See
AWSConnectCreateRoutingProfileResponse
Declaration
Objective-C
- (void) createRoutingProfile: (nonnull AWSConnectCreateRoutingProfileRequest *)request completionHandler: (void (^_Nullable)(AWSConnectCreateRoutingProfileResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createRoutingProfile(_ request: AWSConnectCreateRoutingProfileRequest, completionHandler: ((AWSConnectCreateRoutingProfileResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateRoutingProfile service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorLimitExceeded
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Creates a use case for an AppIntegration association.
See
AWSConnectCreateUseCaseRequest
See
AWSConnectCreateUseCaseResponse
Declaration
Objective-C
- (id)createUseCase:(nonnull AWSConnectCreateUseCaseRequest *)request;
Swift
func createUseCase(_ request: AWSConnectCreateUseCaseRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateUseCase service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateUseCaseResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Creates a use case for an AppIntegration association.
See
AWSConnectCreateUseCaseRequest
See
AWSConnectCreateUseCaseResponse
Declaration
Objective-C
- (void)createUseCase:(nonnull AWSConnectCreateUseCaseRequest *)request completionHandler: (void (^_Nullable)(AWSConnectCreateUseCaseResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createUseCase(_ request: AWSConnectCreateUseCaseRequest, completionHandler: ((AWSConnectCreateUseCaseResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateUseCase service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
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 ofAWSConnectCreateUserResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorLimitExceeded
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Creates a new user hierarchy group.
See
AWSConnectCreateUserHierarchyGroupRequest
See
AWSConnectCreateUserHierarchyGroupResponse
Declaration
Objective-C
- (id)createUserHierarchyGroup: (nonnull AWSConnectCreateUserHierarchyGroupRequest *)request;
Swift
func createUserHierarchyGroup(_ request: AWSConnectCreateUserHierarchyGroupRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateUserHierarchyGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectCreateUserHierarchyGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorLimitExceeded
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Creates a new user hierarchy group.
See
AWSConnectCreateUserHierarchyGroupRequest
See
AWSConnectCreateUserHierarchyGroupResponse
Declaration
Objective-C
- (void)createUserHierarchyGroup: (nonnull AWSConnectCreateUserHierarchyGroupRequest *)request completionHandler: (void (^_Nullable)( AWSConnectCreateUserHierarchyGroupResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createUserHierarchyGroup(_ request: AWSConnectCreateUserHierarchyGroupRequest, completionHandler: ((AWSConnectCreateUserHierarchyGroupResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateUserHierarchyGroup service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorLimitExceeded
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
See
AWSConnectDeleteInstanceRequest
Declaration
Objective-C
- (id)deleteInstance:(nonnull AWSConnectDeleteInstanceRequest *)request;
Swift
func deleteInstance(_ request: AWSConnectDeleteInstanceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteInstance service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
See
AWSConnectDeleteInstanceRequest
Declaration
Objective-C
- (void)deleteInstance:(nonnull AWSConnectDeleteInstanceRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteInstance(_ request: AWSConnectDeleteInstanceRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteInstance service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.
See
AWSConnectDeleteIntegrationAssociationRequest
Declaration
Objective-C
- (id)deleteIntegrationAssociation: (nonnull AWSConnectDeleteIntegrationAssociationRequest *)request;
Swift
func deleteIntegrationAssociation(_ request: AWSConnectDeleteIntegrationAssociationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteIntegrationAssociation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.
See
AWSConnectDeleteIntegrationAssociationRequest
Declaration
Objective-C
- (void)deleteIntegrationAssociation: (nonnull AWSConnectDeleteIntegrationAssociationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteIntegrationAssociation(_ request: AWSConnectDeleteIntegrationAssociationRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteIntegrationAssociation service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes a quick connect.
See
AWSConnectDeleteQuickConnectRequest
Declaration
Objective-C
- (id)deleteQuickConnect:(nonnull AWSConnectDeleteQuickConnectRequest *)request;
Swift
func deleteQuickConnect(_ request: AWSConnectDeleteQuickConnectRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteQuickConnect service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes a quick connect.
See
AWSConnectDeleteQuickConnectRequest
Declaration
Objective-C
- (void) deleteQuickConnect:(nonnull AWSConnectDeleteQuickConnectRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteQuickConnect(_ request: AWSConnectDeleteQuickConnectRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteQuickConnect service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes a use case from an AppIntegration association.
See
AWSConnectDeleteUseCaseRequest
Declaration
Objective-C
- (id)deleteUseCase:(nonnull AWSConnectDeleteUseCaseRequest *)request;
Swift
func deleteUseCase(_ request: AWSConnectDeleteUseCaseRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteUseCase service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes a use case from an AppIntegration association.
See
AWSConnectDeleteUseCaseRequest
Declaration
Objective-C
- (void)deleteUseCase:(nonnull AWSConnectDeleteUseCaseRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteUseCase(_ request: AWSConnectDeleteUseCaseRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteUseCase service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
See
AWSConnectDeleteUserHierarchyGroupRequest
Declaration
Objective-C
- (id)deleteUserHierarchyGroup: (nonnull AWSConnectDeleteUserHierarchyGroupRequest *)request;
Swift
func deleteUserHierarchyGroup(_ request: AWSConnectDeleteUserHierarchyGroupRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteUserHierarchyGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceInUse
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
See
AWSConnectDeleteUserHierarchyGroupRequest
Declaration
Objective-C
- (void)deleteUserHierarchyGroup: (nonnull AWSConnectDeleteUserHierarchyGroupRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteUserHierarchyGroup(_ request: AWSConnectDeleteUserHierarchyGroupRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteUserHierarchyGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceInUse
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Describes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectDescribeContactFlowRequest
See
AWSConnectDescribeContactFlowResponse
Declaration
Objective-C
- (id)describeContactFlow: (nonnull AWSConnectDescribeContactFlowRequest *)request;
Swift
func describeContactFlow(_ request: AWSConnectDescribeContactFlowRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeContactFlow service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeContactFlowResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorContactFlowNotPublished
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Describes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectDescribeContactFlowRequest
See
AWSConnectDescribeContactFlowResponse
Declaration
Objective-C
- (void) describeContactFlow:(nonnull AWSConnectDescribeContactFlowRequest *)request completionHandler: (void (^_Nullable)(AWSConnectDescribeContactFlowResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeContactFlow(_ request: AWSConnectDescribeContactFlowRequest, completionHandler: ((AWSConnectDescribeContactFlowResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeContactFlow service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorContactFlowNotPublished
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
See
AWSConnectDescribeHoursOfOperationRequest
See
AWSConnectDescribeHoursOfOperationResponse
Declaration
Objective-C
- (id)describeHoursOfOperation: (nonnull AWSConnectDescribeHoursOfOperationRequest *)request;
Swift
func describeHours(ofOperation request: AWSConnectDescribeHoursOfOperationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeHoursOfOperation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeHoursOfOperationResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
See
AWSConnectDescribeHoursOfOperationRequest
See
AWSConnectDescribeHoursOfOperationResponse
Declaration
Objective-C
- (void)describeHoursOfOperation: (nonnull AWSConnectDescribeHoursOfOperationRequest *)request completionHandler: (void (^_Nullable)( AWSConnectDescribeHoursOfOperationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeHours(ofOperation request: AWSConnectDescribeHoursOfOperationRequest, completionHandler: ((AWSConnectDescribeHoursOfOperationResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeHoursOfOperation service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
See
AWSConnectDescribeInstanceRequest
See
AWSConnectDescribeInstanceResponse
Declaration
Objective-C
- (id)describeInstance:(nonnull AWSConnectDescribeInstanceRequest *)request;
Swift
func describeInstance(_ request: AWSConnectDescribeInstanceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeInstance service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeInstanceResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
See
AWSConnectDescribeInstanceRequest
See
AWSConnectDescribeInstanceResponse
Declaration
Objective-C
- (void)describeInstance:(nonnull AWSConnectDescribeInstanceRequest *)request completionHandler: (void (^_Nullable)(AWSConnectDescribeInstanceResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeInstance(_ request: AWSConnectDescribeInstanceRequest, completionHandler: ((AWSConnectDescribeInstanceResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeInstance service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
See
AWSConnectDescribeInstanceAttributeRequest
See
AWSConnectDescribeInstanceAttributeResponse
Declaration
Objective-C
- (id)describeInstanceAttribute: (nonnull AWSConnectDescribeInstanceAttributeRequest *)request;
Swift
func describeInstanceAttribute(_ request: AWSConnectDescribeInstanceAttributeRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeInstanceAttribute service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeInstanceAttributeResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
See
AWSConnectDescribeInstanceAttributeRequest
See
AWSConnectDescribeInstanceAttributeResponse
Declaration
Objective-C
- (void)describeInstanceAttribute: (nonnull AWSConnectDescribeInstanceAttributeRequest *)request completionHandler: (void (^_Nullable)( AWSConnectDescribeInstanceAttributeResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeInstanceAttribute(_ request: AWSConnectDescribeInstanceAttributeRequest, completionHandler: ((AWSConnectDescribeInstanceAttributeResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeInstanceAttribute service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
See
AWSConnectDescribeInstanceStorageConfigRequest
See
AWSConnectDescribeInstanceStorageConfigResponse
Declaration
Objective-C
- (id)describeInstanceStorageConfig: (nonnull AWSConnectDescribeInstanceStorageConfigRequest *)request;
Swift
func describeInstanceStorageConfig(_ request: AWSConnectDescribeInstanceStorageConfigRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeInstanceStorageConfig service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeInstanceStorageConfigResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
See
AWSConnectDescribeInstanceStorageConfigRequest
See
AWSConnectDescribeInstanceStorageConfigResponse
Declaration
Objective-C
- (void)describeInstanceStorageConfig: (nonnull AWSConnectDescribeInstanceStorageConfigRequest *)request completionHandler: (void (^_Nullable)( AWSConnectDescribeInstanceStorageConfigResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeInstanceStorageConfig(_ request: AWSConnectDescribeInstanceStorageConfigRequest, completionHandler: ((AWSConnectDescribeInstanceStorageConfigResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeInstanceStorageConfig service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
See
AWSConnectDescribeQueueRequest
See
AWSConnectDescribeQueueResponse
Declaration
Objective-C
- (id)describeQueue:(nonnull AWSConnectDescribeQueueRequest *)request;
Swift
func describeQueue(_ request: AWSConnectDescribeQueueRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeQueue service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeQueueResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
See
AWSConnectDescribeQueueRequest
See
AWSConnectDescribeQueueResponse
Declaration
Objective-C
- (void)describeQueue:(nonnull AWSConnectDescribeQueueRequest *)request completionHandler: (void (^_Nullable)(AWSConnectDescribeQueueResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeQueue(_ request: AWSConnectDescribeQueueRequest, completionHandler: ((AWSConnectDescribeQueueResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeQueue service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the quick connect.
See
AWSConnectDescribeQuickConnectRequest
See
AWSConnectDescribeQuickConnectResponse
Declaration
Objective-C
- (id)describeQuickConnect: (nonnull AWSConnectDescribeQuickConnectRequest *)request;
Swift
func describeQuickConnect(_ request: AWSConnectDescribeQuickConnectRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeQuickConnect service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeQuickConnectResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Describes the quick connect.
See
AWSConnectDescribeQuickConnectRequest
See
AWSConnectDescribeQuickConnectResponse
Declaration
Objective-C
- (void) describeQuickConnect: (nonnull AWSConnectDescribeQuickConnectRequest *)request completionHandler: (void (^_Nullable)(AWSConnectDescribeQuickConnectResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeQuickConnect(_ request: AWSConnectDescribeQuickConnectRequest, completionHandler: ((AWSConnectDescribeQuickConnectResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeQuickConnect service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Describes the specified routing profile.
See
AWSConnectDescribeRoutingProfileRequest
See
AWSConnectDescribeRoutingProfileResponse
Declaration
Objective-C
- (id)describeRoutingProfile: (nonnull AWSConnectDescribeRoutingProfileRequest *)request;
Swift
func describeRoutingProfile(_ request: AWSConnectDescribeRoutingProfileRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeRoutingProfile service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectDescribeRoutingProfileResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Describes the specified routing profile.
See
AWSConnectDescribeRoutingProfileRequest
See
AWSConnectDescribeRoutingProfileResponse
Declaration
Objective-C
- (void)describeRoutingProfile: (nonnull AWSConnectDescribeRoutingProfileRequest *)request completionHandler: (void (^_Nullable)( AWSConnectDescribeRoutingProfileResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeRoutingProfile(_ request: AWSConnectDescribeRoutingProfileRequest, completionHandler: ((AWSConnectDescribeRoutingProfileResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeRoutingProfile service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectDescribeUserResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectDescribeUserHierarchyGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectDescribeUserHierarchyStructureResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
See
AWSConnectDisassociateApprovedOriginRequest
Declaration
Objective-C
- (id)disassociateApprovedOrigin: (nonnull AWSConnectDisassociateApprovedOriginRequest *)request;
Swift
func disassociateApprovedOrigin(_ request: AWSConnectDisassociateApprovedOriginRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateApprovedOrigin service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
See
AWSConnectDisassociateApprovedOriginRequest
Declaration
Objective-C
- (void)disassociateApprovedOrigin: (nonnull AWSConnectDisassociateApprovedOriginRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disassociateApprovedOrigin(_ request: AWSConnectDisassociateApprovedOriginRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisassociateApprovedOrigin service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
See
AWSConnectDisassociateInstanceStorageConfigRequest
Declaration
Objective-C
- (id)disassociateInstanceStorageConfig: (nonnull AWSConnectDisassociateInstanceStorageConfigRequest *)request;
Swift
func disassociateInstanceStorageConfig(_ request: AWSConnectDisassociateInstanceStorageConfigRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateInstanceStorageConfig service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
See
AWSConnectDisassociateInstanceStorageConfigRequest
Declaration
Objective-C
- (void) disassociateInstanceStorageConfig: (nonnull AWSConnectDisassociateInstanceStorageConfigRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func disassociateInstanceStorageConfig(_ request: AWSConnectDisassociateInstanceStorageConfigRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisassociateInstanceStorageConfig service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant contact flow blocks.
See
AWSConnectDisassociateLambdaFunctionRequest
Declaration
Objective-C
- (id)disassociateLambdaFunction: (nonnull AWSConnectDisassociateLambdaFunctionRequest *)request;
Swift
func disassociateLambdaFunction(_ request: AWSConnectDisassociateLambdaFunctionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateLambdaFunction service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant contact flow blocks.
See
AWSConnectDisassociateLambdaFunctionRequest
Declaration
Objective-C
- (void)disassociateLambdaFunction: (nonnull AWSConnectDisassociateLambdaFunctionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disassociateLambdaFunction(_ request: AWSConnectDisassociateLambdaFunctionRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisassociateLambdaFunction service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
See
AWSConnectDisassociateLexBotRequest
Declaration
Objective-C
- (id)disassociateLexBot:(nonnull AWSConnectDisassociateLexBotRequest *)request;
Swift
func disassociateLexBot(_ request: AWSConnectDisassociateLexBotRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateLexBot service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
See
AWSConnectDisassociateLexBotRequest
Declaration
Objective-C
- (void) disassociateLexBot:(nonnull AWSConnectDisassociateLexBotRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disassociateLexBot(_ request: AWSConnectDisassociateLexBotRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisassociateLexBot service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
See
AWSConnectDisassociateQueueQuickConnectsRequest
Declaration
Objective-C
- (id)disassociateQueueQuickConnects: (nonnull AWSConnectDisassociateQueueQuickConnectsRequest *)request;
Swift
func disassociateQueueQuickConnects(_ request: AWSConnectDisassociateQueueQuickConnectsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateQueueQuickConnects service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
See
AWSConnectDisassociateQueueQuickConnectsRequest
Declaration
Objective-C
- (void)disassociateQueueQuickConnects: (nonnull AWSConnectDisassociateQueueQuickConnectsRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func disassociateQueueQuickConnects(_ request: AWSConnectDisassociateQueueQuickConnectsRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisassociateQueueQuickConnects service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Disassociates a set of queues from a routing profile.
See
AWSConnectDisassociateRoutingProfileQueuesRequest
Declaration
Objective-C
- (id)disassociateRoutingProfileQueues: (nonnull AWSConnectDisassociateRoutingProfileQueuesRequest *)request;
Swift
func disassociateRoutingProfileQueues(_ request: AWSConnectDisassociateRoutingProfileQueuesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateRoutingProfileQueues service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Disassociates a set of queues from a routing profile.
See
AWSConnectDisassociateRoutingProfileQueuesRequest
Declaration
Objective-C
- (void)disassociateRoutingProfileQueues: (nonnull AWSConnectDisassociateRoutingProfileQueuesRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func disassociateRoutingProfileQueues(_ request: AWSConnectDisassociateRoutingProfileQueuesRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisassociateRoutingProfileQueues service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
See
AWSConnectDisassociateSecurityKeyRequest
Declaration
Objective-C
- (id)disassociateSecurityKey: (nonnull AWSConnectDisassociateSecurityKeyRequest *)request;
Swift
func disassociateSecurityKey(_ request: AWSConnectDisassociateSecurityKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisassociateSecurityKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
See
AWSConnectDisassociateSecurityKeyRequest
Declaration
Objective-C
- (void)disassociateSecurityKey: (nonnull AWSConnectDisassociateSecurityKeyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disassociateSecurityKey(_ request: AWSConnectDisassociateSecurityKeyRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisassociateSecurityKey service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
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 ofAWSConnectGetContactAttributesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectGetCurrentMetricDataResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectGetFederationTokenResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectGetMetricDataResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorInternalService
,AWSConnectErrorThrottling
,AWSConnectErrorResourceNotFound
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
See
AWSConnectListApprovedOriginsRequest
See
AWSConnectListApprovedOriginsResponse
Declaration
Objective-C
- (id)listApprovedOrigins: (nonnull AWSConnectListApprovedOriginsRequest *)request;
Swift
func listApprovedOrigins(_ request: AWSConnectListApprovedOriginsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListApprovedOrigins service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListApprovedOriginsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
See
AWSConnectListApprovedOriginsRequest
See
AWSConnectListApprovedOriginsResponse
Declaration
Objective-C
- (void) listApprovedOrigins:(nonnull AWSConnectListApprovedOriginsRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListApprovedOriginsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listApprovedOrigins(_ request: AWSConnectListApprovedOriginsRequest, completionHandler: ((AWSConnectListApprovedOriginsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListApprovedOrigins service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
Provides information about the contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
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 ofAWSConnectListContactFlowsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Provides information about the contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectListHoursOfOperationsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
See
AWSConnectListInstanceAttributesRequest
See
AWSConnectListInstanceAttributesResponse
Declaration
Objective-C
- (id)listInstanceAttributes: (nonnull AWSConnectListInstanceAttributesRequest *)request;
Swift
func listInstanceAttributes(_ request: AWSConnectListInstanceAttributesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListInstanceAttributes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListInstanceAttributesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
See
AWSConnectListInstanceAttributesRequest
See
AWSConnectListInstanceAttributesResponse
Declaration
Objective-C
- (void)listInstanceAttributes: (nonnull AWSConnectListInstanceAttributesRequest *)request completionHandler: (void (^_Nullable)( AWSConnectListInstanceAttributesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listInstanceAttributes(_ request: AWSConnectListInstanceAttributesRequest, completionHandler: ((AWSConnectListInstanceAttributesResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListInstanceAttributes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
See
AWSConnectListInstanceStorageConfigsRequest
See
AWSConnectListInstanceStorageConfigsResponse
Declaration
Objective-C
- (id)listInstanceStorageConfigs: (nonnull AWSConnectListInstanceStorageConfigsRequest *)request;
Swift
func listInstanceStorageConfigs(_ request: AWSConnectListInstanceStorageConfigsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListInstanceStorageConfigs service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListInstanceStorageConfigsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
See
AWSConnectListInstanceStorageConfigsRequest
See
AWSConnectListInstanceStorageConfigsResponse
Declaration
Objective-C
- (void) listInstanceStorageConfigs: (nonnull AWSConnectListInstanceStorageConfigsRequest *)request completionHandler: (void (^_Nullable)( AWSConnectListInstanceStorageConfigsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listInstanceStorageConfigs(_ request: AWSConnectListInstanceStorageConfigsRequest, completionHandler: ((AWSConnectListInstanceStorageConfigsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListInstanceStorageConfigs service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren’t successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
See
AWSConnectListInstancesRequest
See
AWSConnectListInstancesResponse
Declaration
Objective-C
- (id)listInstances:(nonnull AWSConnectListInstancesRequest *)request;
Swift
func listInstances(_ request: AWSConnectListInstancesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListInstances service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListInstancesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren’t successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
See
AWSConnectListInstancesRequest
See
AWSConnectListInstancesResponse
Declaration
Objective-C
- (void)listInstances:(nonnull AWSConnectListInstancesRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListInstancesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listInstances(_ request: AWSConnectListInstancesRequest, completionHandler: ((AWSConnectListInstancesResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListInstances service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.
See
AWSConnectListIntegrationAssociationsRequest
See
AWSConnectListIntegrationAssociationsResponse
Declaration
Objective-C
- (id)listIntegrationAssociations: (nonnull AWSConnectListIntegrationAssociationsRequest *)request;
Swift
func listIntegrationAssociations(_ request: AWSConnectListIntegrationAssociationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListIntegrationAssociations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListIntegrationAssociationsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.
See
AWSConnectListIntegrationAssociationsRequest
See
AWSConnectListIntegrationAssociationsResponse
Declaration
Objective-C
- (void) listIntegrationAssociations: (nonnull AWSConnectListIntegrationAssociationsRequest *)request completionHandler: (void (^_Nullable)( AWSConnectListIntegrationAssociationsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listIntegrationAssociations(_ request: AWSConnectListIntegrationAssociationsRequest, completionHandler: ((AWSConnectListIntegrationAssociationsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListIntegrationAssociations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks.
See
AWSConnectListLambdaFunctionsRequest
See
AWSConnectListLambdaFunctionsResponse
Declaration
Objective-C
- (id)listLambdaFunctions: (nonnull AWSConnectListLambdaFunctionsRequest *)request;
Swift
func listLambdaFunctions(_ request: AWSConnectListLambdaFunctionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListLambdaFunctions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListLambdaFunctionsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks.
See
AWSConnectListLambdaFunctionsRequest
See
AWSConnectListLambdaFunctionsResponse
Declaration
Objective-C
- (void) listLambdaFunctions:(nonnull AWSConnectListLambdaFunctionsRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListLambdaFunctionsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listLambdaFunctions(_ request: AWSConnectListLambdaFunctionsRequest, completionHandler: ((AWSConnectListLambdaFunctionsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListLambdaFunctions service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
See
AWSConnectListLexBotsRequest
See
AWSConnectListLexBotsResponse
Declaration
Objective-C
- (id)listLexBots:(nonnull AWSConnectListLexBotsRequest *)request;
Swift
func listLexBots(_ request: AWSConnectListLexBotsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListLexBots service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListLexBotsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
See
AWSConnectListLexBotsRequest
See
AWSConnectListLexBotsResponse
Declaration
Objective-C
- (void)listLexBots:(nonnull AWSConnectListLexBotsRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListLexBotsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listLexBots(_ request: AWSConnectListLexBotsRequest, completionHandler: ((AWSConnectListLexBotsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListLexBots service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
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 ofAWSConnectListPhoneNumbersResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Provides information about the prompts for the specified Amazon Connect instance.
See
AWSConnectListPromptsRequest
See
AWSConnectListPromptsResponse
Declaration
Objective-C
- (id)listPrompts:(nonnull AWSConnectListPromptsRequest *)request;
Swift
func listPrompts(_ request: AWSConnectListPromptsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListPrompts service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListPromptsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Provides information about the prompts for the specified Amazon Connect instance.
See
AWSConnectListPromptsRequest
See
AWSConnectListPromptsResponse
Declaration
Objective-C
- (void)listPrompts:(nonnull AWSConnectListPromptsRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListPromptsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listPrompts(_ request: AWSConnectListPromptsRequest, completionHandler: ((AWSConnectListPromptsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListPrompts service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
See
AWSConnectListQueueQuickConnectsRequest
See
AWSConnectListQueueQuickConnectsResponse
Declaration
Objective-C
- (id)listQueueQuickConnects: (nonnull AWSConnectListQueueQuickConnectsRequest *)request;
Swift
func listQueueQuickConnects(_ request: AWSConnectListQueueQuickConnectsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListQueueQuickConnects service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListQueueQuickConnectsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
See
AWSConnectListQueueQuickConnectsRequest
See
AWSConnectListQueueQuickConnectsResponse
Declaration
Objective-C
- (void)listQueueQuickConnects: (nonnull AWSConnectListQueueQuickConnectsRequest *)request completionHandler: (void (^_Nullable)( AWSConnectListQueueQuickConnectsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listQueueQuickConnects(_ request: AWSConnectListQueueQuickConnectsRequest, completionHandler: ((AWSConnectListQueueQuickConnectsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListQueueQuickConnects service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectListQueuesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the quick connects for the specified Amazon Connect instance.
See
AWSConnectListQuickConnectsRequest
See
AWSConnectListQuickConnectsResponse
Declaration
Objective-C
- (id)listQuickConnects:(nonnull AWSConnectListQuickConnectsRequest *)request;
Swift
func listQuickConnects(_ request: AWSConnectListQuickConnectsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListQuickConnects service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListQuickConnectsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the quick connects for the specified Amazon Connect instance.
See
AWSConnectListQuickConnectsRequest
See
AWSConnectListQuickConnectsResponse
Declaration
Objective-C
- (void)listQuickConnects:(nonnull AWSConnectListQuickConnectsRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListQuickConnectsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listQuickConnects(_ request: AWSConnectListQuickConnectsRequest, completionHandler: ((AWSConnectListQuickConnectsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListQuickConnects service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Lists the queues associated with a routing profile.
See
AWSConnectListRoutingProfileQueuesRequest
See
AWSConnectListRoutingProfileQueuesResponse
Declaration
Objective-C
- (id)listRoutingProfileQueues: (nonnull AWSConnectListRoutingProfileQueuesRequest *)request;
Swift
func listRoutingProfileQueues(_ request: AWSConnectListRoutingProfileQueuesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListRoutingProfileQueues service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListRoutingProfileQueuesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Lists the queues associated with a routing profile.
See
AWSConnectListRoutingProfileQueuesRequest
See
AWSConnectListRoutingProfileQueuesResponse
Declaration
Objective-C
- (void)listRoutingProfileQueues: (nonnull AWSConnectListRoutingProfileQueuesRequest *)request completionHandler: (void (^_Nullable)( AWSConnectListRoutingProfileQueuesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listRoutingProfileQueues(_ request: AWSConnectListRoutingProfileQueuesRequest, completionHandler: ((AWSConnectListRoutingProfileQueuesResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListRoutingProfileQueues service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectListRoutingProfilesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
See
AWSConnectListSecurityKeysRequest
See
AWSConnectListSecurityKeysResponse
Declaration
Objective-C
- (id)listSecurityKeys:(nonnull AWSConnectListSecurityKeysRequest *)request;
Swift
func listSecurityKeys(_ request: AWSConnectListSecurityKeysRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListSecurityKeys service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListSecurityKeysResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
See
AWSConnectListSecurityKeysRequest
See
AWSConnectListSecurityKeysResponse
Declaration
Objective-C
- (void)listSecurityKeys:(nonnull AWSConnectListSecurityKeysRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListSecurityKeysResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listSecurityKeys(_ request: AWSConnectListSecurityKeysRequest, completionHandler: ((AWSConnectListSecurityKeysResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListSecurityKeys service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
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 ofAWSConnectListSecurityProfilesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectListTagsForResourceResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorInternalService
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Lists the use cases.
See
AWSConnectListUseCasesRequest
See
AWSConnectListUseCasesResponse
Declaration
Objective-C
- (id)listUseCases:(nonnull AWSConnectListUseCasesRequest *)request;
Swift
func listUseCases(_ request: AWSConnectListUseCasesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListUseCases service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectListUseCasesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Lists the use cases.
See
AWSConnectListUseCasesRequest
See
AWSConnectListUseCasesResponse
Declaration
Objective-C
- (void)listUseCases:(nonnull AWSConnectListUseCasesRequest *)request completionHandler: (void (^_Nullable)(AWSConnectListUseCasesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listUseCases(_ request: AWSConnectListUseCasesRequest, completionHandler: ((AWSConnectListUseCasesResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListUseCases service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,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 ofAWSConnectListUserHierarchyGroupsResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 ofAWSConnectListUsersResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
See
AWSConnectResumeContactRecordingRequest
See
AWSConnectResumeContactRecordingResponse
Declaration
Objective-C
- (id)resumeContactRecording: (nonnull AWSConnectResumeContactRecordingRequest *)request;
Swift
func resumeContactRecording(_ request: AWSConnectResumeContactRecordingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ResumeContactRecording service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectResumeContactRecordingResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
See
AWSConnectResumeContactRecordingRequest
See
AWSConnectResumeContactRecordingResponse
Declaration
Objective-C
- (void)resumeContactRecording: (nonnull AWSConnectResumeContactRecordingRequest *)request completionHandler: (void (^_Nullable)( AWSConnectResumeContactRecordingResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func resumeContactRecording(_ request: AWSConnectResumeContactRecordingRequest, completionHandler: ((AWSConnectResumeContactRecordingResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ResumeContactRecording service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,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 must 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 chat, 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 ofAWSConnectStartChatContactResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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 must 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 chat, 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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorLimitExceeded
. -
Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
See
AWSConnectStartContactRecordingRequest
See
AWSConnectStartContactRecordingResponse
Declaration
Objective-C
- (id)startContactRecording: (nonnull AWSConnectStartContactRecordingRequest *)request;
Swift
func startContactRecording(_ request: AWSConnectStartContactRecordingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the StartContactRecording service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectStartContactRecordingResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
See
AWSConnectStartContactRecordingRequest
See
AWSConnectStartContactRecordingResponse
Declaration
Objective-C
- (void)startContactRecording: (nonnull AWSConnectStartContactRecordingRequest *)request completionHandler: (void (^_Nullable)( AWSConnectStartContactRecordingResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func startContactRecording(_ request: AWSConnectStartContactRecordingRequest, completionHandler: ((AWSConnectStartContactRecordingResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the StartContactRecording service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
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 do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then 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 ofAWSConnectStartOutboundVoiceContactResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorLimitExceeded
,AWSConnectErrorDestinationNotAllowed
,AWSConnectErrorOutboundContactNotPermitted
. -
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 do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then 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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorLimitExceeded
,AWSConnectErrorDestinationNotAllowed
,AWSConnectErrorOutboundContactNotPermitted
. -
Initiates a contact flow to start a new task.
See
AWSConnectStartTaskContactRequest
See
AWSConnectStartTaskContactResponse
Declaration
Objective-C
- (id)startTaskContact:(nonnull AWSConnectStartTaskContactRequest *)request;
Swift
func startTaskContact(_ request: AWSConnectStartTaskContactRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the StartTaskContact service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectStartTaskContactResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorInternalService
. -
Initiates a contact flow to start a new task.
See
AWSConnectStartTaskContactRequest
See
AWSConnectStartTaskContactResponse
Declaration
Objective-C
- (void)startTaskContact:(nonnull AWSConnectStartTaskContactRequest *)request completionHandler: (void (^_Nullable)(AWSConnectStartTaskContactResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func startTaskContact(_ request: AWSConnectStartTaskContactRequest, completionHandler: ((AWSConnectStartTaskContactResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the StartTaskContact service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorServiceQuotaExceeded
,AWSConnectErrorInternalService
. -
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 ofAWSConnectStopContactResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorContactNotFound
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
See
AWSConnectStopContactRecordingRequest
See
AWSConnectStopContactRecordingResponse
Declaration
Objective-C
- (id)stopContactRecording: (nonnull AWSConnectStopContactRecordingRequest *)request;
Swift
func stopContactRecording(_ request: AWSConnectStopContactRecordingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the StopContactRecording service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectStopContactRecordingResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
See
AWSConnectStopContactRecordingRequest
See
AWSConnectStopContactRecordingResponse
Declaration
Objective-C
- (void) stopContactRecording: (nonnull AWSConnectStopContactRecordingRequest *)request completionHandler: (void (^_Nullable)(AWSConnectStopContactRecordingResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func stopContactRecording(_ request: AWSConnectStopContactRecordingRequest, completionHandler: ((AWSConnectStopContactRecordingResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the StopContactRecording service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
See
AWSConnectSuspendContactRecordingRequest
See
AWSConnectSuspendContactRecordingResponse
Declaration
Objective-C
- (id)suspendContactRecording: (nonnull AWSConnectSuspendContactRecordingRequest *)request;
Swift
func suspendContactRecording(_ request: AWSConnectSuspendContactRecordingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the SuspendContactRecording service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSConnectSuspendContactRecordingResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
See
AWSConnectSuspendContactRecordingRequest
See
AWSConnectSuspendContactRecordingResponse
Declaration
Objective-C
- (void)suspendContactRecording: (nonnull AWSConnectSuspendContactRecordingRequest *)request completionHandler: (void (^_Nullable)( AWSConnectSuspendContactRecordingResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func suspendContactRecording(_ request: AWSConnectSuspendContactRecordingRequest, completionHandler: ((AWSConnectSuspendContactRecordingResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the SuspendContactRecording service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
Adds the specified tags to the specified resource.
The supported resource types are users, routing profiles, queues, quick connects, and contact flows.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorInternalService
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
. -
Adds the specified tags to the specified resource.
The supported resource types are users, routing profiles, queues, quick connects, and contact flows.
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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, while the call is active, you can update the customer’s name or the reason the customer called. You can add notes about steps that the agent took during the call that display 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 to identify 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, which was 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 ofAWSConnectUpdateContactAttributesResponse
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, while the call is active, you can update the customer’s name or the reason the customer called. You can add notes about steps that the agent took during the call that display 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 to identify 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, which was 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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
. -
Updates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectUpdateContactFlowContentRequest
Declaration
Objective-C
- (id)updateContactFlowContent: (nonnull AWSConnectUpdateContactFlowContentRequest *)request;
Swift
func updateContactFlowContent(_ request: AWSConnectUpdateContactFlowContentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateContactFlowContent service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidContactFlow
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectUpdateContactFlowContentRequest
Declaration
Objective-C
- (void)updateContactFlowContent: (nonnull AWSConnectUpdateContactFlowContentRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateContactFlowContent(_ request: AWSConnectUpdateContactFlowContentRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateContactFlowContent service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidContactFlow
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
The name of the contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectUpdateContactFlowNameRequest
Declaration
Objective-C
- (id)updateContactFlowName: (nonnull AWSConnectUpdateContactFlowNameRequest *)request;
Swift
func updateContactFlowName(_ request: AWSConnectUpdateContactFlowNameRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateContactFlowName service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
The name of the contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
See
AWSConnectUpdateContactFlowNameRequest
Declaration
Objective-C
- (void)updateContactFlowName: (nonnull AWSConnectUpdateContactFlowNameRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateContactFlowName(_ request: AWSConnectUpdateContactFlowNameRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateContactFlowName service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
See
AWSConnectUpdateInstanceAttributeRequest
Declaration
Objective-C
- (id)updateInstanceAttribute: (nonnull AWSConnectUpdateInstanceAttributeRequest *)request;
Swift
func updateInstanceAttribute(_ request: AWSConnectUpdateInstanceAttributeRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateInstanceAttribute service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
See
AWSConnectUpdateInstanceAttributeRequest
Declaration
Objective-C
- (void)updateInstanceAttribute: (nonnull AWSConnectUpdateInstanceAttributeRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateInstanceAttribute(_ request: AWSConnectUpdateInstanceAttributeRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateInstanceAttribute service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
See
AWSConnectUpdateInstanceStorageConfigRequest
Declaration
Objective-C
- (id)updateInstanceStorageConfig: (nonnull AWSConnectUpdateInstanceStorageConfigRequest *)request;
Swift
func updateInstanceStorageConfig(_ request: AWSConnectUpdateInstanceStorageConfigRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateInstanceStorageConfig service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
See
AWSConnectUpdateInstanceStorageConfigRequest
Declaration
Objective-C
- (void)updateInstanceStorageConfig: (nonnull AWSConnectUpdateInstanceStorageConfigRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateInstanceStorageConfig(_ request: AWSConnectUpdateInstanceStorageConfigRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateInstanceStorageConfig service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorResourceNotFound
,AWSConnectErrorInternalService
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorThrottling
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
See
AWSConnectUpdateQueueHoursOfOperationRequest
Declaration
Objective-C
- (id)updateQueueHoursOfOperation: (nonnull AWSConnectUpdateQueueHoursOfOperationRequest *)request;
Swift
func updateQueueHours(ofOperation request: AWSConnectUpdateQueueHoursOfOperationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateQueueHoursOfOperation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
See
AWSConnectUpdateQueueHoursOfOperationRequest
Declaration
Objective-C
- (void)updateQueueHoursOfOperation: (nonnull AWSConnectUpdateQueueHoursOfOperationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateQueueHours(ofOperation request: AWSConnectUpdateQueueHoursOfOperationRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateQueueHoursOfOperation service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
See
AWSConnectUpdateQueueMaxContactsRequest
Declaration
Objective-C
- (id)updateQueueMaxContacts: (nonnull AWSConnectUpdateQueueMaxContactsRequest *)request;
Swift
func updateQueueMaxContacts(_ request: AWSConnectUpdateQueueMaxContactsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateQueueMaxContacts service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
See
AWSConnectUpdateQueueMaxContactsRequest
Declaration
Objective-C
- (void)updateQueueMaxContacts: (nonnull AWSConnectUpdateQueueMaxContactsRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateQueueMaxContacts(_ request: AWSConnectUpdateQueueMaxContactsRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateQueueMaxContacts service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least
Name
orDescription
must be provided.See
AWSConnectUpdateQueueNameRequest
Declaration
Objective-C
- (id)updateQueueName:(nonnull AWSConnectUpdateQueueNameRequest *)request;
Swift
func updateQueueName(_ request: AWSConnectUpdateQueueNameRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateQueueName service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least
Name
orDescription
must be provided.See
AWSConnectUpdateQueueNameRequest
Declaration
Objective-C
- (void)updateQueueName:(nonnull AWSConnectUpdateQueueNameRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateQueueName(_ request: AWSConnectUpdateQueueNameRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateQueueName service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
See
AWSConnectUpdateQueueOutboundCallerConfigRequest
Declaration
Objective-C
- (id)updateQueueOutboundCallerConfig: (nonnull AWSConnectUpdateQueueOutboundCallerConfigRequest *)request;
Swift
func updateQueueOutboundCallerConfig(_ request: AWSConnectUpdateQueueOutboundCallerConfigRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateQueueOutboundCallerConfig service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
See
AWSConnectUpdateQueueOutboundCallerConfigRequest
Declaration
Objective-C
- (void)updateQueueOutboundCallerConfig: (nonnull AWSConnectUpdateQueueOutboundCallerConfigRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func updateQueueOutboundCallerConfig(_ request: AWSConnectUpdateQueueOutboundCallerConfigRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateQueueOutboundCallerConfig service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
See
AWSConnectUpdateQueueStatusRequest
Declaration
Objective-C
- (id)updateQueueStatus:(nonnull AWSConnectUpdateQueueStatusRequest *)request;
Swift
func updateQueueStatus(_ request: AWSConnectUpdateQueueStatusRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateQueueStatus service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
See
AWSConnectUpdateQueueStatusRequest
Declaration
Objective-C
- (void)updateQueueStatus:(nonnull AWSConnectUpdateQueueStatusRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateQueueStatus(_ request: AWSConnectUpdateQueueStatusRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateQueueStatus service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the configuration settings for the specified quick connect.
See
AWSConnectUpdateQuickConnectConfigRequest
Declaration
Objective-C
- (id)updateQuickConnectConfig: (nonnull AWSConnectUpdateQuickConnectConfigRequest *)request;
Swift
func updateQuickConnectConfig(_ request: AWSConnectUpdateQuickConnectConfigRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateQuickConnectConfig service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the configuration settings for the specified quick connect.
See
AWSConnectUpdateQuickConnectConfigRequest
Declaration
Objective-C
- (void)updateQuickConnectConfig: (nonnull AWSConnectUpdateQuickConnectConfigRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateQuickConnectConfig(_ request: AWSConnectUpdateQuickConnectConfigRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateQuickConnectConfig service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least
Name
orDescription
must be provided.See
AWSConnectUpdateQuickConnectNameRequest
Declaration
Objective-C
- (id)updateQuickConnectName: (nonnull AWSConnectUpdateQuickConnectNameRequest *)request;
Swift
func updateQuickConnectName(_ request: AWSConnectUpdateQuickConnectNameRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateQuickConnectName service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least
Name
orDescription
must be provided.See
AWSConnectUpdateQuickConnectNameRequest
Declaration
Objective-C
- (void)updateQuickConnectName: (nonnull AWSConnectUpdateQuickConnectNameRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateQuickConnectName(_ request: AWSConnectUpdateQuickConnectNameRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateQuickConnectName service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
See
AWSConnectUpdateRoutingProfileConcurrencyRequest
Declaration
Objective-C
- (id)updateRoutingProfileConcurrency: (nonnull AWSConnectUpdateRoutingProfileConcurrencyRequest *)request;
Swift
func updateRoutingProfileConcurrency(_ request: AWSConnectUpdateRoutingProfileConcurrencyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileConcurrency service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
See
AWSConnectUpdateRoutingProfileConcurrencyRequest
Declaration
Objective-C
- (void)updateRoutingProfileConcurrency: (nonnull AWSConnectUpdateRoutingProfileConcurrencyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func updateRoutingProfileConcurrency(_ request: AWSConnectUpdateRoutingProfileConcurrencyRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileConcurrency service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the default outbound queue of a routing profile.
See
AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest
Declaration
Objective-C
- (id)updateRoutingProfileDefaultOutboundQueue: (nonnull AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest *) request;
Swift
func updateRoutingProfileDefaultOutboundQueue(_ request: AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileDefaultOutboundQueue service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the default outbound queue of a routing profile.
See
AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest
Declaration
Objective-C
- (void) updateRoutingProfileDefaultOutboundQueue: (nonnull AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest *) request completionHandler: (void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func updateRoutingProfileDefaultOutboundQueue(_ request: AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileDefaultOutboundQueue service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least
Name
orDescription
must be provided.See
AWSConnectUpdateRoutingProfileNameRequest
Declaration
Objective-C
- (id)updateRoutingProfileName: (nonnull AWSConnectUpdateRoutingProfileNameRequest *)request;
Swift
func updateRoutingProfileName(_ request: AWSConnectUpdateRoutingProfileNameRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileName service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least
Name
orDescription
must be provided.See
AWSConnectUpdateRoutingProfileNameRequest
Declaration
Objective-C
- (void)updateRoutingProfileName: (nonnull AWSConnectUpdateRoutingProfileNameRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateRoutingProfileName(_ request: AWSConnectUpdateRoutingProfileNameRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileName service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorDuplicateResource
,AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the properties associated with a set of queues for a routing profile.
See
AWSConnectUpdateRoutingProfileQueuesRequest
Declaration
Objective-C
- (id)updateRoutingProfileQueues: (nonnull AWSConnectUpdateRoutingProfileQueuesRequest *)request;
Swift
func updateRoutingProfileQueues(_ request: AWSConnectUpdateRoutingProfileQueuesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileQueues service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the properties associated with a set of queues for a routing profile.
See
AWSConnectUpdateRoutingProfileQueuesRequest
Declaration
Objective-C
- (void)updateRoutingProfileQueues: (nonnull AWSConnectUpdateRoutingProfileQueuesRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateRoutingProfileQueues(_ request: AWSConnectUpdateRoutingProfileQueuesRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateRoutingProfileQueues service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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
- (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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the name of the user hierarchy group.
See
AWSConnectUpdateUserHierarchyGroupNameRequest
Declaration
Objective-C
- (id)updateUserHierarchyGroupName: (nonnull AWSConnectUpdateUserHierarchyGroupNameRequest *)request;
Swift
func updateUserHierarchyGroupName(_ request: AWSConnectUpdateUserHierarchyGroupNameRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateUserHierarchyGroupName service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the name of the user hierarchy group.
See
AWSConnectUpdateUserHierarchyGroupNameRequest
Declaration
Objective-C
- (void)updateUserHierarchyGroupName: (nonnull AWSConnectUpdateUserHierarchyGroupNameRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateUserHierarchyGroupName(_ request: AWSConnectUpdateUserHierarchyGroupNameRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateUserHierarchyGroupName service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorDuplicateResource
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
See
AWSConnectUpdateUserHierarchyStructureRequest
Declaration
Objective-C
- (id)updateUserHierarchyStructure: (nonnull AWSConnectUpdateUserHierarchyStructureRequest *)request;
Swift
func updateUserHierarchyStructure(_ request: AWSConnectUpdateUserHierarchyStructureRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateUserHierarchyStructure service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceInUse
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
See
AWSConnectUpdateUserHierarchyStructureRequest
Declaration
Objective-C
- (void)updateUserHierarchyStructure: (nonnull AWSConnectUpdateUserHierarchyStructureRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateUserHierarchyStructure(_ request: AWSConnectUpdateUserHierarchyStructureRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateUserHierarchyStructure service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorResourceInUse
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke
UpdateUserIdentityInfo
. Someone with that ability 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. 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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
domain and the following error code:AWSConnectErrorInvalidRequest
,AWSConnectErrorInvalidParameter
,AWSConnectErrorResourceNotFound
,AWSConnectErrorThrottling
,AWSConnectErrorInternalService
. -
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke
UpdateUserIdentityInfo
. Someone with that ability 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. 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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSConnectErrorDomain
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 benil
. On failed execution,task.error
may contain anNSError
withAWSConnectErrorDomain
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