Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeInstance

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.

Request Syntax


GET /instance/InstanceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Instance": { 
      "Arn": "string",
      "CreatedTime": number,
      "Id": "string",
      "IdentityManagementType": "string",
      "InboundCallsEnabled": boolean,
      "InstanceAccessUrl": "string",
      "InstanceAlias": "string",
      "InstanceStatus": "string",
      "OutboundCallsEnabled": boolean,
      "ServiceRole": "string",
      "StatusReason": { 
         "Message": "string"
      },
      "Tags": { 
         "string" : "string" 
      }
   },
   "ReplicationConfiguration": { 
      "GlobalSignInEndpoint": "string",
      "ReplicationStatusSummaryList": [ 
         { 
            "Region": "string",
            "ReplicationStatus": "string",
            "ReplicationStatusReason": "string"
         }
      ],
      "SourceRegion": "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.

Instance

The name of the instance.

Type: Instance object

ReplicationConfiguration

Status information about the replication process. This field is included only when you are using the ReplicateInstance API to replicate an Amazon Connect instance across AWS Regions. For information about replicating Amazon Connect instances, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

Type: ReplicationConfiguration object

Errors

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

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404