StartInstanceOnboardingJob - Amazon Connect


Starts the workflow to onboard an Amazon Connect instance to outbound campaigns.

Request Syntax

PUT /connect-instance/connectInstanceId/onboarding HTTP/1.1 Content-type: application/json { "encryptionConfig": { "enabled": boolean, "encryptionType": "string", "keyArn": "string" } }

URI Request Parameters

The request uses the following URI parameters.


The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^[a-zA-Z0-9_\-.]*$

Required: Yes

Request Body

The request accepts the following data in JSON format.


Encryption configuration for an Amazon Connect instance.

Type: EncryptionConfig object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "connectInstanceOnboardingJobStatus": { "connectInstanceId": "string", "failureCode": "string", "status": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The status of the onboarding workflow.

Type: InstanceOnboardingJobStatus object


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 403


The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409


This exception occurs when there is an internal failure in the outbound campaigns.

HTTP Status Code: 500


The specified resource does not exist.

HTTP Status Code: 404


The request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the constraints specified by an AWSservice.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: