Amazon Connect · Schema

CreateInstanceRequest

CreateInstanceRequest schema from Amazon Connect Service API

ChatContact CenterCustomer ServiceVoiceAIOmnichannel

Properties

Name Type Description
ClientToken string The idempotency token.
IdentityManagementType string The type of identity management for your Amazon Connect users.
InstanceAlias string The name for your instance.
DirectoryId string The identifier for the directory.
InboundCallsEnabled boolean Your contact center handles incoming contacts.
OutboundCallsEnabled boolean Your contact center allows outbound calls.
Tags object The tags used to organize, track, or control access for this resource.
View JSON Schema on GitHub

JSON Schema

create-instance-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-connect/refs/heads/main/json-schema/create-instance-request-schema.json",
  "title": "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"
  ]
}