Returns the current configuration and state of a channel¶

Description¶

Returns the current configuration and state of a channel.

Usage¶

kafka_describe_channel(ChannelArn, ClusterArn)

Arguments¶

ChannelArn

[required] The Amazon Resource Name (ARN) that uniquely identifies the channel.
ClusterArn

[required] The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Value¶

A list with the following syntax:

list(
  ChannelArn = "string",
  ChannelName = "string",
  EncryptionConfiguration = list(
    KmsKeyArn = "string"
  ),
  IcebergDestinationConfiguration = list(
    AppendOnly = TRUE|FALSE,
    Catalog = list(
      CatalogArn = "string",
      WarehouseLocation = "string"
    ),
    DataFreshnessInSeconds = 123,
    DeadLetterQueueS3 = list(
      BucketArn = "string",
      ErrorOutputPrefix = "string",
      ExpectedBucketOwner = "string"
    ),
    DestinationTableList = list(
      list(
        DestinationDatabaseName = "string",
        DestinationTableName = "string",
        PartitionSpec = list(
          PartitionStrategy = "TIME_HOUR",
          SourceList = list(
            list(
              SourceName = "string"
            )
          )
        )
      )
    ),
    SchemaEvolution = list(
      EnableSchemaEvolution = TRUE|FALSE
    ),
    ServiceExecutionRoleArn = "string",
    TableCreation = list(
      EnableTableCreation = TRUE|FALSE
    ),
    CompressionType = "ZSTD"|"SNAPPY"
  ),
  S3DestinationConfiguration = list(
    DataFreshnessInSeconds = 123,
    DeadLetterQueueS3 = list(
      BucketArn = "string",
      ErrorOutputPrefix = "string",
      ExpectedBucketOwner = "string"
    ),
    ServiceExecutionRoleArn = "string",
    Storage = list(
      BucketArn = "string",
      CompressionType = "NONE"|"GZIP"|"ZSTD",
      OutputPrefix = "string",
      OutputKeyTemplate = "string",
      StorageClass = "STANDARD"|"INTELLIGENT_TIERING"|"GLACIER_IR",
      ExpectedBucketOwner = "string"
    )
  ),
  Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED"|"SUSPENDING"|"SUSPENDED",
  DestinationType = "ICEBERG"|"S3",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  TopicConfigurationList = list(
    list(
      RecordConverter = list(
        ValueConverter = "BYTE_ARRAY"|"JSON"|"JSON_SCHEMA_GSR"|"STRING"
      ),
      RecordSchema = list(
        GsrArn = "string"
      ),
      TopicArn = "string"
    )
  ),
  LoggingInfo = list(
    CloudWatchLogs = list(
      Enabled = TRUE|FALSE,
      LogGroup = "string"
    ),
    Firehose = list(
      DeliveryStream = "string",
      Enabled = TRUE|FALSE
    ),
    S3 = list(
      Bucket = "string",
      Enabled = TRUE|FALSE,
      Prefix = "string"
    )
  ),
  StateInfo = list(
    Code = "string",
    Message = "string"
  ),
  ClusterOperationArn = "string",
  Tags = list(
    "string"
  )
)

Request syntax¶

svc$describe_channel(
  ChannelArn = "string",
  ClusterArn = "string"
)