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

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

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

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { TagResourceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Applies the specified tags to the specified 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 TagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -55,11 +62,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { UntagResourceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes the specified tags from the specified 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 UntagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { UpdateChannelRequest, UpdateChannelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateChannelCommand}.
  */
 export interface UpdateChannelCommandInput extends UpdateChannelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateChannelCommand}.
  */
 export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Update a channel's attributes.</p>
  *          <p>
  *             <b>Restriction</b>: You can't change a channel's privacy. </p>
@@ -32,6 +37,8 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateChannelCommandInput - {@link UpdateChannelCommandInput}
+ * @returns {@link UpdateChannelCommandOutput}
  * @see {@link UpdateChannelCommandInput} for command's `input` shape.
  * @see {@link UpdateChannelCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
 export declare class UpdateChannelCommand extends $Command<UpdateChannelCommandInput, UpdateChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: UpdateChannelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateChannelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateChannelCommandInput, UpdateChannelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
 import { UpdateChannelFlowRequest, UpdateChannelFlowResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateChannelFlowCommand}.
  */
 export interface UpdateChannelFlowCommandInput extends UpdateChannelFlowRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateChannelFlowCommand}.
  */
 export interface UpdateChannelFlowCommandOutput extends UpdateChannelFlowResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates channel flow attributes. 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 UpdateChannelFlowCommandOutput extends UpdateChannelFlowRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateChannelFlowCommandInput - {@link UpdateChannelFlowCommandInput}
+ * @returns {@link UpdateChannelFlowCommandOutput}
  * @see {@link UpdateChannelFlowCommandInput} for command's `input` shape.
  * @see {@link UpdateChannelFlowCommandOutput} for command's `response` shape.
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateChannelFlowCommandOutput extends UpdateChannelFlowRespons
 export declare class UpdateChannelFlowCommand extends $Command<UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
     readonly input: UpdateChannelFlowCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateChannelFlowCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

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

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

@@ -12,6 +12,7 @@ export * from "./DeleteChannelFlowCommand";
 export * from "./DeleteChannelMembershipCommand";
 export * from "./DeleteChannelMessageCommand";
 export * from "./DeleteChannelModeratorCommand";
+export * from "./DeleteMessagingStreamingConfigurationsCommand";
 export * from "./DescribeChannelBanCommand";
 export * from "./DescribeChannelCommand";
 export * from "./DescribeChannelFlowCommand";
@@ -24,6 +25,7 @@ export * from "./GetChannelMembershipPreferencesCommand";
 export * from "./GetChannelMessageCommand";
 export * from "./GetChannelMessageStatusCommand";
 export * from "./GetMessagingSessionEndpointCommand";
+export * from "./GetMessagingStreamingConfigurationsCommand";
 export * from "./ListChannelBansCommand";
 export * from "./ListChannelFlowsCommand";
 export * from "./ListChannelMembershipsCommand";
@@ -36,6 +38,7 @@ export * from "./ListChannelsModeratedByAppInstanceUserCommand";
 export * from "./ListSubChannelsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PutChannelMembershipPreferencesCommand";
+export * from "./PutMessagingStreamingConfigurationsCommand";
 export * from "./RedactChannelMessageCommand";
 export * from "./SearchChannelsCommand";
 export * from "./SendChannelMessageCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region: string;
+    Region?: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;

package/dist-types/models/ChimeSDKMessagingServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from ChimeSDKMessaging service.
  */
 export declare class ChimeSDKMessagingServiceException extends __ServiceException {