選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料,以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用,但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意,AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定,並顯示相關內容,包括相關廣告。若要接受或拒絕所有非必要 Cookie,請按一下「接受」或「拒絕」。若要進行更詳細的選擇,請按一下「自訂」。

DescribeInstance - Amazon Connect
此頁面尚未翻譯為您的語言。 請求翻譯

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。