dynamodbstreams

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package dynamodbstreams provides the client and types for making API requests to Amazon DynamoDB Streams.

Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) in the Amazon DynamoDB Developer Guide.

See https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10 for more information on this service.

See dynamodbstreams package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/dynamodbstreams/

Using the Client

To Amazon DynamoDB Streams with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon DynamoDB Streams client DynamoDBStreams for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/dynamodbstreams/#New

Index

Examples

Constants

View Source 
const (

	// ErrCodeExpiredIteratorException for service response error code
	// "ExpiredIteratorException".
	//
	// The shard iterator has expired and can no longer be used to retrieve stream
	// records. A shard iterator expires 15 minutes after it is retrieved using
	// the GetShardIterator action.
	ErrCodeExpiredIteratorException = "ExpiredIteratorException"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// An error occurred on the server side.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Your request rate is too high. The AWS SDKs for DynamoDB automatically retry
	// requests that receive this exception. Your request is eventually successful,
	// unless your retry queue is too large to finish. Reduce the frequency of requests
	// and use exponential backoff. For more information, go to Error Retries and
	// Exponential Backoff (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries)
	// in the Amazon DynamoDB Developer Guide.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The operation tried to access a nonexistent stream.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTrimmedDataAccessException for service response error code
	// "TrimmedDataAccessException".
	//
	// The operation attempted to read past the oldest stream record in a 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.
	// You might receive a TrimmedDataAccessException if:
	//
	//    * You request a shard iterator with a sequence number older than the trim
	//    point (24 hours).
	//
	//    * You obtain a shard iterator, but before you use the iterator in a GetRecords
	//    request, a stream record in the shard exceeds the 24 hour period and is
	//    trimmed. This causes the iterator to access a record that no longer exists.
	ErrCodeTrimmedDataAccessException = "TrimmedDataAccessException"
)
View Source 
const (
	ServiceName = "streams.dynamodb" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName        // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type DescribeStreamInput 

type DescribeStreamInput struct {

	// The shard ID of the first item that this operation will evaluate. Use the
	// value that was returned for LastEvaluatedShardId in the previous operation.
	ExclusiveStartShardId *string `min:"28" type:"string"`

	// The maximum number of shard objects to return. The upper limit is 100.
	Limit *int64 `min:"1" type:"integer"`

	// The Amazon Resource Name (ARN) for the stream.
	//
	// StreamArn is a required field
	StreamArn *string `min:"37" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeStream operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStreamInput

func (DescribeStreamInput) GoString 

func (s DescribeStreamInput) GoString() string

GoString returns the string representation

func (DescribeStreamInput) String 

func (s DescribeStreamInput) String() string

String returns the string representation

func (*DescribeStreamInput) Validate 

func (s *DescribeStreamInput) Validate() error

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

type DescribeStreamOutput 

type DescribeStreamOutput struct {

	// A complete description of the stream, including its creation date and time,
	// the DynamoDB table associated with the stream, the shard IDs within the stream,
	// and the beginning and ending sequence numbers of stream records within the
	// shards.
	StreamDescription *StreamDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeStream operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStreamOutput

func (DescribeStreamOutput) GoString 

func (s DescribeStreamOutput) GoString() string

GoString returns the string representation

func (DescribeStreamOutput) SDKResponseMetadata 

func (s DescribeStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeStreamOutput) String 

func (s DescribeStreamOutput) String() string

String returns the string representation

type DescribeStreamRequest 

type DescribeStreamRequest struct {
	*aws.Request
	Input *DescribeStreamInput
	Copy  func(*DescribeStreamInput) DescribeStreamRequest
}

DescribeStreamRequest is a API request type for the DescribeStream API operation.

func (DescribeStreamRequest) Send 

func (r DescribeStreamRequest) Send() (*DescribeStreamOutput, error)

Send marshals and sends the DescribeStream API request.

type DynamoDBStreams 

type DynamoDBStreams struct {
	*aws.Client
}

DynamoDBStreams provides the API operation methods for making requests to Amazon DynamoDB Streams. See this package's package overview docs for details on the service.

DynamoDBStreams methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *DynamoDBStreams

New creates a new instance of the DynamoDBStreams client with a config.

Example: 

// Create a DynamoDBStreams client from just a config.
svc := dynamodbstreams.New(myConfig)

func (*DynamoDBStreams) DescribeStreamRequest 

func (c *DynamoDBStreams) DescribeStreamRequest(input *DescribeStreamInput) DescribeStreamRequest

DescribeStreamRequest returns a request value for making API operation for Amazon DynamoDB Streams.

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

You can call DescribeStream at a maximum rate of 10 times per second.

Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data. 

// Example sending a request using the DescribeStreamRequest method.
req := client.DescribeStreamRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStream

Example (Shared00)

To describe a stream with a given stream ARN

The following example describes a stream with a given stream ARN. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/dynamodbstreams"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := dynamodbstreams.New(cfg)
	input := &dynamodbstreams.DescribeStreamInput{
		StreamArn: aws.String("arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"),
	}

	req := svc.DescribeStreamRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodbstreams.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodbstreams.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodbstreams.ErrCodeInternalServerError:
				fmt.Println(dynamodbstreams.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDBStreams) GetRecordsRequest 

func (c *DynamoDBStreams) GetRecordsRequest(input *GetRecordsInput) GetRecordsRequest

GetRecordsRequest returns a request value for making API operation for Amazon DynamoDB Streams.

Retrieves the stream records from a given shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.

GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first. 

// Example sending a request using the GetRecordsRequest method.
req := client.GetRecordsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecords

Example (Shared00)

To retrieve all the stream records from a shard

The following example retrieves all the stream records from a shard. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/dynamodbstreams"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := dynamodbstreams.New(cfg)
	input := &dynamodbstreams.GetRecordsInput{
		ShardIterator: aws.String("arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ...  <remaining characters omitted> ..."),
	}

	req := svc.GetRecordsRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodbstreams.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodbstreams.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodbstreams.ErrCodeLimitExceededException:
				fmt.Println(dynamodbstreams.ErrCodeLimitExceededException, aerr.Error())
			case dynamodbstreams.ErrCodeInternalServerError:
				fmt.Println(dynamodbstreams.ErrCodeInternalServerError, aerr.Error())
			case dynamodbstreams.ErrCodeExpiredIteratorException:
				fmt.Println(dynamodbstreams.ErrCodeExpiredIteratorException, aerr.Error())
			case dynamodbstreams.ErrCodeTrimmedDataAccessException:
				fmt.Println(dynamodbstreams.ErrCodeTrimmedDataAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDBStreams) GetShardIteratorRequest 

func (c *DynamoDBStreams) GetShardIteratorRequest(input *GetShardIteratorInput) GetShardIteratorRequest

GetShardIteratorRequest returns a request value for making API operation for Amazon DynamoDB Streams.

Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.

A shard iterator expires 15 minutes after it is returned to the requester. 

// Example sending a request using the GetShardIteratorRequest method.
req := client.GetShardIteratorRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIterator

Example (Shared00)

To obtain a shard iterator for the provided stream ARN and shard ID

The following example returns a shard iterator for the provided stream ARN and shard ID. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/dynamodbstreams"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := dynamodbstreams.New(cfg)
	input := &dynamodbstreams.GetShardIteratorInput{
		ShardId:           aws.String("00000001414576573621-f55eea83"),
		ShardIteratorType: dynamodbstreams.ShardIteratorTypeTrimHorizon,
		StreamArn:         aws.String("arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"),
	}

	req := svc.GetShardIteratorRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodbstreams.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodbstreams.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodbstreams.ErrCodeInternalServerError:
				fmt.Println(dynamodbstreams.ErrCodeInternalServerError, aerr.Error())
			case dynamodbstreams.ErrCodeTrimmedDataAccessException:
				fmt.Println(dynamodbstreams.ErrCodeTrimmedDataAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDBStreams) ListStreamsRequest 

func (c *DynamoDBStreams) ListStreamsRequest(input *ListStreamsInput) ListStreamsRequest

ListStreamsRequest returns a request value for making API operation for Amazon DynamoDB Streams.

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.

You can call ListStreams at a maximum rate of 5 times per second. 

// Example sending a request using the ListStreamsRequest method.
req := client.ListStreamsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreams

Example (Shared00)

To list all of the stream ARNs

The following example lists all of the stream ARNs. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/dynamodbstreams"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := dynamodbstreams.New(cfg)
	input := &dynamodbstreams.ListStreamsInput{}

	req := svc.ListStreamsRequest(input)
	result, err := req.Send()
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodbstreams.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodbstreams.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodbstreams.ErrCodeInternalServerError:
				fmt.Println(dynamodbstreams.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

type GetRecordsInput 

type GetRecordsInput struct {

	// The maximum number of records to return from the shard. The upper limit is
	// 1000.
	Limit *int64 `min:"1" type:"integer"`

	// A shard iterator that was retrieved from a previous GetShardIterator operation.
	// This iterator can be used to access the stream records in this shard.
	//
	// ShardIterator is a required field
	ShardIterator *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a GetRecords operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecordsInput

func (GetRecordsInput) GoString 

func (s GetRecordsInput) GoString() string

GoString returns the string representation

func (GetRecordsInput) String 

func (s GetRecordsInput) String() string

String returns the string representation

func (*GetRecordsInput) Validate 

func (s *GetRecordsInput) Validate() error

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

type GetRecordsOutput 

type GetRecordsOutput struct {

	// The next position in the shard from which to start sequentially reading stream
	// records. If set to null, the shard has been closed and the requested iterator
	// will not return any more data.
	NextShardIterator *string `min:"1" type:"string"`

	// The stream records from the shard, which were retrieved using the shard iterator.
	Records []Record `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a GetRecords operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecordsOutput

func (GetRecordsOutput) GoString 

func (s GetRecordsOutput) GoString() string

GoString returns the string representation

func (GetRecordsOutput) SDKResponseMetadata 

func (s GetRecordsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetRecordsOutput) String 

func (s GetRecordsOutput) String() string

String returns the string representation

type GetRecordsRequest 

type GetRecordsRequest struct {
	*aws.Request
	Input *GetRecordsInput
	Copy  func(*GetRecordsInput) GetRecordsRequest
}

GetRecordsRequest is a API request type for the GetRecords API operation.

func (GetRecordsRequest) Send 

func (r GetRecordsRequest) Send() (*GetRecordsOutput, error)

Send marshals and sends the GetRecords API request.

type GetShardIteratorInput 

type GetShardIteratorInput struct {

	// The sequence number of a stream record in the shard from which to start reading.
	SequenceNumber *string `min:"21" type:"string"`

	// The identifier of the shard. The iterator will be returned for this shard
	// ID.
	//
	// ShardId is a required field
	ShardId *string `min:"28" type:"string" required:"true"`

	// 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
	ShardIteratorType ShardIteratorType `type:"string" required:"true" enum:"true"`

	// The Amazon Resource Name (ARN) for the stream.
	//
	// StreamArn is a required field
	StreamArn *string `min:"37" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a GetShardIterator operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIteratorInput

func (GetShardIteratorInput) GoString 

func (s GetShardIteratorInput) GoString() string

GoString returns the string representation

func (GetShardIteratorInput) String 

func (s GetShardIteratorInput) String() string

String returns the string representation

func (*GetShardIteratorInput) Validate 

func (s *GetShardIteratorInput) Validate() error

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

type GetShardIteratorOutput 

type GetShardIteratorOutput struct {

	// The position in the shard from which to start reading stream records sequentially.
	// A shard iterator specifies this position using the sequence number of a stream
	// record in a shard.
	ShardIterator *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a GetShardIterator operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIteratorOutput

func (GetShardIteratorOutput) GoString 

func (s GetShardIteratorOutput) GoString() string

GoString returns the string representation

func (GetShardIteratorOutput) SDKResponseMetadata 

func (s GetShardIteratorOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetShardIteratorOutput) String 

func (s GetShardIteratorOutput) String() string

String returns the string representation

type GetShardIteratorRequest 

type GetShardIteratorRequest struct {
	*aws.Request
	Input *GetShardIteratorInput
	Copy  func(*GetShardIteratorInput) GetShardIteratorRequest
}

GetShardIteratorRequest is a API request type for the GetShardIterator API operation.

func (GetShardIteratorRequest) Send 

func (r GetShardIteratorRequest) Send() (*GetShardIteratorOutput, error)

Send marshals and sends the GetShardIterator API request.

type Identity 

type Identity struct {

	// A unique identifier for the entity that made the call. For Time To Live,
	// the principalId is "dynamodb.amazonaws.com".
	PrincipalId *string `type:"string"`

	// The type of the identity. For Time To Live, the type is "Service".
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details about the type of identity that made the request. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Identity

func (Identity) GoString 

func (s Identity) GoString() string

GoString returns the string representation

func (Identity) String 

func (s Identity) String() string

String returns the string representation

type KeyType 

type KeyType string
const (
	KeyTypeHash  KeyType = "HASH"
	KeyTypeRange KeyType = "RANGE"
)

Enum values for KeyType

func (KeyType) MarshalValue added in v0.3.0 

func (enum KeyType) MarshalValue() (string, error)

func (KeyType) MarshalValueBuf added in v0.3.0 

func (enum KeyType) MarshalValueBuf(b []byte) ([]byte, error)

type ListStreamsInput 

type ListStreamsInput struct {

	// The ARN (Amazon Resource Name) of the first item that this operation will
	// evaluate. Use the value that was returned for LastEvaluatedStreamArn in the
	// previous operation.
	ExclusiveStartStreamArn *string `min:"37" type:"string"`

	// The maximum number of streams to return. The upper limit is 100.
	Limit *int64 `min:"1" type:"integer"`

	// If this parameter is provided, then only the streams associated with this
	// table name are returned.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a ListStreams operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreamsInput

func (ListStreamsInput) GoString 

func (s ListStreamsInput) GoString() string

GoString returns the string representation

func (ListStreamsInput) String 

func (s ListStreamsInput) String() string

String returns the string representation

func (*ListStreamsInput) Validate 

func (s *ListStreamsInput) Validate() error

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

type ListStreamsOutput 

type ListStreamsOutput struct {

	// The stream ARN 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 LastEvaluatedStreamArn is empty, then the "last page" of results has been
	// processed and there is no more data to be retrieved.
	//
	// If LastEvaluatedStreamArn 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 LastEvaluatedStreamArn is empty.
	LastEvaluatedStreamArn *string `min:"37" type:"string"`

	// A list of stream descriptors associated with the current account and endpoint.
	Streams []Stream `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a ListStreams operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreamsOutput

func (ListStreamsOutput) GoString 

func (s ListStreamsOutput) GoString() string

GoString returns the string representation

func (ListStreamsOutput) SDKResponseMetadata 

func (s ListStreamsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListStreamsOutput) String 

func (s ListStreamsOutput) String() string

String returns the string representation

type ListStreamsRequest 

type ListStreamsRequest struct {
	*aws.Request
	Input *ListStreamsInput
	Copy  func(*ListStreamsInput) ListStreamsRequest
}

ListStreamsRequest is a API request type for the ListStreams API operation.

func (ListStreamsRequest) Send 

func (r ListStreamsRequest) Send() (*ListStreamsOutput, error)

Send marshals and sends the ListStreams API request.

type OperationType 

type OperationType string
const (
	OperationTypeInsert OperationType = "INSERT"
	OperationTypeModify OperationType = "MODIFY"
	OperationTypeRemove OperationType = "REMOVE"
)

Enum values for OperationType

func (OperationType) MarshalValue added in v0.3.0 

func (enum OperationType) MarshalValue() (string, error)

func (OperationType) MarshalValueBuf added in v0.3.0 

func (enum OperationType) MarshalValueBuf(b []byte) ([]byte, error)

type Record 

type Record struct {

	// The region in which the GetRecords request was received.
	AwsRegion *string `locationName:"awsRegion" type:"string"`

	// The main body of the stream record, containing all of the DynamoDB-specific
	// fields.
	Dynamodb *StreamRecord `locationName:"dynamodb" type:"structure"`

	// A globally unique identifier for the event that was recorded in this stream
	// record.
	EventID *string `locationName:"eventID" type:"string"`

	// The type of data modification that was performed on the DynamoDB table:
	//
	//    * INSERT - a new item was added to the table.
	//
	//    * MODIFY - one or more of an existing item's attributes were modified.
	//
	//    * REMOVE - the item was deleted from the table
	EventName OperationType `locationName:"eventName" type:"string" enum:"true"`

	// The AWS service from which the stream record originated. For DynamoDB Streams,
	// this is aws:dynamodb.
	EventSource *string `locationName:"eventSource" type:"string"`

	// The version number of the stream record format. This number is updated whenever
	// the structure of Record is modified.
	//
	// Client applications must not assume that eventVersion will remain at a particular
	// value, as this number is subject to change at any time. In general, eventVersion
	// will only increase as the low-level DynamoDB Streams API evolves.
	EventVersion *string `locationName:"eventVersion" type:"string"`

	// Items that are deleted by the Time to Live process after expiration have
	// the following fields:
	//
	//    * Records[].userIdentity.type
	//
	// "Service"
	//
	//    * Records[].userIdentity.principalId
	//
	// "dynamodb.amazonaws.com"
	UserIdentity *Identity `locationName:"userIdentity" type:"structure"`
	// contains filtered or unexported fields
}

A description of a unique event within a stream. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Record

func (Record) GoString 

func (s Record) GoString() string

GoString returns the string representation

func (Record) String 

func (s Record) String() string

String returns the string representation

type SequenceNumberRange 

type SequenceNumberRange struct {

	// The last sequence number.
	EndingSequenceNumber *string `min:"21" type:"string"`

	// The first sequence number.
	StartingSequenceNumber *string `min:"21" type:"string"`
	// contains filtered or unexported fields
}

The beginning and ending sequence numbers for the stream records contained within a shard. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/SequenceNumberRange

func (SequenceNumberRange) GoString 

func (s SequenceNumberRange) GoString() string

GoString returns the string representation

func (SequenceNumberRange) String 

func (s SequenceNumberRange) String() string

String returns the string representation

type Shard 

type Shard struct {

	// The shard ID of the current shard's parent.
	ParentShardId *string `min:"28" type:"string"`

	// The range of possible sequence numbers for the shard.
	SequenceNumberRange *SequenceNumberRange `type:"structure"`

	// The system-generated identifier for this shard.
	ShardId *string `min:"28" type:"string"`
	// contains filtered or unexported fields
}

A uniquely identified group of stream records within a stream. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Shard

func (Shard) GoString 

func (s Shard) GoString() string

GoString returns the string representation

func (Shard) String 

func (s Shard) String() string

String returns the string representation

type ShardIteratorType 

type ShardIteratorType string
const (
	ShardIteratorTypeTrimHorizon         ShardIteratorType = "TRIM_HORIZON"
	ShardIteratorTypeLatest              ShardIteratorType = "LATEST"
	ShardIteratorTypeAtSequenceNumber    ShardIteratorType = "AT_SEQUENCE_NUMBER"
	ShardIteratorTypeAfterSequenceNumber ShardIteratorType = "AFTER_SEQUENCE_NUMBER"
)

Enum values for ShardIteratorType

func (ShardIteratorType) MarshalValue added in v0.3.0 

func (enum ShardIteratorType) MarshalValue() (string, error)

func (ShardIteratorType) MarshalValueBuf added in v0.3.0 

func (enum ShardIteratorType) MarshalValueBuf(b []byte) ([]byte, error)

type Stream 

type Stream struct {

	// The Amazon Resource Name (ARN) for the stream.
	StreamArn *string `min:"37" 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
	StreamLabel *string `type:"string"`

	// The DynamoDB table with which the stream is associated.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Represents all of the data describing a particular stream. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Stream

func (Stream) GoString 

func (s Stream) GoString() string

GoString returns the string representation

func (Stream) String 

func (s Stream) String() string

String returns the string representation

type StreamDescription 

type StreamDescription struct {

	// The date and time when the request to create this stream was issued.
	CreationRequestDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The key attribute(s) of the stream's DynamoDB table.
	KeySchema []dynamodb.KeySchemaElement `min:"1" type:"list"`

	// 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.
	LastEvaluatedShardId *string `min:"28" type:"string"`

	// The shards that comprise the stream.
	Shards []Shard `type:"list"`

	// The Amazon Resource Name (ARN) for the stream.
	StreamArn *string `min:"37" 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
	StreamLabel *string `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.
	StreamStatus StreamStatus `type:"string" enum:"true"`

	// 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.
	StreamViewType StreamViewType `type:"string" enum:"true"`

	// The DynamoDB table with which the stream is associated.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Represents all of the data describing a particular stream. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/StreamDescription

func (StreamDescription) GoString 

func (s StreamDescription) GoString() string

GoString returns the string representation

func (StreamDescription) String 

func (s StreamDescription) String() string

String returns the string representation

type StreamRecord 

type StreamRecord struct {

	// The approximate date and time when the stream record was created, in UNIX
	// epoch time (http://www.epochconverter.com/) format.
	ApproximateCreationDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The primary key attribute(s) for the DynamoDB item that was modified.
	Keys map[string]dynamodb.AttributeValue `type:"map"`

	// The item in the DynamoDB table as it appeared after it was modified.
	NewImage map[string]dynamodb.AttributeValue `type:"map"`

	// The item in the DynamoDB table as it appeared before it was modified.
	OldImage map[string]dynamodb.AttributeValue `type:"map"`

	// The sequence number of the stream record.
	SequenceNumber *string `min:"21" type:"string"`

	// The size of the stream record, in bytes.
	SizeBytes *int64 `min:"1" type:"long"`

	// The type of data from the modified DynamoDB item that was captured in this
	// stream record:
	//
	//    * KEYS_ONLY - only the key attributes of the modified item.
	//
	//    * NEW_IMAGE - the entire item, as it appeared after it was modified.
	//
	//    * OLD_IMAGE - the entire item, as it appeared before it was modified.
	//
	//    * NEW_AND_OLD_IMAGES - both the new and the old item images of the item.
	StreamViewType StreamViewType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A description of a single data modification that was performed on an item in a DynamoDB table. Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/StreamRecord

func (StreamRecord) GoString 

func (s StreamRecord) GoString() string

GoString returns the string representation

func (StreamRecord) String 

func (s StreamRecord) String() string

String returns the string representation

type StreamStatus 

type StreamStatus string
const (
	StreamStatusEnabling  StreamStatus = "ENABLING"
	StreamStatusEnabled   StreamStatus = "ENABLED"
	StreamStatusDisabling StreamStatus = "DISABLING"
	StreamStatusDisabled  StreamStatus = "DISABLED"
)

Enum values for StreamStatus

func (StreamStatus) MarshalValue added in v0.3.0 

func (enum StreamStatus) MarshalValue() (string, error)

func (StreamStatus) MarshalValueBuf added in v0.3.0 

func (enum StreamStatus) MarshalValueBuf(b []byte) ([]byte, error)

type StreamViewType 

type StreamViewType string
const (
	StreamViewTypeNewImage        StreamViewType = "NEW_IMAGE"
	StreamViewTypeOldImage        StreamViewType = "OLD_IMAGE"
	StreamViewTypeNewAndOldImages StreamViewType = "NEW_AND_OLD_IMAGES"
	StreamViewTypeKeysOnly        StreamViewType = "KEYS_ONLY"
)

Enum values for StreamViewType

func (StreamViewType) MarshalValue added in v0.3.0 

func (enum StreamViewType) MarshalValue() (string, error)

func (StreamViewType) MarshalValueBuf added in v0.3.0 

func (enum StreamViewType) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package dynamodbstreamsiface provides an interface to enable mocking the Amazon DynamoDB Streams service client for testing your code.
 Package dynamodbstreamsiface provides an interface to enable mocking the Amazon DynamoDB Streams service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.