Describes the specified channel, including its configuration and current status¶

Description¶

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.

Usage¶

kinesis_describe_channel(ChannelARN)

Arguments¶

ChannelARN

[required] The Amazon Resource Name (ARN) of the channel to describe.

Value¶

A list with the following syntax:

list(
  ChannelDescription = list(
    ChannelName = "string",
    ChannelARN = "string",
    ChannelId = "string",
    ChannelStatus = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED",
    ChannelStatusReason = "string",
    ChannelCreationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ServiceExecutionRoleARN = "string",
    StreamConfigurationList = list(
      list(
        StreamARN = "string",
        StreamCreationTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        RecordConfiguration = list(
          RecordFormatType = "GSR_JSON"|"JSON"|"STRING"|"BYTE_ARRAY",
          GSRSchemaARN = "string"
        )
      )
    ),
    S3DestinationConfiguration = list(
      DataFreshnessInSeconds = 123,
      DeadLetterQueueS3Configuration = list(
        BucketARN = "string",
        ExpectedBucketOwner = "string",
        ErrorOutputPrefix = "string"
      ),
      StorageConfiguration = list(
        BucketARN = "string",
        ExpectedBucketOwner = "string",
        OutputKeyTemplate = "string",
        StorageClass = "STANDARD"|"INTELLIGENT_TIERING"|"GLACIER_IR",
        CompressionType = "NONE"|"GZIP"|"ZSTD"
      )
    ),
    S3TablesDestinationConfiguration = list(
      DataFreshnessInSeconds = 123,
      DeadLetterQueueS3Configuration = list(
        BucketARN = "string",
        ExpectedBucketOwner = "string",
        ErrorOutputPrefix = "string"
      ),
      S3TablesConfigurationList = list(
        list(
          TableBucketARN = "string",
          Namespace = "string",
          TableName = "string",
          CompressionType = "NONE"|"ZSTD"|"SNAPPY",
          PartitionSpec = list(
            PartitionFields = list(
              list(
                Transform = "TIME_HOUR",
                SourceName = "string"
              )
            )
          )
        )
      )
    ),
    EncryptionConfiguration = list(
      EncryptionType = "KMS",
      KeyId = "string"
    ),
    LoggingConfiguration = list(
      CloudWatchLogs = list(
        Enabled = TRUE|FALSE,
        LogGroupName = "string",
        LogStreamName = "string"
      )
    )
  )
)

Request syntax¶

svc$describe_channel(
  ChannelARN = "string"
)