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.

StreamDescription

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

type StreamDescription struct { CreationRequestDateTime *time.Time `type:"timestamp"` KeySchema []*dynamodb.KeySchemaElement `min:"1" type:"list"` LastEvaluatedShardId *string `min:"28" type:"string"` Shards []*Shard `type:"list"` StreamArn *string `min:"37" type:"string"` StreamLabel *string `type:"string"` StreamStatus *string `type:"string" enum:"StreamStatus"` StreamViewType *string `type:"string" enum:"StreamViewType"` TableName *string `min:"3" type:"string"` }

Represents all of the data describing a particular stream.

CreationRequestDateTime

Type: *time.Time

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

KeySchema

Type: []*dynamodb.KeySchemaElement

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

LastEvaluatedShardId

Type: *string

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.

Shards

A uniquely identified group of stream records within a stream.

StreamArn

Type: *string

The Amazon Resource Name (ARN) for the stream.

StreamLabel

Type: *string

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

StreamStatus

Type: *string

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.

StreamViewType

Type: *string

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.

TableName

Type: *string

The DynamoDB table with which the stream is associated.

Method

GoString

func (s StreamDescription) GoString() string

GoString returns the string representation

SetCreationRequestDateTime

func (s *StreamDescription) SetCreationRequestDateTime(v time.Time) *StreamDescription

SetCreationRequestDateTime sets the CreationRequestDateTime field's value.

SetKeySchema

func (s *StreamDescription) SetKeySchema(v []*dynamodb.KeySchemaElement) *StreamDescription

SetKeySchema sets the KeySchema field's value.

SetLastEvaluatedShardId

func (s *StreamDescription) SetLastEvaluatedShardId(v string) *StreamDescription

SetLastEvaluatedShardId sets the LastEvaluatedShardId field's value.

SetShards

func (s *StreamDescription) SetShards(v []*Shard) *StreamDescription

SetShards sets the Shards field's value.

SetStreamArn

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

SetStreamArn sets the StreamArn field's value.

SetStreamLabel

func (s *StreamDescription) SetStreamLabel(v string) *StreamDescription

SetStreamLabel sets the StreamLabel field's value.

SetStreamStatus

func (s *StreamDescription) SetStreamStatus(v string) *StreamDescription

SetStreamStatus sets the StreamStatus field's value.

SetStreamViewType

func (s *StreamDescription) SetStreamViewType(v string) *StreamDescription

SetStreamViewType sets the StreamViewType field's value.

SetTableName

func (s *StreamDescription) SetTableName(v string) *StreamDescription

SetTableName sets the TableName field's value.

String

func (s StreamDescription) String() string

String returns the string representation

On this page: