ConnectCampaignServiceV2 / Client / start_instance_onboarding_job

start_instance_onboarding_job

ConnectCampaignServiceV2.Client.start_instance_onboarding_job(**kwargs)

Onboard the specific Amazon Connect instance to Connect Campaigns.

See also: AWS API Documentation

Request Syntax

response = client.start_instance_onboarding_job(
    connectInstanceId='string',
    encryptionConfig={
        'enabled': True|False,
        'encryptionType': 'KMS',
        'keyArn': 'string'
    }
)

Parameters:

• connectInstanceId (string) –

  [REQUIRED]

  Amazon Connect Instance Id

• encryptionConfig (dict) –

  [REQUIRED]

  Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported

  • enabled (boolean) – [REQUIRED]

    Boolean to indicate if custom encryption has been enabled.

  • encryptionType (string) –

    Server-side encryption type.

  • keyArn (string) –

    KMS key id/arn for encryption config.

Return type:

dict

Returns:

Response Syntax

{
    'connectInstanceOnboardingJobStatus': {
        'connectInstanceId': 'string',
        'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'failureCode': 'EVENT_BRIDGE_ACCESS_DENIED'|'EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED'|'IAM_ACCESS_DENIED'|'KMS_ACCESS_DENIED'|'KMS_KEY_NOT_FOUND'|'INTERNAL_FAILURE'
    }
}

Response Structure

• (dict) –

  The response for StartInstanceOnboardingJob API.

  • connectInstanceOnboardingJobStatus (dict) –

    Instance onboarding job status object

    • connectInstanceId (string) –

      Amazon Connect Instance Id

    • status (string) –

      Enumeration of the possible states for instance onboarding job

    • failureCode (string) –

      Enumeration of the possible failure codes for instance onboarding job

Exceptions

• ConnectCampaignServiceV2.Client.exceptions.InternalServerException

• ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundException

• ConnectCampaignServiceV2.Client.exceptions.ValidationException

• ConnectCampaignServiceV2.Client.exceptions.ConflictException

• ConnectCampaignServiceV2.Client.exceptions.AccessDeniedException

• ConnectCampaignServiceV2.Client.exceptions.ThrottlingException