import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient"; import type { ListChannelMembershipsRequest, ListChannelMembershipsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListChannelMembershipsCommand}. */ export interface ListChannelMembershipsCommandInput extends ListChannelMembershipsRequest { } /** * @public * * The output of {@link ListChannelMembershipsCommand}. */ export interface ListChannelMembershipsCommandOutput extends ListChannelMembershipsResponse, __MetadataBearer { } declare const ListChannelMembershipsCommand_base: { new (input: ListChannelMembershipsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: ListChannelMembershipsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Lists all channel memberships in a channel.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

*
*

If you want to list the channels to which a specific app instance user belongs, see the * ListChannelMembershipsForAppInstanceUser API.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ChimeSDKMessagingClient, ListChannelMembershipsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import * // const { ChimeSDKMessagingClient, ListChannelMembershipsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import * // import type { ChimeSDKMessagingClientConfig } from "@aws-sdk/client-chime-sdk-messaging"; * const config = {}; // type is ChimeSDKMessagingClientConfig * const client = new ChimeSDKMessagingClient(config); * const input = { // ListChannelMembershipsRequest * ChannelArn: "STRING_VALUE", // required * Type: "DEFAULT" || "HIDDEN", * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * ChimeBearer: "STRING_VALUE", // required * SubChannelId: "STRING_VALUE", * }; * const command = new ListChannelMembershipsCommand(input); * const response = await client.send(command); * // { // ListChannelMembershipsResponse * // ChannelArn: "STRING_VALUE", * // ChannelMemberships: [ // ChannelMembershipSummaryList * // { // ChannelMembershipSummary * // Member: { // Identity * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param ListChannelMembershipsCommandInput - {@link ListChannelMembershipsCommandInput} * @returns {@link ListChannelMembershipsCommandOutput} * @see {@link ListChannelMembershipsCommandInput} for command's `input` shape. * @see {@link ListChannelMembershipsCommandOutput} for command's `response` shape. * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

The input parameters don't match the service's restrictions.

* * @throws {@link ForbiddenException} (client fault) *

The client is permanently forbidden from making the request.

* * @throws {@link ServiceFailureException} (server fault) *

The service encountered an unexpected error.

* * @throws {@link ServiceUnavailableException} (server fault) *

The service is currently unavailable.

* * @throws {@link ThrottledClientException} (client fault) *

The client exceeded its request rate limit.

* * @throws {@link UnauthorizedClientException} (client fault) *

The client is not currently authorized to make the request.

* * @throws {@link ChimeSDKMessagingServiceException} *

Base exception class for all service exceptions from ChimeSDKMessaging service.

* * * @public */ export declare class ListChannelMembershipsCommand extends ListChannelMembershipsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListChannelMembershipsRequest; output: ListChannelMembershipsResponse; }; sdk: { input: ListChannelMembershipsCommandInput; output: ListChannelMembershipsCommandOutput; }; }; }