@aws-sdk/client-chime-sdk-messaging 3.297.0 → 3.298.0

package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts

@@ -20,10 +20,10 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extend
 /**
  * @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

package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts

@@ -20,10 +20,10 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends
 /**
  * @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

package/dist-types/commands/DisassociateChannelFlowCommand.d.ts

@@ -22,8 +22,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.

package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts

@@ -19,9 +19,16 @@ export interface GetChannelMembershipPreferencesCommandOutput extends GetChannel
 }
 /**
  * @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

package/dist-types/commands/GetChannelMessageCommand.d.ts

@@ -21,8 +21,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

package/dist-types/commands/GetChannelMessageStatusCommand.d.ts

@@ -49,7 +49,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>

package/dist-types/commands/ListChannelBansCommand.d.ts

@@ -19,10 +19,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

package/dist-types/commands/ListChannelMembershipsCommand.d.ts

@@ -22,7 +22,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

package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts

@@ -19,11 +19,11 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
 }
 /**
  * @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

package/dist-types/commands/ListChannelMessagesCommand.d.ts

@@ -26,8 +26,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

package/dist-types/commands/ListChannelModeratorsCommand.d.ts

@@ -22,7 +22,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

package/dist-types/commands/ListChannelsCommand.d.ts

@@ -36,7 +36,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

package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts

@@ -22,7 +22,7 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
  * <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
+ *             ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
  *             the header.</p>
  *          </note>
  * @example

package/dist-types/commands/PutChannelExpirationSettingsCommand.d.ts

@@ -0,0 +1,99 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
+import { PutChannelExpirationSettingsRequest, PutChannelExpirationSettingsResponse } from "../models/models_0";
+/**
+ * @public
+ *
+ * The input for {@link PutChannelExpirationSettingsCommand}.
+ */
+export interface PutChannelExpirationSettingsCommandInput extends PutChannelExpirationSettingsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutChannelExpirationSettingsCommand}.
+ */
+export interface PutChannelExpirationSettingsCommandOutput extends PutChannelExpirationSettingsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Sets the number of days before the channel is automatically deleted.</p>
+ *          <note>
+ *             <ul>
+ *                <li>
+ *                   <p>A background process deletes expired channels within 6 hours of expiration.
+ *             Actual deletion times may vary.</p>
+ *                </li>
+ *                <li>
+ *                   <p>Expired channels that have not yet been deleted appear as active, and you can update
+ *             their expiration settings. The system honors the new settings.</p>
+ *                </li>
+ *                <li>
+ *                   <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKMessagingClient, PutChannelExpirationSettingsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
+ * // const { ChimeSDKMessagingClient, PutChannelExpirationSettingsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
+ * const client = new ChimeSDKMessagingClient(config);
+ * const command = new PutChannelExpirationSettingsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param PutChannelExpirationSettingsCommandInput - {@link PutChannelExpirationSettingsCommandInput}
+ * @returns {@link PutChannelExpirationSettingsCommandOutput}
+ * @see {@link PutChannelExpirationSettingsCommandInput} for command's `input` shape.
+ * @see {@link PutChannelExpirationSettingsCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be processed because of conflict in the current state of the
+ *          resource.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The client exceeded its request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client is not currently authorized to make the request.</p>
+ *
+ *
+ */
+export declare class PutChannelExpirationSettingsCommand extends $Command<PutChannelExpirationSettingsCommandInput, PutChannelExpirationSettingsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
+    readonly input: PutChannelExpirationSettingsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutChannelExpirationSettingsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutChannelExpirationSettingsCommandInput, PutChannelExpirationSettingsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts

@@ -19,9 +19,16 @@ export interface PutChannelMembershipPreferencesCommandOutput extends PutChannel
 }
 /**
  * @public
- * <p>Sets 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 set preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't set preferences for other users.
- *          Banned users can't set membership preferences for the channel from which they are banned.</p>
+ * <p>Sets the membership preferences of an <code>AppInstanceUser</code> or <code>AppIntanceBot</code>
+ *          for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the
+ *          membership can set preferences. Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't set
+ *          preferences for other users or users. Banned users or bots can't set membership preferences for the channel from
+ *          which they are banned.</p>
+ *          <note>
+ *             <p>The x-amz-chime-bearer request header is mandatory. Use the ARN of an
+ *          <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

package/dist-types/commands/RedactChannelMessageCommand.d.ts

@@ -23,7 +23,7 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR
  *          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
+ *             ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
  *             the header.</p>
  *          </note>
  * @example

package/dist-types/commands/SearchChannelsCommand.d.ts

@@ -19,7 +19,12 @@ export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __M
 }
 /**
  * @public
- * <p>Allows <code>ChimeBearer</code> to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.</p>
+ * <p>Allows the <code>ChimeBearer</code> to search channels by channel members. Users or bots can search
+ *          across the channels that they belong to. Users in the <code>AppInstanceAdmin</code> role can search across
+ *          all channels.</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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/SendChannelMessageCommand.d.ts

@@ -22,7 +22,7 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
  * <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
+ *             ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> 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>

package/dist-types/commands/UpdateChannelCommand.d.ts

@@ -24,7 +24,7 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
  *             <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
+ *             ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
  *             the header.</p>
  *          </note>
  * @example

package/dist-types/commands/UpdateChannelMessageCommand.d.ts

@@ -22,7 +22,7 @@ export interface UpdateChannelMessageCommandOutput extends UpdateChannelMessageR
  * <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
+ *             ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
  *             the header.</p>
  *          </note>
  * @example

package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts

@@ -22,7 +22,7 @@ export interface UpdateChannelReadMarkerCommandOutput extends UpdateChannelReadM
  * <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
+ *             ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
  *             the header.</p>
  *          </note>
  * @example

package/dist-types/commands/index.d.ts

@@ -37,6 +37,7 @@ export * from "./ListChannelsCommand";
 export * from "./ListChannelsModeratedByAppInstanceUserCommand";
 export * from "./ListSubChannelsCommand";
 export * from "./ListTagsForResourceCommand";
+export * from "./PutChannelExpirationSettingsCommand";
 export * from "./PutChannelMembershipPreferencesCommand";
 export * from "./PutMessagingStreamingConfigurationsCommand";
 export * from "./RedactChannelMessageCommand";