Onboard the specific Amazon Connect instance to Connect Campaigns¶

Description¶

Onboard the specific Amazon Connect instance to Connect Campaigns.

Usage¶

connectcampaignservice_start_instance_onboarding_job(connectInstanceId,
  encryptionConfig)

Arguments¶

connectInstanceId

[required] Amazon Connect Instance Id
encryptionConfig

[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

Value¶

A list with the following syntax:

list(
  connectInstanceOnboardingJobStatus = list(
    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"
  )
)

Request syntax¶

svc$start_instance_onboarding_job(
  connectInstanceId = "string",
  encryptionConfig = list(
    enabled = TRUE|FALSE,
    encryptionType = "KMS",
    keyArn = "string"
  )
)