Amazon Connect · JSON Structure

Contact Flow Summary Structure

Contains summary information about a contact flow.

Type: object Properties: 5
ChatContact CenterCustomer ServiceVoiceAIOmnichannel

ContactFlowSummary is a JSON Structure definition published by Amazon Connect, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Id Arn Name ContactFlowType ContactFlowState

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/contact-flow-summary-structure.json",
  "name": "ContactFlowSummary",
  "description": "Contains summary information about a contact flow.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "The identifier of the contact flow.",
      "example": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
    },
    "Arn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the contact flow."
    },
    "Name": {
      "type": "string",
      "description": "The name of the contact flow.",
      "example": "Default inbound flow"
    },
    "ContactFlowType": {
      "type": "string",
      "description": "The type of contact flow.",
      "enum": [
        "CONTACT_FLOW",
        "CUSTOMER_QUEUE",
        "CUSTOMER_HOLD",
        "CUSTOMER_WHISPER",
        "AGENT_HOLD",
        "AGENT_WHISPER",
        "OUTBOUND_WHISPER",
        "AGENT_TRANSFER",
        "QUEUE_TRANSFER"
      ]
    },
    "ContactFlowState": {
      "type": "string",
      "description": "The status of the contact flow.",
      "enum": [
        "ACTIVE",
        "ARCHIVED"
      ],
      "example": "ACTIVE"
    }
  }
}