You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_request_date_timeTime

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

Returns:

  • (Time)


601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#key_schemaArray<Types::KeySchemaElement>

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

Returns:



601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#last_evaluated_shard_idString

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)


601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#shardsArray<Types::Shard>

The shards that comprise the stream.

Returns:



601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#stream_arnString

The Amazon Resource Name (ARN) for the stream.

Returns:

  • (String)


601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#stream_labelString

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 AWS customer ID.

  • the table name

  • the StreamLabel

Returns:

  • (String)


601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#stream_statusString

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)


601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#stream_view_typeString

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)


601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end

#table_nameString

The DynamoDB table with which the stream is associated.

Returns:

  • (String)


601
602
603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 601

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)
  include Aws::Structure
end