Amazon Connect · Example Payload

Amazon Connect Describeinstance Example

ChatContact CenterCustomer ServiceVoiceAIOmnichannel

Amazon Connect Describeinstance Example is an example object payload from Amazon Connect, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "describeInstance",
  "method": "GET",
  "path": "/instance/{InstanceId}",
  "summary": "Amazon Connect Describe Instance",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "DescribeInstance200Example",
      "example": {
        "Instance": {
          "Id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
          "Arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
          "IdentityManagementType": "CONNECT_MANAGED",
          "InstanceAlias": "my-contact-center",
          "InstanceStatus": "ACTIVE",
          "InboundCallsEnabled": true,
          "OutboundCallsEnabled": true
        }
      }
    }
  ]
}