Amazon Connect · JSON Structure

Create Instance Request Structure

CreateInstanceRequest schema from Amazon Connect Service API

Type: object Properties: 7 Required: 3
ChatContact CenterCustomer ServiceVoiceAIOmnichannel

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

Properties

ClientToken IdentityManagementType InstanceAlias DirectoryId InboundCallsEnabled OutboundCallsEnabled Tags

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/create-instance-request-structure.json",
  "name": "CreateInstanceRequest",
  "description": "CreateInstanceRequest schema from Amazon Connect Service API",
  "type": "object",
  "properties": {
    "ClientToken": {
      "type": "string",
      "description": "The idempotency token."
    },
    "IdentityManagementType": {
      "type": "string",
      "description": "The type of identity management for your Amazon Connect users.",
      "enum": [
        "SAML",
        "CONNECT_MANAGED",
        "EXISTING_DIRECTORY"
      ],
      "example": "CONNECT_MANAGED"
    },
    "InstanceAlias": {
      "type": "string",
      "description": "The name for your instance.",
      "example": "my-contact-center"
    },
    "DirectoryId": {
      "type": "string",
      "description": "The identifier for the directory."
    },
    "InboundCallsEnabled": {
      "type": "boolean",
      "description": "Your contact center handles incoming contacts.",
      "example": true
    },
    "OutboundCallsEnabled": {
      "type": "boolean",
      "description": "Your contact center allows outbound calls.",
      "example": true
    },
    "Tags": {
      "type": "object",
      "description": "The tags used to organize, track, or control access for this resource.",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "IdentityManagementType",
    "InboundCallsEnabled",
    "OutboundCallsEnabled"
  ]
}