Class: Aws::KeyspacesStreams::Types::GetStreamInput

Inherits:

Struct

• Object
• Struct
• Aws::KeyspacesStreams::Types::GetStreamInput

Includes:

Structure

Defined in:

lib/aws-sdk-keyspacesstreams/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of shard objects to return in a single ‘GetStream` request.

• #next_token ⇒ String

  An optional pagination token provided by a previous ‘GetStream` operation.

• #shard_filter ⇒ Types::ShardFilter

  Optional filter criteria to apply when retrieving shards.

• #stream_arn ⇒ String

  The Amazon Resource Name (ARN) of the stream for which detailed information is requested.

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of shard objects to return in a single ‘GetStream` request. The default value is 100. The minimum value is 1 and the maximum value is 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 177

class GetStreamInput < Struct.new(
  :stream_arn,
  :max_results,
  :shard_filter,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

An optional pagination token provided by a previous ‘GetStream` operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by `MaxResults`.

Returns:

• (String)

# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 177

class GetStreamInput < Struct.new(
  :stream_arn,
  :max_results,
  :shard_filter,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#shard_filter ⇒ Types::ShardFilter

Optional filter criteria to apply when retrieving shards. You can filter shards based on their parent ‘shardID` to get a list of children shards to narrow down the results returned by the `GetStream` operation.

Returns:

• (Types::ShardFilter)

# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 177

class GetStreamInput < Struct.new(
  :stream_arn,
  :max_results,
  :shard_filter,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.

Returns:

• (String)

# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 177

class GetStreamInput < Struct.new(
  :stream_arn,
  :max_results,
  :shard_filter,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end