DescribeInstanceCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, DescribeInstanceCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribeInstanceCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribeInstanceRequest
  InstanceId: "STRING_VALUE", // required
};
const command = new DescribeInstanceCommand(input);
const response = await client.send(command);
// { // DescribeInstanceResponse
//   Instance: { // Instance
//     Id: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     IdentityManagementType: "SAML" || "CONNECT_MANAGED" || "EXISTING_DIRECTORY",
//     InstanceAlias: "STRING_VALUE",
//     CreatedTime: new Date("TIMESTAMP"),
//     ServiceRole: "STRING_VALUE",
//     InstanceStatus: "CREATION_IN_PROGRESS" || "ACTIVE" || "CREATION_FAILED",
//     StatusReason: { // InstanceStatusReason
//       Message: "STRING_VALUE",
//     },
//     InboundCallsEnabled: true || false,
//     OutboundCallsEnabled: true || false,
//     InstanceAccessUrl: "STRING_VALUE",
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//   },
//   ReplicationConfiguration: { // ReplicationConfiguration
//     ReplicationStatusSummaryList: [ // ReplicationStatusSummaryList
//       { // ReplicationStatusSummary
//         Region: "STRING_VALUE",
//         ReplicationStatus: "INSTANCE_REPLICATION_COMPLETE" || "INSTANCE_REPLICATION_IN_PROGRESS" || "INSTANCE_REPLICATION_FAILED" || "INSTANCE_REPLICA_DELETING" || "INSTANCE_REPLICATION_DELETION_FAILED" || "RESOURCE_REPLICATION_NOT_STARTED",
//         ReplicationStatusReason: "STRING_VALUE",
//       },
//     ],
//     SourceRegion: "STRING_VALUE",
//     GlobalSignInEndpoint: "STRING_VALUE",
//   },
// };

DescribeInstanceCommand Input

See DescribeInstanceCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

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

DescribeInstanceCommand Output

See DescribeInstanceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Instance
Instance | undefined

The name of the instance.

ReplicationConfiguration
ReplicationConfiguration | undefined

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 Amazon Web Services Regions. For information about replicating Amazon Connect instances, see Create a replica of your existing Amazon Connect instance  in the Amazon Connect Administrator Guide.

Throws

Name
Fault
Details
InternalServiceException
server

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

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ConnectServiceException
Base exception class for all service exceptions from Connect service.