Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]



This API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--instance-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--instance-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.


Instance -> (structure)

The name of the instance.

Id -> (string)

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

Arn -> (string)

The Amazon Resource Name (ARN) of the instance.

IdentityManagementType -> (string)

The identity management type.

InstanceAlias -> (string)

The alias of instance.

CreatedTime -> (timestamp)

When the instance was created.

ServiceRole -> (string)

The service role of the instance.

InstanceStatus -> (string)

The state of the instance.

StatusReason -> (structure)

Relevant details why the instance was not successfully created.

Message -> (string)

The message.

InboundCallsEnabled -> (boolean)

Whether inbound calls are enabled.

OutboundCallsEnabled -> (boolean)

Whether outbound calls are enabled.