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

Returns the full details of a channel in an Amazon Chime * AppInstance.

* *

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, DescribeChannelCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import * // const { ChimeSDKMessagingClient, DescribeChannelCommand } = 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 = { // DescribeChannelRequest * ChannelArn: "STRING_VALUE", // required * ChimeBearer: "STRING_VALUE", // required * }; * const command = new DescribeChannelCommand(input); * const response = await client.send(command); * // { // DescribeChannelResponse * // Channel: { // Channel * // Name: "STRING_VALUE", * // ChannelArn: "STRING_VALUE", * // Mode: "UNRESTRICTED" || "RESTRICTED", * // Privacy: "PUBLIC" || "PRIVATE", * // Metadata: "STRING_VALUE", * // CreatedBy: { // Identity * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // }, * // CreatedTimestamp: new Date("TIMESTAMP"), * // LastMessageTimestamp: new Date("TIMESTAMP"), * // LastUpdatedTimestamp: new Date("TIMESTAMP"), * // ChannelFlowArn: "STRING_VALUE", * // ElasticChannelConfiguration: { // ElasticChannelConfiguration * // MaximumSubChannels: Number("int"), // required * // TargetMembershipsPerSubChannel: Number("int"), // required * // MinimumMembershipPercentage: Number("int"), // required * // }, * // ExpirationSettings: { // ExpirationSettings * // ExpirationDays: Number("int"), // required * // ExpirationCriterion: "CREATED_TIMESTAMP" || "LAST_MESSAGE_TIMESTAMP", // required * // }, * // }, * // }; * * ``` * * @param DescribeChannelCommandInput - {@link DescribeChannelCommandInput} * @returns {@link DescribeChannelCommandOutput} * @see {@link DescribeChannelCommandInput} for command's `input` shape. * @see {@link DescribeChannelCommandOutput} 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 DescribeChannelCommand extends DescribeChannelCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeChannelRequest; output: DescribeChannelResponse; }; sdk: { input: DescribeChannelCommandInput; output: DescribeChannelCommandOutput; }; }; }