import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeChannelInput, DescribeChannelOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeChannelCommand}. */ export interface DescribeChannelCommandInput extends DescribeChannelInput { } /** * @public * * The output of {@link DescribeChannelCommand}. */ export interface DescribeChannelCommandOutput extends DescribeChannelOutput, __MetadataBearer { } declare const DescribeChannelCommand_base: { new (input: DescribeChannelCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeChannelCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Describes the specified channel, including its configuration and current status.

*

Use this operation to verify that a channel reached the ACTIVE state after creation, or to diagnose a channel in the FAILED state by reading the ChannelStatusReason.

*

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KinesisClient, DescribeChannelCommand } from "@aws-sdk/client-kinesis"; // ES Modules import * // const { KinesisClient, DescribeChannelCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import * // import type { KinesisClientConfig } from "@aws-sdk/client-kinesis"; * const config = {}; // type is KinesisClientConfig * const client = new KinesisClient(config); * const input = { // DescribeChannelInput * ChannelARN: "STRING_VALUE", // required * }; * const command = new DescribeChannelCommand(input); * const response = await client.send(command); * // { // DescribeChannelOutput * // ChannelDescription: { // ChannelDescription * // ChannelName: "STRING_VALUE", // required * // ChannelARN: "STRING_VALUE", // required * // ChannelId: "STRING_VALUE", // required * // ChannelStatus: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required * // ChannelStatusReason: "STRING_VALUE", * // ChannelCreationTimestamp: new Date("TIMESTAMP"), // required * // ServiceExecutionRoleARN: "STRING_VALUE", // required * // StreamConfigurationList: [ // ChannelStreamDescriptionList // required * // { // ChannelStreamDescription * // StreamARN: "STRING_VALUE", // required * // StreamCreationTimestamp: new Date("TIMESTAMP"), // required * // RecordConfiguration: { // RecordConfiguration * // RecordFormatType: "GSR_JSON" || "JSON" || "STRING" || "BYTE_ARRAY", // required * // GSRSchemaARN: "STRING_VALUE", * // }, * // }, * // ], * // S3DestinationConfiguration: { // S3DestinationDescription * // DataFreshnessInSeconds: Number("int"), // required * // DeadLetterQueueS3Configuration: { // DeadLetterQueueS3Configuration * // BucketARN: "STRING_VALUE", // required * // ExpectedBucketOwner: "STRING_VALUE", // required * // ErrorOutputPrefix: "STRING_VALUE", * // }, * // StorageConfiguration: { // S3StorageConfiguration * // BucketARN: "STRING_VALUE", // required * // ExpectedBucketOwner: "STRING_VALUE", // required * // OutputKeyTemplate: "STRING_VALUE", * // StorageClass: "STANDARD" || "INTELLIGENT_TIERING" || "GLACIER_IR", * // CompressionType: "NONE" || "GZIP" || "ZSTD", // required * // }, * // }, * // S3TablesDestinationConfiguration: { // S3TablesDestinationDescription * // DataFreshnessInSeconds: Number("int"), // required * // DeadLetterQueueS3Configuration: { * // BucketARN: "STRING_VALUE", // required * // ExpectedBucketOwner: "STRING_VALUE", // required * // ErrorOutputPrefix: "STRING_VALUE", * // }, * // S3TablesConfigurationList: [ // S3TablesConfigurationList // required * // { // S3TablesConfiguration * // TableBucketARN: "STRING_VALUE", // required * // Namespace: "STRING_VALUE", // required * // TableName: "STRING_VALUE", // required * // CompressionType: "NONE" || "ZSTD" || "SNAPPY", // required * // PartitionSpec: { // PartitionSpec * // PartitionFields: [ // PartitionFieldList // required * // { // PartitionField * // Transform: "TIME_HOUR", // required * // SourceName: "STRING_VALUE", // required * // }, * // ], * // }, * // }, * // ], * // }, * // EncryptionConfiguration: { // ChannelEncryptionConfiguration * // EncryptionType: "KMS", // required * // KeyId: "STRING_VALUE", // required * // }, * // LoggingConfiguration: { // ChannelLoggingConfiguration * // CloudWatchLogs: { // CloudWatchLogs * // Enabled: true || false, // required * // LogGroupName: "STRING_VALUE", * // LogStreamName: "STRING_VALUE", * // }, * // }, * // }, * // }; * * ``` * * @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 KinesisClientResolvedConfig | config} for KinesisClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Specifies that you do not have the permissions required to perform this * operation.

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

A specified parameter exceeds its restrictions, is not supported, or can't be used. * For more information, see the returned message.

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

The requested resource exceeds the maximum number allowed, or the number of concurrent * stream requests exceeds the maximum number allowed.

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

The requested resource could not be found. The stream might not be specified * correctly.

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

The request failed validation. For example, a parameter value is not valid, a * combination of parameters is not supported, or the operation is not supported for the * stream's capacity mode. The error message describes the specific reason.

* * @throws {@link KinesisServiceException} *

Base exception class for all service exceptions from Kinesis service.

* * * @public */ export declare class DescribeChannelCommand extends DescribeChannelCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeChannelInput; output: DescribeChannelOutput; }; sdk: { input: DescribeChannelCommandInput; output: DescribeChannelCommandOutput; }; }; }