{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-chime/json-schema/amazon-chime-register-app-instance-user-endpoint-request-schema.json",
  "title": "RegisterAppInstanceUserEndpointRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-chime-endpoints-api-openapi.yml#/components/schemas/RegisterAppInstanceUserEndpointRequest",
  "type": "object",
  "properties": {
    "AppInstanceUserArn": {
      "type": "string",
      "description": "The ARN of the AppInstanceUser."
    },
    "Name": {
      "type": "string",
      "description": "The name of the AppInstanceUserEndpoint."
    },
    "Type": {
      "type": "string",
      "enum": [
        "APNS",
        "APNS_SANDBOX",
        "GCM"
      ],
      "description": "The type of the AppInstanceUserEndpoint. Supported types: APNS: The mobile notification service for an Apple device. APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device. GCM: The mobile notification service for an Android device. Populate the ResourceArn value of each type as PinpointAppArn."
    },
    "ResourceArn": {
      "type": "string",
      "description": "The ARN of the resource to which the endpoint belongs."
    },
    "EndpointAttributes": {
      "$ref": "#/$defs/EndpointAttributes"
    },
    "ClientRequestToken": {
      "type": "string",
      "description": "The unique ID assigned to the request. Use different tokens to register other endpoints."
    },
    "AllowMessages": {
      "type": "string",
      "enum": [
        "ALL",
        "NONE"
      ],
      "description": "Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages."
    }
  },
  "required": [
    "AppInstanceUserArn",
    "Type",
    "ResourceArn",
    "EndpointAttributes",
    "ClientRequestToken"
  ],
  "$defs": {
    "EndpointAttributes": {
      "type": "object",
      "properties": {
        "DeviceToken": {
          "type": "string",
          "description": "The device token for the GCM, APNS, and APNS_SANDBOX endpoint types."
        },
        "VoipDeviceToken": {
          "type": "string",
          "description": "The VOIP device token for the APNS and APNS_SANDBOX endpoint types."
        }
      },
      "required": [
        "DeviceToken"
      ]
    }
  }
}