{ "openapi": "3.0.0", "info": { "version": "2021-04-20", "x-release": "v4", "title": "Amazon Chime SDK Identity", "description": "The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.", "x-logo": { "url": "https://twitter.com/awscloud/profile_image?size=original", "backgroundColor": "#FFFFFF" }, "termsOfService": "https://aws.amazon.com/service-terms/", "contact": { "name": "Mike Ralphson", "email": "mike.ralphson@gmail.com", "url": "https://github.com/mermade/aws2openapi", "x-twitter": "PermittedSoc" }, "license": { "name": "Apache 2.0 License", "url": "http://www.apache.org/licenses/" }, "x-providerName": "amazonaws.com", "x-serviceName": "chime-sdk-identity", "x-aws-signingName": "chime", "x-origin": [ { "contentType": "application/json", "url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/chime-sdk-identity-2021-04-20.normal.json", "converter": { "url": "https://github.com/mermade/aws2openapi", "version": "1.0.0" }, "x-apisguru-driver": "external" } ], "x-apiClientRegistration": { "url": "https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct" }, "x-apisguru-categories": [ "cloud" ], "x-preferred": true }, "externalDocs": { "description": "Amazon Web Services documentation", "url": "https://docs.aws.amazon.com/identity-chime/" }, "servers": [ { "url": "http://identity-chime.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-south-1", "af-south-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-east-1", "ap-south-1", "sa-east-1", "me-south-1" ], "default": "us-east-1" } }, "description": "The Amazon Chime SDK Identity multi-region endpoint" }, { "url": "https://identity-chime.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-south-1", "af-south-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-east-1", "ap-south-1", "sa-east-1", "me-south-1" ], "default": "us-east-1" } }, "description": "The Amazon Chime SDK Identity multi-region endpoint" }, { "url": "http://identity-chime.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon Chime SDK Identity endpoint for China (Beijing) and China (Ningxia)" }, { "url": "https://identity-chime.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon Chime SDK Identity endpoint for China (Beijing) and China (Ningxia)" } ], "x-hasEquivalentPaths": true, "paths": { "/app-instances": { "post": { "operationId": "CreateAppInstance", "description": "

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

identity

", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppInstanceResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "Name", "ClientRequestToken" ], "properties": { "Name": { "description": "The name of the AppInstance.", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "minLength": 1, "maxLength": 256, "format": "password" }, "Metadata": { "description": "The metadata of the AppInstance. Limited to a 1KB string in UTF-8.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1024, "format": "password" }, "ClientRequestToken": { "description": "The unique ID of the request. Use different tokens to create different AppInstances.", "type": "string", "pattern": "[-_a-zA-Z0-9]*", "minLength": 2, "maxLength": 64 }, "Tags": { "description": "Tags assigned to the AppInstance.", "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "minItems": 1, "maxItems": 50 } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "get": { "operationId": "ListAppInstances", "description": "Lists all Amazon Chime AppInstances created under a single AWS account.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAppInstancesResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "max-results", "in": "query", "required": false, "description": "The maximum number of AppInstances that you want to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "next-token", "in": "query", "required": false, "description": "The token passed by previous API requests until you reach the maximum number of AppInstances.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 2048, "format": "password" } }, { "name": "MaxResults", "in": "query", "schema": { "type": "string" }, "description": "Pagination limit", "required": false }, { "name": "NextToken", "in": "query", "schema": { "type": "string" }, "description": "Pagination token", "required": false } ] } }, "/app-instances/{appInstanceArn}/admins": { "post": { "operationId": "CreateAppInstanceAdmin", "description": "

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppInstanceAdminResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "AppInstanceAdminArn" ], "properties": { "AppInstanceAdminArn": { "description": "The ARN of the administrator of the current AppInstance.", "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "get": { "operationId": "ListAppInstanceAdmins", "description": "Returns a list of the administrators in the AppInstance.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAppInstanceAdminsResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } }, { "name": "max-results", "in": "query", "required": false, "description": "The maximum number of administrators that you want to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "next-token", "in": "query", "required": false, "description": "The token returned from previous API requests until the number of administrators is reached.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 2048, "format": "password" } }, { "name": "MaxResults", "in": "query", "schema": { "type": "string" }, "description": "Pagination limit", "required": false }, { "name": "NextToken", "in": "query", "schema": { "type": "string" }, "description": "Pagination token", "required": false } ] } }, "/app-instance-bots": { "post": { "operationId": "CreateAppInstanceBot", "description": "Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppInstanceBotResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "AppInstanceArn", "ClientRequestToken", "Configuration" ], "properties": { "AppInstanceArn": { "description": "The ARN of the AppInstance request.", "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 }, "Name": { "description": "The user's name.", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "minLength": 0, "maxLength": 256, "format": "password" }, "Metadata": { "description": "The request metadata. Limited to a 1KB string in UTF-8.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1024, "format": "password" }, "ClientRequestToken": { "description": "The unique ID for the client making the request. Use different tokens for different AppInstanceBots.", "type": "string", "pattern": "[-_a-zA-Z0-9]*", "minLength": 2, "maxLength": 64 }, "Tags": { "description": "The tags assigned to the AppInstanceBot.", "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "minItems": 1, "maxItems": 50 }, "Configuration": { "description": "A structure that contains configuration data.", "type": "object", "properties": { "Lex": { "allOf": [ { "$ref": "#/components/schemas/LexConfiguration" }, { "description": "The configuration for an Amazon Lex V2 bot." } ] } } } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] }, "/app-instance-users": { "post": { "operationId": "CreateAppInstanceUser", "description": "Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppInstanceUserResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "AppInstanceArn", "AppInstanceUserId", "Name", "ClientRequestToken" ], "properties": { "AppInstanceArn": { "description": "The ARN of the AppInstance request.", "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 }, "AppInstanceUserId": { "description": "The user ID of the AppInstance.", "type": "string", "pattern": "[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?", "minLength": 1, "maxLength": 64, "format": "password" }, "Name": { "description": "The user's name.", "type": "string", "pattern": ".*\\S.*", "minLength": 1, "maxLength": 100, "format": "password" }, "Metadata": { "description": "The request's metadata. Limited to a 1KB string in UTF-8.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1024, "format": "password" }, "ClientRequestToken": { "description": "The unique ID of the request. Use different tokens to request additional AppInstances.", "type": "string", "pattern": "[-_a-zA-Z0-9]*", "minLength": 2, "maxLength": 64 }, "Tags": { "description": "Tags assigned to the AppInstanceUser.", "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "minItems": 1, "maxItems": 50 }, "ExpirationSettings": { "description": "Determines the interval after which an AppInstanceUser is automatically deleted.", "type": "object", "properties": { "ExpirationDays": { "allOf": [ { "$ref": "#/components/schemas/ExpirationDays" }, { "description": "The period in days after which an AppInstanceUser will be automatically deleted." } ] }, "ExpirationCriterion": { "allOf": [ { "$ref": "#/components/schemas/ExpirationCriterion" }, { "description": "Specifies the conditions under which an AppInstanceUser will expire." } ] } } } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] }, "/app-instances/{appInstanceArn}": { "delete": { "operationId": "DeleteAppInstance", "description": "Deletes an AppInstance and all associated data asynchronously.", "responses": { "204": { "description": "Success" }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "get": { "operationId": "DescribeAppInstance", "description": "Returns the full details of an AppInstance.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescribeAppInstanceResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "put": { "operationId": "UpdateAppInstance", "description": "Updates AppInstance metadata.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppInstanceResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "Name", "Metadata" ], "properties": { "Name": { "description": "The name that you want to change.", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "minLength": 1, "maxLength": 256, "format": "password" }, "Metadata": { "description": "The metadata that you want to change.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1024, "format": "password" } } } } } } } }, "/app-instances/{appInstanceArn}/admins/{appInstanceAdminArn}": { "delete": { "operationId": "DeleteAppInstanceAdmin", "description": "Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.", "responses": { "204": { "description": "Success" }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceAdminArn", "in": "path", "required": true, "description": "The ARN of the AppInstance's administrator.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } }, { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "get": { "operationId": "DescribeAppInstanceAdmin", "description": "Returns the full details of an AppInstanceAdmin.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescribeAppInstanceAdminResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceAdminArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceAdmin.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } }, { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] } }, "/app-instance-bots/{appInstanceBotArn}": { "delete": { "operationId": "DeleteAppInstanceBot", "description": "Deletes an AppInstanceBot.", "responses": { "204": { "description": "Success" }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceBotArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceBot being deleted.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "get": { "operationId": "DescribeAppInstanceBot", "description": "The AppInstanceBot's information.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescribeAppInstanceBotResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "NotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceBotArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceBot.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "put": { "operationId": "UpdateAppInstanceBot", "description": "Updates the name and metadata of an AppInstanceBot.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppInstanceBotResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceBotArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceBot.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "Name", "Metadata" ], "properties": { "Name": { "description": "The name of the AppInstanceBot.", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "minLength": 0, "maxLength": 256, "format": "password" }, "Metadata": { "description": "The metadata of the AppInstanceBot.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1024, "format": "password" } } } } } } } }, "/app-instance-users/{appInstanceUserArn}": { "delete": { "operationId": "DeleteAppInstanceUser", "description": "Deletes an AppInstanceUser.", "responses": { "204": { "description": "Success" }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the user request being deleted.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "get": { "operationId": "DescribeAppInstanceUser", "description": "Returns the full details of an AppInstanceUser.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescribeAppInstanceUserResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "put": { "operationId": "UpdateAppInstanceUser", "description": "Updates the details of an AppInstanceUser. You can update names and metadata.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppInstanceUserResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "Name", "Metadata" ], "properties": { "Name": { "description": "The name of the AppInstanceUser.", "type": "string", "pattern": ".*\\S.*", "minLength": 1, "maxLength": 100, "format": "password" }, "Metadata": { "description": "The metadata of the AppInstanceUser.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1024, "format": "password" } } } } } } } }, "/app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}": { "delete": { "operationId": "DeregisterAppInstanceUserEndpoint", "description": "Deregisters an AppInstanceUserEndpoint.", "responses": { "204": { "description": "Success" }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600, "format": "password" } }, { "name": "endpointId", "in": "path", "required": true, "description": "The unique identifier of the AppInstanceUserEndpoint.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 64, "format": "password" } } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "get": { "operationId": "DescribeAppInstanceUserEndpoint", "description": "Returns the full details of an AppInstanceUserEndpoint.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescribeAppInstanceUserEndpointResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1600, "format": "password" } }, { "name": "endpointId", "in": "path", "required": true, "description": "The unique identifier of the AppInstanceUserEndpoint.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 64, "format": "password" } } ] }, "put": { "operationId": "UpdateAppInstanceUserEndpoint", "description": "Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppInstanceUserEndpointResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600, "format": "password" } }, { "name": "endpointId", "in": "path", "required": true, "description": "The unique identifier of the AppInstanceUserEndpoint.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 64, "format": "password" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "description": "The name of the AppInstanceUserEndpoint.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1600, "format": "password" }, "AllowMessages": { "description": "Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.", "type": "string", "enum": [ "ALL", "NONE" ] } } } } } } } }, "/app-instances/{appInstanceArn}/retention-settings": { "get": { "operationId": "GetAppInstanceRetentionSettings", "description": "Gets the retention settings for an AppInstance.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAppInstanceRetentionSettingsResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "put": { "operationId": "PutAppInstanceRetentionSettings", "description": "Sets the amount of time in days that a given AppInstance retains data.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutAppInstanceRetentionSettingsResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceArn", "in": "path", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "AppInstanceRetentionSettings" ], "properties": { "AppInstanceRetentionSettings": { "description": "The details of the data-retention settings for an AppInstance.", "type": "object", "properties": { "ChannelRetentionSettings": { "allOf": [ { "$ref": "#/components/schemas/ChannelRetentionSettings" }, { "description": "The length of time in days to retain the messages in a channel." } ] } } } } } } } } } }, "/app-instance-bots#app-instance-arn": { "get": { "operationId": "ListAppInstanceBots", "description": "Lists all AppInstanceBots created under a single AppInstance.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAppInstanceBotsResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "app-instance-arn", "in": "query", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } }, { "name": "max-results", "in": "query", "required": false, "description": "The maximum number of requests to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "next-token", "in": "query", "required": false, "description": "The token passed by previous API calls until all requested bots are returned.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 2048, "format": "password" } }, { "name": "MaxResults", "in": "query", "schema": { "type": "string" }, "description": "Pagination limit", "required": false }, { "name": "NextToken", "in": "query", "schema": { "type": "string" }, "description": "Pagination token", "required": false } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] }, "/app-instance-users/{appInstanceUserArn}/endpoints": { "get": { "operationId": "ListAppInstanceUserEndpoints", "description": "Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAppInstanceUserEndpointsResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600, "format": "password" } }, { "name": "max-results", "in": "query", "required": false, "description": "The maximum number of endpoints that you want to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "next-token", "in": "query", "required": false, "description": "The token passed by previous API calls until all requested endpoints are returned.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 2048, "format": "password" } }, { "name": "MaxResults", "in": "query", "schema": { "type": "string" }, "description": "Pagination limit", "required": false }, { "name": "NextToken", "in": "query", "schema": { "type": "string" }, "description": "Pagination token", "required": false } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ], "post": { "operationId": "RegisterAppInstanceUserEndpoint", "description": "Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterAppInstanceUserEndpointResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "486": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "487": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600, "format": "password" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "Type", "ResourceArn", "EndpointAttributes", "ClientRequestToken" ], "properties": { "Name": { "description": "The name of the AppInstanceUserEndpoint.", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1600, "format": "password" }, "Type": { "description": "

The type of the AppInstanceUserEndpoint. Supported types:

Populate the ResourceArn value of each type as PinpointAppArn.

", "type": "string", "enum": [ "APNS", "APNS_SANDBOX", "GCM" ] }, "ResourceArn": { "description": "The ARN of the resource to which the endpoint belongs.", "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 }, "EndpointAttributes": { "description": "The attributes of an Endpoint.", "type": "object", "properties": { "DeviceToken": { "allOf": [ { "$ref": "#/components/schemas/NonEmptySensitiveString1600" }, { "description": "The device token for the GCM, APNS, and APNS_SANDBOX endpoint types." } ] }, "VoipDeviceToken": { "allOf": [ { "$ref": "#/components/schemas/NonEmptySensitiveString1600" }, { "description": "The VOIP device token for the APNS and APNS_SANDBOX endpoint types." } ] } } }, "ClientRequestToken": { "description": "The unique ID assigned to the request. Use different tokens to register other endpoints.", "type": "string", "pattern": "[-_a-zA-Z0-9]*", "minLength": 2, "maxLength": 64 }, "AllowMessages": { "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.", "type": "string", "enum": [ "ALL", "NONE" ] } } } } } } } }, "/app-instance-users#app-instance-arn": { "get": { "operationId": "ListAppInstanceUsers", "description": "List all AppInstanceUsers created under a single AppInstance.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAppInstanceUsersResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "483": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "app-instance-arn", "in": "query", "required": true, "description": "The ARN of the AppInstance.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } }, { "name": "max-results", "in": "query", "required": false, "description": "The maximum number of requests that you want returned.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "next-token", "in": "query", "required": false, "description": "The token passed by previous API calls until all requested users are returned.", "schema": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 2048, "format": "password" } }, { "name": "MaxResults", "in": "query", "schema": { "type": "string" }, "description": "Pagination limit", "required": false }, { "name": "NextToken", "in": "query", "schema": { "type": "string" }, "description": "Pagination token", "required": false } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] }, "/tags#arn": { "get": { "operationId": "ListTagsForResource", "description": "Lists the tags applied to an Amazon Chime SDK identity resource.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTagsForResourceResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "arn", "in": "query", "required": true, "description": "The ARN of the resource.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ] }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] }, "/app-instance-users/{appInstanceUserArn}/expiration-settings": { "put": { "operationId": "PutAppInstanceUserExpirationSettings", "description": "

Sets the number of days before the AppInstanceUser is automatically deleted.

A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary.

Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutAppInstanceUserExpirationSettingsResponse" } } } }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ConflictException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictException" } } } }, "482": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "appInstanceUserArn", "in": "path", "required": true, "description": "The ARN of the AppInstanceUser.", "schema": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ExpirationSettings": { "description": "Determines the interval after which an AppInstanceUser is automatically deleted.", "type": "object", "properties": { "ExpirationDays": { "allOf": [ { "$ref": "#/components/schemas/ExpirationDays" }, { "description": "The period in days after which an AppInstanceUser will be automatically deleted." } ] }, "ExpirationCriterion": { "allOf": [ { "$ref": "#/components/schemas/ExpirationCriterion" }, { "description": "Specifies the conditions under which an AppInstanceUser will expire." } ] } } } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] }, "/tags#operation=tag-resource": { "post": { "operationId": "TagResource", "description": "Applies the specified tags to the specified Amazon Chime SDK identity resource.", "responses": { "204": { "description": "Success" }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "483": { "description": "ResourceLimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLimitExceededException" } } } }, "484": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "485": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "486": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "operation", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "tag-resource" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ResourceARN", "Tags" ], "properties": { "ResourceARN": { "description": "The resource ARN.", "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 }, "Tags": { "description": "The tag key-value pairs.", "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "minItems": 1, "maxItems": 50 } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] }, "/tags#operation=untag-resource": { "post": { "operationId": "UntagResource", "description": "Removes the specified tags from the specified Amazon Chime SDK identity resource.", "responses": { "204": { "description": "Success" }, "480": { "description": "BadRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "481": { "description": "ForbiddenException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenException" } } } }, "482": { "description": "UnauthorizedClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedClientException" } } } }, "483": { "description": "ThrottledClientException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledClientException" } } } }, "484": { "description": "ServiceUnavailableException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUnavailableException" } } } }, "485": { "description": "ServiceFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFailureException" } } } } }, "parameters": [ { "name": "operation", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "untag-resource" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ResourceARN", "TagKeys" ], "properties": { "ResourceARN": { "description": "The resource ARN.", "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 }, "TagKeys": { "description": "The tag keys.", "type": "array", "items": { "$ref": "#/components/schemas/TagKey" }, "minItems": 1, "maxItems": 50 } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/X-Amz-Content-Sha256" }, { "$ref": "#/components/parameters/X-Amz-Date" }, { "$ref": "#/components/parameters/X-Amz-Algorithm" }, { "$ref": "#/components/parameters/X-Amz-Credential" }, { "$ref": "#/components/parameters/X-Amz-Security-Token" }, { "$ref": "#/components/parameters/X-Amz-Signature" }, { "$ref": "#/components/parameters/X-Amz-SignedHeaders" } ] } }, "components": { "parameters": { "X-Amz-Content-Sha256": { "name": "X-Amz-Content-Sha256", "in": "header", "schema": { "type": "string" }, "required": false }, "X-Amz-Date": { "name": "X-Amz-Date", "in": "header", "schema": { "type": "string" }, "required": false }, "X-Amz-Algorithm": { "name": "X-Amz-Algorithm", "in": "header", "schema": { "type": "string" }, "required": false }, "X-Amz-Credential": { "name": "X-Amz-Credential", "in": "header", "schema": { "type": "string" }, "required": false }, "X-Amz-Security-Token": { "name": "X-Amz-Security-Token", "in": "header", "schema": { "type": "string" }, "required": false }, "X-Amz-Signature": { "name": "X-Amz-Signature", "in": "header", "schema": { "type": "string" }, "required": false }, "X-Amz-SignedHeaders": { "name": "X-Amz-SignedHeaders", "in": "header", "schema": { "type": "string" }, "required": false } }, "securitySchemes": { "hmac": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "Amazon Signature authorization v4", "x-amazon-apigateway-authtype": "awsSigv4" } }, "schemas": { "CreateAppInstanceResponse": { "type": "object", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The Amazon Resource Number (ARN) of the AppInstance." } ] } } }, "Tag": { "type": "object", "required": [ "Key", "Value" ], "properties": { "Key": { "allOf": [ { "$ref": "#/components/schemas/TagKey" }, { "description": "The key in a tag." } ] }, "Value": { "allOf": [ { "$ref": "#/components/schemas/TagValue" }, { "description": "The value in a tag." } ] } }, "description": "A tag object containing a key-value pair." }, "BadRequestException": {}, "ConflictException": {}, "ForbiddenException": {}, "ResourceLimitExceededException": {}, "ThrottledClientException": {}, "UnauthorizedClientException": {}, "ServiceUnavailableException": {}, "ServiceFailureException": {}, "CreateAppInstanceAdminResponse": { "type": "object", "properties": { "AppInstanceAdmin": { "allOf": [ { "$ref": "#/components/schemas/Identity" }, { "description": "The ARN and name of the administrator, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds." } ] }, "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the of the admin for the AppInstance." } ] } } }, "CreateAppInstanceBotResponse": { "type": "object", "properties": { "AppInstanceBotArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppinstanceBot." } ] } } }, "LexConfiguration": { "type": "object", "required": [ "RespondsTo", "LexBotAliasArn", "LocaleId" ], "properties": { "RespondsTo": { "allOf": [ { "$ref": "#/components/schemas/RespondsTo" }, { "description": "Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported." } ] }, "LexBotAliasArn": { "allOf": [ { "$ref": "#/components/schemas/LexBotAliasArn" }, { "description": "The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS " } ] }, "LocaleId": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide." } ] }, "WelcomeIntent": { "allOf": [ { "$ref": "#/components/schemas/LexIntentName" }, { "description": "The name of the welcome intent configured in the Amazon Lex V2 bot." } ] } }, "description": "The configuration for an Amazon Lex V2 bot." }, "CreateAppInstanceUserResponse": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The user's ARN." } ] } } }, "ExpirationDays": { "type": "integer", "minimum": 1, "maximum": 5475 }, "ExpirationCriterion": { "type": "string", "enum": [ "CREATED_TIMESTAMP" ] }, "DescribeAppInstanceResponse": { "type": "object", "properties": { "AppInstance": { "allOf": [ { "$ref": "#/components/schemas/AppInstance" }, { "description": "The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds." } ] } } }, "DescribeAppInstanceAdminResponse": { "type": "object", "properties": { "AppInstanceAdmin": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceAdmin" }, { "description": "The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds." } ] } } }, "DescribeAppInstanceBotResponse": { "type": "object", "properties": { "AppInstanceBot": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceBot" }, { "description": "The detials of the AppInstanceBot." } ] } } }, "NotFoundException": {}, "DescribeAppInstanceUserResponse": { "type": "object", "properties": { "AppInstanceUser": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceUser" }, { "description": "The name of the AppInstanceUser." } ] } } }, "DescribeAppInstanceUserEndpointResponse": { "type": "object", "properties": { "AppInstanceUserEndpoint": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceUserEndpoint" }, { "description": "The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds." } ] } } }, "GetAppInstanceRetentionSettingsResponse": { "type": "object", "properties": { "AppInstanceRetentionSettings": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceRetentionSettings" }, { "description": "The retention settings for the AppInstance." } ] }, "InitiateDeletionTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The timestamp representing the time at which the specified items are retained, in Epoch Seconds." } ] } } }, "ListAppInstanceAdminsResponse": { "type": "object", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstance." } ] }, "AppInstanceAdmins": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceAdminList" }, { "description": "The information for each administrator." } ] }, "NextToken": { "allOf": [ { "$ref": "#/components/schemas/NextToken" }, { "description": "The token returned from previous API requests until the number of administrators is reached." } ] } } }, "ListAppInstanceBotsResponse": { "type": "object", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstance." } ] }, "AppInstanceBots": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceBotList" }, { "description": "The information for each requested AppInstanceBot." } ] }, "NextToken": { "allOf": [ { "$ref": "#/components/schemas/NextToken" }, { "description": "The token passed by previous API calls until all requested bots are returned." } ] } } }, "ListAppInstanceUserEndpointsResponse": { "type": "object", "properties": { "AppInstanceUserEndpoints": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceUserEndpointSummaryList" }, { "description": "The information for each requested AppInstanceUserEndpoint." } ] }, "NextToken": { "allOf": [ { "$ref": "#/components/schemas/NextToken" }, { "description": "The token passed by previous API calls until all requested endpoints are returned." } ] } } }, "ListAppInstanceUsersResponse": { "type": "object", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstance." } ] }, "AppInstanceUsers": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceUserList" }, { "description": "The information for each requested AppInstanceUser." } ] }, "NextToken": { "allOf": [ { "$ref": "#/components/schemas/NextToken" }, { "description": "The token passed by previous API calls until all requested users are returned." } ] } } }, "ListAppInstancesResponse": { "type": "object", "properties": { "AppInstances": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceList" }, { "description": "The information for each AppInstance." } ] }, "NextToken": { "allOf": [ { "$ref": "#/components/schemas/NextToken" }, { "description": "The token passed by previous API requests until the maximum number of AppInstances is reached." } ] } } }, "ListTagsForResourceResponse": { "type": "object", "properties": { "Tags": { "allOf": [ { "$ref": "#/components/schemas/TagList" }, { "description": "The tag key-value pairs." } ] } } }, "PutAppInstanceRetentionSettingsResponse": { "type": "object", "properties": { "AppInstanceRetentionSettings": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceRetentionSettings" }, { "description": "The time in days to retain data. Data type: number." } ] }, "InitiateDeletionTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which the API deletes data." } ] } } }, "ChannelRetentionSettings": { "type": "object", "properties": { "RetentionDays": { "allOf": [ { "$ref": "#/components/schemas/RetentionDays" }, { "description": "The time in days to retain the messages in a channel." } ] } }, "description": "The details of the retention settings for a channel." }, "PutAppInstanceUserExpirationSettingsResponse": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] }, "ExpirationSettings": { "allOf": [ { "$ref": "#/components/schemas/ExpirationSettings" }, { "description": "Settings that control the interval after which an AppInstanceUser is automatically deleted." } ] } } }, "RegisterAppInstanceUserEndpointResponse": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/SensitiveChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] }, "EndpointId": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString64" }, { "description": "The unique identifier of the AppInstanceUserEndpoint." } ] } } }, "NonEmptySensitiveString1600": { "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 1600, "format": "password" }, "TagKey": { "type": "string", "minLength": 1, "maxLength": 128, "format": "password" }, "UpdateAppInstanceResponse": { "type": "object", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstance." } ] } } }, "UpdateAppInstanceBotResponse": { "type": "object", "properties": { "AppInstanceBotArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstanceBot." } ] } } }, "UpdateAppInstanceUserResponse": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] } } }, "UpdateAppInstanceUserEndpointResponse": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/SensitiveChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] }, "EndpointId": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString64" }, { "description": "The unique identifier of the AppInstanceUserEndpoint." } ] } } }, "AllowMessages": { "type": "string", "enum": [ "ALL", "NONE" ] }, "ChimeArn": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600 }, "NonEmptyResourceName": { "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "minLength": 1, "maxLength": 256, "format": "password" }, "Timestamp": { "type": "string", "format": "date-time" }, "Metadata": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1024, "format": "password" }, "AppInstance": { "type": "object", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the messaging instance." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/NonEmptyResourceName" }, { "description": "The name of an AppInstance." } ] }, "CreatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which an AppInstance was created. In epoch milliseconds." } ] }, "LastUpdatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time an AppInstance was last updated. In epoch milliseconds." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of an AppInstance." } ] } }, "description": "The details of an AppInstance, an instance of an Amazon Chime SDK messaging application." }, "Identity": { "type": "object", "properties": { "Arn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN in an Identity." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/ResourceName" }, { "description": "The name in an Identity." } ] } }, "description": "The details of a user or bot." }, "AppInstanceAdmin": { "type": "object", "properties": { "Admin": { "allOf": [ { "$ref": "#/components/schemas/Identity" }, { "description": "The AppInstanceAdmin data." } ] }, "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstance for which the user is an administrator." } ] }, "CreatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which an administrator was created." } ] } }, "description": "The name and ARN of the admin for the AppInstance." }, "AppInstanceAdminSummary": { "type": "object", "properties": { "Admin": { "allOf": [ { "$ref": "#/components/schemas/Identity" }, { "description": "The details of the AppInstanceAdmin." } ] } }, "description": "Summary of the details of an AppInstanceAdmin." }, "AppInstanceAdminList": { "type": "array", "items": { "$ref": "#/components/schemas/AppInstanceAdminSummary" } }, "ResourceName": { "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "minLength": 0, "maxLength": 256, "format": "password" }, "Configuration": { "type": "object", "required": [ "Lex" ], "properties": { "Lex": { "allOf": [ { "$ref": "#/components/schemas/LexConfiguration" }, { "description": "The configuration for an Amazon Lex V2 bot." } ] } }, "description": "A structure that contains configuration data." }, "AppInstanceBot": { "type": "object", "properties": { "AppInstanceBotArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstanceBot." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/ResourceName" }, { "description": "The name of the AppInstanceBot." } ] }, "Configuration": { "allOf": [ { "$ref": "#/components/schemas/Configuration" }, { "description": "The data processing instructions for an AppInstanceBot." } ] }, "CreatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which the AppInstanceBot was created." } ] }, "LastUpdatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which the AppInstanceBot was last updated." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata for an AppInstanceBot." } ] } }, "description": "An Amazon Lex V2 chat bot created under an AppInstance." }, "AppInstanceBotSummary": { "type": "object", "properties": { "AppInstanceBotArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstanceBot." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/ResourceName" }, { "description": "The name of the AppInstanceBox." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of the AppInstanceBot." } ] } }, "description": "High-level information about an AppInstanceBot." }, "AppInstanceBotList": { "type": "array", "items": { "$ref": "#/components/schemas/AppInstanceBotSummary" } }, "AppInstanceSummary": { "type": "object", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The AppInstance ARN." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/NonEmptyResourceName" }, { "description": "The name of the AppInstance." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of the AppInstance." } ] } }, "description": "Summary of the data for an AppInstance." }, "AppInstanceList": { "type": "array", "items": { "$ref": "#/components/schemas/AppInstanceSummary" } }, "AppInstanceRetentionSettings": { "type": "object", "properties": { "ChannelRetentionSettings": { "allOf": [ { "$ref": "#/components/schemas/ChannelRetentionSettings" }, { "description": "The length of time in days to retain the messages in a channel." } ] } }, "description": "The details of the data-retention settings for an AppInstance." }, "UserName": { "type": "string", "pattern": ".*\\S.*", "minLength": 1, "maxLength": 100, "format": "password" }, "ExpirationSettings": { "type": "object", "required": [ "ExpirationDays", "ExpirationCriterion" ], "properties": { "ExpirationDays": { "allOf": [ { "$ref": "#/components/schemas/ExpirationDays" }, { "description": "The period in days after which an AppInstanceUser will be automatically deleted." } ] }, "ExpirationCriterion": { "allOf": [ { "$ref": "#/components/schemas/ExpirationCriterion" }, { "description": "Specifies the conditions under which an AppInstanceUser will expire." } ] } }, "description": "Determines the interval after which an AppInstanceUser is automatically deleted." }, "AppInstanceUser": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/UserName" }, { "description": "The name of the AppInstanceUser." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of the AppInstanceUser." } ] }, "CreatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which the AppInstanceUser was created." } ] }, "LastUpdatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which the AppInstanceUser was last updated." } ] }, "ExpirationSettings": { "allOf": [ { "$ref": "#/components/schemas/ExpirationSettings" }, { "description": "The interval after which an AppInstanceUser is automatically deleted." } ] } }, "description": "The details of an AppInstanceUser." }, "SensitiveChimeArn": { "type": "string", "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "minLength": 5, "maxLength": 1600, "format": "password" }, "SensitiveString64": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 64, "format": "password" }, "SensitiveString1600": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 1600, "format": "password" }, "AppInstanceUserEndpointType": { "type": "string", "enum": [ "APNS", "APNS_SANDBOX", "GCM" ] }, "EndpointAttributes": { "type": "object", "required": [ "DeviceToken" ], "properties": { "DeviceToken": { "allOf": [ { "$ref": "#/components/schemas/NonEmptySensitiveString1600" }, { "description": "The device token for the GCM, APNS, and APNS_SANDBOX endpoint types." } ] }, "VoipDeviceToken": { "allOf": [ { "$ref": "#/components/schemas/NonEmptySensitiveString1600" }, { "description": "The VOIP device token for the APNS and APNS_SANDBOX endpoint types." } ] } }, "description": "The attributes of an Endpoint." }, "EndpointState": { "type": "object", "required": [ "Status" ], "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/EndpointStatus" }, { "description": "Enum that indicates the Status of an AppInstanceUserEndpoint." } ] }, "StatusReason": { "allOf": [ { "$ref": "#/components/schemas/EndpointStatusReason" }, { "description": "The reason for the EndpointStatus." } ] } }, "description": "

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

" }, "AppInstanceUserEndpoint": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/SensitiveChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] }, "EndpointId": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString64" }, { "description": "The unique identifier of the AppInstanceUserEndpoint." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString1600" }, { "description": "The name of the AppInstanceUserEndpoint." } ] }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceUserEndpointType" }, { "description": "The type of the AppInstanceUserEndpoint." } ] }, "ResourceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the resource to which the endpoint belongs." } ] }, "EndpointAttributes": { "allOf": [ { "$ref": "#/components/schemas/EndpointAttributes" }, { "description": "The attributes of an Endpoint." } ] }, "CreatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which an AppInstanceUserEndpoint was created." } ] }, "LastUpdatedTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The time at which an AppInstanceUserEndpoint was last updated." } ] }, "AllowMessages": { "allOf": [ { "$ref": "#/components/schemas/AllowMessages" }, { "description": "Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages." } ] }, "EndpointState": { "allOf": [ { "$ref": "#/components/schemas/EndpointState" }, { "description": "

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

" } ] } }, "description": "An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user." }, "AppInstanceUserEndpointSummary": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/SensitiveChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] }, "EndpointId": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString64" }, { "description": "The unique identifier of the AppInstanceUserEndpoint." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString1600" }, { "description": "The name of the AppInstanceUserEndpoint." } ] }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceUserEndpointType" }, { "description": "The type of the AppInstanceUserEndpoint." } ] }, "AllowMessages": { "allOf": [ { "$ref": "#/components/schemas/AllowMessages" }, { "description": "BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages." } ] }, "EndpointState": { "allOf": [ { "$ref": "#/components/schemas/EndpointState" }, { "description": "A read-only field that represent the state of an AppInstanceUserEndpoint." } ] } }, "description": "Summary of the details of an AppInstanceUserEndpoint." }, "AppInstanceUserEndpointSummaryList": { "type": "array", "items": { "$ref": "#/components/schemas/AppInstanceUserEndpointSummary" } }, "AppInstanceUserSummary": { "type": "object", "properties": { "AppInstanceUserArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstanceUser." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/UserName" }, { "description": "The name of an AppInstanceUser." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of the AppInstanceUser." } ] } }, "description": "Summary of the details of an AppInstanceUser." }, "AppInstanceUserList": { "type": "array", "items": { "$ref": "#/components/schemas/AppInstanceUserSummary" } }, "RetentionDays": { "type": "integer", "minimum": 1, "maximum": 5475 }, "ClientRequestToken": { "type": "string", "pattern": "[-_a-zA-Z0-9]*", "minLength": 2, "maxLength": 64 }, "CreateAppInstanceAdminRequest": { "type": "object", "required": [ "AppInstanceAdminArn" ], "title": "CreateAppInstanceAdminRequest", "properties": { "AppInstanceAdminArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the administrator of the current AppInstance." } ] } } }, "TagList": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "minItems": 1, "maxItems": 50 }, "CreateAppInstanceBotRequest": { "type": "object", "required": [ "AppInstanceArn", "ClientRequestToken", "Configuration" ], "title": "CreateAppInstanceBotRequest", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstance request." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/ResourceName" }, { "description": "The user's name." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The request metadata. Limited to a 1KB string in UTF-8." } ] }, "ClientRequestToken": { "allOf": [ { "$ref": "#/components/schemas/ClientRequestToken" }, { "description": "The unique ID for the client making the request. Use different tokens for different AppInstanceBots." } ] }, "Tags": { "allOf": [ { "$ref": "#/components/schemas/TagList" }, { "description": "The tags assigned to the AppInstanceBot." } ] }, "Configuration": { "allOf": [ { "$ref": "#/components/schemas/Configuration" }, { "description": "Configuration information about the Amazon Lex V2 V2 bot." } ] } } }, "CreateAppInstanceRequest": { "type": "object", "required": [ "Name", "ClientRequestToken" ], "title": "CreateAppInstanceRequest", "properties": { "Name": { "allOf": [ { "$ref": "#/components/schemas/NonEmptyResourceName" }, { "description": "The name of the AppInstance." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of the AppInstance. Limited to a 1KB string in UTF-8." } ] }, "ClientRequestToken": { "allOf": [ { "$ref": "#/components/schemas/ClientRequestToken" }, { "description": "The unique ID of the request. Use different tokens to create different AppInstances." } ] }, "Tags": { "allOf": [ { "$ref": "#/components/schemas/TagList" }, { "description": "Tags assigned to the AppInstance." } ] } } }, "UserId": { "type": "string", "pattern": "[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?", "minLength": 1, "maxLength": 64, "format": "password" }, "CreateAppInstanceUserRequest": { "type": "object", "required": [ "AppInstanceArn", "AppInstanceUserId", "Name", "ClientRequestToken" ], "title": "CreateAppInstanceUserRequest", "properties": { "AppInstanceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the AppInstance request." } ] }, "AppInstanceUserId": { "allOf": [ { "$ref": "#/components/schemas/UserId" }, { "description": "The user ID of the AppInstance." } ] }, "Name": { "allOf": [ { "$ref": "#/components/schemas/UserName" }, { "description": "The user's name." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The request's metadata. Limited to a 1KB string in UTF-8." } ] }, "ClientRequestToken": { "allOf": [ { "$ref": "#/components/schemas/ClientRequestToken" }, { "description": "The unique ID of the request. Use different tokens to request additional AppInstances." } ] }, "Tags": { "allOf": [ { "$ref": "#/components/schemas/TagList" }, { "description": "Tags assigned to the AppInstanceUser." } ] }, "ExpirationSettings": { "allOf": [ { "$ref": "#/components/schemas/ExpirationSettings" }, { "description": "Settings that control the interval after which the AppInstanceUser is automatically deleted." } ] } } }, "DeleteAppInstanceAdminRequest": { "type": "object", "title": "DeleteAppInstanceAdminRequest", "properties": {} }, "DeleteAppInstanceBotRequest": { "type": "object", "title": "DeleteAppInstanceBotRequest", "properties": {} }, "DeleteAppInstanceRequest": { "type": "object", "title": "DeleteAppInstanceRequest", "properties": {} }, "DeleteAppInstanceUserRequest": { "type": "object", "title": "DeleteAppInstanceUserRequest", "properties": {} }, "DeregisterAppInstanceUserEndpointRequest": { "type": "object", "title": "DeregisterAppInstanceUserEndpointRequest", "properties": {} }, "DescribeAppInstanceAdminRequest": { "type": "object", "title": "DescribeAppInstanceAdminRequest", "properties": {} }, "DescribeAppInstanceBotRequest": { "type": "object", "title": "DescribeAppInstanceBotRequest", "properties": {} }, "DescribeAppInstanceRequest": { "type": "object", "title": "DescribeAppInstanceRequest", "properties": {} }, "DescribeAppInstanceUserEndpointRequest": { "type": "object", "title": "DescribeAppInstanceUserEndpointRequest", "properties": {} }, "DescribeAppInstanceUserRequest": { "type": "object", "title": "DescribeAppInstanceUserRequest", "properties": {} }, "EndpointStatus": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "EndpointStatusReason": { "type": "string", "enum": [ "INVALID_DEVICE_TOKEN", "INVALID_PINPOINT_ARN" ] }, "GetAppInstanceRetentionSettingsRequest": { "type": "object", "title": "GetAppInstanceRetentionSettingsRequest", "properties": {} }, "LexBotAliasArn": { "type": "string", "pattern": "arn:aws:lex:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:bot-alias/[A-Z0-9]{10}/[A-Z0-9]{10}", "minLength": 15, "maxLength": 2048 }, "RespondsTo": { "type": "string", "enum": [ "STANDARD_MESSAGES" ] }, "String": { "type": "string" }, "LexIntentName": { "type": "string", "pattern": "^([A-Za-z]_?)+$", "minLength": 1, "maxLength": 100 }, "MaxResults": { "type": "integer", "minimum": 1, "maximum": 50 }, "NextToken": { "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 2048, "format": "password" }, "ListAppInstanceAdminsRequest": { "type": "object", "title": "ListAppInstanceAdminsRequest", "properties": {} }, "ListAppInstanceBotsRequest": { "type": "object", "title": "ListAppInstanceBotsRequest", "properties": {} }, "ListAppInstanceUserEndpointsRequest": { "type": "object", "title": "ListAppInstanceUserEndpointsRequest", "properties": {} }, "ListAppInstanceUsersRequest": { "type": "object", "title": "ListAppInstanceUsersRequest", "properties": {} }, "ListAppInstancesRequest": { "type": "object", "title": "ListAppInstancesRequest", "properties": {} }, "ListTagsForResourceRequest": { "type": "object", "title": "ListTagsForResourceRequest", "properties": {} }, "PutAppInstanceRetentionSettingsRequest": { "type": "object", "required": [ "AppInstanceRetentionSettings" ], "title": "PutAppInstanceRetentionSettingsRequest", "properties": { "AppInstanceRetentionSettings": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceRetentionSettings" }, { "description": "The time in days to retain data. Data type: number." } ] } } }, "PutAppInstanceUserExpirationSettingsRequest": { "type": "object", "title": "PutAppInstanceUserExpirationSettingsRequest", "properties": { "ExpirationSettings": { "allOf": [ { "$ref": "#/components/schemas/ExpirationSettings" }, { "description": "Settings that control the interval after which an AppInstanceUser is automatically deleted." } ] } } }, "RegisterAppInstanceUserEndpointRequest": { "type": "object", "required": [ "Type", "ResourceArn", "EndpointAttributes", "ClientRequestToken" ], "title": "RegisterAppInstanceUserEndpointRequest", "properties": { "Name": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString1600" }, { "description": "The name of the AppInstanceUserEndpoint." } ] }, "Type": { "allOf": [ { "$ref": "#/components/schemas/AppInstanceUserEndpointType" }, { "description": "

The type of the AppInstanceUserEndpoint. Supported types:

Populate the ResourceArn value of each type as PinpointAppArn.

" } ] }, "ResourceArn": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The ARN of the resource to which the endpoint belongs." } ] }, "EndpointAttributes": { "allOf": [ { "$ref": "#/components/schemas/EndpointAttributes" }, { "description": "The attributes of an Endpoint." } ] }, "ClientRequestToken": { "allOf": [ { "$ref": "#/components/schemas/ClientRequestToken" }, { "description": "The unique ID assigned to the request. Use different tokens to register other endpoints." } ] }, "AllowMessages": { "allOf": [ { "$ref": "#/components/schemas/AllowMessages" }, { "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." } ] } } }, "TagValue": { "type": "string", "minLength": 1, "maxLength": 256, "format": "password" }, "TagKeyList": { "type": "array", "items": { "$ref": "#/components/schemas/TagKey" }, "minItems": 1, "maxItems": 50 }, "TagResourceRequest": { "type": "object", "required": [ "ResourceARN", "Tags" ], "title": "TagResourceRequest", "properties": { "ResourceARN": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The resource ARN." } ] }, "Tags": { "allOf": [ { "$ref": "#/components/schemas/TagList" }, { "description": "The tag key-value pairs." } ] } } }, "UntagResourceRequest": { "type": "object", "required": [ "ResourceARN", "TagKeys" ], "title": "UntagResourceRequest", "properties": { "ResourceARN": { "allOf": [ { "$ref": "#/components/schemas/ChimeArn" }, { "description": "The resource ARN." } ] }, "TagKeys": { "allOf": [ { "$ref": "#/components/schemas/TagKeyList" }, { "description": "The tag keys." } ] } } }, "UpdateAppInstanceBotRequest": { "type": "object", "required": [ "Name", "Metadata" ], "title": "UpdateAppInstanceBotRequest", "properties": { "Name": { "allOf": [ { "$ref": "#/components/schemas/ResourceName" }, { "description": "The name of the AppInstanceBot." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of the AppInstanceBot." } ] } } }, "UpdateAppInstanceRequest": { "type": "object", "required": [ "Name", "Metadata" ], "title": "UpdateAppInstanceRequest", "properties": { "Name": { "allOf": [ { "$ref": "#/components/schemas/NonEmptyResourceName" }, { "description": "The name that you want to change." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata that you want to change." } ] } } }, "UpdateAppInstanceUserEndpointRequest": { "type": "object", "title": "UpdateAppInstanceUserEndpointRequest", "properties": { "Name": { "allOf": [ { "$ref": "#/components/schemas/SensitiveString1600" }, { "description": "The name of the AppInstanceUserEndpoint." } ] }, "AllowMessages": { "allOf": [ { "$ref": "#/components/schemas/AllowMessages" }, { "description": "Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages." } ] } } }, "UpdateAppInstanceUserRequest": { "type": "object", "required": [ "Name", "Metadata" ], "title": "UpdateAppInstanceUserRequest", "properties": { "Name": { "allOf": [ { "$ref": "#/components/schemas/UserName" }, { "description": "The name of the AppInstanceUser." } ] }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "description": "The metadata of the AppInstanceUser." } ] } } } } }, "security": [ { "hmac": [] } ] }