openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 111 kB

JSON

{"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 <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Identity.html\">Amazon Chime SDK identity</a>.","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 <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API. <code>CreateAppInstance</code> 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 <code>AppInstance</code>.","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 <code>AppInstance</code>. 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 <code>AppInstances</code>.","type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":2,"maxLength":64},"Tags":{"description":"Tags assigned to the <code>AppInstance</code>.","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 <code>AppInstance</code>s 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 <code>AppInstance</code>s 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 <code>AppInstances</code>.","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 <code>AppInstanceUser</code> or <code>AppInstanceBot</code> to an <code>AppInstanceAdmin</code>. The promoted entity can perform the following actions. <ul> <li> <code>ChannelModerator</code> actions across all channels in the <code>AppInstance</code>. </li> <li> <code>DeleteChannelMessage</code> actions. </li> </ul> Only an <code>AppInstanceUser</code> and <code>AppInstanceBot</code> can be promoted to an <code>AppInstanceAdmin</code> 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 <code>AppInstance</code>.","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 <code>AppInstance</code>.","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 <code>AppInstance</code>.","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 <code>AppInstance</code>.","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 <code>AppInstance</code>. The request consists of a unique <code>Configuration</code> and <code>Name</code> 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 <code>AppInstance</code> 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 <code>AppInstanceBots</code>.","type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":2,"maxLength":64},"Tags":{"description":"The tags assigned to the <code>AppInstanceBot</code>.","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 <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> 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 <code>AppInstance</code> 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 <code>AppInstance</code>.","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 <code>AppInstances</code>.","type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":2,"maxLength":64},"Tags":{"description":"Tags assigned to the <code>AppInstanceUser</code>.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":50},"ExpirationSettings":{"description":"Determines the interval after which an <code>AppInstanceUser</code> is automatically deleted.","type":"object","properties":{"ExpirationDays":{"allOf":[{"$ref":"#/components/schemas/ExpirationDays"},{"description":"The period in days after which an <code>AppInstanceUser</code> will be automatically deleted."}]},"ExpirationCriterion":{"allOf":[{"$ref":"#/components/schemas/ExpirationCriterion"},{"description":"Specifies the conditions under which an <code>AppInstanceUser</code> 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 <code>AppInstance</code> 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 <code>AppInstance</code>.","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 <code>AppInstance</code>.","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 <code>AppInstance</code>.","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 <code>AppInstance</code> 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 <code>AppInstance</code>.","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 <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code> or <code>AppInstanceBot</code>. 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 <code>AppInstance</code>'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 <code>AppInstance</code>.","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 <code>AppInstanceAdmin</code>.","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 <code>AppInstanceAdmin</code>.","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 <code>AppInstance</code>.","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 <code>AppInstanceBot</code>.","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 <code>AppInstanceBot</code> 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 <code>AppInstanceBot's</code> 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 <code>AppInstanceBot</code>.","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 <code>AppInstanceBot</code>.","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 <code>AppInstanceBot</code>.","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 <code>AppInstanceBot</code>.","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 <code>AppInstanceBot</code>.","type":"string","pattern":".*","minLength":0,"maxLength":1024,"format":"password"},"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."}]}}}}}}}}}},"/app-instance-users/{appInstanceUserArn}":{"delete":{"operationId":"DeleteAppInstanceUser","description":"Deletes an <code>AppInstanceUser</code>.","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 <code>AppInstanceUser</code>.","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 <code>AppInstanceUser</code>.","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 <code>AppInstanceUser</code>. 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 <code>AppInstanceUser</code>.","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 <code>AppInstanceUser</code>.","type":"string","pattern":".*\\S.*","minLength":1,"maxLength":100,"format":"password"},"Metadata":{"description":"The metadata of the <code>AppInstanceUser</code>.","type":"string","pattern":".*","minLength":0,"maxLength":1024,"format":"password"}}}}}}}},"/app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}":{"delete":{"operationId":"DeregisterAppInstanceUserEndpoint","description":"Deregisters an <code>AppInstanceUserEndpoint</code>.","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 <code>AppInstanceUser</code>.","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":"endpointId","in":"path","required":true,"description":"The unique identifier of the <code>AppInstanceUserEndpoint</code>.","schema":{"type":"string","pattern":".*","minLength":0,"maxLength":64}}]},"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 <code>AppInstanceUserEndpoint</code>.","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 <code>AppInstanceUser</code>.","schema":{"type":"string","pattern":".*","minLength":0,"maxLength":1600}},{"name":"endpointId","in":"path","required":true,"description":"The unique identifier of the <code>AppInstanceUserEndpoint</code>.","schema":{"type":"string","pattern":".*","minLength":0,"maxLength":64}}]},"put":{"operationId":"UpdateAppInstanceUserEndpoint","description":"Updates the details of an <code>AppInstanceUserEndpoint</code>. You can update the name and <code>AllowMessage</code> 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 <code>AppInstanceUser</code>.","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":"endpointId","in":"path","required":true,"description":"The unique identifier of the <code>AppInstanceUserEndpoint</code>.","schema":{"type":"string","pattern":".*","minLength":0,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Name":{"description":"The name of the <code>AppInstanceUserEndpoint</code>.","type":"string","pattern":".*","minLength":0,"maxLength":1600,"format":"password"},"AllowMessages":{"description":"Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> 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 <code>AppInstance</code>.","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 <code>AppInstance</code>.","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":"PutAppInsta