Class: Aws::Kinesis::Types::ChannelSummary

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::ChannelSummary

Includes:

Structure

Defined in:

lib/aws-sdk-kinesis/types.rb

Overview

A summary of a channel, returned by ListChannels.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_arn ⇒ String

  The Amazon Resource Name (ARN) of the channel.

• #channel_creation_timestamp ⇒ Time

  The time at which the channel was created.

• #channel_destination_type ⇒ String

  The destination type of the channel.

• #channel_id ⇒ String

  The unique identifier of the channel.

• #channel_name ⇒ String

  The name of the channel.

• #channel_status ⇒ String

  The current status of the channel.

• #channel_status_reason ⇒ String

  A message describing the reason for a FAILED status.

• #streams ⇒ Array<Types::ChannelStreamIdentifier>

  The source streams associated with the channel.

Instance Attribute Details

#channel_arn ⇒ String

The Amazon Resource Name (ARN) of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end

#channel_creation_timestamp ⇒ Time

The time at which the channel was created.

Returns:

• (Time)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end

#channel_destination_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end

#channel_id ⇒ String

The unique identifier of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end

#channel_name ⇒ String

The name of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end

#channel_status ⇒ String

The current status of the channel. Valid values:

• CREATING

• ACTIVE

• UPDATING

• DELETING

• FAILED - See ChannelStatusReason for the failure cause.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end

#channel_status_reason ⇒ String

A message describing the reason for a FAILED status.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end

#streams ⇒ Array<Types::ChannelStreamIdentifier>

The source streams associated with the channel.

Returns:

• (Array<Types::ChannelStreamIdentifier>)

# File 'lib/aws-sdk-kinesis/types.rb', line 305

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :channel_destination_type,
  :streams)
  SENSITIVE = []
  include Aws::Structure
end