list-channels¶

Description¶

Lists the channels in your account. You can filter the results by source stream. The results are paginated. Use the NextToken value returned in the response to retrieve additional results.

Use this operation to find channels before deleting a stream, or to audit the channels configured in an Amazon Web Services Region.

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 .

Synopsis¶

  list-channels
[--stream-filter <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--stream-filter (list)

Filters the results to channels associated with the specified streams.

Constraints:

min: 1

max: 10000

(structure)

Filters ListChannels results by source stream.

StreamARN -> (string) [required]

The Amazon Resource Name (ARN) of the source stream to filter by.

Constraints:

min: 1

max: 2048

pattern: arn:aws.*:kinesis:.*:\d{12}:stream/\S+

StreamCreationTimestamp -> (timestamp)

The creation timestamp of the source stream.

Shorthand Syntax:

StreamARN=string,StreamCreationTimestamp=timestamp ...

JSON Syntax:

[
  {
    "StreamARN": "string",
    "StreamCreationTimestamp": timestamp
  }
  ...
]

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 10000

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

ChannelSummaries -> (list)

A list of channel summaries.

(structure)

A summary of a channel, returned by ListChannels .

ChannelName -> (string) [required]

The name of the channel.

Constraints:

min: 1

max: 128

pattern: [a-zA-Z0-9_.-]+

ChannelARN -> (string) [required]

The Amazon Resource Name (ARN) of the channel.

Constraints:

min: 1

max: 2048

pattern: arn:aws.*:kinesis:.*:\d{12}:channel/\S+

ChannelId -> (string) [required]

The unique identifier of the channel.

Constraints:

min: 1

max: 64

ChannelStatus -> (string) [required]

The current status of the channel. Valid values:

CREATING - The channel is being created.

ACTIVE - The channel is ready to deliver records.

UPDATING - The channel configuration is being updated.

DELETING - The channel is being deleted.

FAILED - See ChannelStatusReason for the failure cause.

Possible values:

CREATING

ACTIVE

UPDATING

DELETING

FAILED

ChannelStatusReason -> (string)

A message describing the reason for a FAILED status.

Constraints:

min: 1

max: 2048

ChannelCreationTimestamp -> (timestamp) [required]

The time at which the channel was created.

ChannelDestinationType -> (string) [required]

The destination type of the channel. Valid values:

S3 - Delivery to a general purpose Amazon S3 bucket.

S3_TABLES - Delivery to streaming tables on Apache Iceberg.

Possible values:

S3

S3_TABLES

Streams -> (list) [required]

The source streams associated with the channel.

Constraints:

min: 1

max: 10000

(structure)

Identifies a source stream associated with a channel.

StreamARN -> (string) [required]

The Amazon Resource Name (ARN) of the source Kinesis data stream.

Constraints:

min: 1

max: 2048

pattern: arn:aws.*:kinesis:.*:\d{12}:stream/\S+

StreamCreationTimestamp -> (timestamp) [required]

The time at which the source stream was created.

NextToken -> (string)

The pagination token to use in a subsequent call to retrieve the next page of results. This value is null when there are no more results to return.

Constraints:

min: 1

max: 1048576

Table of Contents

Feedback

User Guide