Class: Aws::DynamoDBStreams::Types::StreamDescription

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

Overview

Represents all of the data describing a particular stream.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_request_date_time ⇒ Time

The date and time when the request to create this stream was issued.

Returns:

  • (Time) 


707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#key_schema ⇒ Array<Types::KeySchemaElement>

The key attribute(s) of the stream's DynamoDB table.

Returns:



707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#last_evaluated_shard_id ⇒ String

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Returns:

  • (String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#shards ⇒ Array<Types::Shard>

The shards that comprise the stream.

Returns:



707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The Amazon Resource Name (ARN) for the stream.

Returns:

  • (String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_label ⇒ String

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the Amazon Web Services customer ID.

  • the table name

  • the StreamLabel

Returns:

  • (String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_status ⇒ String

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

Returns:

  • (String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_view_type ⇒ String

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

Returns:

  • (String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The DynamoDB table with which the stream is associated.

Returns:

  • (String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 707

class StreamDescription < Struct.new(
  :stream_arn,
  :stream_label,
  :stream_status,
  :stream_view_type,
  :creation_request_date_time,
  :table_name,
  :key_schema,
  :shards,
  :last_evaluated_shard_id)
  SENSITIVE = []
  include Aws::Structure
end