get_instance_onboarding_job_status

ConnectCampaignService.Client.get_instance_onboarding_job_status(**kwargs)

Get the specific instance onboarding job status.

See also: AWS API Documentation

Request Syntax

response = client.get_instance_onboarding_job_status(
    connectInstanceId='string'
)

Parameters

connectInstanceId (string) --

[REQUIRED]

Amazon Connect Instance Id

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  GetInstanceOnboardingJobStatusResponse

  • connectInstanceOnboardingJobStatus (dict) --

    Instance onboarding job status object

    • connectInstanceId (string) --

      Amazon Connect Instance Id

    • failureCode (string) --

      Enumeration of the possible failure codes for instance onboarding job

    • status (string) --

      Enumeration of the possible states for instance onboarding job

Exceptions

• ConnectCampaignService.Client.exceptions.InternalServerException
• ConnectCampaignService.Client.exceptions.ResourceNotFoundException
• ConnectCampaignService.Client.exceptions.ValidationException
• ConnectCampaignService.Client.exceptions.AccessDeniedException