AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kafka ]

describe-channel

Description

Returns the current configuration and state of a channel.

See also: AWS API Documentation

Synopsis

  describe-channel
--channel-arn <value>
--cluster-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--channel-arn (string)

The Amazon Resource Name (ARN) that uniquely identifies the channel.

--cluster-arn (string)

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ChannelArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the channel.

ChannelName -> (string)

The name of the channel.

EncryptionConfiguration -> (structure)

The encryption configuration applied to the channel.

KmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the data.

IcebergDestinationConfiguration -> (structure)

The Apache Iceberg destination for the channel, if configured.

AppendOnly -> (boolean)

Whether the destination is append-only. Must be true; updates and deletes are not supported.

Catalog -> (structure)

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

CatalogArn -> (string)

The Amazon Resource Name (ARN) of the federated AWS Glue Data Catalog that projects the S3 Tables bucket. If omitted, MSK derives the catalog ARN from warehouseLocation.

WarehouseLocation -> (string)

The Amazon Resource Name (ARN) of the S3 Tables bucket that backs the Apache Iceberg warehouse.

DataFreshnessInSeconds -> (integer)

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

DeadLetterQueueS3 -> (structure)

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

BucketArn -> (string)

The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket.

ErrorOutputPrefix -> (string)

An optional prefix prepended to every dead-letter Amazon S3 object key.

ExpectedBucketOwner -> (string)

Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 bucket.

DestinationTableList -> (list)

The destination Iceberg tables. Currently exactly one table must be specified.

(structure)

Configuration of an Apache Iceberg destination table.

DestinationDatabaseName -> (string)

The name of the destination namespace (database) in the AWS Glue Data Catalog.

DestinationTableName -> (string)

The name of the destination Apache Iceberg table.

PartitionSpec -> (structure)

The partition specification for the destination table.

PartitionStrategy -> (string)

The partitioning strategy applied to records written to the table.

SourceList -> (list)

The source columns used by the partitioning strategy. For TIME_HOUR, must contain exactly one source column whose value is a timestamp.

(structure)

A source column used by an Apache Iceberg destination table’s partition specification.

SourceName -> (string)

Source name.

SchemaEvolution -> (structure)

Configuration controlling whether the destination table’s schema is evolved to match incoming records.

EnableSchemaEvolution -> (boolean)

Whether to allow MSK to evolve the destination table’s schema. Must be false for the current release.

ServiceExecutionRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

TableCreation -> (structure)

Configuration controlling whether MSK creates the destination table if it does not already exist.

EnableTableCreation -> (boolean)

Whether MSK creates the destination table on the customer’s behalf. Must be true for the current release.

CompressionType -> (string)

The compression codec for Iceberg table data files. Defaults to ZSTD.

S3DestinationConfiguration -> (structure)

The Amazon S3 destination for the channel, if configured.

DataFreshnessInSeconds -> (integer)

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

DeadLetterQueueS3 -> (structure)

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

BucketArn -> (string)

The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket.

ErrorOutputPrefix -> (string)

An optional prefix prepended to every dead-letter Amazon S3 object key.

ExpectedBucketOwner -> (string)

Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 bucket.

ServiceExecutionRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to write to the destination Amazon S3 bucket and the dead-letter bucket.

Storage -> (structure)

The Amazon S3 bucket, prefix, and storage class for delivered records.

BucketArn -> (string)

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

CompressionType -> (string)

The compression codec applied to delivered Amazon S3 objects.

OutputPrefix -> (string)

An optional prefix prepended to every Amazon S3 object key written by the channel.

OutputKeyTemplate -> (string)

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

StorageClass -> (string)

The Amazon S3 storage class for delivered objects.

ExpectedBucketOwner -> (string)

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

Status -> (string)

The current lifecycle state of the channel.

DestinationType -> (string)

The type of destination configured for the channel.

CreationTime -> (timestamp)

The time when the channel was created.

TopicConfigurationList -> (list)

The list of topic configurations for the channel.

(structure)

Configuration of an Apache Kafka topic that feeds a channel.

RecordConverter -> (structure)

Configuration that controls how Apache Kafka record values are deserialized for the destination.

ValueConverter -> (string)

The deserialization format applied to Apache Kafka record values.

RecordSchema -> (structure)

The schema used to validate records when the value converter requires one (for example, JSON_SCHEMA_GSR).

GsrArn -> (string)

The Amazon Resource Name (ARN) of the AWS Glue Schema Registry schema (not registry) used to validate records for the destination Apache Iceberg table.

TopicArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the topic.

LoggingInfo -> (structure)

The destinations to which the channel publishes operational logs.

CloudWatchLogs -> (structure)

Details of the CloudWatch Logs destination for Channel logs.

Enabled -> (boolean)

LogGroup -> (string)

Firehose -> (structure)

Details of the Kinesis Data Firehose delivery stream that is the destination for Channel logs.

DeliveryStream -> (string)

Enabled -> (boolean)

S3 -> (structure)

Details of the Amazon S3 destination for Channel logs.

Bucket -> (string)

Enabled -> (boolean)

Prefix -> (string)

StateInfo -> (structure)

Additional context for the current channel state, populated when the channel is in FAILED.

Code -> (string)

A short, machine-readable code identifying the failure cause.

Message -> (string)

A human-readable message describing the failure.

ClusterOperationArn -> (string)

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

Tags -> (map)

The tags attached to the channel.

key -> (string)

value -> (string)