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 • 223 kB

JSON

{"openapi":"3.0.0","info":{"version":"2021-05-15","x-release":"v4","title":"Amazon Chime SDK Messaging","description":"The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html\">Amazon Chime SDK messaging</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-messaging","x-aws-signingName":"chime","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/chime-sdk-messaging-2021-05-15.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/messaging-chime/"},"servers":[{"url":"http://messaging-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 Messaging multi-region endpoint"},{"url":"https://messaging-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 Messaging multi-region endpoint"},{"url":"http://messaging-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 Messaging endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://messaging-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 Messaging endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/channels/{channelArn}/channel-flow#x-amz-chime-bearer":{"put":{"operationId":"AssociateChannelFlow","description":"Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the <code>DisassociateChannelFlow</code> API. <note> Only administrators or channel moderators can associate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","responses":{"200":{"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":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"UnauthorizedClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedClientException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"ThrottledClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledClientException"}}}},"486":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"487":{"description":"ServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceFailureException"}}}}},"parameters":[{"name":"channelArn","in":"path","required":true,"description":"The ARN of the channel.","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":"x-amz-chime-bearer","in":"header","required":true,"description":"The <code>AppInstanceUserArn</code> of the user making the API call.","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":["ChannelFlowArn"],"properties":{"ChannelFlowArn":{"description":"The ARN of the channel flow.","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"}]},"/channels/{channelArn}/memberships#operation=batch-create&x-amz-chime-bearer":{"post":{"operationId":"BatchCreateChannelMembership","description":"Adds a specified number of users and bots to a channel. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateChannelMembershipResponse"}}}},"480":{"description":"ServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceFailureException"}}}},"481":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"482":{"description":"UnauthorizedClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedClientException"}}}},"483":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"486":{"description":"ThrottledClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledClientException"}}}},"487":{"description":"ResourceLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceededException"}}}}},"parameters":[{"name":"channelArn","in":"path","required":true,"description":"The ARN of the channel to which you're adding users or bots.","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":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":"operation","in":"query","required":true,"schema":{"type":"string","enum":["batch-create"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MemberArns"],"properties":{"Type":{"description":"The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.","type":"string","enum":["DEFAULT","HIDDEN"]},"MemberArns":{"description":"The ARNs of the members you want to add to the channel. Only <code>AppInstanceUsers</code> and <code>AppInstanceBots</code> can be added as a channel member.","type":"array","items":{"$ref":"#/components/schemas/ChimeArn"},"minItems":1,"maxItems":100},"SubChannelId":{"description":"The ID of the SubChannel in the request. <note> Only required when creating membership in a SubChannel for a moderator in an elastic channel. </note>","type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":1,"maxLength":128}}}}}}},"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"}]},"/channels/{channelArn}#operation=channel-flow-callback":{"post":{"operationId":"ChannelFlowCallback","description":"Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. You can return one of the following processing responses: <ul> <li> Update message content or metadata </li> <li> Deny a message </li> <li> Make no changes to the message </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelFlowCallbackResponse"}}}},"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":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"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":"channelArn","in":"path","required":true,"description":"The ARN of the channel.","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":"operation","in":"query","required":true,"schema":{"type":"string","enum":["channel-flow-callback"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallbackId","ChannelMessage"],"properties":{"CallbackId":{"description":"The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.","type":"string","minLength":32,"maxLength":64},"DeleteResource":{"description":"When a processor determines that a message needs to be <code>DENIED</code>, pass this parameter with a value of true.","type":"boolean"},"ChannelMessage":{"description":"Stores information about a callback.","type":"object","properties":{"MessageId":{"allOf":[{"$ref":"#/components/schemas/MessageId"},{"description":"The message ID."}]},"Content":{"allOf":[{"$ref":"#/components/schemas/NonEmptyContent"},{"description":"The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html\">Processing responses from an AppInstanceBot</a> in the Amazon Chime SDK Messaging Developer Guide."}]},"Metadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"description":"The message metadata."}]},"PushNotification":{"allOf":[{"$ref":"#/components/schemas/PushNotificationConfiguration"},{"description":"The push notification configuration of the message."}]},"MessageAttributes":{"allOf":[{"$ref":"#/components/schemas/MessageAttributeMap"},{"description":"The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html\">Processing responses from an AppInstanceBot</a> in the Amazon Chime SDK Messaging Developer Guide."}]},"SubChannelId":{"allOf":[{"$ref":"#/components/schemas/SubChannelId"},{"description":"The ID of the SubChannel."}]},"ContentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"},{"description":"The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to <a href=\"https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html\">Processing responses from an AppInstanceBot</a> in the Amazon Chime SDK Messaging Developer Guide."}]}}}}}}}}},"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"}]},"/channels#x-amz-chime-bearer":{"post":{"operationId":"CreateChannel","description":"Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelResponse"}}}},"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":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ResourceLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceededException"}}}},"485":{"description":"ThrottledClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledClientException"}}}},"486":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"487":{"description":"ServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceFailureException"}}}}},"parameters":[{"name":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":["AppInstanceArn","Name","ClientRequestToken"],"properties":{"AppInstanceArn":{"description":"The ARN of the channel 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 name of the channel.","type":"string","pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*","minLength":1,"maxLength":256,"format":"password"},"Mode":{"description":"The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.","type":"string","enum":["UNRESTRICTED","RESTRICTED"]},"Privacy":{"description":"The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the <code>AppInstance</code>.","type":"string","enum":["PUBLIC","PRIVATE"]},"Metadata":{"description":"The metadata of the creation request. Limited to 1KB and UTF-8.","type":"string","pattern":".*","minLength":0,"maxLength":1024,"format":"password"},"ClientRequestToken":{"description":"The client token for the request. An <code>Idempotency</code> token.","type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":2,"maxLength":64,"format":"password"},"Tags":{"description":"The tags for the creation request.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":50},"ChannelId":{"description":"The ID of the channel in the request.","type":"string","pattern":"[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?","minLength":1,"maxLength":64,"format":"password"},"MemberArns":{"description":"The ARNs of the channel members in the request.","type":"array","items":{"$ref":"#/components/schemas/ChimeArn"},"minItems":1,"maxItems":10},"ModeratorArns":{"description":"The ARNs of the channel moderators in the request.","type":"array","items":{"$ref":"#/components/schemas/ChimeArn"},"minItems":1,"maxItems":10},"ElasticChannelConfiguration":{"description":"The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.","type":"object","properties":{"MaximumSubChannels":{"allOf":[{"$ref":"#/components/schemas/MaximumSubChannels"},{"description":"The maximum number of SubChannels that you want to allow in the elastic channel."}]},"TargetMembershipsPerSubChannel":{"allOf":[{"$ref":"#/components/schemas/TargetMembershipsPerSubChannel"},{"description":"The maximum number of members allowed in a SubChannel."}]},"MinimumMembershipPercentage":{"allOf":[{"$ref":"#/components/schemas/MinimumMembershipPercentage"},{"description":"The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel."}]}}},"ExpirationSettings":{"description":"Settings that control the interval after which a channel is deleted.","type":"object","properties":{"ExpirationDays":{"allOf":[{"$ref":"#/components/schemas/ExpirationDays"},{"description":"The period in days after which the system automatically deletes a channel."}]},"ExpirationCriterion":{"allOf":[{"$ref":"#/components/schemas/ExpirationCriterion"},{"description":"The conditions that must be met for a channel to 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"}]},"/channels/{channelArn}/bans#x-amz-chime-bearer":{"post":{"operationId":"CreateChannelBan","description":"Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelBanResponse"}}}},"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":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ResourceLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceededException"}}}},"485":{"description":"ThrottledClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledClientException"}}}},"486":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"487":{"description":"ServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceFailureException"}}}}},"parameters":[{"name":"channelArn","in":"path","required":true,"description":"The ARN of the ban request.","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":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":["MemberArn"],"properties":{"MemberArn":{"description":"The <code>AppInstanceUserArn</code> of the member being banned.","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":"ListChannelBans","description":"Lists all the users and bots banned from a particular channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelBansResponse"}}}},"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":"channelArn","in":"path","required":true,"description":"The ARN of the channel.","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 bans 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 bans are returned.","schema":{"type":"string","pattern":".*","minLength":0,"maxLength":2048,"format":"password"}},{"name":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/channel-flows":{"post":{"operationId":"CreateChannelFlow","description":"Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API. Channel flows process the following items: <ol> <li> New and updated messages </li> <li> Persistent and non-persistent messages </li> <li> The Standard message type </li> </ol> <note> Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to <a href=\"https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types\">Message types</a> in the Amazon Chime developer guide. </note>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelFlowResponse"}}}},"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":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ResourceLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceededException"}}}},"485":{"description":"ThrottledClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledClientException"}}}},"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","Processors","Name","ClientRequestToken"],"properties":{"AppInstanceArn":{"description":"The ARN of the channel flow 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},"Processors":{"description":"Information about the processor Lambda functions.","type":"array","items":{"$ref":"#/components/schemas/Processor"},"minItems":1,"maxItems":3},"Name":{"description":"The name of the channel flow.","type":"string","pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*","minLength":1,"maxLength":256,"format":"password"},"Tags":{"description":"The tags for the creation request.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":50},"ClientRequestToken":{"description":"The client token for the request. An Idempotency token.","type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":2,"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"}]},"/channels/{channelArn}/memberships#x-amz-chime-bearer":{"post":{"operationId":"CreateChannelMembership","description":"Adds a member to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the request header. A channel member can: <ul> <li> List messages </li> <li> Send messages </li> <li> Receive messages </li> <li> Edit their own messages </li> <li> Leave the channel </li> </ul> Privacy settings impact this action as follows: <ul> <li> Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. </li> <li> Private Channels: You must be a member to list or send messages. </li> </ul> <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelMembershipResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"UnauthorizedClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedClientException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"ResourceLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceededException"}}}},"486":{"description":"ThrottledClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledClientException"}}}},"487":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"488":{"description":"ServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceFailureException"}}}}},"parameters":[{"name":"channelArn","in":"path","required":true,"description":"The ARN of the channel to which you're adding users.","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":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":["MemberArn","Type"],"properties":{"MemberArn":{"description":"The <code>AppInstanceUserArn</code> of the member you want to add to the channel.","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},"Type":{"description":"The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.","type":"string","enum":["DEFAULT","HIDDEN"]},"SubChannelId":{"description":"The ID of the SubChannel in the request. <note> Only required when creating membership in a SubChannel for a moderator in an elastic channel. </note>","type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":1,"maxLength":128}}}}}}},"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":"ListChannelMemberships","description":"Lists all channel memberships in a channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note> If you want to list the channels to which a specific app instance user belongs, see the <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html\">ListChannelMembershipsForAppInstanceUser</a> API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelMembershipsResponse"}}}},"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":"channelArn","in":"path","required":true,"description":"The maximum number of channel memberships that you want returned.","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":"type","in":"query","required":false,"description":"The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are returned as part of <code>ListChannelMemberships</code> if no type is specified. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>.","schema":{"type":"string","enum":["DEFAULT","HIDDEN"]}},{"name":"max-results","in":"query","required":false,"description":"The maximum number of channel memberships 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 channel memberships are returned.","schema":{"type":"string","pattern":".*","minLength":0,"maxLength":2048,"format":"password"}},{"name":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":"sub-channel-id","in":"query","required":false,"description":"The ID of the SubChannel in the request. <note> Only required when listing a user's memberships in a particular sub-channel of an elastic channel. </note>","schema":{"type":"string","pattern":"[-_a-zA-Z0-9]*","minLength":1,"maxLength":128}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/channels/{channelArn}/moderators#x-amz-chime-bearer":{"post":{"operationId":"CreateChannelModerator","description":"Creates a new <code>ChannelModerator</code>. A channel moderator can: <ul> <li> Add and remove other members of the channel. </li> <li> Add and remove other moderators of the channel. </li> <li> Add and remove user bans for the channel. </li> <li> Redact messages in the channel. </li> <li> List messages in the channel. </li> </ul> <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>of the user that makes the API call as the value in the header. </note>","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelModeratorResponse"}}}},"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":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ResourceLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceLimitExceededException"}}}},"485":{"description":"ThrottledClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledClientException"}}}},"486":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"487":{"description":"ServiceFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceFailureException"}}}}},"parameters":[{"name":"channelArn","in":"path","required":true,"description":"The ARN of the channel.","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":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":["ChannelModeratorArn"],"properties":{"ChannelModeratorArn":{"description":"The <code>AppInstanceUserArn</code> of the moderator.","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":"ListChannelModerators","description":"Lists all the moderators for a channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelModeratorsResponse"}}}},"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":"channelArn","in":"path","required":true,"description":"The ARN of the channel.","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 moderators 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 moderators are returned.","schema":{"type":"string","pattern":".*","minLength":0,"maxLength":2048,"format":"password"}},{"name":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/channels/{channelArn}#x-amz-chime-bearer":{"delete":{"operationId":"DeleteChannel","description":"Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","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":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"UnauthorizedClientException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedClientException"}}}},"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":"channelArn","in":"path","required":true,"description":"The ARN of the channel 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}},{"name":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":"DescribeChannel","description":"Returns the full details of a channel in an Amazon Chime <code>AppInstance</code>. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeChannelResponse"}}}},"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":"channelArn","in":"path","required":true,"description":"The ARN of the channel.","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":"x-amz-chime-bearer","in":"header","required":true,"description":"The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.","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":"UpdateChannel","description":"Update a channel's attributes. Restriction: You can't change a channel's privacy. <note> The <code>x-amz-chime-bearer