AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetShardIteratorInput

import "github.com/aws/aws-sdk-go/service/dynamodbstreams"

type GetShardIteratorInput struct { SequenceNumber *string `min:"21" type:"string"` ShardId *string `min:"28" type:"string" required:"true"` ShardIteratorType *string `type:"string" required:"true" enum:"ShardIteratorType"` StreamArn *string `min:"37" type:"string" required:"true"` }

Represents the input of a GetShardIterator operation.

SequenceNumber

Type: *string

The sequence number of a stream record in the shard from which to start reading.

ShardId

Type: *string

The identifier of the shard. The iterator will be returned for this shard ID.

ShardId is a required field

ShardIteratorType

Type: *string

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

  • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

ShardIteratorType is a required field

StreamArn

Type: *string

The Amazon Resource Name (ARN) for the stream.

StreamArn is a required field

Method

GoString

func (s GetShardIteratorInput) GoString() string

GoString returns the string representation

SetSequenceNumber

func (s *GetShardIteratorInput) SetSequenceNumber(v string) *GetShardIteratorInput

SetSequenceNumber sets the SequenceNumber field's value.

SetShardId

func (s *GetShardIteratorInput) SetShardId(v string) *GetShardIteratorInput

SetShardId sets the ShardId field's value.

SetShardIteratorType

func (s *GetShardIteratorInput) SetShardIteratorType(v string) *GetShardIteratorInput

SetShardIteratorType sets the ShardIteratorType field's value.

SetStreamArn

func (s *GetShardIteratorInput) SetStreamArn(v string) *GetShardIteratorInput

SetStreamArn sets the StreamArn field's value.

String

func (s GetShardIteratorInput) String() string

String returns the string representation

Validate

func (s *GetShardIteratorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: