describeChannel

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.

Samples

// To describe a channel
val resp = kinesisClient.describeChannel {
    channelArn = "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id"
}