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

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

@@ -4,21 +4,26 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListChannelMembershipsForAppInstanceUserRequest, ListChannelMembershipsForAppInstanceUserResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListChannelMembershipsForAppInstanceUserCommand}.
  */
 export interface ListChannelMembershipsForAppInstanceUserCommandInput extends ListChannelMembershipsForAppInstanceUserRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListChannelMembershipsForAppInstanceUserCommand}.
  */
 export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends ListChannelMembershipsForAppInstanceUserResponse, __MetadataBearer {
 }
 /**
- * <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>
+ * @public
+ * <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
@@ -31,6 +36,8 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
  * const response = await client.send(command);
  * ```
  *
+ * @param ListChannelMembershipsForAppInstanceUserCommandInput - {@link ListChannelMembershipsForAppInstanceUserCommandInput}
+ * @returns {@link ListChannelMembershipsForAppInstanceUserCommandOutput}
  * @see {@link ListChannelMembershipsForAppInstanceUserCommandInput} for command's `input` shape.
  * @see {@link ListChannelMembershipsForAppInstanceUserCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +65,20 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
 export declare class ListChannelMembershipsForAppInstanceUserCommand extends $Command<ListChannelMembershipsForAppInstanceUserCommandInput, ListChannelMembershipsForAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListChannelMembershipsForAppInstanceUserCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListChannelMembershipsForAppInstanceUserCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelMembershipsForAppInstanceUserCommandInput, ListChannelMembershipsForAppInstanceUserCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListChannelMessagesRequest, ListChannelMessagesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListChannelMessagesCommand}.
  */
 export interface ListChannelMessagesCommandInput extends ListChannelMessagesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListChannelMessagesCommand}.
  */
 export interface ListChannelMessagesCommandOutput extends ListChannelMessagesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -21,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
@@ -35,6 +40,8 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListChannelMessagesCommandInput - {@link ListChannelMessagesCommandInput}
+ * @returns {@link ListChannelMessagesCommandOutput}
  * @see {@link ListChannelMessagesCommandInput} for command's `input` shape.
  * @see {@link ListChannelMessagesCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -62,11 +69,20 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
 export declare class ListChannelMessagesCommand extends $Command<ListChannelMessagesCommandInput, ListChannelMessagesCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListChannelMessagesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListChannelMessagesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelMessagesCommandInput, ListChannelMessagesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,20 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListChannelModeratorsRequest, ListChannelModeratorsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListChannelModeratorsCommand}.
  */
 export interface ListChannelModeratorsCommandInput extends ListChannelModeratorsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListChannelModeratorsCommand}.
  */
 export interface ListChannelModeratorsCommandOutput extends ListChannelModeratorsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -30,6 +35,8 @@ export interface ListChannelModeratorsCommandOutput extends ListChannelModerator
  * const response = await client.send(command);
  * ```
  *
+ * @param ListChannelModeratorsCommandInput - {@link ListChannelModeratorsCommandInput}
+ * @returns {@link ListChannelModeratorsCommandOutput}
  * @see {@link ListChannelModeratorsCommandInput} for command's `input` shape.
  * @see {@link ListChannelModeratorsCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ListChannelModeratorsCommandOutput extends ListChannelModerator
 export declare class ListChannelModeratorsCommand extends $Command<ListChannelModeratorsCommandInput, ListChannelModeratorsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListChannelModeratorsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListChannelModeratorsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelModeratorsCommandInput, ListChannelModeratorsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListChannelsAssociatedWithChannelFlowRequest, ListChannelsAssociatedWithChannelFlowResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListChannelsAssociatedWithChannelFlowCommand}.
  */
 export interface ListChannelsAssociatedWithChannelFlowCommandInput extends ListChannelsAssociatedWithChannelFlowRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListChannelsAssociatedWithChannelFlowCommand}.
  */
 export interface ListChannelsAssociatedWithChannelFlowCommandOutput extends ListChannelsAssociatedWithChannelFlowResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListChannelsAssociatedWithChannelFlowCommandOutput extends List
  * const response = await client.send(command);
  * ```
  *
+ * @param ListChannelsAssociatedWithChannelFlowCommandInput - {@link ListChannelsAssociatedWithChannelFlowCommandInput}
+ * @returns {@link ListChannelsAssociatedWithChannelFlowCommandOutput}
  * @see {@link ListChannelsAssociatedWithChannelFlowCommandInput} for command's `input` shape.
  * @see {@link ListChannelsAssociatedWithChannelFlowCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListChannelsAssociatedWithChannelFlowCommandOutput extends List
 export declare class ListChannelsAssociatedWithChannelFlowCommand extends $Command<ListChannelsAssociatedWithChannelFlowCommandInput, ListChannelsAssociatedWithChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListChannelsAssociatedWithChannelFlowCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListChannelsAssociatedWithChannelFlowCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsAssociatedWithChannelFlowCommandInput, ListChannelsAssociatedWithChannelFlowCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListChannelsRequest, ListChannelsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListChannelsCommand}.
  */
 export interface ListChannelsCommandInput extends ListChannelsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListChannelsCommand}.
  */
 export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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">
@@ -31,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
@@ -44,6 +49,8 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
+ * @returns {@link ListChannelsCommandOutput}
  * @see {@link ListChannelsCommandInput} for command's `input` shape.
  * @see {@link ListChannelsCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -71,11 +78,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
 export declare class ListChannelsCommand extends $Command<ListChannelsCommandInput, ListChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListChannelsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListChannelsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsCommandInput, ListChannelsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,20 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListChannelsModeratedByAppInstanceUserRequest, ListChannelsModeratedByAppInstanceUserResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListChannelsModeratedByAppInstanceUserCommand}.
  */
 export interface ListChannelsModeratedByAppInstanceUserCommandInput extends ListChannelsModeratedByAppInstanceUserRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListChannelsModeratedByAppInstanceUserCommand}.
  */
 export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends ListChannelsModeratedByAppInstanceUserResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -30,6 +35,8 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
  * const response = await client.send(command);
  * ```
  *
+ * @param ListChannelsModeratedByAppInstanceUserCommandInput - {@link ListChannelsModeratedByAppInstanceUserCommandInput}
+ * @returns {@link ListChannelsModeratedByAppInstanceUserCommandOutput}
  * @see {@link ListChannelsModeratedByAppInstanceUserCommandInput} for command's `input` shape.
  * @see {@link ListChannelsModeratedByAppInstanceUserCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
 export declare class ListChannelsModeratedByAppInstanceUserCommand extends $Command<ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListChannelsModeratedByAppInstanceUserCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListChannelsModeratedByAppInstanceUserCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListSubChannelsRequest, ListSubChannelsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListSubChannelsCommand}.
  */
 export interface ListSubChannelsCommandInput extends ListSubChannelsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListSubChannelsCommand}.
  */
 export interface ListSubChannelsCommandOutput extends ListSubChannelsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListSubChannelsCommandOutput extends ListSubChannelsResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param ListSubChannelsCommandInput - {@link ListSubChannelsCommandInput}
+ * @returns {@link ListSubChannelsCommandOutput}
  * @see {@link ListSubChannelsCommandInput} for command's `input` shape.
  * @see {@link ListSubChannelsCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListSubChannelsCommandOutput extends ListSubChannelsResponse, _
 export declare class ListSubChannelsCommand extends $Command<ListSubChannelsCommandInput, ListSubChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListSubChannelsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListSubChannelsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSubChannelsCommandInput, ListSubChannelsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists the tags applied to an Amazon Chime SDK messaging resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,19 +4,31 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { PutChannelMembershipPreferencesRequest, PutChannelMembershipPreferencesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutChannelMembershipPreferencesCommand}.
  */
 export interface PutChannelMembershipPreferencesCommandInput extends PutChannelMembershipPreferencesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutChannelMembershipPreferencesCommand}.
  */
 export interface PutChannelMembershipPreferencesCommandOutput extends PutChannelMembershipPreferencesResponse, __MetadataBearer {
 }
 /**
- * <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>
+ * @public
+ * <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
@@ -27,6 +39,8 @@ export interface PutChannelMembershipPreferencesCommandOutput extends PutChannel
  * const response = await client.send(command);
  * ```
  *
+ * @param PutChannelMembershipPreferencesCommandInput - {@link PutChannelMembershipPreferencesCommandInput}
+ * @returns {@link PutChannelMembershipPreferencesCommandOutput}
  * @see {@link PutChannelMembershipPreferencesCommandInput} for command's `input` shape.
  * @see {@link PutChannelMembershipPreferencesCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +72,20 @@ export interface PutChannelMembershipPreferencesCommandOutput extends PutChannel
 export declare class PutChannelMembershipPreferencesCommand extends $Command<PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: PutChannelMembershipPreferencesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutChannelMembershipPreferencesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }