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 { ListChannelsRequest, ListChannelsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListChannelsCommand}. */ export interface ListChannelsCommandInput extends ListChannelsRequest { } /** * @public * * The output of {@link ListChannelsCommand}. */ export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer { } declare const ListChannelsCommand_base: { new (input: ListChannelsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: ListChannelsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Lists all Channels created under a single Chime App as a paginated list. You can specify * filters to narrow results.

*

* Functionality & restrictions *

* * *

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.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ChimeSDKMessagingClient, ListChannelsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import * // const { ChimeSDKMessagingClient, ListChannelsCommand } = 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 = { // ListChannelsRequest * AppInstanceArn: "STRING_VALUE", // required * Privacy: "PUBLIC" || "PRIVATE", * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * ChimeBearer: "STRING_VALUE", // required * }; * const command = new ListChannelsCommand(input); * const response = await client.send(command); * // { // ListChannelsResponse * // Channels: [ // ChannelSummaryList * // { // ChannelSummary * // Name: "STRING_VALUE", * // ChannelArn: "STRING_VALUE", * // Mode: "UNRESTRICTED" || "RESTRICTED", * // Privacy: "PUBLIC" || "PRIVATE", * // Metadata: "STRING_VALUE", * // LastMessageTimestamp: new Date("TIMESTAMP"), * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @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. * * @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 ListChannelsCommand extends ListChannelsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListChannelsRequest; output: ListChannelsResponse; }; sdk: { input: ListChannelsCommandInput; output: ListChannelsCommandOutput; }; }; }