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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

A summary of a channel, returned by ListChannels.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arn ⇒ String

The Amazon Resource Name (ARN) of the channel.

Returns:

  • (String) 


306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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) 


306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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) 


306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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) 


306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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) 


306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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 - 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.

Returns:

  • (String) 


306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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) 


306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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:



306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 306

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