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

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

Overview

Represents the input of a DescribeStream operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_start_shard_id ⇒ String

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) 


136
137
138
139
140
141
142
143
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 136

class DescribeStreamInput < Struct.new(
  :stream_arn,
  :limit,
  :exclusive_start_shard_id,
  :shard_filter)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

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

Returns:

  • (Integer) 


136
137
138
139
140
141
142
143
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 136

class DescribeStreamInput < Struct.new(
  :stream_arn,
  :limit,
  :exclusive_start_shard_id,
  :shard_filter)
  SENSITIVE = []
  include Aws::Structure
end

#shard_filter ⇒ Types::ShardFilter

This optional field contains the filter definition for the DescribeStream API.

Returns:



136
137
138
139
140
141
142
143
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 136

class DescribeStreamInput < Struct.new(
  :stream_arn,
  :limit,
  :exclusive_start_shard_id,
  :shard_filter)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The Amazon Resource Name (ARN) for the stream.

Returns:

  • (String) 


136
137
138
139
140
141
142
143
 
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 136

class DescribeStreamInput < Struct.new(
  :stream_arn,
  :limit,
  :exclusive_start_shard_id,
  :shard_filter)
  SENSITIVE = []
  include Aws::Structure
end