[ aws . connectcampaigns ]

start-instance-onboarding-job

Description

Onboard the specific Amazon Connect instance to Connect Campaigns.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-instance-onboarding-job
--connect-instance-id <value>
--encryption-config <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--connect-instance-id (string)

Amazon Connect Instance Id

--encryption-config (structure)

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 -> (string)

Server-side encryption type.

keyArn -> (string)

KMS key id/arn for encryption config.

Shorthand Syntax:

enabled=boolean,encryptionType=string,keyArn=string

JSON Syntax:

{
  "enabled": true|false,
  "encryptionType": "KMS",
  "keyArn": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

connectInstanceOnboardingJobStatus -> (structure)

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