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 Amazon Web Services 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
  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain 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 or Amazon Lex V2 bot.

    See

    AWSConnectAssociateBotRequest

    Declaration

    Objective-C

    - (id)associateBot:(nonnull AWSConnectAssociateBotRequest *)request;

    Swift

    func associateBot(_ request: AWSConnectAssociateBotRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorResourceConflict, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorLimitExceeded, 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 or Amazon Lex V2 bot.

    See

    AWSConnectAssociateBotRequest

    Declaration

    Objective-C

    - (void)associateBot:(nonnull AWSConnectAssociateBotRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func associateBot(_ request: AWSConnectAssociateBotRequest) async throws

    Parameters

    request

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

    completionHandler

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

  • Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

    See

    AWSConnectAssociateDefaultVocabularyRequest

    See

    AWSConnectAssociateDefaultVocabularyResponse

    Declaration

    Objective-C

    - (id)associateDefaultVocabulary:
        (nonnull AWSConnectAssociateDefaultVocabularyRequest *)request;

    Swift

    func associateDefaultVocabulary(_ request: AWSConnectAssociateDefaultVocabularyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

    See

    AWSConnectAssociateDefaultVocabularyRequest

    See

    AWSConnectAssociateDefaultVocabularyResponse

    Declaration

    Objective-C

    - (void)
        associateDefaultVocabulary:
            (nonnull AWSConnectAssociateDefaultVocabularyRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSConnectAssociateDefaultVocabularyResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func associateDefaultVocabulary(_ request: AWSConnectAssociateDefaultVocabularyRequest) async throws -> AWSConnectAssociateDefaultVocabularyResponse

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectAssociateInstanceStorageConfigResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectAssociateInstanceStorageConfigResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorResourceConflict, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorThrottling.

  • Associates a contact flow with a phone number claimed to your Amazon Connect instance.

    See

    AWSConnectAssociatePhoneNumberContactFlowRequest

    Declaration

    Objective-C

    - (id)associatePhoneNumberContactFlow:
        (nonnull AWSConnectAssociatePhoneNumberContactFlowRequest *)request;

    Swift

    func associatePhoneNumberContactFlow(_ request: AWSConnectAssociatePhoneNumberContactFlowRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Associates a contact flow with a phone number claimed to your Amazon Connect instance.

    See

    AWSConnectAssociatePhoneNumberContactFlowRequest

    Declaration

    Objective-C

    - (void)associatePhoneNumberContactFlow:
                (nonnull AWSConnectAssociatePhoneNumberContactFlowRequest *)request
                          completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                                completionHandler;

    Swift

    func associatePhoneNumberContactFlow(_ request: AWSConnectAssociatePhoneNumberContactFlowRequest) async throws

    Parameters

    request

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

    completionHandler

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

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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 of AWSConnectAssociateSecurityKeyResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectAssociateSecurityKeyResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorResourceConflict, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorThrottling.

  • Claims an available phone number to your Amazon Connect instance.

    See

    AWSConnectClaimPhoneNumberRequest

    See

    AWSConnectClaimPhoneNumberResponse

    Declaration

    Objective-C

    - (id)claimPhoneNumber:(nonnull AWSConnectClaimPhoneNumberRequest *)request;

    Swift

    func claimPhoneNumber(_ request: AWSConnectClaimPhoneNumberRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Claims an available phone number to your Amazon Connect instance.

    See

    AWSConnectClaimPhoneNumberRequest

    See

    AWSConnectClaimPhoneNumberResponse

    Declaration

    Objective-C

    - (void)claimPhoneNumber:(nonnull AWSConnectClaimPhoneNumberRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectClaimPhoneNumberResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func claimPhoneNumber(_ request: AWSConnectClaimPhoneNumberRequest) async throws -> AWSConnectClaimPhoneNumberResponse

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Creates an agent status for the specified Amazon Connect instance.

    See

    AWSConnectCreateAgentStatusRequest

    See

    AWSConnectCreateAgentStatusResponse

    Declaration

    Objective-C

    - (id)createAgentStatus:(nonnull AWSConnectCreateAgentStatusRequest *)request;

    Swift

    func createAgentStatus(_ request: AWSConnectCreateAgentStatusRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectCreateAgentStatusResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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 an agent status for the specified Amazon Connect instance.

    See

    AWSConnectCreateAgentStatusRequest

    See

    AWSConnectCreateAgentStatusResponse

    Declaration

    Objective-C

    - (void)createAgentStatus:(nonnull AWSConnectCreateAgentStatusRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSConnectCreateAgentStatusResponse *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func createAgentStatus(_ request: AWSConnectCreateAgentStatusRequest) async throws -> AWSConnectCreateAgentStatusResponse

    Parameters

    request

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

    completionHandler

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

    - (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 of AWSConnectCreateContactFlowResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectCreateContactFlowResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidContactFlow, AWSConnectErrorInvalidParameter, AWSConnectErrorDuplicateResource, AWSConnectErrorLimitExceeded, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Creates a contact flow module for the specified Amazon Connect instance.

    See

    AWSConnectCreateContactFlowModuleRequest

    See

    AWSConnectCreateContactFlowModuleResponse

    Declaration

    Objective-C

    - (id)createContactFlowModule:
        (nonnull AWSConnectCreateContactFlowModuleRequest *)request;

    Swift

    func createContactFlowModule(_ request: AWSConnectCreateContactFlowModuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a contact flow module for the specified Amazon Connect instance.

    See

    AWSConnectCreateContactFlowModuleRequest

    See

    AWSConnectCreateContactFlowModuleResponse

    Declaration

    Objective-C

    - (void)createContactFlowModule:
                (nonnull AWSConnectCreateContactFlowModuleRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectCreateContactFlowModuleResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func createContactFlowModule(_ request: AWSConnectCreateContactFlowModuleRequest) async throws -> AWSConnectCreateContactFlowModuleResponse

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Creates hours of operation.

    See

    AWSConnectCreateHoursOfOperationRequest

    See

    AWSConnectCreateHoursOfOperationResponse

    Declaration

    Objective-C

    - (id)createHoursOfOperation:
        (nonnull AWSConnectCreateHoursOfOperationRequest *)request;

    Swift

    func createHours(ofOperation request: AWSConnectCreateHoursOfOperationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Creates hours of operation.

    See

    AWSConnectCreateHoursOfOperationRequest

    See

    AWSConnectCreateHoursOfOperationResponse

    Declaration

    Objective-C

    - (void)createHoursOfOperation:
                (nonnull AWSConnectCreateHoursOfOperationRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSConnectCreateHoursOfOperationResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func createHours(ofOperation request: AWSConnectCreateHoursOfOperationRequest) async throws -> AWSConnectCreateHoursOfOperationResponse

    Parameters

    request

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

    completionHandler

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

    Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

    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 of AWSConnectCreateInstanceResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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.

    Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

    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) async throws -> AWSConnectCreateInstanceResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorThrottling, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Creates an Amazon Web Services resource 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 of AWSConnectCreateIntegrationAssociationResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorThrottling.

  • Creates an Amazon Web Services resource 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) async throws -> AWSConnectCreateIntegrationAssociationResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectCreateQueueResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectCreateQueueResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorLimitExceeded, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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 of AWSConnectCreateQuickConnectResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorLimitExceeded, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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) async throws -> AWSConnectCreateQuickConnectResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, 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 of AWSConnectCreateRoutingProfileResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectCreateRoutingProfileResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorLimitExceeded, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • This API is in preview release for Amazon Connect and is subject to change.

    Creates a security profile.

    See

    AWSConnectCreateSecurityProfileRequest

    See

    AWSConnectCreateSecurityProfileResponse

    Declaration

    Objective-C

    - (id)createSecurityProfile:
        (nonnull AWSConnectCreateSecurityProfileRequest *)request;

    Swift

    func createSecurityProfile(_ request: AWSConnectCreateSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Creates a security profile.

    See

    AWSConnectCreateSecurityProfileRequest

    See

    AWSConnectCreateSecurityProfileResponse

    Declaration

    Objective-C

    - (void)createSecurityProfile:
                (nonnull AWSConnectCreateSecurityProfileRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSConnectCreateSecurityProfileResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func createSecurityProfile(_ request: AWSConnectCreateSecurityProfileRequest) async throws -> AWSConnectCreateSecurityProfileResponse

    Parameters

    request

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

    completionHandler

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

  • Creates a new task template in the specified Amazon Connect instance.

    See

    AWSConnectCreateTaskTemplateRequest

    See

    AWSConnectCreateTaskTemplateResponse

    Declaration

    Objective-C

    - (id)createTaskTemplate:(nonnull AWSConnectCreateTaskTemplateRequest *)request;

    Swift

    func createTaskTemplate(_ request: AWSConnectCreateTaskTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new task template in the specified Amazon Connect instance.

    See

    AWSConnectCreateTaskTemplateRequest

    See

    AWSConnectCreateTaskTemplateResponse

    Declaration

    Objective-C

    - (void)createTaskTemplate:
                (nonnull AWSConnectCreateTaskTemplateRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSConnectCreateTaskTemplateResponse *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func createTaskTemplate(_ request: AWSConnectCreateTaskTemplateRequest) async throws -> AWSConnectCreateTaskTemplateResponse

    Parameters

    request

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

    completionHandler

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

  • Creates a use case for an integration 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 of AWSConnectCreateUseCaseResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorThrottling.

  • Creates a use case for an integration 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) async throws -> AWSConnectCreateUseCaseResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectCreateUserResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorLimitExceeded, AWSConnectErrorDuplicateResource, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

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

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

    See

    AWSConnectCreateUserRequest

    See

    AWSConnectCreateUserResponse

    Declaration

    Objective-C

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

    Swift

    func createUser(_ request: AWSConnectCreateUserRequest) async throws -> AWSConnectCreateUserResponse

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectCreateUserHierarchyGroupResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectCreateUserHierarchyGroupResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorDuplicateResource, AWSConnectErrorLimitExceeded, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

    See

    AWSConnectCreateVocabularyRequest

    See

    AWSConnectCreateVocabularyResponse

    Declaration

    Objective-C

    - (id)createVocabulary:(nonnull AWSConnectCreateVocabularyRequest *)request;

    Swift

    func createVocabulary(_ request: AWSConnectCreateVocabularyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

    See

    AWSConnectCreateVocabularyRequest

    See

    AWSConnectCreateVocabularyResponse

    Declaration

    Objective-C

    - (void)createVocabulary:(nonnull AWSConnectCreateVocabularyRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectCreateVocabularyResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func createVocabulary(_ request: AWSConnectCreateVocabularyRequest) async throws -> AWSConnectCreateVocabularyResponse

    Parameters

    request

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

    completionHandler

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

  • Deletes a contact flow for the specified Amazon Connect instance.

    See

    AWSConnectDeleteContactFlowRequest

    Declaration

    Objective-C

    - (id)deleteContactFlow:(nonnull AWSConnectDeleteContactFlowRequest *)request;

    Swift

    func deleteContactFlow(_ request: AWSConnectDeleteContactFlowRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a contact flow for the specified Amazon Connect instance.

    See

    AWSConnectDeleteContactFlowRequest

    Declaration

    Objective-C

    - (void)deleteContactFlow:(nonnull AWSConnectDeleteContactFlowRequest *)request
            completionHandler:
                (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteContactFlow(_ request: AWSConnectDeleteContactFlowRequest) async throws

    Parameters

    request

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

    completionHandler

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

  • Deletes the specified contact flow module.

    See

    AWSConnectDeleteContactFlowModuleRequest

    See

    AWSConnectDeleteContactFlowModuleResponse

    Declaration

    Objective-C

    - (id)deleteContactFlowModule:
        (nonnull AWSConnectDeleteContactFlowModuleRequest *)request;

    Swift

    func deleteContactFlowModule(_ request: AWSConnectDeleteContactFlowModuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes the specified contact flow module.

    See

    AWSConnectDeleteContactFlowModuleRequest

    See

    AWSConnectDeleteContactFlowModuleResponse

    Declaration

    Objective-C

    - (void)deleteContactFlowModule:
                (nonnull AWSConnectDeleteContactFlowModuleRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectDeleteContactFlowModuleResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func deleteContactFlowModule(_ request: AWSConnectDeleteContactFlowModuleRequest) async throws -> AWSConnectDeleteContactFlowModuleResponse

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Deletes an hours of operation.

    See

    AWSConnectDeleteHoursOfOperationRequest

    Declaration

    Objective-C

    - (id)deleteHoursOfOperation:
        (nonnull AWSConnectDeleteHoursOfOperationRequest *)request;

    Swift

    func deleteHours(ofOperation request: AWSConnectDeleteHoursOfOperationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Deletes an hours of operation.

    See

    AWSConnectDeleteHoursOfOperationRequest

    Declaration

    Objective-C

    - (void)deleteHoursOfOperation:
                (nonnull AWSConnectDeleteHoursOfOperationRequest *)request
                 completionHandler:
                     (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteHours(ofOperation request: AWSConnectDeleteHoursOfOperationRequest) async throws

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Deletes the Amazon Connect instance.

    Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

    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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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.

    Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

    See

    AWSConnectDeleteInstanceRequest

    Declaration

    Objective-C

    - (void)deleteInstance:(nonnull AWSConnectDeleteInstanceRequest *)request
         completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteInstance(_ request: AWSConnectDeleteInstanceRequest) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest.

  • Deletes an Amazon Web Services resource 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorThrottling.

  • Deletes an Amazon Web Services resource 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorThrottling.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Deletes a quick connect.

    See

    AWSConnectDeleteQuickConnectRequest

    Declaration

    Objective-C

    - (void)
        deleteQuickConnect:(nonnull AWSConnectDeleteQuickConnectRequest *)request
         completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteQuickConnect(_ request: AWSConnectDeleteQuickConnectRequest) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • This API is in preview release for Amazon Connect and is subject to change.

    Deletes a security profile.

    See

    AWSConnectDeleteSecurityProfileRequest

    Declaration

    Objective-C

    - (id)deleteSecurityProfile:
        (nonnull AWSConnectDeleteSecurityProfileRequest *)request;

    Swift

    func deleteSecurityProfile(_ request: AWSConnectDeleteSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Deletes a security profile.

    See

    AWSConnectDeleteSecurityProfileRequest

    Declaration

    Objective-C

    - (void)deleteSecurityProfile:
                (nonnull AWSConnectDeleteSecurityProfileRequest *)request
                completionHandler:
                    (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteSecurityProfile(_ request: AWSConnectDeleteSecurityProfileRequest) async throws

    Parameters

    request

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

    completionHandler

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

  • Deletes the task template.

    See

    AWSConnectDeleteTaskTemplateRequest

    See

    AWSConnectDeleteTaskTemplateResponse

    Declaration

    Objective-C

    - (id)deleteTaskTemplate:(nonnull AWSConnectDeleteTaskTemplateRequest *)request;

    Swift

    func deleteTaskTemplate(_ request: AWSConnectDeleteTaskTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes the task template.

    See

    AWSConnectDeleteTaskTemplateRequest

    See

    AWSConnectDeleteTaskTemplateResponse

    Declaration

    Objective-C

    - (void)deleteTaskTemplate:
                (nonnull AWSConnectDeleteTaskTemplateRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSConnectDeleteTaskTemplateResponse *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func deleteTaskTemplate(_ request: AWSConnectDeleteTaskTemplateRequest) async throws -> AWSConnectDeleteTaskTemplateResponse

    Parameters

    request

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

    completionHandler

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

  • Deletes a use case from an integration 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorThrottling.

  • Deletes a use case from an integration association.

    See

    AWSConnectDeleteUseCaseRequest

    Declaration

    Objective-C

    - (void)deleteUseCase:(nonnull AWSConnectDeleteUseCaseRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteUseCase(_ request: AWSConnectDeleteUseCaseRequest) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

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

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

    See

    AWSConnectDeleteUserRequest

    Declaration

    Objective-C

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

    Swift

    func deleteUser(_ request: AWSConnectDeleteUserRequest) async throws

    Parameters

    request

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

    completionHandler

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

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorResourceInUse, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Deletes the vocabulary that has the given identifier.

    See

    AWSConnectDeleteVocabularyRequest

    See

    AWSConnectDeleteVocabularyResponse

    Declaration

    Objective-C

    - (id)deleteVocabulary:(nonnull AWSConnectDeleteVocabularyRequest *)request;

    Swift

    func deleteVocabulary(_ request: AWSConnectDeleteVocabularyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes the vocabulary that has the given identifier.

    See

    AWSConnectDeleteVocabularyRequest

    See

    AWSConnectDeleteVocabularyResponse

    Declaration

    Objective-C

    - (void)deleteVocabulary:(nonnull AWSConnectDeleteVocabularyRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectDeleteVocabularyResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func deleteVocabulary(_ request: AWSConnectDeleteVocabularyRequest) async throws -> AWSConnectDeleteVocabularyResponse

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Describes an agent status.

    See

    AWSConnectDescribeAgentStatusRequest

    See

    AWSConnectDescribeAgentStatusResponse

    Declaration

    Objective-C

    - (id)describeAgentStatus:
        (nonnull AWSConnectDescribeAgentStatusRequest *)request;

    Swift

    func describeAgentStatus(_ request: AWSConnectDescribeAgentStatusRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectDescribeAgentStatusResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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 an agent status.

    See

    AWSConnectDescribeAgentStatusRequest

    See

    AWSConnectDescribeAgentStatusResponse

    Declaration

    Objective-C

    - (void)
        describeAgentStatus:(nonnull AWSConnectDescribeAgentStatusRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSConnectDescribeAgentStatusResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeAgentStatus(_ request: AWSConnectDescribeAgentStatusRequest) async throws -> AWSConnectDescribeAgentStatusResponse

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Describes the specified contact.

    Contact information remains available in Amazon Connect for 24 months, and then it is deleted.

    See

    AWSConnectDescribeContactRequest

    See

    AWSConnectDescribeContactResponse

    Declaration

    Objective-C

    - (id)describeContact:(nonnull AWSConnectDescribeContactRequest *)request;

    Swift

    func describeContact(_ request: AWSConnectDescribeContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Describes the specified contact.

    Contact information remains available in Amazon Connect for 24 months, and then it is deleted.

    See

    AWSConnectDescribeContactRequest

    See

    AWSConnectDescribeContactResponse

    Declaration

    Objective-C

    - (void)describeContact:(nonnull AWSConnectDescribeContactRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSConnectDescribeContactResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeContact(_ request: AWSConnectDescribeContactRequest) async throws -> AWSConnectDescribeContactResponse

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectDescribeContactFlowResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectDescribeContactFlowResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorContactFlowNotPublished, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the specified contact flow module.

    See

    AWSConnectDescribeContactFlowModuleRequest

    See

    AWSConnectDescribeContactFlowModuleResponse

    Declaration

    Objective-C

    - (id)describeContactFlowModule:
        (nonnull AWSConnectDescribeContactFlowModuleRequest *)request;

    Swift

    func describeContactFlowModule(_ request: AWSConnectDescribeContactFlowModuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes the specified contact flow module.

    See

    AWSConnectDescribeContactFlowModuleRequest

    See

    AWSConnectDescribeContactFlowModuleResponse

    Declaration

    Objective-C

    - (void)describeContactFlowModule:
                (nonnull AWSConnectDescribeContactFlowModuleRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSConnectDescribeContactFlowModuleResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func describeContactFlowModule(_ request: AWSConnectDescribeContactFlowModuleRequest) async throws -> AWSConnectDescribeContactFlowModuleResponse

    Parameters

    request

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

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorAccessDenied, 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

    - (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 of AWSConnectDescribeHoursOfOperationResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectDescribeHoursOfOperationResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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 of AWSConnectDescribeInstanceResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectDescribeInstanceResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • 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 of AWSConnectDescribeInstanceAttributeResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectDescribeInstanceAttributeResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectDescribeInstanceStorageConfigResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectDescribeInstanceStorageConfigResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorThrottling.

  • Gets details and status of a phone number that’s claimed to your Amazon Connect instance

    See

    AWSConnectDescribePhoneNumberRequest

    See

    AWSConnectDescribePhoneNumberResponse

    Declaration

    Objective-C

    - (id)describePhoneNumber:
        (nonnull AWSConnectDescribePhoneNumberRequest *)request;

    Swift

    func describePhoneNumber(_ request: AWSConnectDescribePhoneNumberRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets details and status of a phone number that’s claimed to your Amazon Connect instance

    See

    AWSConnectDescribePhoneNumberRequest

    See

    AWSConnectDescribePhoneNumberResponse

    Declaration

    Objective-C

    - (void)
        describePhoneNumber:(nonnull AWSConnectDescribePhoneNumberRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSConnectDescribePhoneNumberResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describePhoneNumber(_ request: AWSConnectDescribePhoneNumberRequest) async throws -> AWSConnectDescribePhoneNumberResponse

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectDescribeQueueResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectDescribeQueueResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the 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 of AWSConnectDescribeQuickConnectResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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) async throws -> AWSConnectDescribeQuickConnectResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the specified 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 of AWSConnectDescribeRoutingProfileResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Describes the specified 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) async throws -> AWSConnectDescribeRoutingProfileResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • This API is in preview release for Amazon Connect and is subject to change.

    Gets basic information about the security profle.

    See

    AWSConnectDescribeSecurityProfileRequest

    See

    AWSConnectDescribeSecurityProfileResponse

    Declaration

    Objective-C

    - (id)describeSecurityProfile:
        (nonnull AWSConnectDescribeSecurityProfileRequest *)request;

    Swift

    func describeSecurityProfile(_ request: AWSConnectDescribeSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectDescribeSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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.

    Gets basic information about the security profle.

    See

    AWSConnectDescribeSecurityProfileRequest

    See

    AWSConnectDescribeSecurityProfileResponse

    Declaration

    Objective-C

    - (void)describeSecurityProfile:
                (nonnull AWSConnectDescribeSecurityProfileRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectDescribeSecurityProfileResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeSecurityProfile(_ request: AWSConnectDescribeSecurityProfileRequest) async throws -> AWSConnectDescribeSecurityProfileResponse

    Parameters

    request

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

    completionHandler

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

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

    See

    AWSConnectDescribeUserRequest

    See

    AWSConnectDescribeUserResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectDescribeUserRequest

    See

    AWSConnectDescribeUserResponse

    Declaration

    Objective-C

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

    Swift

    func describeUser(_ request: AWSConnectDescribeUserRequest) async throws -> AWSConnectDescribeUserResponse

    Parameters

    request

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

    completionHandler

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

  • Describes the specified hierarchy group.

    See

    AWSConnectDescribeUserHierarchyGroupRequest

    See

    AWSConnectDescribeUserHierarchyGroupResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Describes the specified hierarchy group.

    See

    AWSConnectDescribeUserHierarchyGroupRequest

    See

    AWSConnectDescribeUserHierarchyGroupResponse

    Declaration

    Objective-C

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

    Swift

    func describeUserHierarchyGroup(_ request: AWSConnectDescribeUserHierarchyGroupRequest) async throws -> AWSConnectDescribeUserHierarchyGroupResponse

    Parameters

    request

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

    completionHandler

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

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

    See

    AWSConnectDescribeUserHierarchyStructureRequest

    See

    AWSConnectDescribeUserHierarchyStructureResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectDescribeUserHierarchyStructureRequest

    See

    AWSConnectDescribeUserHierarchyStructureResponse

    Declaration

    Objective-C

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

    Swift

    func describeUserHierarchyStructure(_ request: AWSConnectDescribeUserHierarchyStructureRequest) async throws -> AWSConnectDescribeUserHierarchyStructureResponse

    Parameters

    request

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

    completionHandler

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

  • Describes the specified vocabulary.

    See

    AWSConnectDescribeVocabularyRequest

    See

    AWSConnectDescribeVocabularyResponse

    Declaration

    Objective-C

    - (id)describeVocabulary:(nonnull AWSConnectDescribeVocabularyRequest *)request;

    Swift

    func describeVocabulary(_ request: AWSConnectDescribeVocabularyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes the specified vocabulary.

    See

    AWSConnectDescribeVocabularyRequest

    See

    AWSConnectDescribeVocabularyResponse

    Declaration

    Objective-C

    - (void)describeVocabulary:
                (nonnull AWSConnectDescribeVocabularyRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSConnectDescribeVocabularyResponse *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func describeVocabulary(_ request: AWSConnectDescribeVocabularyRequest) async throws -> AWSConnectDescribeVocabularyResponse

    Parameters

    request

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

    completionHandler

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

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain 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 or Amazon Lex V2 bot.

    See

    AWSConnectDisassociateBotRequest

    Declaration

    Objective-C

    - (id)disassociateBot:(nonnull AWSConnectDisassociateBotRequest *)request;

    Swift

    func disassociateBot(_ request: AWSConnectDisassociateBotRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, 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 or Amazon Lex V2 bot.

    See

    AWSConnectDisassociateBotRequest

    Declaration

    Objective-C

    - (void)disassociateBot:(nonnull AWSConnectDisassociateBotRequest *)request
          completionHandler:
              (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func disassociateBot(_ request: AWSConnectDisassociateBotRequest) async throws

    Parameters

    request

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

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorThrottling.

  • Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.

    See

    AWSConnectDisassociatePhoneNumberContactFlowRequest

    Declaration

    Objective-C

    - (id)disassociatePhoneNumberContactFlow:
        (nonnull AWSConnectDisassociatePhoneNumberContactFlowRequest *)request;

    Swift

    func disassociatePhoneNumberContactFlow(_ request: AWSConnectDisassociatePhoneNumberContactFlowRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.

    See

    AWSConnectDisassociatePhoneNumberContactFlowRequest

    Declaration

    Objective-C

    - (void)
        disassociatePhoneNumberContactFlow:
            (nonnull AWSConnectDisassociatePhoneNumberContactFlowRequest *)request
                         completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                               completionHandler;

    Swift

    func disassociatePhoneNumberContactFlow(_ request: AWSConnectDisassociatePhoneNumberContactFlowRequest) async throws

    Parameters

    request

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

    completionHandler

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

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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 be nil. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain 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 of AWSConnectGetContactAttributesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService.

  • Retrieves the contact attributes for the specified contact.

    See

    AWSConnectGetContactAttributesRequest

    See

    AWSConnectGetContactAttributesResponse

    Declaration

    Objective-C

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

    Swift

    func contactAttributes(_ request: AWSConnectGetContactAttributesRequest) async throws -> AWSConnectGetContactAttributesResponse

    Parameters

    request

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

    completionHandler

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

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

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

    See

    AWSConnectGetCurrentMetricDataRequest

    See

    AWSConnectGetCurrentMetricDataResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectGetCurrentMetricDataRequest

    See

    AWSConnectGetCurrentMetricDataResponse

    Declaration

    Objective-C

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

    Swift

    func currentMetricData(_ request: AWSConnectGetCurrentMetricDataRequest) async throws -> AWSConnectGetCurrentMetricDataResponse

    Parameters

    request

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

    completionHandler

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

  • Retrieves a token for federation.

    This API doesn’t support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

    Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

    See

    AWSConnectGetFederationTokenRequest

    See

    AWSConnectGetFederationTokenResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Retrieves a token for federation.

    This API doesn’t support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

    Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

    See

    AWSConnectGetFederationTokenRequest

    See

    AWSConnectGetFederationTokenResponse

    Declaration

    Objective-C

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

    Swift

    func federationToken(_ request: AWSConnectGetFederationTokenRequest) async throws -> AWSConnectGetFederationTokenResponse

    Parameters

    request

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

    completionHandler

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

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

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

    See

    AWSConnectGetMetricDataRequest

    See

    AWSConnectGetMetricDataResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectGetMetricDataRequest

    See

    AWSConnectGetMetricDataResponse

    Declaration

    Objective-C

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

    Swift

    func metricData(_ request: AWSConnectGetMetricDataRequest) async throws -> AWSConnectGetMetricDataResponse

    Parameters

    request

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

    completionHandler

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

  • Gets details about a specific task template in the specified Amazon Connect instance.

    See

    AWSConnectGetTaskTemplateRequest

    See

    AWSConnectGetTaskTemplateResponse

    Declaration

    Objective-C

    - (id)getTaskTemplate:(nonnull AWSConnectGetTaskTemplateRequest *)request;

    Swift

    func getTaskTemplate(_ request: AWSConnectGetTaskTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets details about a specific task template in the specified Amazon Connect instance.

    See

    AWSConnectGetTaskTemplateRequest

    See

    AWSConnectGetTaskTemplateResponse

    Declaration

    Objective-C

    - (void)getTaskTemplate:(nonnull AWSConnectGetTaskTemplateRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSConnectGetTaskTemplateResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func taskTemplate(_ request: AWSConnectGetTaskTemplateRequest) async throws -> AWSConnectGetTaskTemplateResponse

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    Lists agent statuses.

    See

    AWSConnectListAgentStatusRequest

    See

    AWSConnectListAgentStatusResponse

    Declaration

    Objective-C

    - (id)listAgentStatuses:(nonnull AWSConnectListAgentStatusRequest *)request;

    Swift

    func listAgentStatuses(_ request: AWSConnectListAgentStatusRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListAgentStatusResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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 agent statuses.

    See

    AWSConnectListAgentStatusRequest

    See

    AWSConnectListAgentStatusResponse

    Declaration

    Objective-C

    - (void)listAgentStatuses:(nonnull AWSConnectListAgentStatusRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSConnectListAgentStatusResponse *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func listAgentStatuses(_ request: AWSConnectListAgentStatusRequest) async throws -> AWSConnectListAgentStatusResponse

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectListApprovedOriginsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListApprovedOriginsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorThrottling.

  • This API is in preview release for Amazon Connect and is subject to change.

    For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance.

    See

    AWSConnectListBotsRequest

    See

    AWSConnectListBotsResponse

    Declaration

    Objective-C

    - (id)listBots:(nonnull AWSConnectListBotsRequest *)request;

    Swift

    func listBots(_ request: AWSConnectListBotsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This API is in preview release for Amazon Connect and is subject to change.

    For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance.

    See

    AWSConnectListBotsRequest

    See

    AWSConnectListBotsResponse

    Declaration

    Objective-C

    - (void)listBots:(nonnull AWSConnectListBotsRequest *)request
        completionHandler:(void (^_Nullable)(AWSConnectListBotsResponse *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listBots(_ request: AWSConnectListBotsRequest) async throws -> AWSConnectListBotsResponse

    Parameters

    request

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

    completionHandler

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

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

    See

    AWSConnectListContactFlowModulesRequest

    See

    AWSConnectListContactFlowModulesResponse

    Declaration

    Objective-C

    - (id)listContactFlowModules:
        (nonnull AWSConnectListContactFlowModulesRequest *)request;

    Swift

    func listContactFlowModules(_ request: AWSConnectListContactFlowModulesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectListContactFlowModulesRequest

    See

    AWSConnectListContactFlowModulesResponse

    Declaration

    Objective-C

    - (void)listContactFlowModules:
                (nonnull AWSConnectListContactFlowModulesRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSConnectListContactFlowModulesResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func listContactFlowModules(_ request: AWSConnectListContactFlowModulesRequest) async throws -> AWSConnectListContactFlowModulesResponse

    Parameters

    request

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

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorAccessDenied, 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

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    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) async throws -> AWSConnectListContactFlowsResponse

    Parameters

    request

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

    completionHandler

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

  • This API is in preview release for Amazon Connect and is subject to change.

    For the specified referenceTypes, returns a list of references associated with the contact.

    See

    AWSConnectListContactReferencesRequest

    See

    AWSConnectListContactReferencesResponse

    Declaration

    Objective-C

    - (id)listContactReferences:
        (nonnull AWSConnectListContactReferencesRequest *)request;

    Swift

    func listContactReferences(_ request: AWSConnectListContactReferencesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • This API is in preview release for Amazon Connect and is subject to change.

    For the specified referenceTypes, returns a list of references associated with the contact.

    See

    AWSConnectListContactReferencesRequest

    See

    AWSConnectListContactReferencesResponse

    Declaration

    Objective-C

    - (void)listContactReferences:
                (nonnull AWSConnectListContactReferencesRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSConnectListContactReferencesResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listContactReferences(_ request: AWSConnectListContactReferencesRequest) async throws -> AWSConnectListContactReferencesResponse

    Parameters

    request

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

    completionHandler

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

  • Lists the default vocabularies for the specified Amazon Connect instance.

    See

    AWSConnectListDefaultVocabulariesRequest

    See

    AWSConnectListDefaultVocabulariesResponse

    Declaration

    Objective-C

    - (id)listDefaultVocabularies:
        (nonnull AWSConnectListDefaultVocabulariesRequest *)request;

    Swift

    func listDefaultVocabularies(_ request: AWSConnectListDefaultVocabulariesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the default vocabularies for the specified Amazon Connect instance.

    See

    AWSConnectListDefaultVocabulariesRequest

    See

    AWSConnectListDefaultVocabulariesResponse

    Declaration

    Objective-C

    - (void)listDefaultVocabularies:
                (nonnull AWSConnectListDefaultVocabulariesRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectListDefaultVocabulariesResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func listDefaultVocabularies(_ request: AWSConnectListDefaultVocabulariesRequest) async throws -> AWSConnectListDefaultVocabulariesResponse

    Parameters

    request

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

    completionHandler

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

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

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

    See

    AWSConnectListHoursOfOperationsRequest

    See

    AWSConnectListHoursOfOperationsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectListHoursOfOperationsRequest

    See

    AWSConnectListHoursOfOperationsResponse

    Declaration

    Objective-C

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

    Swift

    func listHours(ofOperations request: AWSConnectListHoursOfOperationsRequest) async throws -> AWSConnectListHoursOfOperationsResponse

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectListInstanceAttributesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListInstanceAttributesResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectListInstanceStorageConfigsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListInstanceStorageConfigsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectListInstancesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListInstancesResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInternalService.

  • Provides summary information about the Amazon Web Services resource 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 of AWSConnectListIntegrationAssociationsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorThrottling.

  • Provides summary information about the Amazon Web Services resource 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) async throws -> AWSConnectListIntegrationAssociationsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectListLambdaFunctionsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListLambdaFunctionsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectListLexBotsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListLexBotsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectListPhoneNumbersResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

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

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

    See

    AWSConnectListPhoneNumbersRequest

    See

    AWSConnectListPhoneNumbersResponse

    Declaration

    Objective-C

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

    Swift

    func listPhoneNumbers(_ request: AWSConnectListPhoneNumbersRequest) async throws -> AWSConnectListPhoneNumbersResponse

    Parameters

    request

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

    completionHandler

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

  • Lists phone numbers claimed to your 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

    AWSConnectListPhoneNumbersV2Request

    See

    AWSConnectListPhoneNumbersV2Response

    Declaration

    Objective-C

    - (id)listPhoneNumbersV2:(nonnull AWSConnectListPhoneNumbersV2Request *)request;

    Swift

    func listPhoneNumbersV2(_ request: AWSConnectListPhoneNumbersV2Request) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists phone numbers claimed to your 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

    AWSConnectListPhoneNumbersV2Request

    See

    AWSConnectListPhoneNumbersV2Response

    Declaration

    Objective-C

    - (void)listPhoneNumbersV2:
                (nonnull AWSConnectListPhoneNumbersV2Request *)request
             completionHandler:
                 (void (^_Nullable)(AWSConnectListPhoneNumbersV2Response *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func listPhoneNumbersV2(_ request: AWSConnectListPhoneNumbersV2Request) async throws -> AWSConnectListPhoneNumbersV2Response

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectListPromptsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the 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) async throws -> AWSConnectListPromptsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • 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 of AWSConnectListQueueQuickConnectsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListQueueQuickConnectsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

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

    If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

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

    See

    AWSConnectListQueuesRequest

    See

    AWSConnectListQueuesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

    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) async throws -> AWSConnectListQueuesResponse

    Parameters

    request

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

    completionHandler

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

  • Provides 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 of AWSConnectListQuickConnectsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Provides information about the 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) async throws -> AWSConnectListQuickConnectsResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Lists the 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 of AWSConnectListRoutingProfileQueuesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListRoutingProfileQueuesResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

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

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

    See

    AWSConnectListRoutingProfilesRequest

    See

    AWSConnectListRoutingProfilesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectListRoutingProfilesRequest

    See

    AWSConnectListRoutingProfilesResponse

    Declaration

    Objective-C

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

    Swift

    func listRoutingProfiles(_ request: AWSConnectListRoutingProfilesRequest) async throws -> AWSConnectListRoutingProfilesResponse

    Parameters

    request

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

    completionHandler

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

  • 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 of AWSConnectListSecurityKeysResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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) async throws -> AWSConnectListSecurityKeysResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorThrottling.

  • This API is in preview release for Amazon Connect and is subject to change.

    Lists the permissions granted to a security profile.

    See

    AWSConnectListSecurityProfilePermissionsRequest

    See

    AWSConnectListSecurityProfilePermissionsResponse

    Declaration

    Objective-C

    - (id)listSecurityProfilePermissions:
        (nonnull AWSConnectListSecurityProfilePermissionsRequest *)request;

    Swift

    func listSecurityProfilePermissions(_ request: AWSConnectListSecurityProfilePermissionsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectListSecurityProfilePermissionsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain 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 permissions granted to a security profile.

    See

    AWSConnectListSecurityProfilePermissionsRequest

    See

    AWSConnectListSecurityProfilePermissionsResponse

    Declaration

    Objective-C

    - (void)listSecurityProfilePermissions:
                (nonnull AWSConnectListSecurityProfilePermissionsRequest *)request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSConnectListSecurityProfilePermissionsResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listSecurityProfilePermissions(_ request: AWSConnectListSecurityProfilePermissionsRequest) async throws -> AWSConnectListSecurityProfilePermissionsResponse

    Parameters

    request

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

    completionHandler

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

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

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

    See

    AWSConnectListSecurityProfilesRequest

    See

    AWSConnectListSecurityProfilesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectListSecurityProfilesRequest

    See

    AWSConnectListSecurityProfilesResponse

    Declaration

    Objective-C

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

    Swift

    func listSecurityProfiles(_ request: AWSConnectListSecurityProfilesRequest) async throws -> AWSConnectListSecurityProfilesResponse

    Parameters

    request

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

    completionHandler

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

  • Lists the tags for the specified resource.

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

    See

    AWSConnectListTagsForResourceRequest

    See

    AWSConnectListTagsForResourceResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Lists the tags for the specified resource.

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

    See

    AWSConnectListTagsForResourceRequest

    See

    AWSConnectListTagsForResourceResponse

    Declaration

    Objective-C

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

    Swift

    func listTags(forResource request: AWSConnectListTagsForResourceRequest) async throws -> AWSConnectListTagsForResourceResponse

    Parameters

    request

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

    completionHandler

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

  • Lists task templates for the specified Amazon Connect instance.

    See

    AWSConnectListTaskTemplatesRequest

    See

    AWSConnectListTaskTemplatesResponse

    Declaration

    Objective-C

    - (id)listTaskTemplates:(nonnull AWSConnectListTaskTemplatesRequest *)request;

    Swift

    func listTaskTemplates(_ request: AWSConnectListTaskTemplatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists task templates for the specified Amazon Connect instance.

    See

    AWSConnectListTaskTemplatesRequest

    See

    AWSConnectListTaskTemplatesResponse

    Declaration

    Objective-C

    - (void)listTaskTemplates:(nonnull AWSConnectListTaskTemplatesRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSConnectListTaskTemplatesResponse *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func listTaskTemplates(_ request: AWSConnectListTaskTemplatesRequest) async throws -> AWSConnectListTaskTemplatesResponse

    Parameters

    request

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

    completionHandler

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

  • Lists the use cases for the integration association.

    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 of AWSConnectListUseCasesResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorThrottling.

  • Lists the use cases for the integration association.

    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) async throws -> AWSConnectListUseCasesResponse

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSConnectErrorDomain domain and the following error code: 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 of AWSConnectListUserHierarchyGroupsResponse. On failed execution, task.error may contain an NSError with AWSConnectErrorDomain domain and the following error code: AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

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

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

    See

    AWSConnectListUserHierarchyGroupsRequest

    See

    AWSConnectListUserHierarchyGroupsResponse

    Declaration

    Objective-C

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

    Swift

    func listUserHierarchyGroups(_ request: AWSConnectListUserHierarchyGroupsRequest) async throws -> AWSConnectListUserHierarchyGroupsResponse

    Parameters

    request

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

    completionHandler

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