Skip to content

Commit

Permalink
feat(client-chime-sdk-messaging): ExpirationSettings provides automat…
Browse files Browse the repository at this point in the history
…ic resource deletion for Channels.
  • Loading branch information
awstools committed Mar 23, 2023
1 parent 1e3a44a commit f896a63
Show file tree
Hide file tree
Showing 41 changed files with 1,014 additions and 220 deletions.
8 changes: 8 additions & 0 deletions clients/client-chime-sdk-messaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,14 @@ ListTagsForResource

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/listtagsforresourcecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/listtagsforresourcecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/listtagsforresourcecommandoutput.html)

</details>
<details>
<summary>
PutChannelExpirationSettings
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/putchannelexpirationsettingscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/putchannelexpirationsettingscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/putchannelexpirationsettingscommandoutput.html)

</details>
<details>
<summary>
Expand Down
180 changes: 130 additions & 50 deletions clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,10 @@ import {
ListTagsForResourceCommandInput,
ListTagsForResourceCommandOutput,
} from "./commands/ListTagsForResourceCommand";
import {
PutChannelExpirationSettingsCommandInput,
PutChannelExpirationSettingsCommandOutput,
} from "./commands/PutChannelExpirationSettingsCommand";
import {
PutChannelMembershipPreferencesCommandInput,
PutChannelMembershipPreferencesCommandOutput,
Expand Down Expand Up @@ -243,6 +247,7 @@ export type ServiceInputTypes =
| ListChannelsModeratedByAppInstanceUserCommandInput
| ListSubChannelsCommandInput
| ListTagsForResourceCommandInput
| PutChannelExpirationSettingsCommandInput
| PutChannelMembershipPreferencesCommandInput
| PutMessagingStreamingConfigurationsCommandInput
| RedactChannelMessageCommandInput
Expand Down Expand Up @@ -298,6 +303,7 @@ export type ServiceOutputTypes =
| ListChannelsModeratedByAppInstanceUserCommandOutput
| ListSubChannelsCommandOutput
| ListTagsForResourceCommandOutput
| PutChannelExpirationSettingsCommandOutput
| PutChannelMembershipPreferencesCommandOutput
| PutMessagingStreamingConfigurationsCommandOutput
| RedactChannelMessageCommandOutput
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {}
* <p>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.</p>
* <note>
* <p>Only administrators or channel moderators can associate a channel flow. 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>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.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export interface BatchCreateChannelMembershipCommandOutput

/**
* @public
* <p>Adds a specified number of users to a channel. </p>
* <p>Adds a specified number of users and bots to a channel. </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
* 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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
* 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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe

/**
* @public
* <p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the
* request header. A channel member can:</p>
* <p>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:</p>
* <ul>
* <li>
* <p>List messages</p>
Expand Down Expand Up @@ -74,8 +74,8 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
* </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>
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call
* as the value in the header.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
* </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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>of the user that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {}

/**
* @public
* <p>Removes a user from a channel's ban list.</p>
* <p>Removes a member 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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {}
* 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
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {}
* <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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {}
* <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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
* <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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
* <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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface DescribeChannelMembershipCommandOutput extends DescribeChannelM
* <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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput
/**
* @public
* <p> Returns the details of a channel based on the membership of the specified
* <code>AppInstanceUser</code>.</p>
* <code>AppInstanceUser</code> or <code>AppInstanceBot</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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput
/**
* @public
* <p>Returns the full details of a channel moderated by the specified
* <code>AppInstanceUser</code>.</p>
* <code>AppInstanceUser</code> or <code>AppInstanceBot</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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ export interface DisassociateChannelFlowCommandOutput extends __MetadataBearer {
* <p>Disassociates a channel flow from all its channels. Once disassociated, all messages to
* that channel stop going through the channel flow processor.</p>
* <note>
* <p>Only administrators or channel moderators can disassociate a channel flow. 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>Only administrators or channel moderators can disassociate a channel flow.</p>
* <p>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.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,16 @@ export interface GetChannelMembershipPreferencesCommandOutput

/**
* @public
* <p>Gets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel.
* Only the <code>AppInstanceUser</code> who owns the membership can retrieve preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't retrieve preferences for other users.
* Banned users can't retrieve membership preferences for the channel from which they are banned.</p>
* <p>Gets the membership preferences of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
* for the specified channel. A user or a bot must be a member of the channel and own the membership to be able
* to retrieve membership preferences. Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't
* retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the
* channel from which they are banned.</p>
* <note>
* <p>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.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
* @public
* <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
* <p>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.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
* <p>Only the message sender can invoke this API.</p>
* </li>
* <li>
* <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>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.</p>
* </li>
* </ul>
* </note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _

/**
* @public
* <p>Lists all the users banned from a particular channel.</p>
* <p>Lists all the users and bots 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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
* <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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* <p>If you want to list the channels to which a specific app instance user belongs, see the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput

/**
* @public
* <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>
* <p> Lists all channels that anr <code>AppInstanceUser</code> or <code>AppInstanceBot</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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
* <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
* <p>Also, 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.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface ListChannelModeratorsCommandOutput extends ListChannelModerator
* <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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
* </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
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
* the header.</p>
* </note>
* @example
Expand Down
Loading

0 comments on commit f896a63

Please sign in to comment.