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.

  • 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.

  • Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

    See

    AWSConnectActivateEvaluationFormRequest

    See

    AWSConnectActivateEvaluationFormResponse

    Declaration

    Objective-C

    - (id)activateEvaluationForm:
        (nonnull AWSConnectActivateEvaluationFormRequest *)request;

    Swift

    func activateEvaluationForm(_ request: AWSConnectActivateEvaluationFormRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

    See

    AWSConnectActivateEvaluationFormRequest

    See

    AWSConnectActivateEvaluationFormResponse

    Declaration

    Objective-C

    - (void)activateEvaluationForm:
                (nonnull AWSConnectActivateEvaluationFormRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSConnectActivateEvaluationFormResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func activateEvaluationForm(_ request: AWSConnectActivateEvaluationFormRequest) async throws -> AWSConnectActivateEvaluationFormResponse

    Parameters

    request

    A container for the necessary parameters to execute the ActivateEvaluationForm 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, AWSConnectErrorResourceConflict.

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

    Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

    See

    AWSConnectAssociateAnalyticsDataSetRequest

    See

    AWSConnectAssociateAnalyticsDataSetResponse

    Declaration

    Objective-C

    - (id)associateAnalyticsDataSet:
        (nonnull AWSConnectAssociateAnalyticsDataSetRequest *)request;

    Swift

    func associateAnalyticsDataSet(_ request: AWSConnectAssociateAnalyticsDataSetRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectAssociateAnalyticsDataSetResponse. 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.

    Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

    See

    AWSConnectAssociateAnalyticsDataSetRequest

    See

    AWSConnectAssociateAnalyticsDataSetResponse

    Declaration

    Objective-C

    - (void)associateAnalyticsDataSet:
                (nonnull AWSConnectAssociateAnalyticsDataSetRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSConnectAssociateAnalyticsDataSetResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func associateAnalyticsDataSet(_ request: AWSConnectAssociateAnalyticsDataSetRequest) async throws -> AWSConnectAssociateAnalyticsDataSetResponse

    Parameters

    request

    A container for the necessary parameters to execute the AssociateAnalyticsDataSet 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.

    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.

  • Associates a connect resource to a flow.

    See

    AWSConnectAssociateFlowRequest

    See

    AWSConnectAssociateFlowResponse

    Declaration

    Objective-C

    - (id)associateFlow:(nonnull AWSConnectAssociateFlowRequest *)request;

    Swift

    func associateFlow(_ request: AWSConnectAssociateFlowRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Associates a connect resource to a flow.

    See

    AWSConnectAssociateFlowRequest

    See

    AWSConnectAssociateFlowResponse

    Declaration

    Objective-C

    - (void)associateFlow:(nonnull AWSConnectAssociateFlowRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectAssociateFlowResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func associateFlow(_ request: AWSConnectAssociateFlowRequest) async throws -> AWSConnectAssociateFlowResponse

    Parameters

    request

    A container for the necessary parameters to execute the AssociateFlow 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, AWSConnectErrorResourceNotFound, 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

    - (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 V1 bot. This API only supports the association of Amazon Lex V1 bots.

    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 V1 bot. This API only supports the association of Amazon Lex V1 bots.

    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 flow with a phone number claimed to your Amazon Connect instance.

    If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

    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 flow with a phone number claimed to your Amazon Connect instance.

    If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

    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.

  • Associates an agent with a traffic distribution group.

    See

    AWSConnectAssociateTrafficDistributionGroupUserRequest

    See

    AWSConnectAssociateTrafficDistributionGroupUserResponse

    Declaration

    Objective-C

    - (id)associateTrafficDistributionGroupUser:
        (nonnull AWSConnectAssociateTrafficDistributionGroupUserRequest *)request;

    Swift

    func associateTrafficDistributionGroupUser(_ request: AWSConnectAssociateTrafficDistributionGroupUserRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Associates an agent with a traffic distribution group.

    See

    AWSConnectAssociateTrafficDistributionGroupUserRequest

    See

    AWSConnectAssociateTrafficDistributionGroupUserResponse

    Declaration

    Objective-C

    - (void)
        associateTrafficDistributionGroupUser:
            (nonnull AWSConnectAssociateTrafficDistributionGroupUserRequest *)
                request
                            completionHandler:
                                (void (^_Nullable)(
                                    AWSConnectAssociateTrafficDistributionGroupUserResponse
                                        *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func associateTrafficDistributionGroupUser(_ request: AWSConnectAssociateTrafficDistributionGroupUserRequest) async throws -> AWSConnectAssociateTrafficDistributionGroupUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the AssociateTrafficDistributionGroupUser 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, AWSConnectErrorAccessDenied, AWSConnectErrorThrottling, AWSConnectErrorResourceNotFound, AWSConnectErrorResourceConflict, AWSConnectErrorInternalService.

  • >Associates a set of proficiencies with a user.

    See

    AWSConnectAssociateUserProficienciesRequest

    Declaration

    Objective-C

    - (id)associateUserProficiencies:
        (nonnull AWSConnectAssociateUserProficienciesRequest *)request;

    Swift

    func associateUserProficiencies(_ request: AWSConnectAssociateUserProficienciesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AssociateUserProficiencies 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 proficiencies with a user.

    See

    AWSConnectAssociateUserProficienciesRequest

    Declaration

    Objective-C

    - (void)associateUserProficiencies:
                (nonnull AWSConnectAssociateUserProficienciesRequest *)request
                     completionHandler:
                         (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func associateUserProficiencies(_ request: AWSConnectAssociateUserProficienciesRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the AssociateUserProficiencies 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 list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

    See

    AWSConnectBatchAssociateAnalyticsDataSetRequest

    See

    AWSConnectBatchAssociateAnalyticsDataSetResponse

    Declaration

    Objective-C

    - (id)batchAssociateAnalyticsDataSet:
        (nonnull AWSConnectBatchAssociateAnalyticsDataSetRequest *)request;

    Swift

    func batchAssociateAnalyticsDataSet(_ request: AWSConnectBatchAssociateAnalyticsDataSetRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectBatchAssociateAnalyticsDataSetResponse. 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.

    Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

    See

    AWSConnectBatchAssociateAnalyticsDataSetRequest

    See

    AWSConnectBatchAssociateAnalyticsDataSetResponse

    Declaration

    Objective-C

    - (void)batchAssociateAnalyticsDataSet:
                (nonnull AWSConnectBatchAssociateAnalyticsDataSetRequest *)request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSConnectBatchAssociateAnalyticsDataSetResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func batchAssociateAnalyticsDataSet(_ request: AWSConnectBatchAssociateAnalyticsDataSetRequest) async throws -> AWSConnectBatchAssociateAnalyticsDataSetResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchAssociateAnalyticsDataSet 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.

    Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

    See

    AWSConnectBatchDisassociateAnalyticsDataSetRequest

    See

    AWSConnectBatchDisassociateAnalyticsDataSetResponse

    Declaration

    Objective-C

    - (id)batchDisassociateAnalyticsDataSet:
        (nonnull AWSConnectBatchDisassociateAnalyticsDataSetRequest *)request;

    Swift

    func batchDisassociateAnalyticsDataSet(_ request: AWSConnectBatchDisassociateAnalyticsDataSetRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectBatchDisassociateAnalyticsDataSetResponse. 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.

    Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

    See

    AWSConnectBatchDisassociateAnalyticsDataSetRequest

    See

    AWSConnectBatchDisassociateAnalyticsDataSetResponse

    Declaration

    Objective-C

    - (void)
        batchDisassociateAnalyticsDataSet:
            (nonnull AWSConnectBatchDisassociateAnalyticsDataSetRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSConnectBatchDisassociateAnalyticsDataSetResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func batchDisassociateAnalyticsDataSet(_ request: AWSConnectBatchDisassociateAnalyticsDataSetRequest) async throws -> AWSConnectBatchDisassociateAnalyticsDataSetResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchDisassociateAnalyticsDataSet 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.

  • Retrieve the flow associations for the given resources.

    See

    AWSConnectBatchGetFlowAssociationRequest

    See

    AWSConnectBatchGetFlowAssociationResponse

    Declaration

    Objective-C

    - (id)batchGetFlowAssociation:
        (nonnull AWSConnectBatchGetFlowAssociationRequest *)request;

    Swift

    func batchGetFlowAssociation(_ request: AWSConnectBatchGetFlowAssociationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieve the flow associations for the given resources.

    See

    AWSConnectBatchGetFlowAssociationRequest

    See

    AWSConnectBatchGetFlowAssociationResponse

    Declaration

    Objective-C

    - (void)batchGetFlowAssociation:
                (nonnull AWSConnectBatchGetFlowAssociationRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectBatchGetFlowAssociationResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func batchGetFlowAssociation(_ request: AWSConnectBatchGetFlowAssociationRequest) async throws -> AWSConnectBatchGetFlowAssociationResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchGetFlowAssociation 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, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorThrottling.

  • Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

    Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

    See

    AWSConnectBatchPutContactRequest

    See

    AWSConnectBatchPutContactResponse

    Declaration

    Objective-C

    - (id)batchPutContact:(nonnull AWSConnectBatchPutContactRequest *)request;

    Swift

    func batchPutContact(_ request: AWSConnectBatchPutContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

    Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

    See

    AWSConnectBatchPutContactRequest

    See

    AWSConnectBatchPutContactResponse

    Declaration

    Objective-C

    - (void)batchPutContact:(nonnull AWSConnectBatchPutContactRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSConnectBatchPutContactResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func batchPutContact(_ request: AWSConnectBatchPutContactRequest) async throws -> AWSConnectBatchPutContactResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchPutContact 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, AWSConnectErrorInternalService, AWSConnectErrorInvalidRequest, AWSConnectErrorResourceNotFound, AWSConnectErrorLimitExceeded, AWSConnectErrorIdempotency.

  • Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

    For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

    You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

    If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.

    By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.

    For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

    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 or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

    For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

    You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

    If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.

    By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.

    For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

    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 flow for the specified Amazon Connect instance.

    You can also create and update 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 flow for the specified Amazon Connect instance.

    You can also create and update 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 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 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.

  • Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

    See

    AWSConnectCreateEvaluationFormRequest

    See

    AWSConnectCreateEvaluationFormResponse

    Declaration

    Objective-C

    - (id)createEvaluationForm:
        (nonnull AWSConnectCreateEvaluationFormRequest *)request;

    Swift

    func createEvaluationForm(_ request: AWSConnectCreateEvaluationFormRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

    See

    AWSConnectCreateEvaluationFormRequest

    See

    AWSConnectCreateEvaluationFormResponse

    Declaration

    Objective-C

    - (void)
        createEvaluationForm:
            (nonnull AWSConnectCreateEvaluationFormRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSConnectCreateEvaluationFormResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func createEvaluationForm(_ request: AWSConnectCreateEvaluationFormRequest) async throws -> AWSConnectCreateEvaluationFormResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateEvaluationForm 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: AWSConnectErrorInternalService, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorResourceConflict.

  • 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.

  • Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

    See

    AWSConnectCreateParticipantRequest

    See

    AWSConnectCreateParticipantResponse

    Declaration

    Objective-C

    - (id)createParticipant:(nonnull AWSConnectCreateParticipantRequest *)request;

    Swift

    func createParticipant(_ request: AWSConnectCreateParticipantRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

    See

    AWSConnectCreateParticipantRequest

    See

    AWSConnectCreateParticipantResponse

    Declaration

    Objective-C

    - (void)createParticipant:(nonnull AWSConnectCreateParticipantRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSConnectCreateParticipantResponse *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func createParticipant(_ request: AWSConnectCreateParticipantRequest) async throws -> AWSConnectCreateParticipantResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateParticipant 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, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorThrottling.

  • Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.

    See

    AWSConnectCreatePersistentContactAssociationRequest

    See

    AWSConnectCreatePersistentContactAssociationResponse

    Declaration

    Objective-C

    - (id)createPersistentContactAssociation:
        (nonnull AWSConnectCreatePersistentContactAssociationRequest *)request;

    Swift

    func createPersistentContactAssociation(_ request: AWSConnectCreatePersistentContactAssociationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.

    See

    AWSConnectCreatePersistentContactAssociationRequest

    See

    AWSConnectCreatePersistentContactAssociationResponse

    Declaration

    Objective-C

    - (void)
        createPersistentContactAssociation:
            (nonnull AWSConnectCreatePersistentContactAssociationRequest *)request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSConnectCreatePersistentContactAssociationResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func createPersistentContactAssociation(_ request: AWSConnectCreatePersistentContactAssociationRequest) async throws -> AWSConnectCreatePersistentContactAssociationResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreatePersistentContactAssociation 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, AWSConnectErrorAccessDenied, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Creates a new predefined attribute for the specified Amazon Connect instance.

    See

    AWSConnectCreatePredefinedAttributeRequest

    Declaration

    Objective-C

    - (id)createPredefinedAttribute:
        (nonnull AWSConnectCreatePredefinedAttributeRequest *)request;

    Swift

    func createPredefinedAttribute(_ request: AWSConnectCreatePredefinedAttributeRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreatePredefinedAttribute 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: AWSConnectErrorDuplicateResource, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorLimitExceeded, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Creates a new predefined attribute for the specified Amazon Connect instance.

    See

    AWSConnectCreatePredefinedAttributeRequest

    Declaration

    Objective-C

    - (void)createPredefinedAttribute:
                (nonnull AWSConnectCreatePredefinedAttributeRequest *)request
                    completionHandler:
                        (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func createPredefinedAttribute(_ request: AWSConnectCreatePredefinedAttributeRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the CreatePredefinedAttribute 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: AWSConnectErrorDuplicateResource, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorLimitExceeded, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator’s Guide.

    See

    AWSConnectCreatePromptRequest

    See

    AWSConnectCreatePromptResponse

    Declaration

    Objective-C

    - (id)createPrompt:(nonnull AWSConnectCreatePromptRequest *)request;

    Swift

    func createPrompt(_ request: AWSConnectCreatePromptRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator’s Guide.

    See

    AWSConnectCreatePromptRequest

    See

    AWSConnectCreatePromptResponse

    Declaration

    Objective-C

    - (void)createPrompt:(nonnull AWSConnectCreatePromptRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectCreatePromptResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createPrompt(_ request: AWSConnectCreatePromptRequest) async throws -> AWSConnectCreatePromptResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreatePrompt 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, 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.

    • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

    • Only use the phone number ARN format that doesn’t contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

    • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

    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.

    • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

    • Only use the phone number ARN format that doesn’t contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

    • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

    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.

  • Creates a rule for the specified Amazon Connect instance.

    Use the Rules Function language to code conditions for the rule.

    See

    AWSConnectCreateRuleRequest

    See

    AWSConnectCreateRuleResponse

    Declaration

    Objective-C

    - (id)createRule:(nonnull AWSConnectCreateRuleRequest *)request;

    Swift

    func createRule(_ request: AWSConnectCreateRuleRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSConnectCreateRuleResponse. 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 rule for the specified Amazon Connect instance.

    Use the Rules Function language to code conditions for the rule.

    See

    AWSConnectCreateRuleRequest

    See

    AWSConnectCreateRuleResponse

    Declaration

    Objective-C

    - (void)createRule:(nonnull AWSConnectCreateRuleRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectCreateRuleResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createRule(_ request: AWSConnectCreateRuleRequest) async throws -> AWSConnectCreateRuleResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateRule 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.

  • 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.

  • 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 traffic distribution group given an Amazon Connect instance that has been replicated.

    The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

    For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

    See

    AWSConnectCreateTrafficDistributionGroupRequest

    See

    AWSConnectCreateTrafficDistributionGroupResponse

    Declaration

    Objective-C

    - (id)createTrafficDistributionGroup:
        (nonnull AWSConnectCreateTrafficDistributionGroupRequest *)request;

    Swift

    func createTrafficDistributionGroup(_ request: AWSConnectCreateTrafficDistributionGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

    The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

    For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

    See

    AWSConnectCreateTrafficDistributionGroupRequest

    See

    AWSConnectCreateTrafficDistributionGroupResponse

    Declaration

    Objective-C

    - (void)createTrafficDistributionGroup:
                (nonnull AWSConnectCreateTrafficDistributionGroupRequest *)request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSConnectCreateTrafficDistributionGroupResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func createTrafficDistributionGroup(_ request: AWSConnectCreateTrafficDistributionGroupRequest) async throws -> AWSConnectCreateTrafficDistributionGroupResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateTrafficDistributionGroup 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, AWSConnectErrorAccessDenied, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorThrottling, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorResourceConflict, AWSConnectErrorResourceNotReady.

  • 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.

    Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

    For information about how to create users using the Amazon Connect admin website, 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.

    Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

    For information about how to create users using the Amazon Connect admin website, 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 new view with the possible status of SAVED or PUBLISHED.

    The views will have a unique name for each connect instance.

    It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

    See

    AWSConnectCreateViewRequest

    See

    AWSConnectCreateViewResponse

    Declaration

    Objective-C

    - (id)createView:(nonnull AWSConnectCreateViewRequest *)request;

    Swift

    func createView(_ request: AWSConnectCreateViewRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new view with the possible status of SAVED or PUBLISHED.

    The views will have a unique name for each connect instance.

    It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

    See

    AWSConnectCreateViewRequest

    See

    AWSConnectCreateViewResponse

    Declaration

    Objective-C

    - (void)createView:(nonnull AWSConnectCreateViewRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectCreateViewResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createView(_ request: AWSConnectCreateViewRequest) async throws -> AWSConnectCreateViewResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateView 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, AWSConnectErrorInternalService, AWSConnectErrorDuplicateResource, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorTooManyRequests, AWSConnectErrorResourceInUse.

  • Publishes a new version of the view identifier.

    Versions are immutable and monotonically increasing.

    It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

    See

    AWSConnectCreateViewVersionRequest

    See

    AWSConnectCreateViewVersionResponse

    Declaration

    Objective-C

    - (id)createViewVersion:(nonnull AWSConnectCreateViewVersionRequest *)request;

    Swift

    func createViewVersion(_ request: AWSConnectCreateViewVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Publishes a new version of the view identifier.

    Versions are immutable and monotonically increasing.

    It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

    See

    AWSConnectCreateViewVersionRequest

    See

    AWSConnectCreateViewVersionResponse

    Declaration

    Objective-C

    - (void)createViewVersion:(nonnull AWSConnectCreateViewVersionRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSConnectCreateViewVersionResponse *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func createViewVersion(_ request: AWSConnectCreateViewVersionRequest) async throws -> AWSConnectCreateViewVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateViewVersion 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, AWSConnectErrorInternalService, AWSConnectErrorTooManyRequests, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorResourceInUse.

  • 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.

  • Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

    See

    AWSConnectDeactivateEvaluationFormRequest

    See

    AWSConnectDeactivateEvaluationFormResponse

    Declaration

    Objective-C

    - (id)deactivateEvaluationForm:
        (nonnull AWSConnectDeactivateEvaluationFormRequest *)request;

    Swift

    func deactivateEvaluationForm(_ request: AWSConnectDeactivateEvaluationFormRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

    See

    AWSConnectDeactivateEvaluationFormRequest

    See

    AWSConnectDeactivateEvaluationFormResponse

    Declaration

    Objective-C

    - (void)deactivateEvaluationForm:
                (nonnull AWSConnectDeactivateEvaluationFormRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSConnectDeactivateEvaluationFormResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func deactivateEvaluationForm(_ request: AWSConnectDeactivateEvaluationFormRequest) async throws -> AWSConnectDeactivateEvaluationFormResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeactivateEvaluationForm 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, AWSConnectErrorResourceConflict.

  • Deletes a contact evaluation in the specified Amazon Connect instance.

    See

    AWSConnectDeleteContactEvaluationRequest

    Declaration

    Objective-C

    - (id)deleteContactEvaluation:
        (nonnull AWSConnectDeleteContactEvaluationRequest *)request;

    Swift

    func deleteContactEvaluation(_ request: AWSConnectDeleteContactEvaluationRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteContactEvaluation 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, AWSConnectErrorResourceConflict.

  • Deletes a contact evaluation in the specified Amazon Connect instance.

    See

    AWSConnectDeleteContactEvaluationRequest

    Declaration

    Objective-C

    - (void)deleteContactEvaluation:
                (nonnull AWSConnectDeleteContactEvaluationRequest *)request
                  completionHandler:
                      (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteContactEvaluation(_ request: AWSConnectDeleteContactEvaluationRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteContactEvaluation 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, AWSConnectErrorResourceConflict.

  • Deletes a flow for the specified Amazon Connect instance.

    See

    AWSConnectDeleteContactFlowRequest

    See

    AWSConnectDeleteContactFlowResponse

    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 contain an instance of AWSConnectDeleteContactFlowResponse. 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 flow for the specified Amazon Connect instance.

    See

    AWSConnectDeleteContactFlowRequest

    See

    AWSConnectDeleteContactFlowResponse

    Declaration

    Objective-C

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

    Swift

    func deleteContactFlow(_ request: AWSConnectDeleteContactFlowRequest) async throws -> AWSConnectDeleteContactFlowResponse

    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. 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, AWSConnectErrorInternalService, AWSConnectErrorThrottling.

  • Deletes the specified 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 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.

  • Deletes an evaluation form in the specified Amazon Connect instance.

    • If the version property is provided, only the specified version of the evaluation form is deleted.

    • If no version is provided, then the full form (all versions) is deleted.

    See

    AWSConnectDeleteEvaluationFormRequest

    Declaration

    Objective-C

    - (id)deleteEvaluationForm:
        (nonnull AWSConnectDeleteEvaluationFormRequest *)request;

    Swift

    func deleteEvaluationForm(_ request: AWSConnectDeleteEvaluationFormRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteEvaluationForm 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, AWSConnectErrorResourceConflict.

  • Deletes an evaluation form in the specified Amazon Connect instance.

    • If the version property is provided, only the specified version of the evaluation form is deleted.

    • If no version is provided, then the full form (all versions) is deleted.

    See

    AWSConnectDeleteEvaluationFormRequest

    Declaration

    Objective-C

    - (void)deleteEvaluationForm:
                (nonnull AWSConnectDeleteEvaluationFormRequest *)request
               completionHandler:
                   (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteEvaluationForm(_ request: AWSConnectDeleteEvaluationFormRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteEvaluationForm 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, AWSConnectErrorResourceConflict.

  • 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 predefined attribute from the specified Amazon Connect instance.

    See

    AWSConnectDeletePredefinedAttributeRequest

    Declaration

    Objective-C

    - (id)deletePredefinedAttribute:
        (nonnull AWSConnectDeletePredefinedAttributeRequest *)request;

    Swift

    func deletePredefinedAttribute(_ request: AWSConnectDeletePredefinedAttributeRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeletePredefinedAttribute 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: AWSConnectErrorResourceInUse, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Deletes a predefined attribute from the specified Amazon Connect instance.

    See

    AWSConnectDeletePredefinedAttributeRequest

    Declaration

    Objective-C

    - (void)deletePredefinedAttribute:
                (nonnull AWSConnectDeletePredefinedAttributeRequest *)request
                    completionHandler:
                        (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deletePredefinedAttribute(_ request: AWSConnectDeletePredefinedAttributeRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeletePredefinedAttribute 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: AWSConnectErrorResourceInUse, AWSConnectErrorInvalidRequest, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Deletes a prompt.

    See

    AWSConnectDeletePromptRequest

    Declaration

    Objective-C

    - (id)deletePrompt:(nonnull AWSConnectDeletePromptRequest *)request;

    Swift

    func deletePrompt(_ request: AWSConnectDeletePromptRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeletePrompt 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 prompt.

    See

    AWSConnectDeletePromptRequest

    Declaration

    Objective-C

    - (void)deletePrompt:(nonnull AWSConnectDeletePromptRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deletePrompt(_ request: AWSConnectDeletePromptRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeletePrompt 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 a queue.

    See

    AWSConnectDeleteQueueRequest

    Declaration

    Objective-C

    - (id)deleteQueue:(nonnull AWSConnectDeleteQueueRequest *)request;

    Swift

    func deleteQueue(_ request: AWSConnectDeleteQueueRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteQueue 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 a queue.

    See

    AWSConnectDeleteQueueRequest

    Declaration

    Objective-C

    - (void)deleteQueue:(nonnull AWSConnectDeleteQueueRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteQueue(_ request: AWSConnectDeleteQueueRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteQueue 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 a quick connect.

    After calling DeleteUser, it’s important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

    • Avoid dangling resources that impact your service quotas.

    • Remove deleted users so they don’t appear to agents as transfer options.

    • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you’re using Amazon Connect Global Resiliency.

    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.

    After calling DeleteUser, it’s important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

    • Avoid dangling resources that impact your service quotas.

    • Remove deleted users so they don’t appear to agents as transfer options.

    • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you’re using Amazon Connect Global Resiliency.

    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.

  • Deletes a routing profile.

    See

    AWSConnectDeleteRoutingProfileRequest

    Declaration

    Objective-C

    - (id)deleteRoutingProfile:
        (nonnull AWSConnectDeleteRoutingProfileRequest *)request;

    Swift

    func deleteRoutingProfile(_ request: AWSConnectDeleteRoutingProfileRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRoutingProfile 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 a routing profile.

    See

    AWSConnectDeleteRoutingProfileRequest

    Declaration

    Objective-C

    - (void)deleteRoutingProfile:
                (nonnull AWSConnectDeleteRoutingProfileRequest *)request
               completionHandler:
                   (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteRoutingProfile(_ request: AWSConnectDeleteRoutingProfileRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRoutingProfile 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 a rule for the specified Amazon Connect instance.

    See

    AWSConnectDeleteRuleRequest

    Declaration

    Objective-C

    - (id)deleteRule:(nonnull AWSConnectDeleteRuleRequest *)request;

    Swift

    func deleteRule(_ request: AWSConnectDeleteRuleRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRule 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, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorThrottling, AWSConnectErrorAccessDenied.

  • Deletes a rule for the specified Amazon Connect instance.

    See

    AWSConnectDeleteRuleRequest

    Declaration

    Objective-C

    - (void)deleteRule:(nonnull AWSConnectDeleteRuleRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteRule(_ request: AWSConnectDeleteRuleRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRule 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, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorThrottling, AWSConnectErrorAccessDenied.

  • 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.

  • 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 traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

    For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

    See

    AWSConnectDeleteTrafficDistributionGroupRequest

    See

    AWSConnectDeleteTrafficDistributionGroupResponse

    Declaration

    Objective-C

    - (id)deleteTrafficDistributionGroup:
        (nonnull AWSConnectDeleteTrafficDistributionGroupRequest *)request;

    Swift

    func deleteTrafficDistributionGroup(_ request: AWSConnectDeleteTrafficDistributionGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

    For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

    See

    AWSConnectDeleteTrafficDistributionGroupRequest

    See

    AWSConnectDeleteTrafficDistributionGroupResponse

    Declaration

    Objective-C

    - (void)deleteTrafficDistributionGroup:
                (nonnull AWSConnectDeleteTrafficDistributionGroupRequest *)request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSConnectDeleteTrafficDistributionGroupResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func deleteTrafficDistributionGroup(_ request: AWSConnectDeleteTrafficDistributionGroupRequest) async throws -> AWSConnectDeleteTrafficDistributionGroupResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTrafficDistributionGroup 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, AWSConnectErrorAccessDenied, AWSConnectErrorResourceInUse, 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.

    After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

    • Avoid dangling resources that impact your service quotas.

    • Remove deleted users so they don’t appear to agents as transfer options.

    • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you’re using Amazon Connect Global Resiliency.

    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.

    After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

    • Avoid dangling resources that impact your service quotas.

    • Remove deleted users so they don’t appear to agents as transfer options.

    • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you’re using Amazon Connect Global Resiliency.

    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 view entirely. It deletes the view and all associated qualifiers (versions and aliases).

    See

    AWSConnectDeleteViewRequest

    See

    AWSConnectDeleteViewResponse

    Declaration

    Objective-C

    - (id)deleteView:(nonnull AWSConnectDeleteViewRequest *)request;

    Swift

    func deleteView(_ request: AWSConnectDeleteViewRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

    See

    AWSConnectDeleteViewRequest

    See

    AWSConnectDeleteViewResponse

    Declaration

    Objective-C

    - (void)deleteView:(nonnull AWSConnectDeleteViewRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectDeleteViewResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteView(_ request: AWSConnectDeleteViewRequest) async throws -> AWSConnectDeleteViewResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteView 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, AWSConnectErrorInternalService, AWSConnectErrorTooManyRequests, AWSConnectErrorResourceInUse.

  • Deletes the particular version specified in ViewVersion identifier.

    See

    AWSConnectDeleteViewVersionRequest

    See

    AWSConnectDeleteViewVersionResponse

    Declaration

    Objective-C

    - (id)deleteViewVersion:(nonnull AWSConnectDeleteViewVersionRequest *)request;

    Swift

    func deleteViewVersion(_ request: AWSConnectDeleteViewVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes the particular version specified in ViewVersion identifier.

    See

    AWSConnectDeleteViewVersionRequest

    See

    AWSConnectDeleteViewVersionResponse

    Declaration

    Objective-C

    - (void)deleteViewVersion:(nonnull AWSConnectDeleteViewVersionRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSConnectDeleteViewVersionResponse *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func deleteViewVersion(_ request: AWSConnectDeleteViewVersionRequest) async throws -> AWSConnectDeleteViewVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteViewVersion 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, AWSConnectErrorInternalService, AWSConnectErrorTooManyRequests, AWSConnectErrorResourceInUse.

  • 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.

    Only data from November 12, 2021, and later is returned by this API.

    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.

    Only data from November 12, 2021, and later is returned by this API.

    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 a contact evaluation in the specified Amazon Connect instance.

    See

    AWSConnectDescribeContactEvaluationRequest

    See

    AWSConnectDescribeContactEvaluationResponse

    Declaration

    Objective-C

    - (id)describeContactEvaluation:
        (nonnull AWSConnectDescribeContactEvaluationRequest *)request;

    Swift

    func describeContactEvaluation(_ request: AWSConnectDescribeContactEvaluationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a contact evaluation in the specified Amazon Connect instance.

    See

    AWSConnectDescribeContactEvaluationRequest

    See

    AWSConnectDescribeContactEvaluationResponse

    Declaration

    Objective-C

    - (void)describeContactEvaluation:
                (nonnull AWSConnectDescribeContactEvaluationRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSConnectDescribeContactEvaluationResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func describeContactEvaluation(_ request: AWSConnectDescribeContactEvaluationRequest) async throws -> AWSConnectDescribeContactEvaluationResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeContactEvaluation 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.

  • Describes the specified flow.

    You can also create and update 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 flow.

    You can also create and update 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 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 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.

  • Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

    See

    AWSConnectDescribeEvaluationFormRequest

    See

    AWSConnectDescribeEvaluationFormResponse

    Declaration

    Objective-C

    - (id)describeEvaluationForm:
        (nonnull AWSConnectDescribeEvaluationFormRequest *)request;

    Swift

    func describeEvaluationForm(_ request: AWSConnectDescribeEvaluationFormRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

    See

    AWSConnectDescribeEvaluationFormRequest

    See

    AWSConnectDescribeEvaluationFormResponse

    Declaration

    Objective-C

    - (void)describeEvaluationForm:
                (nonnull AWSConnectDescribeEvaluationFormRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSConnectDescribeEvaluationFormResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func describeEvaluationForm(_ request: AWSConnectDescribeEvaluationFormRequest) async throws -> AWSConnectDescribeEvaluationFormResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeEvaluationForm 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.

  • 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 or traffic distribution group.

    If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

    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 or traffic distribution group.

    If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

    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.

  • Describes a predefined attribute for the specified Amazon Connect instance.

    See

    AWSConnectDescribePredefinedAttributeRequest

    See

    AWSConnectDescribePredefinedAttributeResponse

    Declaration

    Objective-C

    - (id)describePredefinedAttribute:
        (nonnull AWSConnectDescribePredefinedAttributeRequest *)request;

    Swift

    func describePredefinedAttribute(_ request: AWSConnectDescribePredefinedAttributeRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a predefined attribute for the specified Amazon Connect instance.

    See

    AWSConnectDescribePredefinedAttributeRequest

    See

    AWSConnectDescribePredefinedAttributeResponse

    Declaration

    Objective-C

    - (void)
        describePredefinedAttribute:
            (nonnull AWSConnectDescribePredefinedAttributeRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSConnectDescribePredefinedAttributeResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describePredefinedAttribute(_ request: AWSConnectDescribePredefinedAttributeRequest) async throws -> AWSConnectDescribePredefinedAttributeResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribePredefinedAttribute 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 prompt.

    See

    AWSConnectDescribePromptRequest

    See

    AWSConnectDescribePromptResponse

    Declaration

    Objective-C

    - (id)describePrompt:(nonnull AWSConnectDescribePromptRequest *)request;

    Swift

    func describePrompt(_ request: AWSConnectDescribePromptRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes the prompt.

    See

    AWSConnectDescribePromptRequest

    See

    AWSConnectDescribePromptResponse

    Declaration

    Objective-C

    - (void)describePrompt:(nonnull AWSConnectDescribePromptRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectDescribePromptResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describePrompt(_ request: AWSConnectDescribePromptRequest) async throws -> AWSConnectDescribePromptResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribePrompt 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 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.

  • Describes a rule for the specified Amazon Connect instance.

    See

    AWSConnectDescribeRuleRequest

    See

    AWSConnectDescribeRuleResponse

    Declaration

    Objective-C

    - (id)describeRule:(nonnull AWSConnectDescribeRuleRequest *)request;

    Swift

    func describeRule(_ request: AWSConnectDescribeRuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a rule for the specified Amazon Connect instance.

    See

    AWSConnectDescribeRuleRequest

    See

    AWSConnectDescribeRuleResponse

    Declaration

    Objective-C

    - (void)describeRule:(nonnull AWSConnectDescribeRuleRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectDescribeRuleResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeRule(_ request: AWSConnectDescribeRuleRequest) async throws -> AWSConnectDescribeRuleResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeRule 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.

  • 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.

  • 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.

  • Gets details and status of a traffic distribution group.

    See

    AWSConnectDescribeTrafficDistributionGroupRequest

    See

    AWSConnectDescribeTrafficDistributionGroupResponse

    Declaration

    Objective-C

    - (id)describeTrafficDistributionGroup:
        (nonnull AWSConnectDescribeTrafficDistributionGroupRequest *)request;

    Swift

    func describeTrafficDistributionGroup(_ request: AWSConnectDescribeTrafficDistributionGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets details and status of a traffic distribution group.

    See

    AWSConnectDescribeTrafficDistributionGroupRequest

    See

    AWSConnectDescribeTrafficDistributionGroupResponse

    Declaration

    Objective-C

    - (void)
        describeTrafficDistributionGroup:
            (nonnull AWSConnectDescribeTrafficDistributionGroupRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSConnectDescribeTrafficDistributionGroupResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeTrafficDistributionGroup(_ request: AWSConnectDescribeTrafficDistributionGroupRequest) async throws -> AWSConnectDescribeTrafficDistributionGroupResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTrafficDistributionGroup 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, AWSConnectErrorAccessDenied, AWSConnectErrorResourceNotFound, AWSConnectErrorInternalService, AWSConnectErrorThrottling.

  • Describes the specified user. You can find the instance ID in the Amazon Connect 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. You can find the instance ID in the Amazon Connect 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.

  • Retrieves the view for the specified Amazon Connect instance and view identifier.

    The view identifier can be supplied as a ViewId or ARN.

    $SAVED needs to be supplied if a view is unpublished.

    The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

    See

    AWSConnectDescribeViewRequest

    See

    AWSConnectDescribeViewResponse

    Declaration

    Objective-C

    - (id)describeView:(nonnull AWSConnectDescribeViewRequest *)request;