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.

  • Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

    See

    AWSConnectBatchGetAttachedFileMetadataRequest

    See

    AWSConnectBatchGetAttachedFileMetadataResponse

    Declaration

    Objective-C

    - (id)batchGetAttachedFileMetadata:
    (nonnull AWSConnectBatchGetAttachedFileMetadataRequest *)request;

    Swift

    func batchGetAttachedFileMetadata(_ request: AWSConnectBatchGetAttachedFileMetadataRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

    See

    AWSConnectBatchGetAttachedFileMetadataRequest

    See

    AWSConnectBatchGetAttachedFileMetadataResponse

    Declaration

    Objective-C

    - (void)batchGetAttachedFileMetadata:
            (nonnull AWSConnectBatchGetAttachedFileMetadataRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSConnectBatchGetAttachedFileMetadataResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func batchGetAttachedFileMetadata(_ request: AWSConnectBatchGetAttachedFileMetadataRequest) async throws -> AWSConnectBatchGetAttachedFileMetadataResponse

    Parameters

    request

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

  • 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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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.

  • Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

    See

    AWSConnectCompleteAttachedFileUploadRequest

    See

    AWSConnectCompleteAttachedFileUploadResponse

    Declaration

    Objective-C

    - (id)completeAttachedFileUpload:
    (nonnull AWSConnectCompleteAttachedFileUploadRequest *)request;

    Swift

    func completeAttachedFileUpload(_ request: AWSConnectCompleteAttachedFileUploadRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

    See

    AWSConnectCompleteAttachedFileUploadRequest

    See

    AWSConnectCompleteAttachedFileUploadResponse

    Declaration

    Objective-C

    - (void)
    completeAttachedFileUpload:
        (nonnull AWSConnectCompleteAttachedFileUploadRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectCompleteAttachedFileUploadResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func completeAttachedFileUpload(_ request: AWSConnectCompleteAttachedFileUploadRequest) async throws -> AWSConnectCompleteAttachedFileUploadResponse

    Parameters

    request

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

  • 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 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 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 an attached file along with the underlying S3 Object.

    The attached file is permanently deleted if S3 bucket versioning is not enabled.

    See

    AWSConnectDeleteAttachedFileRequest

    See

    AWSConnectDeleteAttachedFileResponse

    Declaration

    Objective-C

    - (id)deleteAttachedFile:(nonnull AWSConnectDeleteAttachedFileRequest *)request;

    Swift

    func deleteAttachedFile(_ request: AWSConnectDeleteAttachedFileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes an attached file along with the underlying S3 Object.

    The attached file is permanently deleted if S3 bucket versioning is not enabled.

    See

    AWSConnectDeleteAttachedFileRequest

    See

    AWSConnectDeleteAttachedFileResponse

    Declaration

    Objective-C

    - (void)deleteAttachedFile:
            (nonnull AWSConnectDeleteAttachedFileRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectDeleteAttachedFileResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteAttachedFile(_ request: AWSConnectDeleteAttachedFileRequest) async throws -> AWSConnectDeleteAttachedFileResponse

    Parameters

    request

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

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

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

    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.

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

    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.

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    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.

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    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;

    Swift

    func describeView(_ request: AWSConnectDescribeViewRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • 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

    - (void)describeView:(nonnull AWSConnectDescribeViewRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectDescribeViewResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func describeView(_ request: AWSConnectDescribeViewRequest) async throws -> AWSConnectDescribeViewResponse

    Parameters

    request

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

  • Describes the specified vocabulary.

    See

    AWSConnectDescribeVocabularyRequest

    See

    AWSConnectDescribeVocabularyResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Describes the specified vocabulary.

    See

    AWSConnectDescribeVocabularyRequest

    See

    AWSConnectDescribeVocabularyResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

    Removes the dataset ID associated with a given Amazon Connect instance.

    See

    AWSConnectDisassociateAnalyticsDataSetRequest

    Declaration

    Objective-C

    - (id)disassociateAnalyticsDataSet:
    (nonnull AWSConnectDisassociateAnalyticsDataSetRequest *)request;

    Swift

    func disassociateAnalyticsDataSet(_ request: AWSConnectDisassociateAnalyticsDataSetRequest) -> Any!

    Parameters

    request

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

    Removes the dataset ID associated with a given Amazon Connect instance.

    See

    AWSConnectDisassociateAnalyticsDataSetRequest

    Declaration

    Objective-C

    - (void)disassociateAnalyticsDataSet:
            (nonnull AWSConnectDisassociateAnalyticsDataSetRequest *)request
                   completionHandler:
                       (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func disassociateAnalyticsDataSet(_ request: AWSConnectDisassociateAnalyticsDataSetRequest) async throws

    Parameters

    request

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

    Revokes access to integrated applications from Amazon Connect.

    See

    AWSConnectDisassociateApprovedOriginRequest

    Declaration

    Objective-C

    - (id)disassociateApprovedOrigin:
    (nonnull AWSConnectDisassociateApprovedOriginRequest *)request;

    Swift

    func disassociateApprovedOrigin(_ request: AWSConnectDisassociateApprovedOriginRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Revokes access to integrated applications from Amazon Connect.

    See

    AWSConnectDisassociateApprovedOriginRequest

    Declaration

    Objective-C

    - (void)disassociateApprovedOrigin:
            (nonnull AWSConnectDisassociateApprovedOriginRequest *)request
                 completionHandler:
                     (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func disassociateApprovedOrigin(_ request: AWSConnectDisassociateApprovedOriginRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateApprovedOrigin service method.
    completionHandler

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

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

    Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

    See

    AWSConnectDisassociateBotRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

    See

    AWSConnectDisassociateBotRequest

    Declaration

    Objective-C

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

    Swift

    func disassociateBot(_ request: AWSConnectDisassociateBotRequest) async throws

    Parameters

    request

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

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

  • Disassociates a connect resource from a flow.

    See

    AWSConnectDisassociateFlowRequest

    See

    AWSConnectDisassociateFlowResponse

    Declaration

    Objective-C

    - (id)disassociateFlow:(nonnull AWSConnectDisassociateFlowRequest *)request;

    Swift

    func disassociateFlow(_ request: AWSConnectDisassociateFlowRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Disassociates a connect resource from a flow.

    See

    AWSConnectDisassociateFlowRequest

    See

    AWSConnectDisassociateFlowResponse

    Declaration

    Objective-C

    - (void)disassociateFlow:(nonnull AWSConnectDisassociateFlowRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectDisassociateFlowResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func disassociateFlow(_ request: AWSConnectDisassociateFlowRequest) async throws -> AWSConnectDisassociateFlowResponse

    Parameters

    request

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

    Removes the storage type configurations for the specified resource type and association ID.

    See

    AWSConnectDisassociateInstanceStorageConfigRequest

    Declaration

    Objective-C

    - (id)disassociateInstanceStorageConfig:
    (nonnull AWSConnectDisassociateInstanceStorageConfigRequest *)request;

    Swift

    func disassociateInstanceStorageConfig(_ request: AWSConnectDisassociateInstanceStorageConfigRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Removes the storage type configurations for the specified resource type and association ID.

    See

    AWSConnectDisassociateInstanceStorageConfigRequest

    Declaration

    Objective-C

    - (void)
    disassociateInstanceStorageConfig:
        (nonnull AWSConnectDisassociateInstanceStorageConfigRequest *)request
                    completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                          completionHandler;

    Swift

    func disassociateInstanceStorageConfig(_ request: AWSConnectDisassociateInstanceStorageConfigRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateInstanceStorageConfig service method.
    completionHandler

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

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

    Remove the Lambda function from the dropdown options available in the relevant flow blocks.

    See

    AWSConnectDisassociateLambdaFunctionRequest

    Declaration

    Objective-C

    - (id)disassociateLambdaFunction:
    (nonnull AWSConnectDisassociateLambdaFunctionRequest *)request;

    Swift

    func disassociateLambdaFunction(_ request: AWSConnectDisassociateLambdaFunctionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Remove the Lambda function from the dropdown options available in the relevant flow blocks.

    See

    AWSConnectDisassociateLambdaFunctionRequest

    Declaration

    Objective-C

    - (void)disassociateLambdaFunction:
            (nonnull AWSConnectDisassociateLambdaFunctionRequest *)request
                 completionHandler:
                     (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func disassociateLambdaFunction(_ request: AWSConnectDisassociateLambdaFunctionRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateLambdaFunction service method.
    completionHandler

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

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

    Revokes authorization from the specified instance to access the specified Amazon Lex bot.

    See

    AWSConnectDisassociateLexBotRequest

    Declaration

    Objective-C

    - (id)disassociateLexBot:(nonnull AWSConnectDisassociateLexBotRequest *)request;

    Swift

    func disassociateLexBot(_ request: AWSConnectDisassociateLexBotRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Revokes authorization from the specified instance to access the specified Amazon Lex bot.

    See

    AWSConnectDisassociateLexBotRequest

    Declaration

    Objective-C

    - (void)
    disassociateLexBot:(nonnull AWSConnectDisassociateLexBotRequest *)request
     completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func disassociateLexBot(_ request: AWSConnectDisassociateLexBotRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateLexBot service method.
    completionHandler

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

  • Removes the flow association from 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

    AWSConnectDisassociatePhoneNumberContactFlowRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Removes the flow association from 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

    AWSConnectDisassociatePhoneNumberContactFlowRequest

    Declaration

    Objective-C

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

    Swift

    func disassociatePhoneNumberContactFlow(_ request: AWSConnectDisassociatePhoneNumberContactFlowRequest) async throws

    Parameters

    request

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

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

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

    Disassociates a set of quick connects from a queue.

    See

    AWSConnectDisassociateQueueQuickConnectsRequest

    Declaration

    Objective-C

    - (id)disassociateQueueQuickConnects:
    (nonnull AWSConnectDisassociateQueueQuickConnectsRequest *)request;

    Swift

    func disassociateQueueQuickConnects(_ request: AWSConnectDisassociateQueueQuickConnectsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Disassociates a set of quick connects from a queue.

    See

    AWSConnectDisassociateQueueQuickConnectsRequest

    Declaration

    Objective-C

    - (void)disassociateQueueQuickConnects:
            (nonnull AWSConnectDisassociateQueueQuickConnectsRequest *)request
                     completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                           completionHandler;

    Swift

    func disassociateQueueQuickConnects(_ request: AWSConnectDisassociateQueueQuickConnectsRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateQueueQuickConnects service method.
    completionHandler

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

  • Disassociates a set of queues from a routing profile.

    See

    AWSConnectDisassociateRoutingProfileQueuesRequest

    Declaration

    Objective-C

    - (id)disassociateRoutingProfileQueues:
    (nonnull AWSConnectDisassociateRoutingProfileQueuesRequest *)request;

    Swift

    func disassociateRoutingProfileQueues(_ request: AWSConnectDisassociateRoutingProfileQueuesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Disassociates a set of queues from a routing profile.

    See

    AWSConnectDisassociateRoutingProfileQueuesRequest

    Declaration

    Objective-C

    - (void)disassociateRoutingProfileQueues:
            (nonnull AWSConnectDisassociateRoutingProfileQueuesRequest *)request
                       completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                             completionHandler;

    Swift

    func disassociateRoutingProfileQueues(_ request: AWSConnectDisassociateRoutingProfileQueuesRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateRoutingProfileQueues service method.
    completionHandler

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

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

    Deletes the specified security key.

    See

    AWSConnectDisassociateSecurityKeyRequest

    Declaration

    Objective-C

    - (id)disassociateSecurityKey:
    (nonnull AWSConnectDisassociateSecurityKeyRequest *)request;

    Swift

    func disassociateSecurityKey(_ request: AWSConnectDisassociateSecurityKeyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Deletes the specified security key.

    See

    AWSConnectDisassociateSecurityKeyRequest

    Declaration

    Objective-C

    - (void)disassociateSecurityKey:
            (nonnull AWSConnectDisassociateSecurityKeyRequest *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func disassociateSecurityKey(_ request: AWSConnectDisassociateSecurityKeyRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DisassociateSecurityKey service method.
    completionHandler

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

  • Disassociates an agent from a traffic distribution group.

    See

    AWSConnectDisassociateTrafficDistributionGroupUserRequest

    See

    AWSConnectDisassociateTrafficDistributionGroupUserResponse

    Declaration

    Objective-C

    - (id)disassociateTrafficDistributionGroupUser:
    (nonnull AWSConnectDisassociateTrafficDistributionGroupUserRequest *)
        request;

    Swift

    func disassociateTrafficDistributionGroupUser(_ request: AWSConnectDisassociateTrafficDistributionGroupUserRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Disassociates an agent from a traffic distribution group.

    See

    AWSConnectDisassociateTrafficDistributionGroupUserRequest

    See

    AWSConnectDisassociateTrafficDistributionGroupUserResponse

    Declaration

    Objective-C

    - (void)
    disassociateTrafficDistributionGroupUser:
        (nonnull AWSConnectDisassociateTrafficDistributionGroupUserRequest *)
            request
                           completionHandler:
                               (void (^_Nullable)(
                                   AWSConnectDisassociateTrafficDistributionGroupUserResponse
                                       *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func disassociateTrafficDistributionGroupUser(_ request: AWSConnectDisassociateTrafficDistributionGroupUserRequest) async throws -> AWSConnectDisassociateTrafficDistributionGroupUserResponse

    Parameters

    request

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

  • Disassociates a set of proficiencies from a user.

    See

    AWSConnectDisassociateUserProficienciesRequest

    Declaration

    Objective-C

    - (id)disassociateUserProficiencies:
    (nonnull AWSConnectDisassociateUserProficienciesRequest *)request;

    Swift

    func disassociateUserProficiencies(_ request: AWSConnectDisassociateUserProficienciesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Disassociates a set of proficiencies from a user.

    See

    AWSConnectDisassociateUserProficienciesRequest

    Declaration

    Objective-C

    - (void)disassociateUserProficiencies:
            (nonnull AWSConnectDisassociateUserProficienciesRequest *)request
                    completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                          completionHandler;

    Swift

    func disassociateUserProficiencies(_ request: AWSConnectDisassociateUserProficienciesRequest) async throws

    Parameters

    request

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

  • Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

    See

    AWSConnectDismissUserContactRequest

    See

    AWSConnectDismissUserContactResponse

    Declaration

    Objective-C

    - (id)dismissUserContact:(nonnull AWSConnectDismissUserContactRequest *)request;

    Swift

    func dismissUserContact(_ request: AWSConnectDismissUserContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

    See

    AWSConnectDismissUserContactRequest

    See

    AWSConnectDismissUserContactResponse

    Declaration

    Objective-C

    - (void)dismissUserContact:
            (nonnull AWSConnectDismissUserContactRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectDismissUserContactResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func dismissUserContact(_ request: AWSConnectDismissUserContactRequest) async throws -> AWSConnectDismissUserContactResponse

    Parameters

    request

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

  • Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

    See

    AWSConnectGetAttachedFileRequest

    See

    AWSConnectGetAttachedFileResponse

    Declaration

    Objective-C

    - (id)getAttachedFile:(nonnull AWSConnectGetAttachedFileRequest *)request;

    Swift

    func getAttachedFile(_ request: AWSConnectGetAttachedFileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

    See

    AWSConnectGetAttachedFileRequest

    See

    AWSConnectGetAttachedFileResponse

    Declaration

    Objective-C

    - (void)getAttachedFile:(nonnull AWSConnectGetAttachedFileRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSConnectGetAttachedFileResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func attachedFile(_ request: AWSConnectGetAttachedFileRequest) async throws -> AWSConnectGetAttachedFileResponse

    Parameters

    request

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

  • Retrieves the contact attributes for the specified contact.

    See

    AWSConnectGetContactAttributesRequest

    See

    AWSConnectGetContactAttributesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Retrieves the contact attributes for the specified contact.

    See

    AWSConnectGetContactAttributesRequest

    See

    AWSConnectGetContactAttributesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

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

    See

    AWSConnectGetCurrentMetricDataRequest

    See

    AWSConnectGetCurrentMetricDataResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectGetCurrentMetricDataRequest

    See

    AWSConnectGetCurrentMetricDataResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

    See

    AWSConnectGetCurrentUserDataRequest

    See

    AWSConnectGetCurrentUserDataResponse

    Declaration

    Objective-C

    - (id)getCurrentUserData:(nonnull AWSConnectGetCurrentUserDataRequest *)request;

    Swift

    func getCurrentUserData(_ request: AWSConnectGetCurrentUserDataRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectGetCurrentUserDataRequest

    See

    AWSConnectGetCurrentUserDataResponse

    Declaration

    Objective-C

    - (void)getCurrentUserData:
            (nonnull AWSConnectGetCurrentUserDataRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectGetCurrentUserDataResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func currentUserData(_ request: AWSConnectGetCurrentUserDataRequest) async throws -> AWSConnectGetCurrentUserDataResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetCurrentUserData service method.
    completionHandler

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

  • Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

    For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.

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

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

    See

    AWSConnectGetFederationTokenRequest

    See

    AWSConnectGetFederationTokenResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

    For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.

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

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

    See

    AWSConnectGetFederationTokenRequest

    See

    AWSConnectGetFederationTokenResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Retrieves the flow associated for a given resource.

    See

    AWSConnectGetFlowAssociationRequest

    See

    AWSConnectGetFlowAssociationResponse

    Declaration

    Objective-C

    - (id)getFlowAssociation:(nonnull AWSConnectGetFlowAssociationRequest *)request;

    Swift

    func getFlowAssociation(_ request: AWSConnectGetFlowAssociationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves the flow associated for a given resource.

    See

    AWSConnectGetFlowAssociationRequest

    See

    AWSConnectGetFlowAssociationResponse

    Declaration

    Objective-C

    - (void)getFlowAssociation:
            (nonnull AWSConnectGetFlowAssociationRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectGetFlowAssociationResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func flowAssociation(_ request: AWSConnectGetFlowAssociationRequest) async throws -> AWSConnectGetFlowAssociationResponse

    Parameters

    request

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

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

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

    We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

    See

    AWSConnectGetMetricDataRequest

    See

    AWSConnectGetMetricDataResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

    See

    AWSConnectGetMetricDataRequest

    See

    AWSConnectGetMetricDataResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Gets metric data from the specified Amazon Connect instance.

    GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

    For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.

    See

    AWSConnectGetMetricDataV2Request

    See

    AWSConnectGetMetricDataV2Response

    Declaration

    Objective-C

    - (id)getMetricDataV2:(nonnull AWSConnectGetMetricDataV2Request *)request;

    Swift

    func getMetricDataV2(_ request: AWSConnectGetMetricDataV2Request) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets metric data from the specified Amazon Connect instance.

    GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

    For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.

    See

    AWSConnectGetMetricDataV2Request

    See

    AWSConnectGetMetricDataV2Response

    Declaration

    Objective-C

    - (void)getMetricDataV2:(nonnull AWSConnectGetMetricDataV2Request *)request
      completionHandler:
          (void (^_Nullable)(AWSConnectGetMetricDataV2Response *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func metricDataV2(_ request: AWSConnectGetMetricDataV2Request) async throws -> AWSConnectGetMetricDataV2Response

    Parameters

    request

    A container for the necessary parameters to execute the GetMetricDataV2 service method.
    completionHandler

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

  • Gets the prompt file.

    See

    AWSConnectGetPromptFileRequest

    See

    AWSConnectGetPromptFileResponse

    Declaration

    Objective-C

    - (id)getPromptFile:(nonnull AWSConnectGetPromptFileRequest *)request;

    Swift

    func getPromptFile(_ request: AWSConnectGetPromptFileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the prompt file.

    See

    AWSConnectGetPromptFileRequest

    See

    AWSConnectGetPromptFileResponse

    Declaration

    Objective-C

    - (void)getPromptFile:(nonnull AWSConnectGetPromptFileRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectGetPromptFileResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func promptFile(_ request: AWSConnectGetPromptFileRequest) async throws -> AWSConnectGetPromptFileResponse

    Parameters

    request

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

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

    See

    AWSConnectGetTaskTemplateRequest

    See

    AWSConnectGetTaskTemplateResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectGetTaskTemplateRequest

    See

    AWSConnectGetTaskTemplateResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Retrieves the current traffic distribution for a given traffic distribution group.

    See

    AWSConnectGetTrafficDistributionRequest

    See

    AWSConnectGetTrafficDistributionResponse

    Declaration

    Objective-C

    - (id)getTrafficDistribution:
    (nonnull AWSConnectGetTrafficDistributionRequest *)request;

    Swift

    func getTrafficDistribution(_ request: AWSConnectGetTrafficDistributionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves the current traffic distribution for a given traffic distribution group.

    See

    AWSConnectGetTrafficDistributionRequest

    See

    AWSConnectGetTrafficDistributionResponse

    Declaration

    Objective-C

    - (void)getTrafficDistribution:
            (nonnull AWSConnectGetTrafficDistributionRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectGetTrafficDistributionResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func trafficDistribution(_ request: AWSConnectGetTrafficDistributionRequest) async throws -> AWSConnectGetTrafficDistributionResponse

    Parameters

    request

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

  • Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

    Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.

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

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

    For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 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

    AWSConnectImportPhoneNumberRequest

    See

    AWSConnectImportPhoneNumberResponse

    Declaration

    Objective-C

    - (id)importPhoneNumber:(nonnull AWSConnectImportPhoneNumberRequest *)request;

    Swift

    func importPhoneNumber(_ request: AWSConnectImportPhoneNumberRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

    Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.

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

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

    For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 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

    AWSConnectImportPhoneNumberRequest

    See

    AWSConnectImportPhoneNumberResponse

    Declaration

    Objective-C

    - (void)importPhoneNumber:(nonnull AWSConnectImportPhoneNumberRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectImportPhoneNumberResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func importPhoneNumber(_ request: AWSConnectImportPhoneNumberRequest) async throws -> AWSConnectImportPhoneNumberResponse

    Parameters

    request

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

    Lists agent statuses.

    See

    AWSConnectListAgentStatusRequest

    See

    AWSConnectListAgentStatusResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    Lists agent statuses.

    See

    AWSConnectListAgentStatusRequest

    See

    AWSConnectListAgentStatusResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

    Lists the association status of requested dataset ID for a given Amazon Connect instance.

    See

    AWSConnectListAnalyticsDataAssociationsRequest

    See

    AWSConnectListAnalyticsDataAssociationsResponse

    Declaration

    Objective-C

    - (id)listAnalyticsDataAssociations:
    (nonnull AWSConnectListAnalyticsDataAssociationsRequest *)request;

    Swift

    func listAnalyticsDataAssociations(_ request: AWSConnectListAnalyticsDataAssociationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Lists the association status of requested dataset ID for a given Amazon Connect instance.

    See

    AWSConnectListAnalyticsDataAssociationsRequest

    See

    AWSConnectListAnalyticsDataAssociationsResponse

    Declaration

    Objective-C

    - (void)listAnalyticsDataAssociations:
            (nonnull AWSConnectListAnalyticsDataAssociationsRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSConnectListAnalyticsDataAssociationsResponse
                                *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listAnalyticsDataAssociations(_ request: AWSConnectListAnalyticsDataAssociationsRequest) async throws -> AWSConnectListAnalyticsDataAssociationsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAnalyticsDataAssociations service method.
    completionHandler

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

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

    Returns a paginated list of all approved origins associated with the instance.

    See

    AWSConnectListApprovedOriginsRequest

    See

    AWSConnectListApprovedOriginsResponse

    Declaration

    Objective-C

    - (id)listApprovedOrigins:
    (nonnull AWSConnectListApprovedOriginsRequest *)request;

    Swift

    func listApprovedOrigins(_ request: AWSConnectListApprovedOriginsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Returns a paginated list of all approved origins associated with the instance.

    See

    AWSConnectListApprovedOriginsRequest

    See

    AWSConnectListApprovedOriginsResponse

    Declaration

    Objective-C

    - (void)
    listApprovedOrigins:(nonnull AWSConnectListApprovedOriginsRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSConnectListApprovedOriginsResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listApprovedOrigins(_ request: AWSConnectListApprovedOriginsRequest) async throws -> AWSConnectListApprovedOriginsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListApprovedOrigins service method.
    completionHandler

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

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

    For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

    See

    AWSConnectListBotsRequest

    See

    AWSConnectListBotsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

    See

    AWSConnectListBotsRequest

    See

    AWSConnectListBotsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists contact evaluations in the specified Amazon Connect instance.

    See

    AWSConnectListContactEvaluationsRequest

    See

    AWSConnectListContactEvaluationsResponse

    Declaration

    Objective-C

    - (id)listContactEvaluations:
    (nonnull AWSConnectListContactEvaluationsRequest *)request;

    Swift

    func listContactEvaluations(_ request: AWSConnectListContactEvaluationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists contact evaluations in the specified Amazon Connect instance.

    See

    AWSConnectListContactEvaluationsRequest

    See

    AWSConnectListContactEvaluationsResponse

    Declaration

    Objective-C

    - (void)listContactEvaluations:
            (nonnull AWSConnectListContactEvaluationsRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectListContactEvaluationsResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func listContactEvaluations(_ request: AWSConnectListContactEvaluationsRequest) async throws -> AWSConnectListContactEvaluationsResponse

    Parameters

    request

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

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

    See

    AWSConnectListContactFlowModulesRequest

    See

    AWSConnectListContactFlowModulesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectListContactFlowModulesRequest

    See

    AWSConnectListContactFlowModulesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

    You can also create and update flows using the Amazon Connect Flow language.

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

    See

    AWSConnectListContactFlowsRequest

    See

    AWSConnectListContactFlowsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    You can also create and update flows using the Amazon Connect Flow language.

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

    See

    AWSConnectListContactFlowsRequest

    See

    AWSConnectListContactFlowsResponse

    Declaration

    Objective-C

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

    Swift

    func listContactFlows(_ request: AWSConnectListContactFlowsRequest) async throws -> AWSConnectListContactFlowsResponse

    Parameters

    request

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

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

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

    For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

    See

    AWSConnectListContactReferencesRequest

    See

    AWSConnectListContactReferencesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

    See

    AWSConnectListContactReferencesRequest

    See

    AWSConnectListContactReferencesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

    See

    AWSConnectListDefaultVocabulariesRequest

    See

    AWSConnectListDefaultVocabulariesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectListDefaultVocabulariesRequest

    See

    AWSConnectListDefaultVocabulariesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists versions of an evaluation form in the specified Amazon Connect instance.

    See

    AWSConnectListEvaluationFormVersionsRequest

    See

    AWSConnectListEvaluationFormVersionsResponse

    Declaration

    Objective-C

    - (id)listEvaluationFormVersions:
    (nonnull AWSConnectListEvaluationFormVersionsRequest *)request;

    Swift

    func listEvaluationFormVersions(_ request: AWSConnectListEvaluationFormVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists versions of an evaluation form in the specified Amazon Connect instance.

    See

    AWSConnectListEvaluationFormVersionsRequest

    See

    AWSConnectListEvaluationFormVersionsResponse

    Declaration

    Objective-C

    - (void)
    listEvaluationFormVersions:
        (nonnull AWSConnectListEvaluationFormVersionsRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectListEvaluationFormVersionsResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func listEvaluationFormVersions(_ request: AWSConnectListEvaluationFormVersionsRequest) async throws -> AWSConnectListEvaluationFormVersionsResponse

    Parameters

    request

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

  • Lists evaluation forms in the specified Amazon Connect instance.

    See

    AWSConnectListEvaluationFormsRequest

    See

    AWSConnectListEvaluationFormsResponse

    Declaration

    Objective-C

    - (id)listEvaluationForms:
    (nonnull AWSConnectListEvaluationFormsRequest *)request;

    Swift

    func listEvaluationForms(_ request: AWSConnectListEvaluationFormsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists evaluation forms in the specified Amazon Connect instance.

    See

    AWSConnectListEvaluationFormsRequest

    See

    AWSConnectListEvaluationFormsResponse

    Declaration

    Objective-C

    - (void)
    listEvaluationForms:(nonnull AWSConnectListEvaluationFormsRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSConnectListEvaluationFormsResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listEvaluationForms(_ request: AWSConnectListEvaluationFormsRequest) async throws -> AWSConnectListEvaluationFormsResponse

    Parameters

    request

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

  • List the flow association based on the filters.

    See

    AWSConnectListFlowAssociationsRequest

    See

    AWSConnectListFlowAssociationsResponse

    Declaration

    Objective-C

    - (id)listFlowAssociations:
    (nonnull AWSConnectListFlowAssociationsRequest *)request;

    Swift

    func listFlowAssociations(_ request: AWSConnectListFlowAssociationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List the flow association based on the filters.

    See

    AWSConnectListFlowAssociationsRequest

    See

    AWSConnectListFlowAssociationsResponse

    Declaration

    Objective-C

    - (void)
    listFlowAssociations:
        (nonnull AWSConnectListFlowAssociationsRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectListFlowAssociationsResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listFlowAssociations(_ request: AWSConnectListFlowAssociationsRequest) async throws -> AWSConnectListFlowAssociationsResponse

    Parameters

    request

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

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

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

    See

    AWSConnectListHoursOfOperationsRequest

    See

    AWSConnectListHoursOfOperationsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectListHoursOfOperationsRequest

    See

    AWSConnectListHoursOfOperationsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

    Returns a paginated list of all attribute types for the given instance.

    See

    AWSConnectListInstanceAttributesRequest

    See

    AWSConnectListInstanceAttributesResponse

    Declaration

    Objective-C

    - (id)listInstanceAttributes:
    (nonnull AWSConnectListInstanceAttributesRequest *)request;

    Swift

    func listInstanceAttributes(_ request: AWSConnectListInstanceAttributesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Returns a paginated list of all attribute types for the given instance.

    See

    AWSConnectListInstanceAttributesRequest

    See

    AWSConnectListInstanceAttributesResponse

    Declaration

    Objective-C

    - (void)listInstanceAttributes:
            (nonnull AWSConnectListInstanceAttributesRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectListInstanceAttributesResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func listInstanceAttributes(_ request: AWSConnectListInstanceAttributesRequest) async throws -> AWSConnectListInstanceAttributesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListInstanceAttributes service method.
    completionHandler

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

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

    Returns a paginated list of storage configs for the identified instance and resource type.

    See

    AWSConnectListInstanceStorageConfigsRequest

    See

    AWSConnectListInstanceStorageConfigsResponse

    Declaration

    Objective-C

    - (id)listInstanceStorageConfigs:
    (nonnull AWSConnectListInstanceStorageConfigsRequest *)request;

    Swift

    func listInstanceStorageConfigs(_ request: AWSConnectListInstanceStorageConfigsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Returns a paginated list of storage configs for the identified instance and resource type.

    See

    AWSConnectListInstanceStorageConfigsRequest

    See

    AWSConnectListInstanceStorageConfigsResponse

    Declaration

    Objective-C

    - (void)
    listInstanceStorageConfigs:
        (nonnull AWSConnectListInstanceStorageConfigsRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectListInstanceStorageConfigsResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func listInstanceStorageConfigs(_ request: AWSConnectListInstanceStorageConfigsRequest) async throws -> AWSConnectListInstanceStorageConfigsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListInstanceStorageConfigs service method.
    completionHandler

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

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

    Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren’t successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

    See

    AWSConnectListInstancesRequest

    See

    AWSConnectListInstancesResponse

    Declaration

    Objective-C

    - (id)listInstances:(nonnull AWSConnectListInstancesRequest *)request;

    Swift

    func listInstances(_ request: AWSConnectListInstancesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren’t successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

    See

    AWSConnectListInstancesRequest

    See

    AWSConnectListInstancesResponse

    Declaration

    Objective-C

    - (void)listInstances:(nonnull AWSConnectListInstancesRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectListInstancesResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listInstances(_ request: AWSConnectListInstancesRequest) async throws -> AWSConnectListInstancesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListInstances service method.
    completionHandler

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

  • Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

    See

    AWSConnectListIntegrationAssociationsRequest

    See

    AWSConnectListIntegrationAssociationsResponse

    Declaration

    Objective-C

    - (id)listIntegrationAssociations:
    (nonnull AWSConnectListIntegrationAssociationsRequest *)request;

    Swift

    func listIntegrationAssociations(_ request: AWSConnectListIntegrationAssociationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

    See

    AWSConnectListIntegrationAssociationsRequest

    See

    AWSConnectListIntegrationAssociationsResponse

    Declaration

    Objective-C

    - (void)
    listIntegrationAssociations:
        (nonnull AWSConnectListIntegrationAssociationsRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectListIntegrationAssociationsResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listIntegrationAssociations(_ request: AWSConnectListIntegrationAssociationsRequest) async throws -> AWSConnectListIntegrationAssociationsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListIntegrationAssociations service method.
    completionHandler

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

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

    Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

    See

    AWSConnectListLambdaFunctionsRequest

    See

    AWSConnectListLambdaFunctionsResponse

    Declaration

    Objective-C

    - (id)listLambdaFunctions:
    (nonnull AWSConnectListLambdaFunctionsRequest *)request;

    Swift

    func listLambdaFunctions(_ request: AWSConnectListLambdaFunctionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

    See

    AWSConnectListLambdaFunctionsRequest

    See

    AWSConnectListLambdaFunctionsResponse

    Declaration

    Objective-C

    - (void)
    listLambdaFunctions:(nonnull AWSConnectListLambdaFunctionsRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSConnectListLambdaFunctionsResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listLambdaFunctions(_ request: AWSConnectListLambdaFunctionsRequest) async throws -> AWSConnectListLambdaFunctionsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListLambdaFunctions service method.
    completionHandler

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

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

    Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

    See

    AWSConnectListLexBotsRequest

    See

    AWSConnectListLexBotsResponse

    Declaration

    Objective-C

    - (id)listLexBots:(nonnull AWSConnectListLexBotsRequest *)request;

    Swift

    func listLexBots(_ request: AWSConnectListLexBotsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

    See

    AWSConnectListLexBotsRequest

    See

    AWSConnectListLexBotsResponse

    Declaration

    Objective-C

    - (void)listLexBots:(nonnull AWSConnectListLexBotsRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectListLexBotsResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listLexBots(_ request: AWSConnectListLexBotsRequest) async throws -> AWSConnectListLexBotsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListLexBots service method.
    completionHandler

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

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

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

    • We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn’t support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.

    • The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

    See

    AWSConnectListPhoneNumbersRequest

    See

    AWSConnectListPhoneNumbersResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    • We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn’t support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.

    • The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

    See

    AWSConnectListPhoneNumbersRequest

    See

    AWSConnectListPhoneNumbersResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

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

    • When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

    • When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

    See

    AWSConnectListPhoneNumbersV2Request

    See

    AWSConnectListPhoneNumbersV2Response

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

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

    • When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

    • When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

    See

    AWSConnectListPhoneNumbersV2Request

    See

    AWSConnectListPhoneNumbersV2Response

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists predefined attributes for the specified Amazon Connect instance.

    See

    AWSConnectListPredefinedAttributesRequest

    See

    AWSConnectListPredefinedAttributesResponse

    Declaration

    Objective-C

    - (id)listPredefinedAttributes:
    (nonnull AWSConnectListPredefinedAttributesRequest *)request;

    Swift

    func listPredefinedAttributes(_ request: AWSConnectListPredefinedAttributesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists predefined attributes for the specified Amazon Connect instance.

    See

    AWSConnectListPredefinedAttributesRequest

    See

    AWSConnectListPredefinedAttributesResponse

    Declaration

    Objective-C

    - (void)listPredefinedAttributes:
            (nonnull AWSConnectListPredefinedAttributesRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSConnectListPredefinedAttributesResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listPredefinedAttributes(_ request: AWSConnectListPredefinedAttributesRequest) async throws -> AWSConnectListPredefinedAttributesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListPredefinedAttributes service method.
    completionHandler

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

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

    See

    AWSConnectListPromptsRequest

    See

    AWSConnectListPromptsResponse

    Declaration

    Objective-C

    - (id)listPrompts:(nonnull AWSConnectListPromptsRequest *)request;

    Swift

    func listPrompts(_ request: AWSConnectListPromptsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectListPromptsRequest

    See

    AWSConnectListPromptsResponse

    Declaration

    Objective-C

    - (void)listPrompts:(nonnull AWSConnectListPromptsRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectListPromptsResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listPrompts(_ request: AWSConnectListPromptsRequest) async throws -> AWSConnectListPromptsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListPrompts service method.
    completionHandler

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

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

    Lists the quick connects associated with a queue.

    See

    AWSConnectListQueueQuickConnectsRequest

    See

    AWSConnectListQueueQuickConnectsResponse

    Declaration

    Objective-C

    - (id)listQueueQuickConnects:
    (nonnull AWSConnectListQueueQuickConnectsRequest *)request;

    Swift

    func listQueueQuickConnects(_ request: AWSConnectListQueueQuickConnectsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Lists the quick connects associated with a queue.

    See

    AWSConnectListQueueQuickConnectsRequest

    See

    AWSConnectListQueueQuickConnectsResponse

    Declaration

    Objective-C

    - (void)listQueueQuickConnects:
            (nonnull AWSConnectListQueueQuickConnectsRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectListQueueQuickConnectsResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func listQueueQuickConnects(_ request: AWSConnectListQueueQuickConnectsRequest) async throws -> AWSConnectListQueueQuickConnectsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListQueueQuickConnects service method.
    completionHandler

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

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

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

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

    See

    AWSConnectListQueuesRequest

    See

    AWSConnectListQueuesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

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

    See

    AWSConnectListQueuesRequest

    See

    AWSConnectListQueuesResponse

    Declaration

    Objective-C

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

    Swift

    func listQueues(_ request: AWSConnectListQueuesRequest) async throws -> AWSConnectListQueuesResponse

    Parameters

    request

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

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

  • Provides information about the quick connects for the specified Amazon Connect instance.

    See

    AWSConnectListQuickConnectsRequest

    See

    AWSConnectListQuickConnectsResponse

    Declaration

    Objective-C

    - (id)listQuickConnects:(nonnull AWSConnectListQuickConnectsRequest *)request;

    Swift

    func listQuickConnects(_ request: AWSConnectListQuickConnectsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provides information about the quick connects for the specified Amazon Connect instance.

    See

    AWSConnectListQuickConnectsRequest

    See

    AWSConnectListQuickConnectsResponse

    Declaration

    Objective-C

    - (void)listQuickConnects:(nonnull AWSConnectListQuickConnectsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectListQuickConnectsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listQuickConnects(_ request: AWSConnectListQuickConnectsRequest) async throws -> AWSConnectListQuickConnectsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListQuickConnects service method.
    completionHandler

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

  • Provides a list of analysis segments for a real-time analysis session.

    See

    AWSConnectListRealtimeContactAnalysisSegmentsV2Request

    See

    AWSConnectListRealtimeContactAnalysisSegmentsV2Response

    Declaration

    Objective-C

    - (id)listRealtimeContactAnalysisSegmentsV2:
    (nonnull AWSConnectListRealtimeContactAnalysisSegmentsV2Request *)request;

    Swift

    func listRealtimeContactAnalysisSegmentsV2(_ request: AWSConnectListRealtimeContactAnalysisSegmentsV2Request) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provides a list of analysis segments for a real-time analysis session.

    See

    AWSConnectListRealtimeContactAnalysisSegmentsV2Request

    See

    AWSConnectListRealtimeContactAnalysisSegmentsV2Response

    Declaration

    Objective-C

    - (void)
    listRealtimeContactAnalysisSegmentsV2:
        (nonnull AWSConnectListRealtimeContactAnalysisSegmentsV2Request *)
            request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSConnectListRealtimeContactAnalysisSegmentsV2Response
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listRealtimeContactAnalysisSegmentsV2(_ request: AWSConnectListRealtimeContactAnalysisSegmentsV2Request) async throws -> AWSConnectListRealtimeContactAnalysisSegmentsV2Response

    Parameters

    request

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

  • Lists the queues associated with a routing profile.

    See

    AWSConnectListRoutingProfileQueuesRequest

    See

    AWSConnectListRoutingProfileQueuesResponse

    Declaration

    Objective-C

    - (id)listRoutingProfileQueues:
    (nonnull AWSConnectListRoutingProfileQueuesRequest *)request;

    Swift

    func listRoutingProfileQueues(_ request: AWSConnectListRoutingProfileQueuesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the queues associated with a routing profile.

    See

    AWSConnectListRoutingProfileQueuesRequest

    See

    AWSConnectListRoutingProfileQueuesResponse

    Declaration

    Objective-C

    - (void)listRoutingProfileQueues:
            (nonnull AWSConnectListRoutingProfileQueuesRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSConnectListRoutingProfileQueuesResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listRoutingProfileQueues(_ request: AWSConnectListRoutingProfileQueuesRequest) async throws -> AWSConnectListRoutingProfileQueuesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListRoutingProfileQueues service method.
    completionHandler

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

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

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

    See

    AWSConnectListRoutingProfilesRequest

    See

    AWSConnectListRoutingProfilesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectListRoutingProfilesRequest

    See

    AWSConnectListRoutingProfilesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • List all rules for the specified Amazon Connect instance.

    See

    AWSConnectListRulesRequest

    See

    AWSConnectListRulesResponse

    Declaration

    Objective-C

    - (id)listRules:(nonnull AWSConnectListRulesRequest *)request;

    Swift

    func listRules(_ request: AWSConnectListRulesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List all rules for the specified Amazon Connect instance.

    See

    AWSConnectListRulesRequest

    See

    AWSConnectListRulesResponse

    Declaration

    Objective-C

    - (void)listRules:(nonnull AWSConnectListRulesRequest *)request
    completionHandler:(void (^_Nullable)(AWSConnectListRulesResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listRules(_ request: AWSConnectListRulesRequest) async throws -> AWSConnectListRulesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListRules service method.
    completionHandler

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

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

    Returns a paginated list of all security keys associated with the instance.

    See

    AWSConnectListSecurityKeysRequest

    See

    AWSConnectListSecurityKeysResponse

    Declaration

    Objective-C

    - (id)listSecurityKeys:(nonnull AWSConnectListSecurityKeysRequest *)request;

    Swift

    func listSecurityKeys(_ request: AWSConnectListSecurityKeysRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Returns a paginated list of all security keys associated with the instance.

    See

    AWSConnectListSecurityKeysRequest

    See

    AWSConnectListSecurityKeysResponse

    Declaration

    Objective-C

    - (void)listSecurityKeys:(nonnull AWSConnectListSecurityKeysRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectListSecurityKeysResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listSecurityKeys(_ request: AWSConnectListSecurityKeysRequest) async throws -> AWSConnectListSecurityKeysResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListSecurityKeys service method.
    completionHandler

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

  • Returns a list of third-party applications in a specific security profile.

    See

    AWSConnectListSecurityProfileApplicationsRequest

    See

    AWSConnectListSecurityProfileApplicationsResponse

    Declaration

    Objective-C

    - (id)listSecurityProfileApplications:
    (nonnull AWSConnectListSecurityProfileApplicationsRequest *)request;

    Swift

    func listSecurityProfileApplications(_ request: AWSConnectListSecurityProfileApplicationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns a list of third-party applications in a specific security profile.

    See

    AWSConnectListSecurityProfileApplicationsRequest

    See

    AWSConnectListSecurityProfileApplicationsResponse

    Declaration

    Objective-C

    - (void)listSecurityProfileApplications:
            (nonnull AWSConnectListSecurityProfileApplicationsRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSConnectListSecurityProfileApplicationsResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listSecurityProfileApplications(_ request: AWSConnectListSecurityProfileApplicationsRequest) async throws -> AWSConnectListSecurityProfileApplicationsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListSecurityProfileApplications service method.
    completionHandler

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

  • Lists the permissions granted to a security profile.

    See

    AWSConnectListSecurityProfilePermissionsRequest

    See

    AWSConnectListSecurityProfilePermissionsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Lists the permissions granted to a security profile.

    See

    AWSConnectListSecurityProfilePermissionsRequest

    See

    AWSConnectListSecurityProfilePermissionsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

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

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

    See

    AWSConnectListSecurityProfilesRequest

    See

    AWSConnectListSecurityProfilesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectListSecurityProfilesRequest

    See

    AWSConnectListSecurityProfilesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists the tags for the specified resource.

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

    See

    AWSConnectListTagsForResourceRequest

    See

    AWSConnectListTagsForResourceResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Lists the tags for the specified resource.

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

    See

    AWSConnectListTagsForResourceRequest

    See

    AWSConnectListTagsForResourceResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists task templates for the specified Amazon Connect instance.

    See

    AWSConnectListTaskTemplatesRequest

    See

    AWSConnectListTaskTemplatesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Lists task templates for the specified Amazon Connect instance.

    See

    AWSConnectListTaskTemplatesRequest

    See

    AWSConnectListTaskTemplatesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists traffic distribution group users.

    See

    AWSConnectListTrafficDistributionGroupUsersRequest

    See

    AWSConnectListTrafficDistributionGroupUsersResponse

    Declaration

    Objective-C

    - (id)listTrafficDistributionGroupUsers:
    (nonnull AWSConnectListTrafficDistributionGroupUsersRequest *)request;

    Swift

    func listTrafficDistributionGroupUsers(_ request: AWSConnectListTrafficDistributionGroupUsersRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists traffic distribution group users.

    See

    AWSConnectListTrafficDistributionGroupUsersRequest

    See

    AWSConnectListTrafficDistributionGroupUsersResponse

    Declaration

    Objective-C

    - (void)
    listTrafficDistributionGroupUsers:
        (nonnull AWSConnectListTrafficDistributionGroupUsersRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSConnectListTrafficDistributionGroupUsersResponse
                                *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listTrafficDistributionGroupUsers(_ request: AWSConnectListTrafficDistributionGroupUsersRequest) async throws -> AWSConnectListTrafficDistributionGroupUsersResponse

    Parameters

    request

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

  • Lists traffic distribution groups.

    See

    AWSConnectListTrafficDistributionGroupsRequest

    See

    AWSConnectListTrafficDistributionGroupsResponse

    Declaration

    Objective-C

    - (id)listTrafficDistributionGroups:
    (nonnull AWSConnectListTrafficDistributionGroupsRequest *)request;

    Swift

    func listTrafficDistributionGroups(_ request: AWSConnectListTrafficDistributionGroupsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists traffic distribution groups.

    See

    AWSConnectListTrafficDistributionGroupsRequest

    See

    AWSConnectListTrafficDistributionGroupsResponse

    Declaration

    Objective-C

    - (void)listTrafficDistributionGroups:
            (nonnull AWSConnectListTrafficDistributionGroupsRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSConnectListTrafficDistributionGroupsResponse
                                *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listTrafficDistributionGroups(_ request: AWSConnectListTrafficDistributionGroupsRequest) async throws -> AWSConnectListTrafficDistributionGroupsResponse

    Parameters

    request

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

  • Lists the use cases for the integration association.

    See

    AWSConnectListUseCasesRequest

    See

    AWSConnectListUseCasesResponse

    Declaration

    Objective-C

    - (id)listUseCases:(nonnull AWSConnectListUseCasesRequest *)request;

    Swift

    func listUseCases(_ request: AWSConnectListUseCasesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the use cases for the integration association.

    See

    AWSConnectListUseCasesRequest

    See

    AWSConnectListUseCasesResponse

    Declaration

    Objective-C

    - (void)listUseCases:(nonnull AWSConnectListUseCasesRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectListUseCasesResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listUseCases(_ request: AWSConnectListUseCasesRequest) async throws -> AWSConnectListUseCasesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListUseCases service method.
    completionHandler

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

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

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

    See

    AWSConnectListUserHierarchyGroupsRequest

    See

    AWSConnectListUserHierarchyGroupsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    See

    AWSConnectListUserHierarchyGroupsRequest

    See

    AWSConnectListUserHierarchyGroupsResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

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

  • Lists proficiencies associated with a user.

    See

    AWSConnectListUserProficienciesRequest

    See

    AWSConnectListUserProficienciesResponse

    Declaration

    Objective-C

    - (id)listUserProficiencies:
    (nonnull AWSConnectListUserProficienciesRequest *)request;

    Swift

    func listUserProficiencies(_ request: AWSConnectListUserProficienciesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists proficiencies associated with a user.

    See

    AWSConnectListUserProficienciesRequest

    See

    AWSConnectListUserProficienciesResponse

    Declaration

    Objective-C

    - (void)listUserProficiencies:
            (nonnull AWSConnectListUserProficienciesRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSConnectListUserProficienciesResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func listUserProficiencies(_ request: AWSConnectListUserProficienciesRequest) async throws -> AWSConnectListUserProficienciesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListUserProficiencies service method.
    completionHandler

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

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

    See

    AWSConnectListUsersRequest

    See

    AWSConnectListUsersResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectListUsersRequest

    See

    AWSConnectListUsersResponse

    Declaration

    Objective-C

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

    Swift

    func listUsers(_ request: AWSConnectListUsersRequest) async throws -> AWSConnectListUsersResponse

    Parameters

    request

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

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

  • Returns all the available versions for the specified Amazon Connect instance and view identifier.

    Results will be sorted from highest to lowest.

    See

    AWSConnectListViewVersionsRequest

    See

    AWSConnectListViewVersionsResponse

    Declaration

    Objective-C

    - (id)listViewVersions:(nonnull AWSConnectListViewVersionsRequest *)request;

    Swift

    func listViewVersions(_ request: AWSConnectListViewVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns all the available versions for the specified Amazon Connect instance and view identifier.

    Results will be sorted from highest to lowest.

    See

    AWSConnectListViewVersionsRequest

    See

    AWSConnectListViewVersionsResponse

    Declaration

    Objective-C

    - (void)listViewVersions:(nonnull AWSConnectListViewVersionsRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectListViewVersionsResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listViewVersions(_ request: AWSConnectListViewVersionsRequest) async throws -> AWSConnectListViewVersionsResponse

    Parameters

    request

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

  • Returns views in the given instance.

    Results are sorted primarily by type, and secondarily by name.

    See

    AWSConnectListViewsRequest

    See

    AWSConnectListViewsResponse

    Declaration

    Objective-C

    - (id)listViews:(nonnull AWSConnectListViewsRequest *)request;

    Swift

    func listViews(_ request: AWSConnectListViewsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns views in the given instance.

    Results are sorted primarily by type, and secondarily by name.

    See

    AWSConnectListViewsRequest

    See

    AWSConnectListViewsResponse

    Declaration

    Objective-C

    - (void)listViews:(nonnull AWSConnectListViewsRequest *)request
    completionHandler:(void (^_Nullable)(AWSConnectListViewsResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listViews(_ request: AWSConnectListViewsRequest) async throws -> AWSConnectListViewsResponse

    Parameters

    request

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

  • Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

    See

    AWSConnectMonitorContactRequest

    See

    AWSConnectMonitorContactResponse

    Declaration

    Objective-C

    - (id)monitorContact:(nonnull AWSConnectMonitorContactRequest *)request;

    Swift

    func monitorContact(_ request: AWSConnectMonitorContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

    See

    AWSConnectMonitorContactRequest

    See

    AWSConnectMonitorContactResponse

    Declaration

    Objective-C

    - (void)monitorContact:(nonnull AWSConnectMonitorContactRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSConnectMonitorContactResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func monitorContact(_ request: AWSConnectMonitorContactRequest) async throws -> AWSConnectMonitorContactResponse

    Parameters

    request

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

  • Allows pausing an ongoing task contact.

    See

    AWSConnectPauseContactRequest

    See

    AWSConnectPauseContactResponse

    Declaration

    Objective-C

    - (id)pauseContact:(nonnull AWSConnectPauseContactRequest *)request;

    Swift

    func pauseContact(_ request: AWSConnectPauseContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Allows pausing an ongoing task contact.

    See

    AWSConnectPauseContactRequest

    See

    AWSConnectPauseContactResponse

    Declaration

    Objective-C

    - (void)pauseContact:(nonnull AWSConnectPauseContactRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectPauseContactResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func pauseContact(_ request: AWSConnectPauseContactRequest) async throws -> AWSConnectPauseContactResponse

    Parameters

    request

    A container for the necessary parameters to execute the PauseContact 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, AWSConnectErrorInvalidParameter, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorLimitExceeded, AWSConnectErrorConflict.

  • Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent’s next status.

    For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

    See

    AWSConnectPutUserStatusRequest

    See

    AWSConnectPutUserStatusResponse

    Declaration

    Objective-C

    - (id)putUserStatus:(nonnull AWSConnectPutUserStatusRequest *)request;

    Swift

    func putUserStatus(_ request: AWSConnectPutUserStatusRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent’s next status.

    For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

    See

    AWSConnectPutUserStatusRequest

    See

    AWSConnectPutUserStatusResponse

    Declaration

    Objective-C

    - (void)putUserStatus:(nonnull AWSConnectPutUserStatusRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectPutUserStatusResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func putUserStatus(_ request: AWSConnectPutUserStatusRequest) async throws -> AWSConnectPutUserStatusResponse

    Parameters

    request

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

  • Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

    To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.

    After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

    If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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

    AWSConnectReleasePhoneNumberRequest

    Declaration

    Objective-C

    - (id)releasePhoneNumber:(nonnull AWSConnectReleasePhoneNumberRequest *)request;

    Swift

    func releasePhoneNumber(_ request: AWSConnectReleasePhoneNumberRequest) -> Any!

    Parameters

    request

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

  • Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

    To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.

    After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

    If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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

    AWSConnectReleasePhoneNumberRequest

    Declaration

    Objective-C

    - (void)
    releasePhoneNumber:(nonnull AWSConnectReleasePhoneNumberRequest *)request
     completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func releasePhoneNumber(_ request: AWSConnectReleasePhoneNumberRequest) async throws

    Parameters

    request

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

  • Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

    For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

    See

    AWSConnectReplicateInstanceRequest

    See

    AWSConnectReplicateInstanceResponse

    Declaration

    Objective-C

    - (id)replicateInstance:(nonnull AWSConnectReplicateInstanceRequest *)request;

    Swift

    func replicateInstance(_ request: AWSConnectReplicateInstanceRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

    For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

    See

    AWSConnectReplicateInstanceRequest

    See

    AWSConnectReplicateInstanceResponse

    Declaration

    Objective-C

    - (void)replicateInstance:(nonnull AWSConnectReplicateInstanceRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectReplicateInstanceResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func replicateInstance(_ request: AWSConnectReplicateInstanceRequest) async throws -> AWSConnectReplicateInstanceResponse

    Parameters

    request

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

  • Allows resuming a task contact in a paused state.

    See

    AWSConnectResumeContactRequest

    See

    AWSConnectResumeContactResponse

    Declaration

    Objective-C

    - (id)resumeContact:(nonnull AWSConnectResumeContactRequest *)request;

    Swift

    func resumeContact(_ request: AWSConnectResumeContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Allows resuming a task contact in a paused state.

    See

    AWSConnectResumeContactRequest

    See

    AWSConnectResumeContactResponse

    Declaration

    Objective-C

    - (void)resumeContact:(nonnull AWSConnectResumeContactRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectResumeContactResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func resumeContact(_ request: AWSConnectResumeContactRequest) async throws -> AWSConnectResumeContactResponse

    Parameters

    request

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

  • When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

    Voice and screen recordings are supported.

    See

    AWSConnectResumeContactRecordingRequest

    See

    AWSConnectResumeContactRecordingResponse

    Declaration

    Objective-C

    - (id)resumeContactRecording:
    (nonnull AWSConnectResumeContactRecordingRequest *)request;

    Swift

    func resumeContactRecording(_ request: AWSConnectResumeContactRecordingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

    Voice and screen recordings are supported.

    See

    AWSConnectResumeContactRecordingRequest

    See

    AWSConnectResumeContactRecordingResponse

    Declaration

    Objective-C

    - (void)resumeContactRecording:
            (nonnull AWSConnectResumeContactRecordingRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectResumeContactRecordingResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func resumeContactRecording(_ request: AWSConnectResumeContactRecordingRequest) async throws -> AWSConnectResumeContactRecordingResponse

    Parameters

    request

    A container for the necessary parameters to execute the ResumeContactRecording service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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.

  • Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

    See

    AWSConnectSearchAvailablePhoneNumbersRequest

    See

    AWSConnectSearchAvailablePhoneNumbersResponse

    Declaration

    Objective-C

    - (id)searchAvailablePhoneNumbers:
    (nonnull AWSConnectSearchAvailablePhoneNumbersRequest *)request;

    Swift

    func searchAvailablePhoneNumbers(_ request: AWSConnectSearchAvailablePhoneNumbersRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

    See

    AWSConnectSearchAvailablePhoneNumbersRequest

    See

    AWSConnectSearchAvailablePhoneNumbersResponse

    Declaration

    Objective-C

    - (void)
    searchAvailablePhoneNumbers:
        (nonnull AWSConnectSearchAvailablePhoneNumbersRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectSearchAvailablePhoneNumbersResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func searchAvailablePhoneNumbers(_ request: AWSConnectSearchAvailablePhoneNumbersRequest) async throws -> AWSConnectSearchAvailablePhoneNumbersResponse

    Parameters

    request

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

  • Searches the flow modules in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchContactFlowModulesRequest

    See

    AWSConnectSearchContactFlowModulesResponse

    Declaration

    Objective-C

    - (id)searchContactFlowModules:
    (nonnull AWSConnectSearchContactFlowModulesRequest *)request;

    Swift

    func searchContactFlowModules(_ request: AWSConnectSearchContactFlowModulesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches the flow modules in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchContactFlowModulesRequest

    See

    AWSConnectSearchContactFlowModulesResponse

    Declaration

    Objective-C

    - (void)searchContactFlowModules:
            (nonnull AWSConnectSearchContactFlowModulesRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSConnectSearchContactFlowModulesResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func searchContactFlowModules(_ request: AWSConnectSearchContactFlowModulesRequest) async throws -> AWSConnectSearchContactFlowModulesResponse

    Parameters

    request

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

  • Searches the contact flows in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchContactFlowsRequest

    See

    AWSConnectSearchContactFlowsResponse

    Declaration

    Objective-C

    - (id)searchContactFlows:(nonnull AWSConnectSearchContactFlowsRequest *)request;

    Swift

    func searchContactFlows(_ request: AWSConnectSearchContactFlowsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches the contact flows in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchContactFlowsRequest

    See

    AWSConnectSearchContactFlowsResponse

    Declaration

    Objective-C

    - (void)searchContactFlows:
            (nonnull AWSConnectSearchContactFlowsRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectSearchContactFlowsResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func searchContactFlows(_ request: AWSConnectSearchContactFlowsRequest) async throws -> AWSConnectSearchContactFlowsResponse

    Parameters

    request

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

  • Searches contacts in an Amazon Connect instance.

    See

    AWSConnectSearchContactsRequest

    See

    AWSConnectSearchContactsResponse

    Declaration

    Objective-C

    - (id)searchContacts:(nonnull AWSConnectSearchContactsRequest *)request;

    Swift

    func searchContacts(_ request: AWSConnectSearchContactsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches contacts in an Amazon Connect instance.

    See

    AWSConnectSearchContactsRequest

    See

    AWSConnectSearchContactsResponse

    Declaration

    Objective-C

    - (void)searchContacts:(nonnull AWSConnectSearchContactsRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSConnectSearchContactsResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func searchContacts(_ request: AWSConnectSearchContactsRequest) async throws -> AWSConnectSearchContactsResponse

    Parameters

    request

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

  • Searches the hours of operation in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchHoursOfOperationsRequest

    See

    AWSConnectSearchHoursOfOperationsResponse

    Declaration

    Objective-C

    - (id)searchHoursOfOperations:
    (nonnull AWSConnectSearchHoursOfOperationsRequest *)request;

    Swift

    func searchHours(ofOperations request: AWSConnectSearchHoursOfOperationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches the hours of operation in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchHoursOfOperationsRequest

    See

    AWSConnectSearchHoursOfOperationsResponse

    Declaration

    Objective-C

    - (void)searchHoursOfOperations:
            (nonnull AWSConnectSearchHoursOfOperationsRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectSearchHoursOfOperationsResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func searchHours(ofOperations request: AWSConnectSearchHoursOfOperationsRequest) async throws -> AWSConnectSearchHoursOfOperationsResponse

    Parameters

    request

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

  • Predefined attributes that meet certain criteria.

    See

    AWSConnectSearchPredefinedAttributesRequest

    See

    AWSConnectSearchPredefinedAttributesResponse

    Declaration

    Objective-C

    - (id)searchPredefinedAttributes:
    (nonnull AWSConnectSearchPredefinedAttributesRequest *)request;

    Swift

    func searchPredefinedAttributes(_ request: AWSConnectSearchPredefinedAttributesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Predefined attributes that meet certain criteria.

    See

    AWSConnectSearchPredefinedAttributesRequest

    See

    AWSConnectSearchPredefinedAttributesResponse

    Declaration

    Objective-C

    - (void)
    searchPredefinedAttributes:
        (nonnull AWSConnectSearchPredefinedAttributesRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectSearchPredefinedAttributesResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func searchPredefinedAttributes(_ request: AWSConnectSearchPredefinedAttributesRequest) async throws -> AWSConnectSearchPredefinedAttributesResponse

    Parameters

    request

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

  • Searches prompts in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchPromptsRequest

    See

    AWSConnectSearchPromptsResponse

    Declaration

    Objective-C

    - (id)searchPrompts:(nonnull AWSConnectSearchPromptsRequest *)request;

    Swift

    func searchPrompts(_ request: AWSConnectSearchPromptsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches prompts in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchPromptsRequest

    See

    AWSConnectSearchPromptsResponse

    Declaration

    Objective-C

    - (void)searchPrompts:(nonnull AWSConnectSearchPromptsRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectSearchPromptsResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func searchPrompts(_ request: AWSConnectSearchPromptsRequest) async throws -> AWSConnectSearchPromptsResponse

    Parameters

    request

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

  • Searches queues in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchQueuesRequest

    See

    AWSConnectSearchQueuesResponse

    Declaration

    Objective-C

    - (id)searchQueues:(nonnull AWSConnectSearchQueuesRequest *)request;

    Swift

    func searchQueues(_ request: AWSConnectSearchQueuesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches queues in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchQueuesRequest

    See

    AWSConnectSearchQueuesResponse

    Declaration

    Objective-C

    - (void)searchQueues:(nonnull AWSConnectSearchQueuesRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectSearchQueuesResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func searchQueues(_ request: AWSConnectSearchQueuesRequest) async throws -> AWSConnectSearchQueuesResponse

    Parameters

    request

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

  • Searches quick connects in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchQuickConnectsRequest

    See

    AWSConnectSearchQuickConnectsResponse

    Declaration

    Objective-C

    - (id)searchQuickConnects:
    (nonnull AWSConnectSearchQuickConnectsRequest *)request;

    Swift

    func searchQuickConnects(_ request: AWSConnectSearchQuickConnectsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches quick connects in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchQuickConnectsRequest

    See

    AWSConnectSearchQuickConnectsResponse

    Declaration

    Objective-C

    - (void)
    searchQuickConnects:(nonnull AWSConnectSearchQuickConnectsRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSConnectSearchQuickConnectsResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func searchQuickConnects(_ request: AWSConnectSearchQuickConnectsRequest) async throws -> AWSConnectSearchQuickConnectsResponse

    Parameters

    request

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

  • Searches tags used in an Amazon Connect instance using optional search criteria.

    See

    AWSConnectSearchResourceTagsRequest

    See

    AWSConnectSearchResourceTagsResponse

    Declaration

    Objective-C

    - (id)searchResourceTags:(nonnull AWSConnectSearchResourceTagsRequest *)request;

    Swift

    func searchResourceTags(_ request: AWSConnectSearchResourceTagsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches tags used in an Amazon Connect instance using optional search criteria.

    See

    AWSConnectSearchResourceTagsRequest

    See

    AWSConnectSearchResourceTagsResponse

    Declaration

    Objective-C

    - (void)searchResourceTags:
            (nonnull AWSConnectSearchResourceTagsRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectSearchResourceTagsResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func searchResourceTags(_ request: AWSConnectSearchResourceTagsRequest) async throws -> AWSConnectSearchResourceTagsResponse

    Parameters

    request

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

  • Searches routing profiles in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchRoutingProfilesRequest

    See

    AWSConnectSearchRoutingProfilesResponse

    Declaration

    Objective-C

    - (id)searchRoutingProfiles:
    (nonnull AWSConnectSearchRoutingProfilesRequest *)request;

    Swift

    func searchRoutingProfiles(_ request: AWSConnectSearchRoutingProfilesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches routing profiles in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchRoutingProfilesRequest

    See

    AWSConnectSearchRoutingProfilesResponse

    Declaration

    Objective-C

    - (void)searchRoutingProfiles:
            (nonnull AWSConnectSearchRoutingProfilesRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSConnectSearchRoutingProfilesResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func searchRoutingProfiles(_ request: AWSConnectSearchRoutingProfilesRequest) async throws -> AWSConnectSearchRoutingProfilesResponse

    Parameters

    request

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

  • Searches security profiles in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchSecurityProfilesRequest

    See

    AWSConnectSearchSecurityProfilesResponse

    Declaration

    Objective-C

    - (id)searchSecurityProfiles:
    (nonnull AWSConnectSearchSecurityProfilesRequest *)request;

    Swift

    func searchSecurityProfiles(_ request: AWSConnectSearchSecurityProfilesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches security profiles in an Amazon Connect instance, with optional filtering.

    See

    AWSConnectSearchSecurityProfilesRequest

    See

    AWSConnectSearchSecurityProfilesResponse

    Declaration

    Objective-C

    - (void)searchSecurityProfiles:
            (nonnull AWSConnectSearchSecurityProfilesRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectSearchSecurityProfilesResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func searchSecurityProfiles(_ request: AWSConnectSearchSecurityProfilesRequest) async throws -> AWSConnectSearchSecurityProfilesResponse

    Parameters

    request

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

  • Searches users in an Amazon Connect instance, with optional filtering.

    AfterContactWorkTimeLimit is returned in milliseconds.

    See

    AWSConnectSearchUsersRequest

    See

    AWSConnectSearchUsersResponse

    Declaration

    Objective-C

    - (id)searchUsers:(nonnull AWSConnectSearchUsersRequest *)request;

    Swift

    func searchUsers(_ request: AWSConnectSearchUsersRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches users in an Amazon Connect instance, with optional filtering.

    AfterContactWorkTimeLimit is returned in milliseconds.

    See

    AWSConnectSearchUsersRequest

    See

    AWSConnectSearchUsersResponse

    Declaration

    Objective-C

    - (void)searchUsers:(nonnull AWSConnectSearchUsersRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectSearchUsersResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func searchUsers(_ request: AWSConnectSearchUsersRequest) async throws -> AWSConnectSearchUsersResponse

    Parameters

    request

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

  • Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

    See

    AWSConnectSearchVocabulariesRequest

    See

    AWSConnectSearchVocabulariesResponse

    Declaration

    Objective-C

    - (id)searchVocabularies:(nonnull AWSConnectSearchVocabulariesRequest *)request;

    Swift

    func searchVocabularies(_ request: AWSConnectSearchVocabulariesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

    See

    AWSConnectSearchVocabulariesRequest

    See

    AWSConnectSearchVocabulariesResponse

    Declaration

    Objective-C

    - (void)searchVocabularies:
            (nonnull AWSConnectSearchVocabulariesRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectSearchVocabulariesResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func searchVocabularies(_ request: AWSConnectSearchVocabulariesRequest) async throws -> AWSConnectSearchVocabulariesResponse

    Parameters

    request

    A container for the necessary parameters to execute the SearchVocabularies service method.
    completionHandler

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

  • Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

    • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

    • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

    When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

    Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.

    See

    AWSConnectSendChatIntegrationEventRequest

    See

    AWSConnectSendChatIntegrationEventResponse

    Declaration

    Objective-C

    - (id)sendChatIntegrationEvent:
    (nonnull AWSConnectSendChatIntegrationEventRequest *)request;

    Swift

    func sendChatIntegrationEvent(_ request: AWSConnectSendChatIntegrationEventRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

    • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

    • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

    When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

    Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.

    See

    AWSConnectSendChatIntegrationEventRequest

    See

    AWSConnectSendChatIntegrationEventResponse

    Declaration

    Objective-C

    - (void)sendChatIntegrationEvent:
            (nonnull AWSConnectSendChatIntegrationEventRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSConnectSendChatIntegrationEventResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func sendChatIntegrationEvent(_ request: AWSConnectSendChatIntegrationEventRequest) async throws -> AWSConnectSendChatIntegrationEventResponse

    Parameters

    request

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

  • Provides a pre-signed Amazon S3 URL in response for uploading your content.

    You may only use this API to upload attachments to a Connect Case.

    See

    AWSConnectStartAttachedFileUploadRequest

    See

    AWSConnectStartAttachedFileUploadResponse

    Declaration

    Objective-C

    - (id)startAttachedFileUpload:
    (nonnull AWSConnectStartAttachedFileUploadRequest *)request;

    Swift

    func startAttachedFileUpload(_ request: AWSConnectStartAttachedFileUploadRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provides a pre-signed Amazon S3 URL in response for uploading your content.

    You may only use this API to upload attachments to a Connect Case.

    See

    AWSConnectStartAttachedFileUploadRequest

    See

    AWSConnectStartAttachedFileUploadResponse

    Declaration

    Objective-C

    - (void)startAttachedFileUpload:
            (nonnull AWSConnectStartAttachedFileUploadRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectStartAttachedFileUploadResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func startAttachedFileUpload(_ request: AWSConnectStartAttachedFileUploadRequest) async throws -> AWSConnectStartAttachedFileUploadResponse

    Parameters

    request

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

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

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

    A 429 error occurs in the following situations:

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

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

    If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

    For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

    See

    AWSConnectStartChatContactRequest

    See

    AWSConnectStartChatContactResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

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

    A 429 error occurs in the following situations:

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

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

    If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

    For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

    See

    AWSConnectStartChatContactRequest

    See

    AWSConnectStartChatContactResponse

    Declaration

    Objective-C

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

    Swift

    func startChatContact(_ request: AWSConnectStartChatContactRequest) async throws -> AWSConnectStartChatContactResponse

    Parameters

    request

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

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

  • Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

    Evaluations created through the public API do not contain answer values suggested from automation.

    See

    AWSConnectStartContactEvaluationRequest

    See

    AWSConnectStartContactEvaluationResponse

    Declaration

    Objective-C

    - (id)startContactEvaluation:
    (nonnull AWSConnectStartContactEvaluationRequest *)request;

    Swift

    func startContactEvaluation(_ request: AWSConnectStartContactEvaluationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

    Evaluations created through the public API do not contain answer values suggested from automation.

    See

    AWSConnectStartContactEvaluationRequest

    See

    AWSConnectStartContactEvaluationResponse

    Declaration

    Objective-C

    - (void)startContactEvaluation:
            (nonnull AWSConnectStartContactEvaluationRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSConnectStartContactEvaluationResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func startContactEvaluation(_ request: AWSConnectStartContactEvaluationRequest) async throws -> AWSConnectStartContactEvaluationResponse

    Parameters

    request

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

  • Starts recording the contact:

    • If the API is called before the agent joins the call, recording starts when the agent joins the call.

    • If the API is called after the agent joins the call, recording starts at the time of the API call.

    StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

    You can use this API to override the recording behavior configured in the Set recording behavior block.

    Only voice recordings are supported at this time.

    See

    AWSConnectStartContactRecordingRequest

    See

    AWSConnectStartContactRecordingResponse

    Declaration

    Objective-C

    - (id)startContactRecording:
    (nonnull AWSConnectStartContactRecordingRequest *)request;

    Swift

    func startContactRecording(_ request: AWSConnectStartContactRecordingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts recording the contact:

    • If the API is called before the agent joins the call, recording starts when the agent joins the call.

    • If the API is called after the agent joins the call, recording starts at the time of the API call.

    StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

    You can use this API to override the recording behavior configured in the Set recording behavior block.

    Only voice recordings are supported at this time.

    See

    AWSConnectStartContactRecordingRequest

    See

    AWSConnectStartContactRecordingResponse

    Declaration

    Objective-C

    - (void)startContactRecording:
            (nonnull AWSConnectStartContactRecordingRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSConnectStartContactRecordingResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func startContactRecording(_ request: AWSConnectStartContactRecordingRequest) async throws -> AWSConnectStartContactRecordingResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartContactRecording service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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.

  • Initiates real-time message streaming for a new chat contact.

    For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

    For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

    See

    AWSConnectStartContactStreamingRequest

    See

    AWSConnectStartContactStreamingResponse

    Declaration

    Objective-C

    - (id)startContactStreaming:
    (nonnull AWSConnectStartContactStreamingRequest *)request;

    Swift

    func startContactStreaming(_ request: AWSConnectStartContactStreamingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Initiates real-time message streaming for a new chat contact.

    For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

    For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

    See

    AWSConnectStartContactStreamingRequest

    See

    AWSConnectStartContactStreamingResponse

    Declaration

    Objective-C

    - (void)startContactStreaming:
            (nonnull AWSConnectStartContactStreamingRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSConnectStartContactStreamingResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func startContactStreaming(_ request: AWSConnectStartContactStreamingRequest) async throws -> AWSConnectStartContactStreamingResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartContactStreaming service method.
    completionHandler

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

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

    Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

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

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

    Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

    See

    AWSConnectStartOutboundVoiceContactRequest

    See

    AWSConnectStartOutboundVoiceContactResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

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

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

    Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

    See

    AWSConnectStartOutboundVoiceContactRequest

    See

    AWSConnectStartOutboundVoiceContactResponse

    Declaration

    Objective-C

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

    Swift

    func startOutboundVoiceContact(_ request: AWSConnectStartOutboundVoiceContactRequest) async throws -> AWSConnectStartOutboundVoiceContactResponse

    Parameters

    request

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

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

  • Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.

    When using PreviousContactId and RelatedContactId input parameters, note the following:

    • PreviousContactId

      • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

      • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

    • RelatedContactId

      • Copies contact attributes from the related task contact to the new contact.

      • Any update on attributes in a new task contact does not update attributes on previous contact.

      • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

    In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

    A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.

    See

    AWSConnectStartTaskContactRequest

    See

    AWSConnectStartTaskContactResponse

    Declaration

    Objective-C

    - (id)startTaskContact:(nonnull AWSConnectStartTaskContactRequest *)request;

    Swift

    func startTaskContact(_ request: AWSConnectStartTaskContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.

    When using PreviousContactId and RelatedContactId input parameters, note the following:

    • PreviousContactId

      • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

      • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

    • RelatedContactId

      • Copies contact attributes from the related task contact to the new contact.

      • Any update on attributes in a new task contact does not update attributes on previous contact.

      • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

    In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

    A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.

    See

    AWSConnectStartTaskContactRequest

    See

    AWSConnectStartTaskContactResponse

    Declaration

    Objective-C

    - (void)startTaskContact:(nonnull AWSConnectStartTaskContactRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectStartTaskContactResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func startTaskContact(_ request: AWSConnectStartTaskContactRequest) async throws -> AWSConnectStartTaskContactResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartTaskContact service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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, AWSConnectErrorServiceQuotaExceeded, AWSConnectErrorInternalService.

  • Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

    See

    AWSConnectStartWebRTCContactRequest

    See

    AWSConnectStartWebRTCContactResponse

    Declaration

    Objective-C

    - (id)startWebRTCContact:(nonnull AWSConnectStartWebRTCContactRequest *)request;

    Swift

    func startWebRTCContact(_ request: AWSConnectStartWebRTCContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

    See

    AWSConnectStartWebRTCContactRequest

    See

    AWSConnectStartWebRTCContactResponse

    Declaration

    Objective-C

    - (void)startWebRTCContact:
            (nonnull AWSConnectStartWebRTCContactRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectStartWebRTCContactResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func startWebRTCContact(_ request: AWSConnectStartWebRTCContactRequest) async throws -> AWSConnectStartWebRTCContactResponse

    Parameters

    request

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

  • Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

    • DISCONNECT

    • TRANSFER

    • QUEUE_TRANSFER

    • EXTERNAL_OUTBOUND

    • MONITOR

    Chat and task contacts can be terminated in any state, regardless of initiation method.

    See

    AWSConnectStopContactRequest

    See

    AWSConnectStopContactResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

    • DISCONNECT

    • TRANSFER

    • QUEUE_TRANSFER

    • EXTERNAL_OUTBOUND

    • MONITOR

    Chat and task contacts can be terminated in any state, regardless of initiation method.

    See

    AWSConnectStopContactRequest

    See

    AWSConnectStopContactResponse

    Declaration

    Objective-C

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

    Swift

    func stopContact(_ request: AWSConnectStopContactRequest) async throws -> AWSConnectStopContactResponse

    Parameters

    request

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

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

  • Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

    Only voice recordings are supported at this time.

    See

    AWSConnectStopContactRecordingRequest

    See

    AWSConnectStopContactRecordingResponse

    Declaration

    Objective-C

    - (id)stopContactRecording:
    (nonnull AWSConnectStopContactRecordingRequest *)request;

    Swift

    func stopContactRecording(_ request: AWSConnectStopContactRecordingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

    Only voice recordings are supported at this time.

    See

    AWSConnectStopContactRecordingRequest

    See

    AWSConnectStopContactRecordingResponse

    Declaration

    Objective-C

    - (void)
    stopContactRecording:
        (nonnull AWSConnectStopContactRecordingRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectStopContactRecordingResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func stopContactRecording(_ request: AWSConnectStopContactRecordingRequest) async throws -> AWSConnectStopContactRecordingResponse

    Parameters

    request

    A container for the necessary parameters to execute the StopContactRecording service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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.

  • Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

    See

    AWSConnectStopContactStreamingRequest

    See

    AWSConnectStopContactStreamingResponse

    Declaration

    Objective-C

    - (id)stopContactStreaming:
    (nonnull AWSConnectStopContactStreamingRequest *)request;

    Swift

    func stopContactStreaming(_ request: AWSConnectStopContactStreamingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

    See

    AWSConnectStopContactStreamingRequest

    See

    AWSConnectStopContactStreamingResponse

    Declaration

    Objective-C

    - (void)
    stopContactStreaming:
        (nonnull AWSConnectStopContactStreamingRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectStopContactStreamingResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func stopContactStreaming(_ request: AWSConnectStopContactStreamingRequest) async throws -> AWSConnectStopContactStreamingResponse

    Parameters

    request

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

  • Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.

    If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

    See

    AWSConnectSubmitContactEvaluationRequest

    See

    AWSConnectSubmitContactEvaluationResponse

    Declaration

    Objective-C

    - (id)submitContactEvaluation:
    (nonnull AWSConnectSubmitContactEvaluationRequest *)request;

    Swift

    func submitContactEvaluation(_ request: AWSConnectSubmitContactEvaluationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.

    If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

    See

    AWSConnectSubmitContactEvaluationRequest

    See

    AWSConnectSubmitContactEvaluationResponse

    Declaration

    Objective-C

    - (void)submitContactEvaluation:
            (nonnull AWSConnectSubmitContactEvaluationRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectSubmitContactEvaluationResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func submitContactEvaluation(_ request: AWSConnectSubmitContactEvaluationRequest) async throws -> AWSConnectSubmitContactEvaluationResponse

    Parameters

    request

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

  • When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

    The period of time that the recording is suspended is filled with silence in the final recording.

    Voice and screen recordings are supported.

    See

    AWSConnectSuspendContactRecordingRequest

    See

    AWSConnectSuspendContactRecordingResponse

    Declaration

    Objective-C

    - (id)suspendContactRecording:
    (nonnull AWSConnectSuspendContactRecordingRequest *)request;

    Swift

    func suspendContactRecording(_ request: AWSConnectSuspendContactRecordingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

    The period of time that the recording is suspended is filled with silence in the final recording.

    Voice and screen recordings are supported.

    See

    AWSConnectSuspendContactRecordingRequest

    See

    AWSConnectSuspendContactRecordingResponse

    Declaration

    Objective-C

    - (void)suspendContactRecording:
            (nonnull AWSConnectSuspendContactRecordingRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectSuspendContactRecordingResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func suspendContactRecording(_ request: AWSConnectSuspendContactRecordingRequest) async throws -> AWSConnectSuspendContactRecordingResponse

    Parameters

    request

    A container for the necessary parameters to execute the SuspendContactRecording service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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.

  • Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

    See

    AWSConnectTagContactRequest

    See

    AWSConnectTagContactResponse

    Declaration

    Objective-C

    - (id)tagContact:(nonnull AWSConnectTagContactRequest *)request;

    Swift

    func tagContact(_ request: AWSConnectTagContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

    See

    AWSConnectTagContactRequest

    See

    AWSConnectTagContactResponse

    Declaration

    Objective-C

    - (void)tagContact:(nonnull AWSConnectTagContactRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectTagContactResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func tagContact(_ request: AWSConnectTagContactRequest) async throws -> AWSConnectTagContactResponse

    Parameters

    request

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

  • Adds the specified tags to the specified resource.

    Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.

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

    See

    AWSConnectTagResourceRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Adds the specified tags to the specified resource.

    Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.

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

    See

    AWSConnectTagResourceRequest

    Declaration

    Objective-C

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

    Swift

    func tagResource(_ request: AWSConnectTagResourceRequest) async throws

    Parameters

    request

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

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

  • Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

    Note the following requirements:

    • Transfer is supported for only TASK contacts.

    • Do not use both QueueId and UserId in the same call.

    • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

    • The TransferContact API can be called only on active contacts.

    • A contact cannot be transferred more than 11 times.

    See

    AWSConnectTransferContactRequest

    See

    AWSConnectTransferContactResponse

    Declaration

    Objective-C

    - (id)transferContact:(nonnull AWSConnectTransferContactRequest *)request;

    Swift

    func transferContact(_ request: AWSConnectTransferContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

    Note the following requirements:

    • Transfer is supported for only TASK contacts.

    • Do not use both QueueId and UserId in the same call.

    • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

    • The TransferContact API can be called only on active contacts.

    • A contact cannot be transferred more than 11 times.

    See

    AWSConnectTransferContactRequest

    See

    AWSConnectTransferContactResponse

    Declaration

    Objective-C

    - (void)transferContact:(nonnull AWSConnectTransferContactRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSConnectTransferContactResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func transferContact(_ request: AWSConnectTransferContactRequest) async throws -> AWSConnectTransferContactResponse

    Parameters

    request

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

  • Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

    See

    AWSConnectUntagContactRequest

    See

    AWSConnectUntagContactResponse

    Declaration

    Objective-C

    - (id)untagContact:(nonnull AWSConnectUntagContactRequest *)request;

    Swift

    func untagContact(_ request: AWSConnectUntagContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

    See

    AWSConnectUntagContactRequest

    See

    AWSConnectUntagContactResponse

    Declaration

    Objective-C

    - (void)untagContact:(nonnull AWSConnectUntagContactRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectUntagContactResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func untagContact(_ request: AWSConnectUntagContactRequest) async throws -> AWSConnectUntagContactResponse

    Parameters

    request

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

  • Removes the specified tags from the specified resource.

    See

    AWSConnectUntagResourceRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Removes the specified tags from the specified resource.

    See

    AWSConnectUntagResourceRequest

    Declaration

    Objective-C

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

    Swift

    func untagResource(_ request: AWSConnectUntagResourceRequest) async throws

    Parameters

    request

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

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

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

    Updates agent status.

    See

    AWSConnectUpdateAgentStatusRequest

    Declaration

    Objective-C

    - (id)updateAgentStatus:(nonnull AWSConnectUpdateAgentStatusRequest *)request;

    Swift

    func updateAgentStatus(_ request: AWSConnectUpdateAgentStatusRequest) -> Any!

    Parameters

    request

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

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

    Updates agent status.

    See

    AWSConnectUpdateAgentStatusRequest

    Declaration

    Objective-C

    - (void)updateAgentStatus:(nonnull AWSConnectUpdateAgentStatusRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateAgentStatus(_ request: AWSConnectUpdateAgentStatusRequest) async throws

    Parameters

    request

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

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

    Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

    You can add or update user-defined contact information for both ongoing and completed contacts.

    See

    AWSConnectUpdateContactRequest

    See

    AWSConnectUpdateContactResponse

    Declaration

    Objective-C

    - (id)updateContact:(nonnull AWSConnectUpdateContactRequest *)request;

    Swift

    func updateContact(_ request: AWSConnectUpdateContactRequest) -> Any!

    Parameters

    request

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

    Return Value

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

    Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

    You can add or update user-defined contact information for both ongoing and completed contacts.

    See

    AWSConnectUpdateContactRequest

    See

    AWSConnectUpdateContactResponse

    Declaration

    Objective-C

    - (void)updateContact:(nonnull AWSConnectUpdateContactRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectUpdateContactResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func updateContact(_ request: AWSConnectUpdateContactRequest) async throws -> AWSConnectUpdateContactResponse

    Parameters

    request

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

  • Creates or updates user-defined contact attributes associated with the specified contact.

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

    Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

    See

    AWSConnectUpdateContactAttributesRequest

    See

    AWSConnectUpdateContactAttributesResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Creates or updates user-defined contact attributes associated with the specified contact.

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

    Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

    See

    AWSConnectUpdateContactAttributesRequest

    See

    AWSConnectUpdateContactAttributesResponse

    Declaration

    Objective-C

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

    Swift

    func updateContactAttributes(_ request: AWSConnectUpdateContactAttributesRequest) async throws -> AWSConnectUpdateContactAttributesResponse

    Parameters

    request

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

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

  • Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

    See

    AWSConnectUpdateContactEvaluationRequest

    See

    AWSConnectUpdateContactEvaluationResponse

    Declaration

    Objective-C

    - (id)updateContactEvaluation:
    (nonnull AWSConnectUpdateContactEvaluationRequest *)request;

    Swift

    func updateContactEvaluation(_ request: AWSConnectUpdateContactEvaluationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

    See

    AWSConnectUpdateContactEvaluationRequest

    See

    AWSConnectUpdateContactEvaluationResponse

    Declaration

    Objective-C

    - (void)updateContactEvaluation:
            (nonnull AWSConnectUpdateContactEvaluationRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectUpdateContactEvaluationResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func updateContactEvaluation(_ request: AWSConnectUpdateContactEvaluationRequest) async throws -> AWSConnectUpdateContactEvaluationResponse

    Parameters

    request

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

  • Updates the specified flow.

    You can also create and update flows using the Amazon Connect Flow language.

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    See

    AWSConnectUpdateContactFlowContentRequest

    See

    AWSConnectUpdateContactFlowContentResponse

    Declaration

    Objective-C

    - (id)updateContactFlowContent:
    (nonnull AWSConnectUpdateContactFlowContentRequest *)request;

    Swift

    func updateContactFlowContent(_ request: AWSConnectUpdateContactFlowContentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the specified flow.

    You can also create and update flows using the Amazon Connect Flow language.

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    See

    AWSConnectUpdateContactFlowContentRequest

    See

    AWSConnectUpdateContactFlowContentResponse

    Declaration

    Objective-C

    - (void)updateContactFlowContent:
            (nonnull AWSConnectUpdateContactFlowContentRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSConnectUpdateContactFlowContentResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func updateContactFlowContent(_ request: AWSConnectUpdateContactFlowContentRequest) async throws -> AWSConnectUpdateContactFlowContentResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateContactFlowContent service method.
    completionHandler

    The completion handler to call when the load request is complete. 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, AWSConnectErrorResourceNotFound, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates metadata about specified flow.

    See

    AWSConnectUpdateContactFlowMetadataRequest

    See

    AWSConnectUpdateContactFlowMetadataResponse

    Declaration

    Objective-C

    - (id)updateContactFlowMetadata:
    (nonnull AWSConnectUpdateContactFlowMetadataRequest *)request;

    Swift

    func updateContactFlowMetadata(_ request: AWSConnectUpdateContactFlowMetadataRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates metadata about specified flow.

    See

    AWSConnectUpdateContactFlowMetadataRequest

    See

    AWSConnectUpdateContactFlowMetadataResponse

    Declaration

    Objective-C

    - (void)updateContactFlowMetadata:
            (nonnull AWSConnectUpdateContactFlowMetadataRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSConnectUpdateContactFlowMetadataResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func updateContactFlowMetadata(_ request: AWSConnectUpdateContactFlowMetadataRequest) async throws -> AWSConnectUpdateContactFlowMetadataResponse

    Parameters

    request

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

  • Updates specified flow module for the specified Amazon Connect instance.

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    See

    AWSConnectUpdateContactFlowModuleContentRequest

    See

    AWSConnectUpdateContactFlowModuleContentResponse

    Declaration

    Objective-C

    - (id)updateContactFlowModuleContent:
    (nonnull AWSConnectUpdateContactFlowModuleContentRequest *)request;

    Swift

    func updateContactFlowModuleContent(_ request: AWSConnectUpdateContactFlowModuleContentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates specified flow module for the specified Amazon Connect instance.

    Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

    See

    AWSConnectUpdateContactFlowModuleContentRequest

    See

    AWSConnectUpdateContactFlowModuleContentResponse

    Declaration

    Objective-C

    - (void)updateContactFlowModuleContent:
            (nonnull AWSConnectUpdateContactFlowModuleContentRequest *)request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSConnectUpdateContactFlowModuleContentResponse
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func updateContactFlowModuleContent(_ request: AWSConnectUpdateContactFlowModuleContentRequest) async throws -> AWSConnectUpdateContactFlowModuleContentResponse

    Parameters

    request

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

  • Updates metadata about specified flow module.

    See

    AWSConnectUpdateContactFlowModuleMetadataRequest

    See

    AWSConnectUpdateContactFlowModuleMetadataResponse

    Declaration

    Objective-C

    - (id)updateContactFlowModuleMetadata:
    (nonnull AWSConnectUpdateContactFlowModuleMetadataRequest *)request;

    Swift

    func updateContactFlowModuleMetadata(_ request: AWSConnectUpdateContactFlowModuleMetadataRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates metadata about specified flow module.

    See

    AWSConnectUpdateContactFlowModuleMetadataRequest

    See

    AWSConnectUpdateContactFlowModuleMetadataResponse

    Declaration

    Objective-C

    - (void)updateContactFlowModuleMetadata:
            (nonnull AWSConnectUpdateContactFlowModuleMetadataRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSConnectUpdateContactFlowModuleMetadataResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func updateContactFlowModuleMetadata(_ request: AWSConnectUpdateContactFlowModuleMetadataRequest) async throws -> AWSConnectUpdateContactFlowModuleMetadataResponse

    Parameters

    request

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

  • The name of the flow.

    You can also create and update flows using the Amazon Connect Flow language.

    See

    AWSConnectUpdateContactFlowNameRequest

    See

    AWSConnectUpdateContactFlowNameResponse

    Declaration

    Objective-C

    - (id)updateContactFlowName:
    (nonnull AWSConnectUpdateContactFlowNameRequest *)request;

    Swift

    func updateContactFlowName(_ request: AWSConnectUpdateContactFlowNameRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • The name of the flow.

    You can also create and update flows using the Amazon Connect Flow language.

    See

    AWSConnectUpdateContactFlowNameRequest

    See

    AWSConnectUpdateContactFlowNameResponse

    Declaration

    Objective-C

    - (void)updateContactFlowName:
            (nonnull AWSConnectUpdateContactFlowNameRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSConnectUpdateContactFlowNameResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func updateContactFlowName(_ request: AWSConnectUpdateContactFlowNameRequest) async throws -> AWSConnectUpdateContactFlowNameResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateContactFlowName service method.
    completionHandler

    The completion handler to call when the load request is complete. 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, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer’s position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.

    Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.

    See

    AWSConnectUpdateContactRoutingDataRequest

    See

    AWSConnectUpdateContactRoutingDataResponse

    Declaration

    Objective-C

    - (id)updateContactRoutingData:
    (nonnull AWSConnectUpdateContactRoutingDataRequest *)request;

    Swift

    func updateContactRoutingData(_ request: AWSConnectUpdateContactRoutingDataRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer’s position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.

    Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.

    See

    AWSConnectUpdateContactRoutingDataRequest

    See

    AWSConnectUpdateContactRoutingDataResponse

    Declaration

    Objective-C

    - (void)updateContactRoutingData:
            (nonnull AWSConnectUpdateContactRoutingDataRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSConnectUpdateContactRoutingDataResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func updateContactRoutingData(_ request: AWSConnectUpdateContactRoutingDataRequest) async throws -> AWSConnectUpdateContactRoutingDataResponse

    Parameters

    request

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

  • Updates the scheduled time of a task contact that is already scheduled.

    See

    AWSConnectUpdateContactScheduleRequest

    See

    AWSConnectUpdateContactScheduleResponse

    Declaration

    Objective-C

    - (id)updateContactSchedule:
    (nonnull AWSConnectUpdateContactScheduleRequest *)request;

    Swift

    func updateContactSchedule(_ request: AWSConnectUpdateContactScheduleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the scheduled time of a task contact that is already scheduled.

    See

    AWSConnectUpdateContactScheduleRequest

    See

    AWSConnectUpdateContactScheduleResponse

    Declaration

    Objective-C

    - (void)updateContactSchedule:
            (nonnull AWSConnectUpdateContactScheduleRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSConnectUpdateContactScheduleResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func updateContactSchedule(_ request: AWSConnectUpdateContactScheduleRequest) async throws -> AWSConnectUpdateContactScheduleResponse

    Parameters

    request

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

  • Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.

    This operation does not support partial updates. Instead it does a full update of evaluation form content.

    See

    AWSConnectUpdateEvaluationFormRequest

    See

    AWSConnectUpdateEvaluationFormResponse

    Declaration

    Objective-C

    - (id)updateEvaluationForm:
    (nonnull AWSConnectUpdateEvaluationFormRequest *)request;

    Swift

    func updateEvaluationForm(_ request: AWSConnectUpdateEvaluationFormRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.

    This operation does not support partial updates. Instead it does a full update of evaluation form content.

    See

    AWSConnectUpdateEvaluationFormRequest

    See

    AWSConnectUpdateEvaluationFormResponse

    Declaration

    Objective-C

    - (void)
    updateEvaluationForm:
        (nonnull AWSConnectUpdateEvaluationFormRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSConnectUpdateEvaluationFormResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func updateEvaluationForm(_ request: AWSConnectUpdateEvaluationFormRequest) async throws -> AWSConnectUpdateEvaluationFormResponse

    Parameters

    request

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

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

    Updates the hours of operation.

    See

    AWSConnectUpdateHoursOfOperationRequest

    Declaration

    Objective-C

    - (id)updateHoursOfOperation:
    (nonnull AWSConnectUpdateHoursOfOperationRequest *)request;

    Swift

    func updateHours(ofOperation request: AWSConnectUpdateHoursOfOperationRequest) -> Any!

    Parameters

    request

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

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

    Updates the hours of operation.

    See

    AWSConnectUpdateHoursOfOperationRequest

    Declaration

    Objective-C

    - (void)updateHoursOfOperation:
            (nonnull AWSConnectUpdateHoursOfOperationRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateHours(ofOperation request: AWSConnectUpdateHoursOfOperationRequest) async throws

    Parameters

    request

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

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

    Updates the value for the specified attribute type.

    See

    AWSConnectUpdateInstanceAttributeRequest

    Declaration

    Objective-C

    - (id)updateInstanceAttribute:
    (nonnull AWSConnectUpdateInstanceAttributeRequest *)request;

    Swift

    func updateInstanceAttribute(_ request: AWSConnectUpdateInstanceAttributeRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Updates the value for the specified attribute type.

    See

    AWSConnectUpdateInstanceAttributeRequest

    Declaration

    Objective-C

    - (void)updateInstanceAttribute:
            (nonnull AWSConnectUpdateInstanceAttributeRequest *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateInstanceAttribute(_ request: AWSConnectUpdateInstanceAttributeRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateInstanceAttribute service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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.

    Updates an existing configuration for a resource type. This API is idempotent.

    See

    AWSConnectUpdateInstanceStorageConfigRequest

    Declaration

    Objective-C

    - (id)updateInstanceStorageConfig:
    (nonnull AWSConnectUpdateInstanceStorageConfigRequest *)request;

    Swift

    func updateInstanceStorageConfig(_ request: AWSConnectUpdateInstanceStorageConfigRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Updates an existing configuration for a resource type. This API is idempotent.

    See

    AWSConnectUpdateInstanceStorageConfigRequest

    Declaration

    Objective-C

    - (void)updateInstanceStorageConfig:
            (nonnull AWSConnectUpdateInstanceStorageConfigRequest *)request
                  completionHandler:
                      (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateInstanceStorageConfig(_ request: AWSConnectUpdateInstanceStorageConfigRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateInstanceStorageConfig service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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.

  • Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

    • Customer idle timeout

    • Customer auto-disconnect timeout

    • Agent idle timeout

    • Agent auto-disconnect timeout

    For more information about how chat timeouts work, see Set up chat timeouts for human participants.

    See

    AWSConnectUpdateParticipantRoleConfigRequest

    See

    AWSConnectUpdateParticipantRoleConfigResponse

    Declaration

    Objective-C

    - (id)updateParticipantRoleConfig:
    (nonnull AWSConnectUpdateParticipantRoleConfigRequest *)request;

    Swift

    func updateParticipantRoleConfig(_ request: AWSConnectUpdateParticipantRoleConfigRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

    • Customer idle timeout

    • Customer auto-disconnect timeout

    • Agent idle timeout

    • Agent auto-disconnect timeout

    For more information about how chat timeouts work, see Set up chat timeouts for human participants.

    See

    AWSConnectUpdateParticipantRoleConfigRequest

    See

    AWSConnectUpdateParticipantRoleConfigResponse

    Declaration

    Objective-C

    - (void)
    updateParticipantRoleConfig:
        (nonnull AWSConnectUpdateParticipantRoleConfigRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSConnectUpdateParticipantRoleConfigResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func updateParticipantRoleConfig(_ request: AWSConnectUpdateParticipantRoleConfigRequest) async throws -> AWSConnectUpdateParticipantRoleConfigResponse

    Parameters

    request

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

  • Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

    After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn’t migrate the flow configuration of the phone number, too.

    You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

    See

    AWSConnectUpdatePhoneNumberRequest

    See

    AWSConnectUpdatePhoneNumberResponse

    Declaration

    Objective-C

    - (id)updatePhoneNumber:(nonnull AWSConnectUpdatePhoneNumberRequest *)request;

    Swift

    func updatePhoneNumber(_ request: AWSConnectUpdatePhoneNumberRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

    After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn’t migrate the flow configuration of the phone number, too.

    You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

    See

    AWSConnectUpdatePhoneNumberRequest

    See

    AWSConnectUpdatePhoneNumberResponse

    Declaration

    Objective-C

    - (void)updatePhoneNumber:(nonnull AWSConnectUpdatePhoneNumberRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectUpdatePhoneNumberResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func updatePhoneNumber(_ request: AWSConnectUpdatePhoneNumberRequest) async throws -> AWSConnectUpdatePhoneNumberResponse

    Parameters

    request

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

  • Updates a phone number’s metadata.

    To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

    See

    AWSConnectUpdatePhoneNumberMetadataRequest

    Declaration

    Objective-C

    - (id)updatePhoneNumberMetadata:
    (nonnull AWSConnectUpdatePhoneNumberMetadataRequest *)request;

    Swift

    func updatePhoneNumberMetadata(_ request: AWSConnectUpdatePhoneNumberMetadataRequest) -> Any!

    Parameters

    request

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

  • Updates a phone number’s metadata.

    To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

    See

    AWSConnectUpdatePhoneNumberMetadataRequest

    Declaration

    Objective-C

    - (void)updatePhoneNumberMetadata:
            (nonnull AWSConnectUpdatePhoneNumberMetadataRequest *)request
                completionHandler:
                    (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updatePhoneNumberMetadata(_ request: AWSConnectUpdatePhoneNumberMetadataRequest) async throws

    Parameters

    request

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

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

    See

    AWSConnectUpdatePredefinedAttributeRequest

    Declaration

    Objective-C

    - (id)updatePredefinedAttribute:
    (nonnull AWSConnectUpdatePredefinedAttributeRequest *)request;

    Swift

    func updatePredefinedAttribute(_ request: AWSConnectUpdatePredefinedAttributeRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSConnectUpdatePredefinedAttributeRequest

    Declaration

    Objective-C

    - (void)updatePredefinedAttribute:
            (nonnull AWSConnectUpdatePredefinedAttributeRequest *)request
                completionHandler:
                    (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updatePredefinedAttribute(_ request: AWSConnectUpdatePredefinedAttributeRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdatePredefinedAttribute service method.
    completionHandler

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

  • Updates a prompt.

    See

    AWSConnectUpdatePromptRequest

    See

    AWSConnectUpdatePromptResponse

    Declaration

    Objective-C

    - (id)updatePrompt:(nonnull AWSConnectUpdatePromptRequest *)request;

    Swift

    func updatePrompt(_ request: AWSConnectUpdatePromptRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a prompt.

    See

    AWSConnectUpdatePromptRequest

    See

    AWSConnectUpdatePromptResponse

    Declaration

    Objective-C

    - (void)updatePrompt:(nonnull AWSConnectUpdatePromptRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSConnectUpdatePromptResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func updatePrompt(_ request: AWSConnectUpdatePromptRequest) async throws -> AWSConnectUpdatePromptResponse

    Parameters

    request

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

    Updates the hours of operation for the specified queue.

    See

    AWSConnectUpdateQueueHoursOfOperationRequest

    Declaration

    Objective-C

    - (id)updateQueueHoursOfOperation:
    (nonnull AWSConnectUpdateQueueHoursOfOperationRequest *)request;

    Swift

    func updateQueueHours(ofOperation request: AWSConnectUpdateQueueHoursOfOperationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

    Updates the hours of operation for the specified queue.

    See

    AWSConnectUpdateQueueHoursOfOperationRequest

    Declaration

    Objective-C

    - (void)updateQueueHoursOfOperation:
            (nonnull AWSConnectUpdateQueueHoursOfOperationRequest *)request
                  completionHandler:
                      (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateQueueHours(ofOperation request: AWSConnectUpdateQueueHoursOfOperationRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateQueueHoursOfOperation service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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.

    Updates the maximum number of contacts allowed in a queue before it is considered full.

    See

    AWSConnectUpdateQueueMaxContactsRequest

    Declaration

    Objective-C

    - (id)updateQueueMaxContacts:
    (nonnull AWSConnectUpdateQueueMaxContactsRequest *)request;

    Swift

    func updateQueueMaxContacts(_ request: AWSConnectUpdateQueueMaxContactsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

    Updates the maximum number of contacts allowed in a queue before it is considered full.

    See

    AWSConnectUpdateQueueMaxContactsRequest

    Declaration

    Objective-C

    - (void)updateQueueMaxContacts:
            (nonnull AWSConnectUpdateQueueMaxContactsRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateQueueMaxContacts(_ request: AWSConnectUpdateQueueMaxContactsRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateQueueMaxContacts service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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.

    Updates the name and description of a queue. At least Name or Description must be provided.

    See

    AWSConnectUpdateQueueNameRequest

    Declaration

    Objective-C

    - (id)updateQueueName:(nonnull AWSConnectUpdateQueueNameRequest *)request;

    Swift

    func updateQueueName(_ request: AWSConnectUpdateQueueNameRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Updates the name and description of a queue. At least Name or Description must be provided.

    See

    AWSConnectUpdateQueueNameRequest

    Declaration

    Objective-C

    - (void)updateQueueName:(nonnull AWSConnectUpdateQueueNameRequest *)request
      completionHandler:
          (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateQueueName(_ request: AWSConnectUpdateQueueNameRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateQueueName service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

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

    Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

    • 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

    AWSConnectUpdateQueueOutboundCallerConfigRequest

    Declaration

    Objective-C

    - (id)updateQueueOutboundCallerConfig:
    (nonnull AWSConnectUpdateQueueOutboundCallerConfigRequest *)request;

    Swift

    func updateQueueOutboundCallerConfig(_ request: AWSConnectUpdateQueueOutboundCallerConfigRequest) -> Any!

    Parameters

    request

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

    Return Value

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

    Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

    • 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

    AWSConnectUpdateQueueOutboundCallerConfigRequest

    Declaration

    Objective-C

    - (void)updateQueueOutboundCallerConfig:
            (nonnull AWSConnectUpdateQueueOutboundCallerConfigRequest *)request
                      completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                            completionHandler;

    Swift

    func updateQueueOutboundCallerConfig(_ request: AWSConnectUpdateQueueOutboundCallerConfigRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateQueueOutboundCallerConfig service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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.

    Updates the status of the queue.

    See

    AWSConnectUpdateQueueStatusRequest

    Declaration

    Objective-C

    - (id)updateQueueStatus:(nonnull AWSConnectUpdateQueueStatusRequest *)request;

    Swift

    func updateQueueStatus(_ request: AWSConnectUpdateQueueStatusRequest) -> Any!

    Parameters

    request

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

    Return Value

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

    Updates the status of the queue.

    See

    AWSConnectUpdateQueueStatusRequest

    Declaration

    Objective-C

    - (void)updateQueueStatus:(nonnull AWSConnectUpdateQueueStatusRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateQueueStatus(_ request: AWSConnectUpdateQueueStatusRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateQueueStatus service method.
    completionHandler

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

  • Updates the configuration settings for the specified quick connect.

    See

    AWSConnectUpdateQuickConnectConfigRequest

    Declaration

    Objective-C

    - (id)updateQuickConnectConfig:
    (nonnull AWSConnectUpdateQuickConnectConfigRequest *)request;

    Swift

    func updateQuickConnectConfig(_ request: AWSConnectUpdateQuickConnectConfigRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the configuration settings for the specified quick connect.

    See

    AWSConnectUpdateQuickConnectConfigRequest

    Declaration

    Objective-C

    - (void)updateQuickConnectConfig:
            (nonnull AWSConnectUpdateQuickConnectConfigRequest *)request
               completionHandler:
                   (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateQuickConnectConfig(_ request: AWSConnectUpdateQuickConnectConfigRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateQuickConnectConfig service method.
    completionHandler

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

  • Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

    See

    AWSConnectUpdateQuickConnectNameRequest

    Declaration

    Objective-C

    - (id)updateQuickConnectName:
    (nonnull AWSConnectUpdateQuickConnectNameRequest *)request;

    Swift

    func updateQuickConnectName(_ request: AWSConnectUpdateQuickConnectNameRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

    See

    AWSConnectUpdateQuickConnectNameRequest

    Declaration

    Objective-C

    - (void)updateQuickConnectName:
            (nonnull AWSConnectUpdateQuickConnectNameRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateQuickConnectName(_ request: AWSConnectUpdateQuickConnectNameRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateQuickConnectName service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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.

  • Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

    See

    AWSConnectUpdateRoutingProfileAgentAvailabilityTimerRequest

    Declaration

    Objective-C

    - (id)updateRoutingProfileAgentAvailabilityTimer:
    (nonnull AWSConnectUpdateRoutingProfileAgentAvailabilityTimerRequest *)
        request;

    Swift

    func updateRoutingProfileAgentAvailabilityTimer(_ request: AWSConnectUpdateRoutingProfileAgentAvailabilityTimerRequest) -> Any!

    Parameters

    request

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

  • Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

    See

    AWSConnectUpdateRoutingProfileAgentAvailabilityTimerRequest

    Declaration

    Objective-C

    - (void)
    updateRoutingProfileAgentAvailabilityTimer:
        (nonnull AWSConnectUpdateRoutingProfileAgentAvailabilityTimerRequest *)
            request
                             completionHandler:
                                 (void (^_Nullable)(NSError *_Nullable))
                                     completionHandler;

    Swift

    func updateRoutingProfileAgentAvailabilityTimer(_ request: AWSConnectUpdateRoutingProfileAgentAvailabilityTimerRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateRoutingProfileAgentAvailabilityTimer service method.
    completionHandler

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

  • Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

    See

    AWSConnectUpdateRoutingProfileConcurrencyRequest

    Declaration

    Objective-C

    - (id)updateRoutingProfileConcurrency:
    (nonnull AWSConnectUpdateRoutingProfileConcurrencyRequest *)request;

    Swift

    func updateRoutingProfileConcurrency(_ request: AWSConnectUpdateRoutingProfileConcurrencyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

    See

    AWSConnectUpdateRoutingProfileConcurrencyRequest

    Declaration

    Objective-C

    - (void)updateRoutingProfileConcurrency:
            (nonnull AWSConnectUpdateRoutingProfileConcurrencyRequest *)request
                      completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                            completionHandler;

    Swift

    func updateRoutingProfileConcurrency(_ request: AWSConnectUpdateRoutingProfileConcurrencyRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateRoutingProfileConcurrency service method.
    completionHandler

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

  • Updates the default outbound queue of a routing profile.

    See

    AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest

    Declaration

    Objective-C

    - (id)updateRoutingProfileDefaultOutboundQueue:
    (nonnull AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest *)
        request;

    Swift

    func updateRoutingProfileDefaultOutboundQueue(_ request: AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the default outbound queue of a routing profile.

    See

    AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest

    Declaration

    Objective-C

    - (void)
    updateRoutingProfileDefaultOutboundQueue:
        (nonnull AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest *)
            request
                           completionHandler:
                               (void (^_Nullable)(NSError *_Nullable))
                                   completionHandler;

    Swift

    func updateRoutingProfileDefaultOutboundQueue(_ request: AWSConnectUpdateRoutingProfileDefaultOutboundQueueRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateRoutingProfileDefaultOutboundQueue service method.
    completionHandler

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

  • Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

    See

    AWSConnectUpdateRoutingProfileNameRequest

    Declaration

    Objective-C

    - (id)updateRoutingProfileName:
    (nonnull AWSConnectUpdateRoutingProfileNameRequest *)request;

    Swift

    func updateRoutingProfileName(_ request: AWSConnectUpdateRoutingProfileNameRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

    See

    AWSConnectUpdateRoutingProfileNameRequest

    Declaration

    Objective-C

    - (void)updateRoutingProfileName:
            (nonnull AWSConnectUpdateRoutingProfileNameRequest *)request
               completionHandler:
                   (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateRoutingProfileName(_ request: AWSConnectUpdateRoutingProfileNameRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateRoutingProfileName service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates the properties associated with a set of queues for a routing profile.

    See

    AWSConnectUpdateRoutingProfileQueuesRequest

    Declaration

    Objective-C

    - (id)updateRoutingProfileQueues:
    (nonnull AWSConnectUpdateRoutingProfileQueuesRequest *)request;

    Swift

    func updateRoutingProfileQueues(_ request: AWSConnectUpdateRoutingProfileQueuesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the properties associated with a set of queues for a routing profile.

    See

    AWSConnectUpdateRoutingProfileQueuesRequest

    Declaration

    Objective-C

    - (void)updateRoutingProfileQueues:
            (nonnull AWSConnectUpdateRoutingProfileQueuesRequest *)request
                 completionHandler:
                     (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateRoutingProfileQueues(_ request: AWSConnectUpdateRoutingProfileQueuesRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateRoutingProfileQueues service method.
    completionHandler

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

  • Updates a rule for the specified Amazon Connect instance.

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

    See

    AWSConnectUpdateRuleRequest

    Declaration

    Objective-C

    - (id)updateRule:(nonnull AWSConnectUpdateRuleRequest *)request;

    Swift

    func updateRule(_ request: AWSConnectUpdateRuleRequest) -> Any!

    Parameters

    request

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

  • Updates a rule for the specified Amazon Connect instance.

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

    See

    AWSConnectUpdateRuleRequest

    Declaration

    Objective-C

    - (void)updateRule:(nonnull AWSConnectUpdateRuleRequest *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateRule(_ request: AWSConnectUpdateRuleRequest) async throws

    Parameters

    request

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

  • Updates a security profile.

    See

    AWSConnectUpdateSecurityProfileRequest

    Declaration

    Objective-C

    - (id)updateSecurityProfile:
    (nonnull AWSConnectUpdateSecurityProfileRequest *)request;

    Swift

    func updateSecurityProfile(_ request: AWSConnectUpdateSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a security profile.

    See

    AWSConnectUpdateSecurityProfileRequest

    Declaration

    Objective-C

    - (void)updateSecurityProfile:
            (nonnull AWSConnectUpdateSecurityProfileRequest *)request
            completionHandler:
                (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateSecurityProfile(_ request: AWSConnectUpdateSecurityProfileRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateSecurityProfile service method.
    completionHandler

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

  • Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

    See

    AWSConnectUpdateTaskTemplateRequest

    See

    AWSConnectUpdateTaskTemplateResponse

    Declaration

    Objective-C

    - (id)updateTaskTemplate:(nonnull AWSConnectUpdateTaskTemplateRequest *)request;

    Swift

    func updateTaskTemplate(_ request: AWSConnectUpdateTaskTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

    See

    AWSConnectUpdateTaskTemplateRequest

    See

    AWSConnectUpdateTaskTemplateResponse

    Declaration

    Objective-C

    - (void)updateTaskTemplate:
            (nonnull AWSConnectUpdateTaskTemplateRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectUpdateTaskTemplateResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateTaskTemplate(_ request: AWSConnectUpdateTaskTemplateRequest) async throws -> AWSConnectUpdateTaskTemplateResponse

    Parameters

    request

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

  • Updates the traffic distribution for a given traffic distribution group.

    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 updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

    See

    AWSConnectUpdateTrafficDistributionRequest

    See

    AWSConnectUpdateTrafficDistributionResponse

    Declaration

    Objective-C

    - (id)updateTrafficDistribution:
    (nonnull AWSConnectUpdateTrafficDistributionRequest *)request;

    Swift

    func updateTrafficDistribution(_ request: AWSConnectUpdateTrafficDistributionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the traffic distribution for a given traffic distribution group.

    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 updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

    See

    AWSConnectUpdateTrafficDistributionRequest

    See

    AWSConnectUpdateTrafficDistributionResponse

    Declaration

    Objective-C

    - (void)updateTrafficDistribution:
            (nonnull AWSConnectUpdateTrafficDistributionRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSConnectUpdateTrafficDistributionResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func updateTrafficDistribution(_ request: AWSConnectUpdateTrafficDistributionRequest) async throws -> AWSConnectUpdateTrafficDistributionResponse

    Parameters

    request

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

  • Assigns the specified hierarchy group to the specified user.

    See

    AWSConnectUpdateUserHierarchyRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Assigns the specified hierarchy group to the specified user.

    See

    AWSConnectUpdateUserHierarchyRequest

    Declaration

    Objective-C

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

    Swift

    func updateUserHierarchy(_ request: AWSConnectUpdateUserHierarchyRequest) async throws

    Parameters

    request

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

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

  • Updates the name of the user hierarchy group.

    See

    AWSConnectUpdateUserHierarchyGroupNameRequest

    Declaration

    Objective-C

    - (id)updateUserHierarchyGroupName:
    (nonnull AWSConnectUpdateUserHierarchyGroupNameRequest *)request;

    Swift

    func updateUserHierarchyGroupName(_ request: AWSConnectUpdateUserHierarchyGroupNameRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the name of the user hierarchy group.

    See

    AWSConnectUpdateUserHierarchyGroupNameRequest

    Declaration

    Objective-C

    - (void)updateUserHierarchyGroupName:
            (nonnull AWSConnectUpdateUserHierarchyGroupNameRequest *)request
                   completionHandler:
                       (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserHierarchyGroupName(_ request: AWSConnectUpdateUserHierarchyGroupNameRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserHierarchyGroupName service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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, AWSConnectErrorThrottling, AWSConnectErrorInternalService.

  • Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

    See

    AWSConnectUpdateUserHierarchyStructureRequest

    Declaration

    Objective-C

    - (id)updateUserHierarchyStructure:
    (nonnull AWSConnectUpdateUserHierarchyStructureRequest *)request;

    Swift

    func updateUserHierarchyStructure(_ request: AWSConnectUpdateUserHierarchyStructureRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

    See

    AWSConnectUpdateUserHierarchyStructureRequest

    Declaration

    Objective-C

    - (void)updateUserHierarchyStructure:
            (nonnull AWSConnectUpdateUserHierarchyStructureRequest *)request
                   completionHandler:
                       (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserHierarchyStructure(_ request: AWSConnectUpdateUserHierarchyStructureRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserHierarchyStructure service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, 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.

  • Updates the identity information for the specified user.

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

    See

    AWSConnectUpdateUserIdentityInfoRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Updates the identity information for the specified user.

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

    See

    AWSConnectUpdateUserIdentityInfoRequest

    Declaration

    Objective-C

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

    Swift

    func updateUserIdentityInfo(_ request: AWSConnectUpdateUserIdentityInfoRequest) async throws

    Parameters

    request

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

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

  • Updates the phone configuration settings for the specified user.

    See

    AWSConnectUpdateUserPhoneConfigRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Updates the phone configuration settings for the specified user.

    See

    AWSConnectUpdateUserPhoneConfigRequest

    Declaration

    Objective-C

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

    Swift

    func updateUserPhoneConfig(_ request: AWSConnectUpdateUserPhoneConfigRequest) async throws

    Parameters

    request

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

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

  • Updates the properties associated with the proficiencies of a user.

    See

    AWSConnectUpdateUserProficienciesRequest

    Declaration

    Objective-C

    - (id)updateUserProficiencies:
    (nonnull AWSConnectUpdateUserProficienciesRequest *)request;

    Swift

    func updateUserProficiencies(_ request: AWSConnectUpdateUserProficienciesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the properties associated with the proficiencies of a user.

    See

    AWSConnectUpdateUserProficienciesRequest

    Declaration

    Objective-C

    - (void)updateUserProficiencies:
            (nonnull AWSConnectUpdateUserProficienciesRequest *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateUserProficiencies(_ request: AWSConnectUpdateUserProficienciesRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UpdateUserProficiencies service method.
    completionHandler

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

  • Assigns the specified routing profile to the specified user.

    See

    AWSConnectUpdateUserRoutingProfileRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Assigns the specified routing profile to the specified user.

    See

    AWSConnectUpdateUserRoutingProfileRequest

    Declaration

    Objective-C

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

    Swift

    func updateUserRoutingProfile(_ request: AWSConnectUpdateUserRoutingProfileRequest) async throws

    Parameters

    request

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

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

  • Assigns the specified security profiles to the specified user.

    See

    AWSConnectUpdateUserSecurityProfilesRequest

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Assigns the specified security profiles to the specified user.

    See

    AWSConnectUpdateUserSecurityProfilesRequest

    Declaration

    Objective-C

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

    Swift

    func updateUserSecurityProfiles(_ request: AWSConnectUpdateUserSecurityProfilesRequest) async throws

    Parameters

    request

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

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

  • Updates the view content of the given view identifier in the specified Amazon Connect instance.

    It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias’ content will always be updated, but the $LATEST alias’ content will only be updated if Status is PUBLISHED.

    See

    AWSConnectUpdateViewContentRequest

    See

    AWSConnectUpdateViewContentResponse

    Declaration

    Objective-C

    - (id)updateViewContent:(nonnull AWSConnectUpdateViewContentRequest *)request;

    Swift

    func updateViewContent(_ request: AWSConnectUpdateViewContentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the view content of the given view identifier in the specified Amazon Connect instance.

    It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias’ content will always be updated, but the $LATEST alias’ content will only be updated if Status is PUBLISHED.

    See

    AWSConnectUpdateViewContentRequest

    See

    AWSConnectUpdateViewContentResponse

    Declaration

    Objective-C

    - (void)updateViewContent:(nonnull AWSConnectUpdateViewContentRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSConnectUpdateViewContentResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func updateViewContent(_ request: AWSConnectUpdateViewContentRequest) async throws -> AWSConnectUpdateViewContentResponse

    Parameters

    request

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

  • Updates the view metadata. Note that either Name or Description must be provided.

    See

    AWSConnectUpdateViewMetadataRequest

    See

    AWSConnectUpdateViewMetadataResponse

    Declaration

    Objective-C

    - (id)updateViewMetadata:(nonnull AWSConnectUpdateViewMetadataRequest *)request;

    Swift

    func updateViewMetadata(_ request: AWSConnectUpdateViewMetadataRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the view metadata. Note that either Name or Description must be provided.

    See

    AWSConnectUpdateViewMetadataRequest

    See

    AWSConnectUpdateViewMetadataResponse

    Declaration

    Objective-C

    - (void)updateViewMetadata:
            (nonnull AWSConnectUpdateViewMetadataRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSConnectUpdateViewMetadataResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateViewMetadata(_ request: AWSConnectUpdateViewMetadataRequest) async throws -> AWSConnectUpdateViewMetadataResponse

    Parameters

    request

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