ChannelDescription

Describes the configuration and current status of a channel.

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

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

LoggingConfiguration

The Amazon CloudWatch Logs configuration for the channel.

Type: ChannelLoggingConfiguration object

Required: Yes

ServiceExecutionRoleARN

The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

Type: String

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

Pattern: arn:aws[-a-z0-9]*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Required: Yes

StreamConfigurationList

The source stream configuration for the channel.

Type: Array of ChannelStreamDescription 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

EncryptionConfiguration

The Amazon KMS key configuration that Amazon Kinesis Data Streams uses to encrypt data delivered to the channel's destination.

Type: ChannelEncryptionConfiguration object

Required: No

S3DestinationConfiguration

The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

Type: S3DestinationDescription object

Required: No

S3TablesDestinationConfiguration

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

Type: S3TablesDestinationDescription object

Required: No

ChannelDescription

Contents

See Also