---
title: "PUT /v2/connect-instance/{connectInstanceId}/onboarding"
method: PUT
path: "/v2/connect-instance/{connectInstanceId}/onboarding"
---

# PUT /v2/connect-instance/{connectInstanceId}/onboarding

`PUT /v2/connect-instance/{connectInstanceId}/onboarding`

Onboard the specific Amazon Connect instance to Connect Campaigns.

## Path parameters

- `connectInstanceId` string, required — Amazon Connect Instance Id

## Request body

- object
  - `encryptionConfig` object, 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 — Boolean to indicate if custom encryption has been enabled.
    - `encryptionType` 'KMS' — Server-side encryption type.
    - `keyArn` string — KMS key id/arn for encryption config.

## Response `200`

Success

- StartInstanceOnboardingJobResponse — The response for StartInstanceOnboardingJob API.
  - `connectInstanceOnboardingJobStatus` InstanceOnboardingJobStatus — Instance onboarding job status object
    - `connectInstanceId` string, required — Amazon Connect Instance Id
    - `status` 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED', required — Enumeration of the possible states for instance onboarding job
    - `failureCode` 'EVENT_BRIDGE_ACCESS_DENIED' | 'EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED' | 'IAM_ACCESS_DENIED' | 'KMS_ACCESS_DENIED' | 'KMS_KEY_NOT_FOUND' | 'INTERNAL_FAILURE' — Enumeration of the possible failure codes for instance onboarding job

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ValidationException
- `483` — ConflictException
- `484` — AccessDeniedException
- `485` — ThrottlingException

---

[API](https://skmtc.net/aws/apis/connectcampaignsv2.md) · [All operations](https://skmtc.net/aws/apis/connectcampaignsv2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/connectcampaignsv2/versions/d9204d79443e/schema)