"documentation":"<p>Adds a specified number of users to a channel. </p>"
},
"CreateChannel":{
"name":"CreateChannel",
"http":{
"method":"POST",
"requestUri":"/channels",
"responseCode":201
},
"input":{"shape":"CreateChannelRequest"},
"output":{"shape":"CreateChannelResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ConflictException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Creates a channel to which you can add users and send messages.</p> <p> <b>Restriction</b>: You can't change a channel's privacy.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
},
"CreateChannelBan":{
"name":"CreateChannelBan",
"http":{
"method":"POST",
"requestUri":"/channels/{channelArn}/bans",
"responseCode":201
},
"input":{"shape":"CreateChannelBanRequest"},
"output":{"shape":"CreateChannelBanResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ConflictException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>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.</p> <p>If you ban a user who is already part of a channel, that user is automatically kicked from the channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Adds a user to a channel. The <code>InvitedBy</code> response field is derived from the request header. A channel member can:</p> <ul> <li> <p>List messages</p> </li> <li> <p>Send messages</p> </li> <li> <p>Receive messages</p> </li> <li> <p>Edit their own messages</p> </li> <li> <p>Leave the channel</p> </li> </ul> <p>Privacy settings impact this action as follows:</p> <ul> <li> <p>Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.</p> </li> <li> <p>Private Channels: You must be a member to list or send messages.</p> </li> </ul> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p> <ul> <li> <p>Add and remove other members of the channel.</p> </li> <li> <p>Add and remove other moderators of the channel.</p> </li> <li> <p>Add and remove user bans for the channel.</p> </li> <li> <p>Redact messages in the channel.</p> </li> <li> <p>List messages in the channel.</p> </li> </ul> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
},
"DeleteChannel":{
"name":"DeleteChannel",
"http":{
"method":"DELETE",
"requestUri":"/channels/{channelArn}",
"responseCode":204
},
"input":{"shape":"DeleteChannelRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Removes a user from a channel's ban list.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Removes a member from a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by <code>UpdateChannelMessage</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Deletes a channel moderator.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
},
"DescribeChannel":{
"name":"DescribeChannel",
"http":{
"method":"GET",
"requestUri":"/channels/{channelArn}",
"responseCode":200
},
"input":{"shape":"DescribeChannelRequest"},
"output":{"shape":"DescribeChannelResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Returns the full details of a channel in an Amazon Chime <code>AppInstance</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Returns the full details of a channel ban.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Returns the full details of a user's channel membership.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p> Returns the details of a channel based on the membership of the specified <code>AppInstanceUser</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Returns the full details of a channel moderated by the specified <code>AppInstanceUser</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Returns the full details of a single ChannelModerator.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Gets the full details of a channel message.</p> <note> <p>The x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>The details of the endpoint for the messaging session.</p>"
},
"ListChannelBans":{
"name":"ListChannelBans",
"http":{
"method":"GET",
"requestUri":"/channels/{channelArn}/bans",
"responseCode":200
},
"input":{"shape":"ListChannelBansRequest"},
"output":{"shape":"ListChannelBansResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Lists all the users banned from a particular channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Lists all channel memberships in a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
},
"ListChannelMessages":{
"name":"ListChannelMessages",
"http":{
"method":"GET",
"requestUri":"/channels/{channelArn}/messages",
"responseCode":200
},
"input":{"shape":"ListChannelMessagesRequest"},
"output":{"shape":"ListChannelMessagesResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>List all the messages in a channel. Returns a paginated list of <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending order.</p> <note> <p>Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.</p> <p>Also, the x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Lists all the moderators for a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
},
"ListChannels":{
"name":"ListChannels",
"http":{
"method":"GET",
"requestUri":"/channels",
"responseCode":200
},
"input":{"shape":"ListChannelsRequest"},
"output":{"shape":"ListChannelsResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.</p> <p class=\"title\"> <b>Functionality & restrictions</b> </p> <ul> <li> <p>Use privacy = <code>PUBLIC</code> to retrieve all public channels in the account.</p> </li> <li> <p>Only an <code>AppInstanceAdmin</code> can set privacy = <code>PRIVATE</code> to list the private channels in an account.</p> </li> </ul> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
},
"SendChannelMessage":{
"name":"SendChannelMessage",
"http":{
"method":"POST",
"requestUri":"/channels/{channelArn}/messages",
"responseCode":201
},
"input":{"shape":"SendChannelMessageRequest"},
"output":{"shape":"SendChannelMessageResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Sends a message to a particular channel that the member is a part of.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata. <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p> </note>"
},
"UpdateChannel":{
"name":"UpdateChannel",
"http":{
"method":"PUT",
"requestUri":"/channels/{channelArn}",
"responseCode":200
},
"input":{"shape":"UpdateChannelRequest"},
"output":{"shape":"UpdateChannelResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ConflictException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Update a channel's attributes.</p> <p> <b>Restriction</b>: You can't change a channel's privacy. </p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>Updates the content of a message.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
"documentation":"<p>The details of the time when a user last read messages in a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
}
},
"shapes":{
"AppInstanceUserMembershipSummary":{
"type":"structure",
"members":{
"Type":{
"shape":"ChannelMembershipType",
"documentation":"<p>The type of <code>ChannelMembership</code>.</p>"
},
"ReadMarkerTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The time at which a message was last read.</p>"
}
},
"documentation":"<p>Summary of the membership details of an <code>AppInstanceUser</code>.</p>"
},
"BadRequestException":{
"type":"structure",
"members":{
"Code":{"shape":"ErrorCode"},
"Message":{"shape":"String"}
},
"documentation":"<p>The input parameters don't match the service's restrictions.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"BatchChannelMemberships":{
"type":"structure",
"members":{
"InvitedBy":{
"shape":"Identity",
"documentation":"<p>The identifier of the member who invited another member.</p>"
},
"Type":{
"shape":"ChannelMembershipType",
"documentation":"<p>The membership types set for the channel users.</p>"
},
"Members":{
"shape":"Members",
"documentation":"<p>The users successfully added to the request.</p>"
},
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel to which you're adding users.</p>"
}
},
"documentation":"<p>The membership information, including member ARNs, the channel ARN, and membership types.</p>"
},
"BatchCreateChannelMembershipError":{
"type":"structure",
"members":{
"MemberArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the member that the service couldn't add.</p>"
},
"ErrorCode":{
"shape":"ErrorCode",
"documentation":"<p>The error code.</p>"
},
"ErrorMessage":{
"shape":"String",
"documentation":"<p>The error message.</p>"
}
},
"documentation":"<p>A list of failed member ARNs, error codes, and error messages.</p>"
"documentation":"<p>The ARN of the channel to which you're adding users.</p>",
"location":"uri",
"locationName":"channelArn"
},
"Type":{
"shape":"ChannelMembershipType",
"documentation":"<p>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.</p>"
},
"MemberArns":{
"shape":"MemberArns",
"documentation":"<p>The ARNs of the members you want to add to the channel.</p>"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"BatchCreateChannelMembershipResponse":{
"type":"structure",
"members":{
"BatchChannelMemberships":{
"shape":"BatchChannelMemberships",
"documentation":"<p>The list of channel memberships in the response.</p>"
},
"Errors":{
"shape":"BatchCreateChannelMembershipErrors",
"documentation":"<p>If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.</p>"
"documentation":"<p>The request could not be processed because of conflict in the current state of the resource.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"Content":{
"type":"string",
"max":4096,
"min":0,
"pattern":"[\\s\\S]*",
"sensitive":true
},
"CreateChannelBanRequest":{
"type":"structure",
"required":[
"ChannelArn",
"MemberArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the ban request.</p>",
"location":"uri",
"locationName":"channelArn"
},
"MemberArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the member being banned.</p>"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"CreateChannelBanResponse":{
"type":"structure",
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the response to the ban request.</p>"
},
"Member":{
"shape":"Identity",
"documentation":"<p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban response.</p>"
}
}
},
"CreateChannelMembershipRequest":{
"type":"structure",
"required":[
"ChannelArn",
"MemberArn",
"Type",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel to which you're adding users.</p>",
"location":"uri",
"locationName":"channelArn"
},
"MemberArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the member you want to add to the channel.</p>"
},
"Type":{
"shape":"ChannelMembershipType",
"documentation":"<p>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.</p>"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"CreateChannelMembershipResponse":{
"type":"structure",
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>"
},
"Member":{
"shape":"Identity",
"documentation":"<p>The ARN and metadata of the member being added.</p>"
}
}
},
"CreateChannelModeratorRequest":{
"type":"structure",
"required":[
"ChannelArn",
"ChannelModeratorArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>",
"location":"uri",
"locationName":"channelArn"
},
"ChannelModeratorArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the moderator.</p>"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"CreateChannelModeratorResponse":{
"type":"structure",
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>"
},
"ChannelModerator":{
"shape":"Identity",
"documentation":"<p>The ARNs of the channel and the moderator.</p>"
}
}
},
"CreateChannelRequest":{
"type":"structure",
"required":[
"AppInstanceArn",
"Name",
"ClientRequestToken",
"ChimeBearer"
],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel request.</p>"
},
"Name":{
"shape":"NonEmptyResourceName",
"documentation":"<p>The name of the channel.</p>"
},
"Mode":{
"shape":"ChannelMode",
"documentation":"<p>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.</p>"
},
"Privacy":{
"shape":"ChannelPrivacy",
"documentation":"<p>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>.</p>"
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>The metadata of the creation request. Limited to 1KB and UTF-8.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>The client token for the request. An <code>Idempotency</code> token.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags for the creation request.</p>"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"CreateChannelResponse":{
"type":"structure",
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>"
}
}
},
"DeleteChannelBanRequest":{
"type":"structure",
"required":[
"ChannelArn",
"MemberArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel from which the <code>AppInstanceUser</code> was banned.</p>",
"location":"uri",
"locationName":"channelArn"
},
"MemberArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstanceUser</code> that you want to reinstate.</p>",
"location":"uri",
"locationName":"memberArn"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"DeleteChannelMembershipRequest":{
"type":"structure",
"required":[
"ChannelArn",
"MemberArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel from which you want to remove the user.</p>",
"location":"uri",
"locationName":"channelArn"
},
"MemberArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the member that you're removing from the channel.</p>",
"location":"uri",
"locationName":"memberArn"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"DeleteChannelMessageRequest":{
"type":"structure",
"required":[
"ChannelArn",
"MessageId",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>",
"location":"uri",
"locationName":"channelArn"
},
"MessageId":{
"shape":"MessageId",
"documentation":"<p>The ID of the message being deleted.</p>",
"location":"uri",
"locationName":"messageId"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"DeleteChannelModeratorRequest":{
"type":"structure",
"required":[
"ChannelArn",
"ChannelModeratorArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>",
"location":"uri",
"locationName":"channelArn"
},
"ChannelModeratorArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the moderator being deleted.</p>",
"location":"uri",
"locationName":"channelModeratorArn"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"DeleteChannelRequest":{
"type":"structure",
"required":[
"ChannelArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel being deleted.</p>",
"location":"uri",
"locationName":"channelArn"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"DescribeChannelBanRequest":{
"type":"structure",
"required":[
"ChannelArn",
"MemberArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel from which the user is banned.</p>",
"location":"uri",
"locationName":"channelArn"
},
"MemberArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the member being banned.</p>",
"location":"uri",
"locationName":"memberArn"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"documentation":"<p>The token passed by previous API calls until all requested users are returned.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested users are returned.</p>"
}
}
},
"ListChannelMembershipsRequest":{
"type":"structure",
"required":[
"ChannelArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The maximum number of channel memberships that you want returned.</p>",
"location":"uri",
"locationName":"channelArn"
},
"Type":{
"shape":"ChannelMembershipType",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"type"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of channel memberships that you want returned.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested channel memberships are returned.</p>",
"location":"querystring",
"locationName":"next-token"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"ListChannelMembershipsResponse":{
"type":"structure",
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>"
},
"ChannelMemberships":{
"shape":"ChannelMembershipSummaryList",
"documentation":"<p>The information for the requested channel memberships.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested channel memberships are returned.</p>"
}
}
},
"ListChannelMessagesRequest":{
"type":"structure",
"required":[
"ChannelArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>",
"location":"uri",
"locationName":"channelArn"
},
"SortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order in which you want messages sorted. Default is Descending, based on time created.</p>",
"location":"querystring",
"locationName":"sort-order"
},
"NotBefore":{
"shape":"Timestamp",
"documentation":"<p>The initial or starting time stamp for your requested messages.</p>",
"location":"querystring",
"locationName":"not-before"
},
"NotAfter":{
"shape":"Timestamp",
"documentation":"<p>The final or ending time stamp for your requested messages.</p>",
"location":"querystring",
"locationName":"not-after"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of messages that you want returned.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested messages are returned.</p>",
"location":"querystring",
"locationName":"next-token"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"ListChannelMessagesResponse":{
"type":"structure",
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel containing the requested messages.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested messages are returned.</p>"
},
"ChannelMessages":{
"shape":"ChannelMessageSummaryList",
"documentation":"<p>The information about, and content of, each requested message.</p>"
}
}
},
"ListChannelModeratorsRequest":{
"type":"structure",
"required":[
"ChannelArn",
"ChimeBearer"
],
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>",
"location":"uri",
"locationName":"channelArn"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of moderators that you want returned.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested moderators are returned.</p>",
"location":"querystring",
"locationName":"next-token"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"ListChannelModeratorsResponse":{
"type":"structure",
"members":{
"ChannelArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the channel.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested moderators are returned.</p>"
},
"ChannelModerators":{
"shape":"ChannelModeratorSummaryList",
"documentation":"<p>The information about and names of each moderator.</p>"
}
}
},
"ListChannelsModeratedByAppInstanceUserRequest":{
"type":"structure",
"required":["ChimeBearer"],
"members":{
"AppInstanceUserArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the user in the moderated channel.</p>",
"location":"querystring",
"locationName":"app-instance-user-arn"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of channels in the request.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned from previous API requests until the number of channels moderated by the user is reached.</p>",
"location":"querystring",
"locationName":"next-token"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"documentation":"<p>The moderated channels in the request.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned from previous API requests until the number of channels moderated by the user is reached.</p>"
}
}
},
"ListChannelsRequest":{
"type":"structure",
"required":[
"AppInstanceArn",
"ChimeBearer"
],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"querystring",
"locationName":"app-instance-arn"
},
"Privacy":{
"shape":"ChannelPrivacy",
"documentation":"<p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels. <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code> can retrieve private channels. </p>",
"location":"querystring",
"locationName":"privacy"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of channels that you want to return.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested channels are returned.</p>",
"location":"querystring",
"locationName":"next-token"
},
"ChimeBearer":{
"shape":"ChimeArn",
"documentation":"<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"location":"header",
"locationName":"x-amz-chime-bearer"
}
}
},
"ListChannelsResponse":{
"type":"structure",
"members":{
"Channels":{
"shape":"ChannelSummaryList",
"documentation":"<p>The information about each channel.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned from previous API requests until the number of channels is reached.</p>"
}
}
},
"MaxResults":{
"type":"integer",
"max":50,
"min":1
},
"MemberArns":{
"type":"list",
"member":{"shape":"ChimeArn"},
"max":100,
"min":1
},
"Members":{
"type":"list",
"member":{"shape":"Identity"}
},
"MessageId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[-_a-zA-Z0-9]*"
},
"MessagingSessionEndpoint":{
"type":"structure",
"members":{
"Url":{
"shape":"UrlType",
"documentation":"<p>The endpoint to which you establish a websocket connection.</p>"
}
},
"documentation":"<p>The websocket endpoint used to connect to Amazon Chime SDK messaging.</p>"
"documentation":"<p>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\">Amazon Chime SDK messaging</a> </p>"
