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

Class: Aws::DynamoDBStreams::Types::DescribeStreamInput

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

Overview

Note:

When making an API call, you may pass DescribeStreamInput data as a hash:

{
  stream_arn: "StreamArn", # required
  limit: 1,
  exclusive_start_shard_id: "ShardId",
}

Represents the input of a DescribeStream operation.

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_start_shard_idString

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Returns:

  • (String)


104
105
106
107
108
109
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 104

class DescribeStreamInput < Struct.new(
  :stream_arn,
  :limit,
  :exclusive_start_shard_id)
  include Aws::Structure
end

#limitInteger

The maximum number of shard objects to return. The upper limit is 100.

Returns:

  • (Integer)


104
105
106
107
108
109
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 104

class DescribeStreamInput < Struct.new(
  :stream_arn,
  :limit,
  :exclusive_start_shard_id)
  include Aws::Structure
end

#stream_arnString

The Amazon Resource Name (ARN) for the stream.

Returns:

  • (String)


104
105
106
107
108
109
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 104

class DescribeStreamInput < Struct.new(
  :stream_arn,
  :limit,
  :exclusive_start_shard_id)
  include Aws::Structure
end