View a markdown version of this page

ChannelSummary - Amazon Kinesis Data Streams Service
ContentsSee Also

ChannelSummary

A summary of a channel, returned by ListChannels.

Contents

ChannelARN

The Amazon Resource Name (ARN) of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

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

Required: Yes

ChannelCreationTimestamp

The time at which the channel was created.

Type: Timestamp

Required: Yes

ChannelDestinationType

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.

Type: String

Valid Values: S3 | S3_TABLES

Required: Yes

ChannelId

The unique identifier of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

ChannelName

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: Yes

ChannelStatus

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.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING | FAILED

Required: Yes

Streams

The source streams associated with the channel.

Type: Array of ChannelStreamIdentifier objects

Array Members: Minimum number of 1 item. Maximum number of 10000 items.

Required: Yes

ChannelStatusReason

A message describing the reason for a FAILED status.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: