feat(client-chime-sdk-messaging): This release adds support for searching channels by members via the SearchChannels API, removes required restrictions for Name and Mode in UpdateChannel API and enhances CreateChannel API by exposing member and moderator list as well as channel id as optional parameters.

Author: awstools

clients/client-chime-sdk-messaging/README.md

@@ -12,8 +12,7 @@ AWS SDK for JavaScript ChimeSDKMessaging Client for Node.js, Browser and React N
 <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
 and receive messages in custom messaging applications. These APIs depend on the frameworks
 provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
-APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging">Amazon Chime SDK messaging</a>
-</p>
+APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
 
 ## Installing
 

clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts

@@ -192,6 +192,11 @@ import {
   RedactChannelMessageCommandInput,
   RedactChannelMessageCommandOutput,
 } from "./commands/RedactChannelMessageCommand";
+import {
+  SearchChannelsCommand,
+  SearchChannelsCommandInput,
+  SearchChannelsCommandOutput,
+} from "./commands/SearchChannelsCommand";
 import {
   SendChannelMessageCommand,
   SendChannelMessageCommandInput,
@@ -228,8 +233,7 @@ import {
  * <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
  *          and receive messages in custom messaging applications. These APIs depend on the frameworks
  *          provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
- *          APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging">Amazon Chime SDK messaging</a>
- *          </p>
+ *          APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
  */
 export class ChimeSDKMessaging extends ChimeSDKMessagingClient {
   /**
@@ -1774,6 +1778,39 @@ export class ChimeSDKMessaging extends ChimeSDKMessagingClient {
     }
   }
 
+  /**
+   * <p>Allows an <code>AppInstanceUser</code> to search the channels that they belong to. The <code>AppInstanceUser</code> can search by membership or external ID.
+   *          An <code>AppInstanceAdmin</code> can search across all channels within the <code>AppInstance</code>.</p>
+   */
+  public searchChannels(
+    args: SearchChannelsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<SearchChannelsCommandOutput>;
+  public searchChannels(
+    args: SearchChannelsCommandInput,
+    cb: (err: any, data?: SearchChannelsCommandOutput) => void
+  ): void;
+  public searchChannels(
+    args: SearchChannelsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: SearchChannelsCommandOutput) => void
+  ): void;
+  public searchChannels(
+    args: SearchChannelsCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchChannelsCommandOutput) => void),
+    cb?: (err: any, data?: SearchChannelsCommandOutput) => void
+  ): Promise<SearchChannelsCommandOutput> | void {
+    const command = new SearchChannelsCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
+
   /**
    * <p>Sends a message to a particular channel that the member is a part of.</p>
    *

clients/client-chime-sdk-messaging/src/ChimeSDKMessagingClient.ts

@@ -169,6 +169,7 @@ import {
   RedactChannelMessageCommandInput,
   RedactChannelMessageCommandOutput,
 } from "./commands/RedactChannelMessageCommand";
+import { SearchChannelsCommandInput, SearchChannelsCommandOutput } from "./commands/SearchChannelsCommand";
 import { SendChannelMessageCommandInput, SendChannelMessageCommandOutput } from "./commands/SendChannelMessageCommand";
 import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
@@ -223,6 +224,7 @@ export type ServiceInputTypes =
   | ListTagsForResourceCommandInput
   | PutChannelMembershipPreferencesCommandInput
   | RedactChannelMessageCommandInput
+  | SearchChannelsCommandInput
   | SendChannelMessageCommandInput
   | TagResourceCommandInput
   | UntagResourceCommandInput
@@ -270,6 +272,7 @@ export type ServiceOutputTypes =
   | ListTagsForResourceCommandOutput
   | PutChannelMembershipPreferencesCommandOutput
   | RedactChannelMessageCommandOutput
+  | SearchChannelsCommandOutput
   | SendChannelMessageCommandOutput
   | TagResourceCommandOutput
   | UntagResourceCommandOutput
@@ -435,8 +438,7 @@ export interface ChimeSDKMessagingClientResolvedConfig extends ChimeSDKMessaging
  * <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
  *          and receive messages in custom messaging applications. These APIs depend on the frameworks
  *          provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
- *          APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging">Amazon Chime SDK messaging</a>
- *          </p>
+ *          APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
  */
 export class ChimeSDKMessagingClient extends __Client<
   __HttpHandlerOptions,

clients/client-chime-sdk-messaging/src/commands/SearchChannelsCommand.ts

@@ -0,0 +1,101 @@
+// smithy-typescript generated code
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import {
+  ChimeSDKMessagingClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../ChimeSDKMessagingClient";
+import { SearchChannelsRequest, SearchChannelsResponse } from "../models/models_0";
+import {
+  deserializeAws_restJson1SearchChannelsCommand,
+  serializeAws_restJson1SearchChannelsCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface SearchChannelsCommandInput extends SearchChannelsRequest {}
+export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __MetadataBearer {}
+
+/**
+ * <p>Allows an <code>AppInstanceUser</code> to search the channels that they belong to. The <code>AppInstanceUser</code> can search by membership or external ID.
+ *          An <code>AppInstanceAdmin</code> can search across all channels within the <code>AppInstance</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKMessagingClient, SearchChannelsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
+ * // const { ChimeSDKMessagingClient, SearchChannelsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
+ * const client = new ChimeSDKMessagingClient(config);
+ * const command = new SearchChannelsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @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.
+ *
+ */
+export class SearchChannelsCommand extends $Command<
+  SearchChannelsCommandInput,
+  SearchChannelsCommandOutput,
+  ChimeSDKMessagingClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  constructor(readonly input: SearchChannelsCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: ChimeSDKMessagingClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<SearchChannelsCommandInput, SearchChannelsCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "ChimeSDKMessagingClient";
+    const commandName = "SearchChannelsCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: SearchChannelsRequest.filterSensitiveLog,
+      outputFilterSensitiveLog: SearchChannelsResponse.filterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: SearchChannelsCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_restJson1SearchChannelsCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<SearchChannelsCommandOutput> {
+    return deserializeAws_restJson1SearchChannelsCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}

clients/client-chime-sdk-messaging/src/commands/index.ts

@@ -37,6 +37,7 @@ export * from "./ListChannelsModeratedByAppInstanceUserCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PutChannelMembershipPreferencesCommand";
 export * from "./RedactChannelMessageCommand";
+export * from "./SearchChannelsCommand";
 export * from "./SendChannelMessageCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";

clients/client-chime-sdk-messaging/src/models/models_0.ts

@@ -24,7 +24,7 @@ export interface AppInstanceUserMembershipSummary {
   Type?: ChannelMembershipType | string;
 
   /**
-   * <p>The time at which a message was last read.</p>
+   * <p>The time at which an <code>AppInstanceUser</code> last marked a channel as read.</p>
    */
   ReadMarkerTimestamp?: Date;
 }
@@ -1047,7 +1047,7 @@ export interface PushNotificationPreferences {
   AllowNotifications: AllowNotifications | string | undefined;
 
   /**
-   * <p>The simple JSON object used to send a subset of a push notification to the requsted member.</p>
+   * <p>The simple JSON object used to send a subset of a push notification to the requested member.</p>
    */
   FilterRule?: string;
 }
@@ -1464,6 +1464,21 @@ export interface CreateChannelRequest {
    * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
    */
   ChimeBearer: string | undefined;
+
+  /**
+   * <p>The ID of the channel in the request.</p>
+   */
+  ChannelId?: string;
+
+  /**
+   * <p>The ARNs of the channel members in the request.</p>
+   */
+  MemberArns?: string[];
+
+  /**
+   * <p>The ARNs of the channel moderators in the request.</p>
+   */
+  ModeratorArns?: string[];
 }
 
 export namespace CreateChannelRequest {
@@ -1476,6 +1491,7 @@ export namespace CreateChannelRequest {
     ...(obj.Metadata && { Metadata: SENSITIVE_STRING }),
     ...(obj.ClientRequestToken && { ClientRequestToken: SENSITIVE_STRING }),
     ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }),
+    ...(obj.ChannelId && { ChannelId: SENSITIVE_STRING }),
   });
 }
 
@@ -2587,7 +2603,7 @@ export namespace ListChannelMembershipsForAppInstanceUserRequest {
 
 export interface ListChannelMembershipsForAppInstanceUserResponse {
   /**
-   * <p>The token passed by previous API calls until all requested users are returned.</p>
+   * <p>The information for the requested channel memberships.</p>
    */
   ChannelMemberships?: ChannelMembershipForAppInstanceUserSummary[];
 
@@ -3073,6 +3089,104 @@ export namespace RedactChannelMessageResponse {
   });
 }
 
+export enum SearchFieldKey {
+  MEMBERS = "MEMBERS",
+}
+
+export enum SearchFieldOperator {
+  EQUALS = "EQUALS",
+  INCLUDES = "INCLUDES",
+}
+
+/**
+ * <p>A <code>Field</code> of the channel that you want to search.</p>
+ */
+export interface SearchField {
+  /**
+   * <p>An <code>enum</code> value that indicates the key to search the channel on. <code>MEMBERS</code> allows you to search channels based on memberships. You can use it with the <code>EQUALS</code>
+   *          operator to get channels whose memberships are equal to the specified values, and with the <code>INCLUDES</code>  operator to get channels whose memberships include the specified values.</p>
+   */
+  Key: SearchFieldKey | string | undefined;
+
+  /**
+   * <p>The values that you want to search for, a list of strings. The values must be <code>AppInstanceUserArns</code> specified as a list of strings.</p>
+   *          <note>
+   *             <p>This operation isn't supported for <code>AppInstanceUsers</code> with large number of memberships.</p>
+   *          </note>
+   */
+  Values: string[] | undefined;
+
+  /**
+   * <p>The operator used to compare field values, currently <code>EQUALS</code> or <code>INCLUDES</code>.  Use the <code>EQUALS</code> operator to find channels whose memberships equal the specified values.
+   *          Use the <code>INCLUDES</code> operator to find channels whose memberships include the specified values.</p>
+   */
+  Operator: SearchFieldOperator | string | undefined;
+}
+
+export namespace SearchField {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: SearchField): any => ({
+    ...obj,
+  });
+}
+
+export interface SearchChannelsRequest {
+  /**
+   * <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
+   */
+  ChimeBearer?: string;
+
+  /**
+   * <p>A list of the <code>Field</code> objects in the channel being searched.</p>
+   */
+  Fields: SearchField[] | undefined;
+
+  /**
+   * <p>The maximum number of channels that you want returned.</p>
+   */
+  MaxResults?: number;
+
+  /**
+   * <p>The token returned from previous API requests until the number of channels is reached.</p>
+   */
+  NextToken?: string;
+}
+
+export namespace SearchChannelsRequest {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: SearchChannelsRequest): any => ({
+    ...obj,
+    ...(obj.NextToken && { NextToken: SENSITIVE_STRING }),
+  });
+}
+
+export interface SearchChannelsResponse {
+  /**
+   * <p>A list of the channels in the request.</p>
+   */
+  Channels?: ChannelSummary[];
+
+  /**
+   * <p>The token returned from previous API responses until the number of channels is reached.</p>
+   */
+  NextToken?: string;
+}
+
+export namespace SearchChannelsResponse {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: SearchChannelsResponse): any => ({
+    ...obj,
+    ...(obj.Channels && { Channels: obj.Channels.map((item) => ChannelSummary.filterSensitiveLog(item)) }),
+    ...(obj.NextToken && { NextToken: SENSITIVE_STRING }),
+  });
+}
+
 export interface SendChannelMessageRequest {
   /**
    * <p>The ARN of the channel.</p>
@@ -3223,12 +3337,12 @@ export interface UpdateChannelRequest {
   /**
    * <p>The name of the channel.</p>
    */
-  Name: string | undefined;
+  Name?: string;
 
   /**
    * <p>The mode of the update request.</p>
    */
-  Mode: ChannelMode | string | undefined;
+  Mode?: ChannelMode | string;
 
   /**
    * <p>The metadata for the update request.</p>