Amazon Connect · JSON Structure

Search Contacts Request Structure

SearchContactsRequest schema from Amazon Connect Service API

Type: object Properties: 6 Required: 2
ChatContact CenterCustomer ServiceVoiceAIOmnichannel

SearchContactsRequest is a JSON Structure definition published by Amazon Connect, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

InstanceId TimeRange SearchCriteria MaxResults NextToken Sort

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-connect/refs/heads/main/json-structure/search-contacts-request-structure.json",
  "name": "SearchContactsRequest",
  "description": "SearchContactsRequest schema from Amazon Connect Service API",
  "type": "object",
  "properties": {
    "InstanceId": {
      "type": "string",
      "description": "The identifier of the Amazon Connect instance.",
      "example": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
    },
    "TimeRange": {
      "type": "object",
      "required": [
        "EndTime",
        "StartTime",
        "Type"
      ],
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "INITIATION_TIMESTAMP",
            "SCHEDULED_TIMESTAMP",
            "CONNECTED_TO_AGENT_TIMESTAMP",
            "DISCONNECT_TIMESTAMP"
          ],
          "example": "INITIATION_TIMESTAMP"
        },
        "StartTime": {
          "type": "datetime",
          "example": "2025-03-15T00:00:00Z"
        },
        "EndTime": {
          "type": "datetime",
          "example": "2025-03-15T23:59:59Z"
        }
      }
    },
    "SearchCriteria": {
      "type": "object",
      "properties": {
        "AgentIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "QueueIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Channels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "MaxResults": {
      "type": "int32",
      "description": "The maximum number of results to return.",
      "example": 50
    },
    "NextToken": {
      "type": "string"
    },
    "Sort": {
      "type": "object",
      "properties": {
        "FieldName": {
          "type": "string"
        },
        "Order": {
          "type": "string",
          "enum": [
            "ASCENDING",
            "DESCENDING"
          ]
        }
      }
    }
  },
  "required": [
    "InstanceId",
    "TimeRange"
  ]
}