Amazon Connect · Example Payload

Amazon Connect Describeuser Example

ChatContact CenterCustomer ServiceVoiceAIOmnichannel

Amazon Connect Describeuser 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": "describeUser",
  "method": "GET",
  "path": "/users/{InstanceId}/{UserId}",
  "summary": "Amazon Connect Describe User",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "DescribeUser200Example",
      "example": {
        "User": {
          "Id": "500123",
          "Arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4/agent/500123",
          "Username": "jsmith",
          "IdentityInfo": {
            "FirstName": "Jane",
            "LastName": "Smith",
            "Email": "jsmith@example.com"
          },
          "PhoneConfig": {
            "PhoneType": "SOFT_PHONE",
            "AutoAccept": false,
            "AfterContactWorkTimeLimit": 0
          },
          "SecurityProfileIds": [
            "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
          ],
          "RoutingProfileId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE"
        }
      }
    }
  ]
}