aws-sdk-go-v2: github.com/aws/aws-sdk-go-v2/service/dynamodb Index | Examples | Files | Directories

package dynamodb

import "github.com/aws/aws-sdk-go-v2/service/dynamodb"

Package dynamodb provides the client and types for making API requests to DynamoDB.

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.

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

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

Using the Client

To use DynamoDB 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 DynamoDB client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/dynamodb/#New

AttributeValue Marshaling and Unmarshaling Helpers

Utility helpers to marshal and unmarshal AttributeValue to and from Go types can be found in the dynamodbattribute sub package. This package provides has specialized functions for the common ways of working with AttributeValues. Such as map[string]*AttributeValue, []*AttributeValue, and directly with *AttributeValue. This is helpful for marshaling Go types for API operations such as PutItem, and unmarshaling Query and Scan APIs' responses.

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

Expression Builders

The expression package provides utility types and functions to build DynamoDB expression for type safe construction of API ExpressionAttributeNames, and ExpressionAttribute Values.

The package represents the various DynamoDB Expressions as structs named accordingly. For example, ConditionBuilder represents a DynamoDB Condition Expression, an UpdateBuilder represents a DynamoDB Update Expression, and so on.

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

Index

Examples

Package Files

api_client.go api_doc.go api_enums.go api_errors.go api_op_BatchGetItem.go api_op_BatchWriteItem.go api_op_CreateBackup.go api_op_CreateGlobalTable.go api_op_CreateTable.go api_op_DeleteBackup.go api_op_DeleteItem.go api_op_DeleteTable.go api_op_DescribeBackup.go api_op_DescribeContinuousBackups.go api_op_DescribeContributorInsights.go api_op_DescribeEndpoints.go api_op_DescribeGlobalTable.go api_op_DescribeGlobalTableSettings.go api_op_DescribeLimits.go api_op_DescribeTable.go api_op_DescribeTableReplicaAutoScaling.go api_op_DescribeTimeToLive.go api_op_GetItem.go api_op_ListBackups.go api_op_ListContributorInsights.go api_op_ListGlobalTables.go api_op_ListTables.go api_op_ListTagsOfResource.go api_op_PutItem.go api_op_Query.go api_op_RestoreTableFromBackup.go api_op_RestoreTableToPointInTime.go api_op_Scan.go api_op_TagResource.go api_op_TransactGetItems.go api_op_TransactWriteItems.go api_op_UntagResource.go api_op_UpdateContinuousBackups.go api_op_UpdateContributorInsights.go api_op_UpdateGlobalTable.go api_op_UpdateGlobalTableSettings.go api_op_UpdateItem.go api_op_UpdateTable.go api_op_UpdateTableReplicaAutoScaling.go api_op_UpdateTimeToLive.go api_types.go api_waiters.go customizations.go doc_custom.go

Constants

const (
    ServiceName = "DynamoDB" // Service's name
    ServiceID   = "DynamoDB" // Service's identifier
    EndpointsID = "dynamodb" // Service's Endpoint identifier
)
const (

    // ErrCodeBackupInUseException for service response error code
    // "BackupInUseException".
    //
    // There is another ongoing conflicting backup control plane operation on the
    // table. The backup is either being created, deleted or restored to a table.
    ErrCodeBackupInUseException = "BackupInUseException"

    // ErrCodeBackupNotFoundException for service response error code
    // "BackupNotFoundException".
    //
    // Backup not found for the given BackupARN.
    ErrCodeBackupNotFoundException = "BackupNotFoundException"

    // ErrCodeConditionalCheckFailedException for service response error code
    // "ConditionalCheckFailedException".
    //
    // A condition specified in the operation could not be evaluated.
    ErrCodeConditionalCheckFailedException = "ConditionalCheckFailedException"

    // ErrCodeContinuousBackupsUnavailableException for service response error code
    // "ContinuousBackupsUnavailableException".
    //
    // Backups have not yet been enabled for this table.
    ErrCodeContinuousBackupsUnavailableException = "ContinuousBackupsUnavailableException"

    // ErrCodeGlobalTableAlreadyExistsException for service response error code
    // "GlobalTableAlreadyExistsException".
    //
    // The specified global table already exists.
    ErrCodeGlobalTableAlreadyExistsException = "GlobalTableAlreadyExistsException"

    // ErrCodeGlobalTableNotFoundException for service response error code
    // "GlobalTableNotFoundException".
    //
    // The specified global table does not exist.
    ErrCodeGlobalTableNotFoundException = "GlobalTableNotFoundException"

    // ErrCodeIdempotentParameterMismatchException for service response error code
    // "IdempotentParameterMismatchException".
    //
    // DynamoDB rejected the request because you retried a request with a different
    // payload but with an idempotent token that was already used.
    ErrCodeIdempotentParameterMismatchException = "IdempotentParameterMismatchException"

    // ErrCodeIndexNotFoundException for service response error code
    // "IndexNotFoundException".
    //
    // The operation tried to access a nonexistent index.
    ErrCodeIndexNotFoundException = "IndexNotFoundException"

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

    // ErrCodeInvalidRestoreTimeException for service response error code
    // "InvalidRestoreTimeException".
    //
    // An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime
    // and LatestRestorableDateTime.
    ErrCodeInvalidRestoreTimeException = "InvalidRestoreTimeException"

    // ErrCodeItemCollectionSizeLimitExceededException for service response error code
    // "ItemCollectionSizeLimitExceededException".
    //
    // An item collection is too large. This exception is only returned for tables
    // that have one or more local secondary indexes.
    ErrCodeItemCollectionSizeLimitExceededException = "ItemCollectionSizeLimitExceededException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // There is no limit to the number of daily on-demand backups that can be taken.
    //
    // Up to 50 simultaneous table operations are allowed per account. These operations
    // include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup,
    // and RestoreTableToPointInTime.
    //
    // The only exception is when you are creating a table with one or more secondary
    // indexes. You can have up to 25 such requests running at a time; however,
    // if the table or index specifications are complex, DynamoDB might temporarily
    // reduce the number of concurrent operations.
    //
    // There is a soft account limit of 256 tables.
    ErrCodeLimitExceededException = "LimitExceededException"

    // ErrCodePointInTimeRecoveryUnavailableException for service response error code
    // "PointInTimeRecoveryUnavailableException".
    //
    // Point in time recovery has not yet been enabled for this source table.
    ErrCodePointInTimeRecoveryUnavailableException = "PointInTimeRecoveryUnavailableException"

    // ErrCodeProvisionedThroughputExceededException for service response error code
    // "ProvisionedThroughputExceededException".
    //
    // 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff)
    // in the Amazon DynamoDB Developer Guide.
    ErrCodeProvisionedThroughputExceededException = "ProvisionedThroughputExceededException"

    // ErrCodeReplicaAlreadyExistsException for service response error code
    // "ReplicaAlreadyExistsException".
    //
    // The specified replica is already part of the global table.
    ErrCodeReplicaAlreadyExistsException = "ReplicaAlreadyExistsException"

    // ErrCodeReplicaNotFoundException for service response error code
    // "ReplicaNotFoundException".
    //
    // The specified replica is no longer part of the global table.
    ErrCodeReplicaNotFoundException = "ReplicaNotFoundException"

    // ErrCodeRequestLimitExceeded for service response error code
    // "RequestLimitExceeded".
    //
    // Throughput exceeds the current throughput limit for your account. Please
    // contact AWS Support at AWS Support (https://aws.amazon.com/support) to request
    // a limit increase.
    ErrCodeRequestLimitExceeded = "RequestLimitExceeded"

    // ErrCodeResourceInUseException for service response error code
    // "ResourceInUseException".
    //
    // The operation conflicts with the resource's availability. For example, you
    // attempted to recreate an existing table, or tried to delete a table currently
    // in the CREATING state.
    ErrCodeResourceInUseException = "ResourceInUseException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // The operation tried to access a nonexistent table or index. The resource
    // might not be specified correctly, or its status might not be ACTIVE.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeTableAlreadyExistsException for service response error code
    // "TableAlreadyExistsException".
    //
    // A target table with the specified name already exists.
    ErrCodeTableAlreadyExistsException = "TableAlreadyExistsException"

    // ErrCodeTableInUseException for service response error code
    // "TableInUseException".
    //
    // A target table with the specified name is either being created or deleted.
    ErrCodeTableInUseException = "TableInUseException"

    // ErrCodeTableNotFoundException for service response error code
    // "TableNotFoundException".
    //
    // A source table with the name TableName does not currently exist within the
    // subscriber's account.
    ErrCodeTableNotFoundException = "TableNotFoundException"

    // ErrCodeTransactionCanceledException for service response error code
    // "TransactionCanceledException".
    //
    // The entire transaction request was canceled.
    //
    // DynamoDB cancels a TransactWriteItems request under the following circumstances:
    //
    //    * A condition in one of the condition expressions is not met.
    //
    //    * A table in the TransactWriteItems request is in a different account
    //    or region.
    //
    //    * More than one action in the TransactWriteItems operation targets the
    //    same item.
    //
    //    * There is insufficient provisioned capacity for the transaction to be
    //    completed.
    //
    //    * An item size becomes too large (larger than 400 KB), or a local secondary
    //    index (LSI) becomes too large, or a similar validation error occurs because
    //    of changes made by the transaction.
    //
    //    * There is a user error, such as an invalid data format.
    //
    // DynamoDB cancels a TransactGetItems request under the following circumstances:
    //
    //    * There is an ongoing TransactGetItems operation that conflicts with a
    //    concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request.
    //    In this case the TransactGetItems operation fails with a TransactionCanceledException.
    //
    //    * A table in the TransactGetItems request is in a different account or
    //    region.
    //
    //    * There is insufficient provisioned capacity for the transaction to be
    //    completed.
    //
    //    * There is a user error, such as an invalid data format.
    //
    // If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons
    // property. This property is not set for other languages. Transaction cancellation
    // reasons are ordered in the order of requested items, if an item has no error
    // it will have NONE code and Null message.
    //
    // Cancellation reason codes and possible error messages:
    //
    //    * No Errors: Code: NONE Message: null
    //
    //    * Conditional Check Failed: Code: ConditionalCheckFailed Message: The
    //    conditional request failed.
    //
    //    * Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded
    //    Message: Collection size exceeded.
    //
    //    * Transaction Conflict: Code: TransactionConflict Message: Transaction
    //    is ongoing for the item.
    //
    //    * Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded
    //    Messages: The level of configured provisioned throughput for the table
    //    was exceeded. Consider increasing your provisioning level with the UpdateTable
    //    API. This Message is received when provisioned throughput is exceeded
    //    is on a provisioned DynamoDB table. The level of configured provisioned
    //    throughput for one or more global secondary indexes of the table was exceeded.
    //    Consider increasing your provisioning level for the under-provisioned
    //    global secondary indexes with the UpdateTable API. This message is returned
    //    when provisioned throughput is exceeded is on a provisioned GSI.
    //
    //    * Throttling Error: Code: ThrottlingError Messages: Throughput exceeds
    //    the current capacity of your table or index. DynamoDB is automatically
    //    scaling your table or index so please try again shortly. If exceptions
    //    persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
    //    This message is returned when writes get throttled on an On-Demand table
    //    as DynamoDB is automatically scaling the table. Throughput exceeds the
    //    current capacity for one or more global secondary indexes. DynamoDB is
    //    automatically scaling your index so please try again shortly. This message
    //    is returned when when writes get throttled on an On-Demand GSI as DynamoDB
    //    is automatically scaling the GSI.
    //
    //    * Validation Error: Code: ValidationError Messages: One or more parameter
    //    values were invalid. The update expression attempted to update the secondary
    //    index key beyond allowed size limits. The update expression attempted
    //    to update the secondary index key to unsupported type. An operand in the
    //    update expression has an incorrect data type. Item size to update has
    //    exceeded the maximum allowed size. Number overflow. Attempting to store
    //    a number with magnitude larger than supported range. Type mismatch for
    //    attribute to update. Nesting Levels have exceeded supported limits. The
    //    document path provided in the update expression is invalid for update.
    //    The provided expression refers to an attribute that does not exist in
    //    the item.
    ErrCodeTransactionCanceledException = "TransactionCanceledException"

    // ErrCodeTransactionConflictException for service response error code
    // "TransactionConflictException".
    //
    // Operation was rejected because there is an ongoing transaction for the item.
    ErrCodeTransactionConflictException = "TransactionConflictException"

    // ErrCodeTransactionInProgressException for service response error code
    // "TransactionInProgressException".
    //
    // The transaction with the given request token is already in progress.
    ErrCodeTransactionInProgressException = "TransactionInProgressException"
)

type ArchivalSummary Uses

type ArchivalSummary struct {

    // The Amazon Resource Name (ARN) of the backup the table was archived to, when
    // applicable in the archival reason. If you wish to restore this backup to
    // the same table name, you will need to delete the original table.
    ArchivalBackupArn *string `min:"37" type:"string"`

    // The date and time when table archival was initiated by DynamoDB, in UNIX
    // epoch time format.
    ArchivalDateTime *time.Time `type:"timestamp"`

    // The reason DynamoDB archived the table. Currently, the only possible value
    // is:
    //
    //    * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to
    //    the table's AWS KMS key being inaccessible for more than seven days. An
    //    On-Demand backup was created at the archival time.
    ArchivalReason *string `type:"string"`
    // contains filtered or unexported fields
}

Contains details of a table archival operation.

func (ArchivalSummary) String Uses

func (s ArchivalSummary) String() string

String returns the string representation

type AttributeAction Uses

type AttributeAction string
const (
    AttributeActionAdd    AttributeAction = "ADD"
    AttributeActionPut    AttributeAction = "PUT"
    AttributeActionDelete AttributeAction = "DELETE"
)

Enum values for AttributeAction

func (AttributeAction) MarshalValue Uses

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

func (AttributeAction) MarshalValueBuf Uses

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

type AttributeDefinition Uses

type AttributeDefinition struct {

    // A name for the attribute.
    //
    // AttributeName is a required field
    AttributeName *string `min:"1" type:"string" required:"true"`

    // The data type for the attribute, where:
    //
    //    * S - the attribute is of type String
    //
    //    * N - the attribute is of type Number
    //
    //    * B - the attribute is of type Binary
    //
    // AttributeType is a required field
    AttributeType ScalarAttributeType `type:"string" required:"true" enum:"true"`
    // contains filtered or unexported fields
}

Represents an attribute for describing the key schema for the table and indexes.

func (AttributeDefinition) String Uses

func (s AttributeDefinition) String() string

String returns the string representation

func (*AttributeDefinition) Validate Uses

func (s *AttributeDefinition) Validate() error

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

type AttributeValue Uses

type AttributeValue struct {

    // An attribute of type Binary. For example:
    //
    // "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
    //
    // B is automatically base64 encoded/decoded by the SDK.
    B   []byte `type:"blob"`

    // An attribute of type Boolean. For example:
    //
    // "BOOL": true
    BOOL *bool `type:"boolean"`

    // An attribute of type Binary Set. For example:
    //
    // "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
    BS  [][]byte `type:"list"`

    // An attribute of type List. For example:
    //
    // "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]
    L   []AttributeValue `type:"list"`

    // An attribute of type Map. For example:
    //
    // "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
    M   map[string]AttributeValue `type:"map"`

    // An attribute of type Number. For example:
    //
    // "N": "123.45"
    //
    // Numbers are sent across the network to DynamoDB as strings, to maximize compatibility
    // across languages and libraries. However, DynamoDB treats them as number type
    // attributes for mathematical operations.
    N   *string `type:"string"`

    // An attribute of type Number Set. For example:
    //
    // "NS": ["42.2", "-19", "7.5", "3.14"]
    //
    // Numbers are sent across the network to DynamoDB as strings, to maximize compatibility
    // across languages and libraries. However, DynamoDB treats them as number type
    // attributes for mathematical operations.
    NS  []string `type:"list"`

    // An attribute of type Null. For example:
    //
    // "NULL": true
    NULL *bool `type:"boolean"`

    // An attribute of type String. For example:
    //
    // "S": "Hello"
    S   *string `type:"string"`

    // An attribute of type String Set. For example:
    //
    // "SS": ["Giraffe", "Hippo" ,"Zebra"]
    SS  []string `type:"list"`
    // contains filtered or unexported fields
}

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the Amazon DynamoDB Developer Guide.

func (AttributeValue) String Uses

func (s AttributeValue) String() string

String returns the string representation

type AttributeValueUpdate Uses

type AttributeValueUpdate struct {

    // Specifies how to perform the update. Valid values are PUT (default), DELETE,
    // and ADD. The behavior depends on whether the specified primary key already
    // exists in the table.
    //
    // If an item with the specified Key is found in the table:
    //
    //    * PUT - Adds the specified attribute to the item. If the attribute already
    //    exists, it is replaced by the new value.
    //
    //    * DELETE - If no value is specified, the attribute and its value are removed
    //    from the item. The data type of the specified value must match the existing
    //    value's data type. If a set of values is specified, then those values
    //    are subtracted from the old set. For example, if the attribute value was
    //    the set [a,b,c] and the DELETE action specified [a,c], then the final
    //    attribute value would be [b]. Specifying an empty set is an error.
    //
    //    * ADD - If the attribute does not already exist, then the attribute and
    //    its values are added to the item. If the attribute does exist, then the
    //    behavior of ADD depends on the data type of the attribute: If the existing
    //    attribute is a number, and if Value is also a number, then the Value is
    //    mathematically added to the existing attribute. If Value is a negative
    //    number, then it is subtracted from the existing attribute. If you use
    //    ADD to increment or decrement a number value for an item that doesn't
    //    exist before the update, DynamoDB uses 0 as the initial value. In addition,
    //    if you use ADD to update an existing item, and intend to increment or
    //    decrement an attribute value which does not yet exist, DynamoDB uses 0
    //    as the initial value. For example, suppose that the item you want to update
    //    does not yet have an attribute named itemcount, but you decide to ADD
    //    the number 3 to this attribute anyway, even though it currently does not
    //    exist. DynamoDB will create the itemcount attribute, set its initial value
    //    to 0, and finally add 3 to it. The result will be a new itemcount attribute
    //    in the item, with a value of 3. If the existing data type is a set, and
    //    if the Value is also a set, then the Value is added to the existing set.
    //    (This is a set operation, not mathematical addition.) For example, if
    //    the attribute value was the set [1,2], and the ADD action specified [3],
    //    then the final attribute value would be [1,2,3]. An error occurs if an
    //    Add action is specified for a set attribute and the attribute type specified
    //    does not match the existing set type. Both sets must have the same primitive
    //    data type. For example, if the existing data type is a set of strings,
    //    the Value must also be a set of strings. The same holds true for number
    //    sets and binary sets. This action is only valid for an existing attribute
    //    whose data type is number or is a set. Do not use ADD for any other data
    //    types.
    //
    // If no item with the specified Key is found:
    //
    //    * PUT - DynamoDB creates a new item with the specified primary key, and
    //    then adds the attribute.
    //
    //    * DELETE - Nothing happens; there is no attribute to delete.
    //
    //    * ADD - DynamoDB creates an item with the supplied primary key and number
    //    (or set of numbers) for the attribute value. The only data types allowed
    //    are number and number set; no other data types can be specified.
    Action AttributeAction `type:"string" enum:"true"`

    // Represents the data for an attribute.
    //
    // Each attribute value is described as a name-value pair. The name is the data
    // type, and the value is the data itself.
    //
    // For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes)
    // in the Amazon DynamoDB Developer Guide.
    Value *AttributeValue `type:"structure"`
    // contains filtered or unexported fields
}

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.

Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

func (AttributeValueUpdate) String Uses

func (s AttributeValueUpdate) String() string

String returns the string representation

type AutoScalingPolicyDescription Uses

type AutoScalingPolicyDescription struct {

    // The name of the scaling policy.
    PolicyName *string `min:"1" type:"string"`

    // Represents a target tracking scaling policy configuration.
    TargetTrackingScalingPolicyConfiguration *AutoScalingTargetTrackingScalingPolicyConfigurationDescription `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of the scaling policy.

func (AutoScalingPolicyDescription) String Uses

func (s AutoScalingPolicyDescription) String() string

String returns the string representation

type AutoScalingPolicyUpdate Uses

type AutoScalingPolicyUpdate struct {

    // The name of the scaling policy.
    PolicyName *string `min:"1" type:"string"`

    // Represents a target tracking scaling policy configuration.
    //
    // TargetTrackingScalingPolicyConfiguration is a required field
    TargetTrackingScalingPolicyConfiguration *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Represents the auto scaling policy to be modified.

func (AutoScalingPolicyUpdate) String Uses

func (s AutoScalingPolicyUpdate) String() string

String returns the string representation

func (*AutoScalingPolicyUpdate) Validate Uses

func (s *AutoScalingPolicyUpdate) Validate() error

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

type AutoScalingSettingsDescription Uses

type AutoScalingSettingsDescription struct {

    // Disabled auto scaling for this global table or global secondary index.
    AutoScalingDisabled *bool `type:"boolean"`

    // Role ARN used for configuring the auto scaling policy.
    AutoScalingRoleArn *string `type:"string"`

    // The maximum capacity units that a global table or global secondary index
    // should be scaled up to.
    MaximumUnits *int64 `min:"1" type:"long"`

    // The minimum capacity units that a global table or global secondary index
    // should be scaled down to.
    MinimumUnits *int64 `min:"1" type:"long"`

    // Information about the scaling policies.
    ScalingPolicies []AutoScalingPolicyDescription `type:"list"`
    // contains filtered or unexported fields
}

Represents the auto scaling settings for a global table or global secondary index.

func (AutoScalingSettingsDescription) String Uses

func (s AutoScalingSettingsDescription) String() string

String returns the string representation

type AutoScalingSettingsUpdate Uses

type AutoScalingSettingsUpdate struct {

    // Disabled auto scaling for this global table or global secondary index.
    AutoScalingDisabled *bool `type:"boolean"`

    // Role ARN used for configuring auto scaling policy.
    AutoScalingRoleArn *string `min:"1" type:"string"`

    // The maximum capacity units that a global table or global secondary index
    // should be scaled up to.
    MaximumUnits *int64 `min:"1" type:"long"`

    // The minimum capacity units that a global table or global secondary index
    // should be scaled down to.
    MinimumUnits *int64 `min:"1" type:"long"`

    // The scaling policy to apply for scaling target global table or global secondary
    // index capacity units.
    ScalingPolicyUpdate *AutoScalingPolicyUpdate `type:"structure"`
    // contains filtered or unexported fields
}

Represents the auto scaling settings to be modified for a global table or global secondary index.

func (AutoScalingSettingsUpdate) String Uses

func (s AutoScalingSettingsUpdate) String() string

String returns the string representation

func (*AutoScalingSettingsUpdate) Validate Uses

func (s *AutoScalingSettingsUpdate) Validate() error

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

type AutoScalingTargetTrackingScalingPolicyConfigurationDescription Uses

type AutoScalingTargetTrackingScalingPolicyConfigurationDescription struct {

    // Indicates whether scale in by the target tracking policy is disabled. If
    // the value is true, scale in is disabled and the target tracking policy won't
    // remove capacity from the scalable resource. Otherwise, scale in is enabled
    // and the target tracking policy can remove capacity from the scalable resource.
    // The default value is false.
    DisableScaleIn *bool `type:"boolean"`

    // The amount of time, in seconds, after a scale in activity completes before
    // another scale in activity can start. The cooldown period is used to block
    // subsequent scale in requests until it has expired. You should scale in conservatively
    // to protect your application's availability. However, if another alarm triggers
    // a scale out policy during the cooldown period after a scale-in, application
    // auto scaling scales out your scalable target immediately.
    ScaleInCooldown *int64 `type:"integer"`

    // The amount of time, in seconds, after a scale out activity completes before
    // another scale out activity can start. While the cooldown period is in effect,
    // the capacity that has been added by the previous scale out event that initiated
    // the cooldown is calculated as part of the desired capacity for the next scale
    // out. You should continuously (but not excessively) scale out.
    ScaleOutCooldown *int64 `type:"integer"`

    // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108
    // (Base 10) or 2e-360 to 2e360 (Base 2).
    //
    // TargetValue is a required field
    TargetValue *float64 `type:"double" required:"true"`
    // contains filtered or unexported fields
}

Represents the properties of a target tracking scaling policy.

func (AutoScalingTargetTrackingScalingPolicyConfigurationDescription) String Uses

func (s AutoScalingTargetTrackingScalingPolicyConfigurationDescription) String() string

String returns the string representation

type AutoScalingTargetTrackingScalingPolicyConfigurationUpdate Uses

type AutoScalingTargetTrackingScalingPolicyConfigurationUpdate struct {

    // Indicates whether scale in by the target tracking policy is disabled. If
    // the value is true, scale in is disabled and the target tracking policy won't
    // remove capacity from the scalable resource. Otherwise, scale in is enabled
    // and the target tracking policy can remove capacity from the scalable resource.
    // The default value is false.
    DisableScaleIn *bool `type:"boolean"`

    // The amount of time, in seconds, after a scale in activity completes before
    // another scale in activity can start. The cooldown period is used to block
    // subsequent scale in requests until it has expired. You should scale in conservatively
    // to protect your application's availability. However, if another alarm triggers
    // a scale out policy during the cooldown period after a scale-in, application
    // auto scaling scales out your scalable target immediately.
    ScaleInCooldown *int64 `type:"integer"`

    // The amount of time, in seconds, after a scale out activity completes before
    // another scale out activity can start. While the cooldown period is in effect,
    // the capacity that has been added by the previous scale out event that initiated
    // the cooldown is calculated as part of the desired capacity for the next scale
    // out. You should continuously (but not excessively) scale out.
    ScaleOutCooldown *int64 `type:"integer"`

    // The target value for the metric. The range is 8.515920e-109 to 1.174271e+108
    // (Base 10) or 2e-360 to 2e360 (Base 2).
    //
    // TargetValue is a required field
    TargetValue *float64 `type:"double" required:"true"`
    // contains filtered or unexported fields
}

Represents the settings of a target tracking scaling policy that will be modified.

func (AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) String Uses

func (s AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) String() string

String returns the string representation

func (*AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) Validate Uses

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) Validate() error

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

type BackupDescription Uses

type BackupDescription struct {

    // Contains the details of the backup created for the table.
    BackupDetails *BackupDetails `type:"structure"`

    // Contains the details of the table when the backup was created.
    SourceTableDetails *SourceTableDetails `type:"structure"`

    // Contains the details of the features enabled on the table when the backup
    // was created. For example, LSIs, GSIs, streams, TTL.
    SourceTableFeatureDetails *SourceTableFeatureDetails `type:"structure"`
    // contains filtered or unexported fields
}

Contains the description of the backup created for the table.

func (BackupDescription) String Uses

func (s BackupDescription) String() string

String returns the string representation

type BackupDetails Uses

type BackupDetails struct {

    // ARN associated with the backup.
    //
    // BackupArn is a required field
    BackupArn *string `min:"37" type:"string" required:"true"`

    // Time at which the backup was created. This is the request time of the backup.
    //
    // BackupCreationDateTime is a required field
    BackupCreationDateTime *time.Time `type:"timestamp" required:"true"`

    // Time at which the automatic on-demand backup created by DynamoDB will expire.
    // This SYSTEM on-demand backup expires automatically 35 days after its creation.
    BackupExpiryDateTime *time.Time `type:"timestamp"`

    // Name of the requested backup.
    //
    // BackupName is a required field
    BackupName *string `min:"3" type:"string" required:"true"`

    // Size of the backup in bytes.
    BackupSizeBytes *int64 `type:"long"`

    // Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
    //
    // BackupStatus is a required field
    BackupStatus BackupStatus `type:"string" required:"true" enum:"true"`

    // BackupType:
    //
    //    * USER - You create and manage these using the on-demand backup feature.
    //
    //    * SYSTEM - If you delete a table with point-in-time recovery enabled,
    //    a SYSTEM backup is automatically created and is retained for 35 days (at
    //    no additional cost). System backups allow you to restore the deleted table
    //    to the state it was in just before the point of deletion.
    //
    //    * AWS_BACKUP - On-demand backup created by you from AWS Backup service.
    //
    // BackupType is a required field
    BackupType BackupType `type:"string" required:"true" enum:"true"`
    // contains filtered or unexported fields
}

Contains the details of the backup created for the table.

func (BackupDetails) String Uses

func (s BackupDetails) String() string

String returns the string representation

type BackupStatus Uses

type BackupStatus string
const (
    BackupStatusCreating  BackupStatus = "CREATING"
    BackupStatusDeleted   BackupStatus = "DELETED"
    BackupStatusAvailable BackupStatus = "AVAILABLE"
)

Enum values for BackupStatus

func (BackupStatus) MarshalValue Uses

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

func (BackupStatus) MarshalValueBuf Uses

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

type BackupSummary Uses

type BackupSummary struct {

    // ARN associated with the backup.
    BackupArn *string `min:"37" type:"string"`

    // Time at which the backup was created.
    BackupCreationDateTime *time.Time `type:"timestamp"`

    // Time at which the automatic on-demand backup created by DynamoDB will expire.
    // This SYSTEM on-demand backup expires automatically 35 days after its creation.
    BackupExpiryDateTime *time.Time `type:"timestamp"`

    // Name of the specified backup.
    BackupName *string `min:"3" type:"string"`

    // Size of the backup in bytes.
    BackupSizeBytes *int64 `type:"long"`

    // Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
    BackupStatus BackupStatus `type:"string" enum:"true"`

    // BackupType:
    //
    //    * USER - You create and manage these using the on-demand backup feature.
    //
    //    * SYSTEM - If you delete a table with point-in-time recovery enabled,
    //    a SYSTEM backup is automatically created and is retained for 35 days (at
    //    no additional cost). System backups allow you to restore the deleted table
    //    to the state it was in just before the point of deletion.
    //
    //    * AWS_BACKUP - On-demand backup created by you from AWS Backup service.
    BackupType BackupType `type:"string" enum:"true"`

    // ARN associated with the table.
    TableArn *string `type:"string"`

    // Unique identifier for the table.
    TableId *string `type:"string"`

    // Name of the table.
    TableName *string `min:"3" type:"string"`
    // contains filtered or unexported fields
}

Contains details for the backup.

func (BackupSummary) String Uses

func (s BackupSummary) String() string

String returns the string representation

type BackupType Uses

type BackupType string
const (
    BackupTypeUser      BackupType = "USER"
    BackupTypeSystem    BackupType = "SYSTEM"
    BackupTypeAwsBackup BackupType = "AWS_BACKUP"
)

Enum values for BackupType

func (BackupType) MarshalValue Uses

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

func (BackupType) MarshalValueBuf Uses

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

type BackupTypeFilter Uses

type BackupTypeFilter string
const (
    BackupTypeFilterUser      BackupTypeFilter = "USER"
    BackupTypeFilterSystem    BackupTypeFilter = "SYSTEM"
    BackupTypeFilterAwsBackup BackupTypeFilter = "AWS_BACKUP"
    BackupTypeFilterAll       BackupTypeFilter = "ALL"
)

Enum values for BackupTypeFilter

func (BackupTypeFilter) MarshalValue Uses

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

func (BackupTypeFilter) MarshalValueBuf Uses

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

type BatchGetItemInput Uses

type BatchGetItemInput struct {

    // A map of one or more table names and, for each table, a map that describes
    // one or more items to retrieve from that table. Each table name can be used
    // only once per BatchGetItem request.
    //
    // Each element in the map of items to retrieve consists of the following:
    //
    //    * ConsistentRead - If true, a strongly consistent read is used; if false
    //    (the default), an eventually consistent read is used.
    //
    //    * ExpressionAttributeNames - One or more substitution tokens for attribute
    //    names in the ProjectionExpression parameter. The following are some use
    //    cases for using ExpressionAttributeNames: To access an attribute whose
    //    name conflicts with a DynamoDB reserved word. To create a placeholder
    //    for repeating occurrences of an attribute name in an expression. To prevent
    //    special characters in an attribute name from being misinterpreted in an
    //    expression. Use the # character in an expression to dereference an attribute
    //    name. For example, consider the following attribute name: Percentile The
    //    name of this attribute conflicts with a reserved word, so it cannot be
    //    used directly in an expression. (For the complete list of reserved words,
    //    see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    //    in the Amazon DynamoDB Developer Guide). To work around this, you could
    //    specify the following for ExpressionAttributeNames: {"#P":"Percentile"}
    //    You could then use this substitution in an expression, as in this example:
    //    #P = :val Tokens that begin with the : character are expression attribute
    //    values, which are placeholders for the actual value at runtime. For more
    //    information about expression attribute names, see Accessing Item Attributes
    //    (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    //    in the Amazon DynamoDB Developer Guide.
    //
    //    * Keys - An array of primary key attribute values that define specific
    //    items in the table. For each primary key, you must provide all of the
    //    key attributes. For example, with a simple primary key, you only need
    //    to provide the partition key value. For a composite key, you must provide
    //    both the partition key value and the sort key value.
    //
    //    * ProjectionExpression - A string that identifies one or more attributes
    //    to retrieve from the table. These attributes can include scalars, sets,
    //    or elements of a JSON document. The attributes in the expression must
    //    be separated by commas. If no attribute names are specified, then all
    //    attributes are returned. If any of the requested attributes are not found,
    //    they do not appear in the result. For more information, see Accessing
    //    Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    //    in the Amazon DynamoDB Developer Guide.
    //
    //    * AttributesToGet - This is a legacy parameter. Use ProjectionExpression
    //    instead. For more information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
    //    in the Amazon DynamoDB Developer Guide.
    //
    // RequestItems is a required field
    RequestItems map[string]KeysAndAttributes `min:"1" type:"map" required:"true"`

    // Determines the level of detail about provisioned throughput consumption that
    // is returned in the response:
    //
    //    * INDEXES - The response includes the aggregate ConsumedCapacity for the
    //    operation, together with ConsumedCapacity for each table and secondary
    //    index that was accessed. Note that some operations, such as GetItem and
    //    BatchGetItem, do not access any indexes at all. In these cases, specifying
    //    INDEXES will only return ConsumedCapacity information for table(s).
    //
    //    * TOTAL - The response includes only the aggregate ConsumedCapacity for
    //    the operation.
    //
    //    * NONE - No ConsumedCapacity details are included in the response.
    ReturnConsumedCapacity ReturnConsumedCapacity `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

Represents the input of a BatchGetItem operation.

func (BatchGetItemInput) String Uses

func (s BatchGetItemInput) String() string

String returns the string representation

func (*BatchGetItemInput) Validate Uses

func (s *BatchGetItemInput) Validate() error

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

type BatchGetItemOutput Uses

type BatchGetItemOutput struct {

    // The read capacity units consumed by the entire BatchGetItem operation.
    //
    // Each element consists of:
    //
    //    * TableName - The table that consumed the provisioned throughput.
    //
    //    * CapacityUnits - The total number of capacity units consumed.
    ConsumedCapacity []ConsumedCapacity `type:"list"`

    // A map of table name to a list of items. Each object in Responses consists
    // of a table name, along with a map of attribute data consisting of the data
    // type and attribute value.
    Responses map[string][]map[string]AttributeValue `type:"map"`

    // A map of tables and their respective keys that were not processed with the
    // current response. The UnprocessedKeys value is in the same form as RequestItems,
    // so the value can be provided directly to a subsequent BatchGetItem operation.
    // For more information, see RequestItems in the Request Parameters section.
    //
    // Each element consists of:
    //
    //    * Keys - An array of primary key attribute values that define specific
    //    items in the table.
    //
    //    * ProjectionExpression - One or more attributes to be retrieved from the
    //    table or index. By default, all attributes are returned. If a requested
    //    attribute is not found, it does not appear in the result.
    //
    //    * ConsistentRead - The consistency of a read operation. If set to true,
    //    then a strongly consistent read is used; otherwise, an eventually consistent
    //    read is used.
    //
    // If there are no unprocessed keys remaining, the response contains an empty
    // UnprocessedKeys map.
    UnprocessedKeys map[string]KeysAndAttributes `min:"1" type:"map"`
    // contains filtered or unexported fields
}

Represents the output of a BatchGetItem operation.

func (BatchGetItemOutput) String Uses

func (s BatchGetItemOutput) String() string

String returns the string representation

type BatchGetItemPaginator Uses

type BatchGetItemPaginator struct {
    aws.Pager
}

BatchGetItemPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewBatchGetItemPaginator Uses

func NewBatchGetItemPaginator(req BatchGetItemRequest) BatchGetItemPaginator

NewBatchGetItemRequestPaginator returns a paginator for BatchGetItem. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.BatchGetItemRequest(input)
p := dynamodb.NewBatchGetItemRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*BatchGetItemPaginator) CurrentPage Uses

func (p *BatchGetItemPaginator) CurrentPage() *BatchGetItemOutput

type BatchGetItemRequest Uses

type BatchGetItemRequest struct {
    *aws.Request
    Input *BatchGetItemInput
    Copy  func(*BatchGetItemInput) BatchGetItemRequest
}

BatchGetItemRequest is the request type for the BatchGetItem API operation.

func (BatchGetItemRequest) Send Uses

func (r BatchGetItemRequest) Send(ctx context.Context) (*BatchGetItemResponse, error)

Send marshals and sends the BatchGetItem API request.

type BatchGetItemResponse Uses

type BatchGetItemResponse struct {
    *BatchGetItemOutput
    // contains filtered or unexported fields
}

BatchGetItemResponse is the response type for the BatchGetItem API operation.

func (*BatchGetItemResponse) SDKResponseMetdata Uses

func (r *BatchGetItemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchGetItem request.

type BatchWriteItemInput Uses

type BatchWriteItemInput struct {

    // A map of one or more table names and, for each table, a list of operations
    // to be performed (DeleteRequest or PutRequest). Each element in the map consists
    // of the following:
    //
    //    * DeleteRequest - Perform a DeleteItem operation on the specified item.
    //    The item to be deleted is identified by a Key subelement: Key - A map
    //    of primary key attribute values that uniquely identify the item. Each
    //    entry in this map consists of an attribute name and an attribute value.
    //    For each primary key, you must provide all of the key attributes. For
    //    example, with a simple primary key, you only need to provide a value for
    //    the partition key. For a composite primary key, you must provide values
    //    for both the partition key and the sort key.
    //
    //    * PutRequest - Perform a PutItem operation on the specified item. The
    //    item to be put is identified by an Item subelement: Item - A map of attributes
    //    and their values. Each entry in this map consists of an attribute name
    //    and an attribute value. Attribute values must not be null; string and
    //    binary type attributes must have lengths greater than zero; and set type
    //    attributes must not be empty. Requests that contain empty values are rejected
    //    with a ValidationException exception. If you specify any attributes that
    //    are part of an index key, then the data types for those attributes must
    //    match those of the schema in the table's attribute definition.
    //
    // RequestItems is a required field
    RequestItems map[string][]WriteRequest `min:"1" type:"map" required:"true"`

    // Determines the level of detail about provisioned throughput consumption that
    // is returned in the response:
    //
    //    * INDEXES - The response includes the aggregate ConsumedCapacity for the
    //    operation, together with ConsumedCapacity for each table and secondary
    //    index that was accessed. Note that some operations, such as GetItem and
    //    BatchGetItem, do not access any indexes at all. In these cases, specifying
    //    INDEXES will only return ConsumedCapacity information for table(s).
    //
    //    * TOTAL - The response includes only the aggregate ConsumedCapacity for
    //    the operation.
    //
    //    * NONE - No ConsumedCapacity details are included in the response.
    ReturnConsumedCapacity ReturnConsumedCapacity `type:"string" enum:"true"`

    // Determines whether item collection metrics are returned. If set to SIZE,
    // the response includes statistics about item collections, if any, that were
    // modified during the operation are returned in the response. If set to NONE
    // (the default), no statistics are returned.
    ReturnItemCollectionMetrics ReturnItemCollectionMetrics `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

Represents the input of a BatchWriteItem operation.

func (BatchWriteItemInput) String Uses

func (s BatchWriteItemInput) String() string

String returns the string representation

func (*BatchWriteItemInput) Validate Uses

func (s *BatchWriteItemInput) Validate() error

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

type BatchWriteItemOutput Uses

type BatchWriteItemOutput struct {

    // The capacity units consumed by the entire BatchWriteItem operation.
    //
    // Each element consists of:
    //
    //    * TableName - The table that consumed the provisioned throughput.
    //
    //    * CapacityUnits - The total number of capacity units consumed.
    ConsumedCapacity []ConsumedCapacity `type:"list"`

    // A list of tables that were processed by BatchWriteItem and, for each table,
    // information about any item collections that were affected by individual DeleteItem
    // or PutItem operations.
    //
    // Each entry consists of the following subelements:
    //
    //    * ItemCollectionKey - The partition key value of the item collection.
    //    This is the same as the partition key value of the item.
    //
    //    * SizeEstimateRangeGB - An estimate of item collection size, expressed
    //    in GB. This is a two-element array containing a lower bound and an upper
    //    bound for the estimate. The estimate includes the size of all the items
    //    in the table, plus the size of all attributes projected into all of the
    //    local secondary indexes on the table. Use this estimate to measure whether
    //    a local secondary index is approaching its size limit. The estimate is
    //    subject to change over time; therefore, do not rely on the precision or
    //    accuracy of the estimate.
    ItemCollectionMetrics map[string][]ItemCollectionMetrics `type:"map"`

    // A map of tables and requests against those tables that were not processed.
    // The UnprocessedItems value is in the same form as RequestItems, so you can
    // provide this value directly to a subsequent BatchGetItem operation. For more
    // information, see RequestItems in the Request Parameters section.
    //
    // Each UnprocessedItems entry consists of a table name and, for that table,
    // a list of operations to perform (DeleteRequest or PutRequest).
    //
    //    * DeleteRequest - Perform a DeleteItem operation on the specified item.
    //    The item to be deleted is identified by a Key subelement: Key - A map
    //    of primary key attribute values that uniquely identify the item. Each
    //    entry in this map consists of an attribute name and an attribute value.
    //
    //    * PutRequest - Perform a PutItem operation on the specified item. The
    //    item to be put is identified by an Item subelement: Item - A map of attributes
    //    and their values. Each entry in this map consists of an attribute name
    //    and an attribute value. Attribute values must not be null; string and
    //    binary type attributes must have lengths greater than zero; and set type
    //    attributes must not be empty. Requests that contain empty values will
    //    be rejected with a ValidationException exception. If you specify any attributes
    //    that are part of an index key, then the data types for those attributes
    //    must match those of the schema in the table's attribute definition.
    //
    // If there are no unprocessed items remaining, the response contains an empty
    // UnprocessedItems map.
    UnprocessedItems map[string][]WriteRequest `min:"1" type:"map"`
    // contains filtered or unexported fields
}

Represents the output of a BatchWriteItem operation.

func (BatchWriteItemOutput) String Uses

func (s BatchWriteItemOutput) String() string

String returns the string representation

type BatchWriteItemRequest Uses

type BatchWriteItemRequest struct {
    *aws.Request
    Input *BatchWriteItemInput
    Copy  func(*BatchWriteItemInput) BatchWriteItemRequest
}

BatchWriteItemRequest is the request type for the BatchWriteItem API operation.

func (BatchWriteItemRequest) Send Uses

func (r BatchWriteItemRequest) Send(ctx context.Context) (*BatchWriteItemResponse, error)

Send marshals and sends the BatchWriteItem API request.

type BatchWriteItemResponse Uses

type BatchWriteItemResponse struct {
    *BatchWriteItemOutput
    // contains filtered or unexported fields
}

BatchWriteItemResponse is the response type for the BatchWriteItem API operation.

func (*BatchWriteItemResponse) SDKResponseMetdata Uses

func (r *BatchWriteItemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchWriteItem request.

type BillingMode Uses

type BillingMode string
const (
    BillingModeProvisioned   BillingMode = "PROVISIONED"
    BillingModePayPerRequest BillingMode = "PAY_PER_REQUEST"
)

Enum values for BillingMode

func (BillingMode) MarshalValue Uses

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

func (BillingMode) MarshalValueBuf Uses

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

type BillingModeSummary Uses

type BillingModeSummary struct {

    // Controls how you are charged for read and write throughput and how you manage
    // capacity. This setting can be changed later.
    //
    //    * PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend
    //    using PROVISIONED for predictable workloads.
    //
    //    * PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST.
    //    We recommend using PAY_PER_REQUEST for unpredictable workloads.
    BillingMode BillingMode `type:"string" enum:"true"`

    // Represents the time when PAY_PER_REQUEST was last set as the read/write capacity
    // mode.
    LastUpdateToPayPerRequestDateTime *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Contains the details for the read/write capacity mode.

func (BillingModeSummary) String Uses

func (s BillingModeSummary) String() string

String returns the string representation

type CRC32CheckFailedError Uses

type CRC32CheckFailedError struct{}

CRC32CheckFailedError provides the error type for when a DynamoDB operation response's doesn't match the precomputed CRC32 value supplied by the service's API.

func (*CRC32CheckFailedError) Error Uses

func (*CRC32CheckFailedError) Error() string

func (*CRC32CheckFailedError) RetryableError Uses

func (*CRC32CheckFailedError) RetryableError() bool

RetryableError signals that the error should be retried.

type CancellationReason Uses

type CancellationReason struct {

    // Status code for the result of the cancelled transaction.
    Code *string `type:"string"`

    // Item in the request which caused the transaction to get cancelled.
    Item map[string]AttributeValue `type:"map"`

    // Cancellation reason message description.
    Message *string `type:"string"`
    // contains filtered or unexported fields
}

An ordered list of errors for each item in the request which caused the transaction to get cancelled. The values of the list are ordered according to the ordering of the TransactWriteItems request parameter. If no error occurred for the associated item an error with a Null code and Null message will be present.

func (CancellationReason) String Uses

func (s CancellationReason) String() string

String returns the string representation

type Capacity Uses

type Capacity struct {

    // The total number of capacity units consumed on a table or an index.
    CapacityUnits *float64 `type:"double"`

    // The total number of read capacity units consumed on a table or an index.
    ReadCapacityUnits *float64 `type:"double"`

    // The total number of write capacity units consumed on a table or an index.
    WriteCapacityUnits *float64 `type:"double"`
    // contains filtered or unexported fields
}

Represents the amount of provisioned throughput capacity consumed on a table or an index.

func (Capacity) String Uses

func (s Capacity) String() string

String returns the string representation

type Client Uses

type Client struct {
    *aws.Client

    // Disables the computation and validation of request and response checksums.
    DisableComputeChecksums bool
    // contains filtered or unexported fields
}

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

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

func New Uses

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

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

func (*Client) BatchGetItemRequest Uses

func (c *Client) BatchGetItemRequest(input *BatchGetItemInput) BatchGetItemRequest

BatchGetItemRequest returns a request value for making API operation for Amazon DynamoDB.

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items, BatchGetItem returns a ValidationException with the message "Too many items requested for the BatchGetItem call."

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations) in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) in the Amazon DynamoDB Developer Guide.

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

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

To retrieve multiple items from a table

This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.BatchGetItemInput{
    RequestItems: map[string]dynamodb.KeysAndAttributes{
        "Music": {
            Keys: []map[string]dynamodb.AttributeValue{
                {
                    "Artist": dynamodb.AttributeValue{
                        S: aws.String("No One You Know"),
                    },
                    "SongTitle": dynamodb.AttributeValue{
                        S: aws.String("Call Me Today"),
                    },
                },
                {
                    "Artist": dynamodb.AttributeValue{
                        S: aws.String("Acme Band"),
                    },
                    "SongTitle": dynamodb.AttributeValue{
                        S: aws.String("Happy Day"),
                    },
                },
                {
                    "Artist": dynamodb.AttributeValue{
                        S: aws.String("No One You Know"),
                    },
                    "SongTitle": dynamodb.AttributeValue{
                        S: aws.String("Scared of My Shadow"),
                    },
                },
            },
            ProjectionExpression: aws.String("AlbumTitle"),
        },
    },
}

req := svc.BatchGetItemRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) BatchWriteItemRequest Uses

func (c *Client) BatchWriteItemRequest(input *BatchWriteItemInput) BatchWriteItemRequest

BatchWriteItemRequest returns a request value for making API operation for Amazon DynamoDB.

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

BatchWriteItem cannot update items. To update items, use the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations) in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

* One or more tables specified in the BatchWriteItem request does not
exist.

* Primary key attributes specified on an item in the request do not match
those in the corresponding table's primary key schema.

* You try to perform multiple operations on the same item in the same
BatchWriteItem request. For example, you cannot put and delete the same
item in the same BatchWriteItem request.

* Your request contains at least two items with identical hash and range
keys (which essentially is two put operations).

* There are more than 25 requests in the batch.

* Any individual item in a batch exceeds 400 KB.

* The total request size exceeds 16 MB.

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

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

To add multiple items to a table

This example adds three new items to the Music table using a batch of three PutItem requests.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.BatchWriteItemInput{
    RequestItems: map[string][]dynamodb.WriteRequest{
        "Music": {
            {
                PutRequest: &dynamodb.PutRequest{
                    Item: map[string]dynamodb.AttributeValue{
                        "AlbumTitle": {
                            S: aws.String("Somewhat Famous"),
                        },
                        "Artist": {
                            S: aws.String("No One You Know"),
                        },
                        "SongTitle": {
                            S: aws.String("Call Me Today"),
                        },
                    },
                },
            },
            {
                PutRequest: &dynamodb.PutRequest{
                    Item: map[string]dynamodb.AttributeValue{
                        "AlbumTitle": {
                            S: aws.String("Songs About Life"),
                        },
                        "Artist": {
                            S: aws.String("Acme Band"),
                        },
                        "SongTitle": {
                            S: aws.String("Happy Day"),
                        },
                    },
                },
            },
            {
                PutRequest: &dynamodb.PutRequest{
                    Item: map[string]dynamodb.AttributeValue{
                        "AlbumTitle": {
                            S: aws.String("Blue Sky Blues"),
                        },
                        "Artist": {
                            S: aws.String("No One You Know"),
                        },
                        "SongTitle": {
                            S: aws.String("Scared of My Shadow"),
                        },
                    },
                },
            },
        },
    },
}

req := svc.BatchWriteItemRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
            fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) CreateBackupRequest Uses

func (c *Client) CreateBackupRequest(input *CreateBackupInput) CreateBackupRequest

CreateBackupRequest returns a request value for making API operation for Amazon DynamoDB.

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

* Global secondary indexes (GSIs)

* Local secondary indexes (LSIs)

* Streams

* Provisioned read and write capacity

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

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

func (*Client) CreateGlobalTableRequest Uses

func (c *Client) CreateGlobalTableRequest(input *CreateGlobalTableInput) CreateGlobalTableRequest

CreateGlobalTableRequest returns a request value for making API operation for Amazon DynamoDB.

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

This method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.

If you want to add a new replica table to a global table, each of the following conditions must be true:

* The table must have the same primary key as all of the other replicas.

* The table must have the same name as all of the other replicas.

* The table must have DynamoDB Streams enabled, with the stream containing
both the new and the old images of the item.

* None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

* The global secondary indexes must have the same name.

* The global secondary indexes must have the same hash key and sort key
(if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

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

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

func (*Client) CreateTableRequest Uses

func (c *Client) CreateTableRequest(input *CreateTableInput) CreateTableRequest

CreateTableRequest returns a request value for making API operation for Amazon DynamoDB.

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

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

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

To create a table

This example creates a table named Music.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.CreateTableInput{
    AttributeDefinitions: []dynamodb.AttributeDefinition{
        {
            AttributeName: aws.String("Artist"),
            AttributeType: dynamodb.ScalarAttributeTypeS,
        },
        {
            AttributeName: aws.String("SongTitle"),
            AttributeType: dynamodb.ScalarAttributeTypeS,
        },
    },
    KeySchema: []dynamodb.KeySchemaElement{
        {
            AttributeName: aws.String("Artist"),
            KeyType:       dynamodb.KeyTypeHash,
        },
        {
            AttributeName: aws.String("SongTitle"),
            KeyType:       dynamodb.KeyTypeRange,
        },
    },
    ProvisionedThroughput: &dynamodb.ProvisionedThroughput{
        ReadCapacityUnits:  aws.Int64(5),
        WriteCapacityUnits: aws.Int64(5),
    },
    TableName: aws.String("Music"),
}

req := svc.CreateTableRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeResourceInUseException:
            fmt.Println(dynamodb.ErrCodeResourceInUseException, aerr.Error())
        case dynamodb.ErrCodeLimitExceededException:
            fmt.Println(dynamodb.ErrCodeLimitExceededException, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) DeleteBackupRequest Uses

func (c *Client) DeleteBackupRequest(input *DeleteBackupInput) DeleteBackupRequest

DeleteBackupRequest returns a request value for making API operation for Amazon DynamoDB.

Deletes an existing backup of a table.

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

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

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

func (*Client) DeleteItemRequest Uses

func (c *Client) DeleteItemRequest(input *DeleteItemInput) DeleteItemRequest

DeleteItemRequest returns a request value for making API operation for Amazon DynamoDB.

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

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

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

To delete an item

This example deletes an item from the Music table.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.DeleteItemInput{
    Key: map[string]dynamodb.AttributeValue{
        "Artist": {
            S: aws.String("No One You Know"),
        },
        "SongTitle": {
            S: aws.String("Scared of My Shadow"),
        },
    },
    TableName: aws.String("Music"),
}

req := svc.DeleteItemRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeConditionalCheckFailedException:
            fmt.Println(dynamodb.ErrCodeConditionalCheckFailedException, aerr.Error())
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
            fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
        case dynamodb.ErrCodeTransactionConflictException:
            fmt.Println(dynamodb.ErrCodeTransactionConflictException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) DeleteTableRequest Uses

func (c *Client) DeleteTableRequest(input *DeleteTableInput) DeleteTableRequest

DeleteTableRequest returns a request value for making API operation for Amazon DynamoDB.

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the table.

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

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

To delete a table

This example deletes the Music table.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.DeleteTableInput{
    TableName: aws.String("Music"),
}

req := svc.DeleteTableRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeResourceInUseException:
            fmt.Println(dynamodb.ErrCodeResourceInUseException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeLimitExceededException:
            fmt.Println(dynamodb.ErrCodeLimitExceededException, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) DescribeBackupRequest Uses

func (c *Client) DescribeBackupRequest(input *DescribeBackupInput) DescribeBackupRequest

DescribeBackupRequest returns a request value for making API operation for Amazon DynamoDB.

Describes an existing backup of a table.

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

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

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

func (*Client) DescribeContinuousBackupsRequest Uses

func (c *Client) DescribeContinuousBackupsRequest(input *DescribeContinuousBackupsInput) DescribeContinuousBackupsRequest

DescribeContinuousBackupsRequest returns a request value for making API operation for Amazon DynamoDB.

Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

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

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

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

func (*Client) DescribeContributorInsightsRequest Uses

func (c *Client) DescribeContributorInsightsRequest(input *DescribeContributorInsightsInput) DescribeContributorInsightsRequest

DescribeContributorInsightsRequest returns a request value for making API operation for Amazon DynamoDB.

Returns information about contributor insights, for a given table or global secondary index.

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

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

func (*Client) DescribeEndpointsRequest Uses

func (c *Client) DescribeEndpointsRequest(input *DescribeEndpointsInput) DescribeEndpointsRequest

DescribeEndpointsRequest returns a request value for making API operation for Amazon DynamoDB.

Returns the regional endpoint information.

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

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

func (*Client) DescribeGlobalTableRequest Uses

func (c *Client) DescribeGlobalTableRequest(input *DescribeGlobalTableInput) DescribeGlobalTableRequest

DescribeGlobalTableRequest returns a request value for making API operation for Amazon DynamoDB.

Returns information about the specified global table.

This method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.

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

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

func (*Client) DescribeGlobalTableSettingsRequest Uses

func (c *Client) DescribeGlobalTableSettingsRequest(input *DescribeGlobalTableSettingsInput) DescribeGlobalTableSettingsRequest

DescribeGlobalTableSettingsRequest returns a request value for making API operation for Amazon DynamoDB.

Describes Region-specific settings for a global table.

This method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.

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

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

func (*Client) DescribeLimitsRequest Uses

func (c *Client) DescribeLimitsRequest(input *DescribeLimitsInput) DescribeLimitsRequest

DescribeLimitsRequest returns a request value for making API operation for Amazon DynamoDB.

Returns the current provisioned-capacity limits for your AWS account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.

When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) page in the Amazon DynamoDB Developer Guide.

Although you can increase these limits by filing a case at AWS Support Center (https://console.aws.amazon.com/support/home#/), obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.

For example, you could use one of the AWS SDKs to do the following:

Call DescribeLimits for a particular Region to obtain your current account limits on provisioned capacity there.

Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.

Call ListTables to obtain a list of all your DynamoDB tables.

For each table name listed by ListTables, do the following:

* Call DescribeTable with the table name.

* Use the data returned by DescribeTable to add the read capacity units
and write capacity units provisioned for the table itself to your variables.

* If the table has one or more global secondary indexes (GSIs), loop over
these GSIs and add their provisioned capacity values to your variables
as well.

Report the account limits for that Region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level limits.

The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly. But the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

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

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

To determine capacity limits per table and account, in the current AWS region

The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.DescribeLimitsInput{}

req := svc.DescribeLimitsRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) DescribeTableReplicaAutoScalingRequest Uses

func (c *Client) DescribeTableReplicaAutoScalingRequest(input *DescribeTableReplicaAutoScalingInput) DescribeTableReplicaAutoScalingRequest

DescribeTableReplicaAutoScalingRequest returns a request value for making API operation for Amazon DynamoDB.

Describes auto scaling settings across replicas of the global table at once.

This method only applies to Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global tables.

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

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

func (*Client) DescribeTableRequest Uses

func (c *Client) DescribeTableRequest(input *DescribeTableInput) DescribeTableRequest

DescribeTableRequest returns a request value for making API operation for Amazon DynamoDB.

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

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

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

To describe a table

This example describes the Music table.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.DescribeTableInput{
    TableName: aws.String("Music"),
}

req := svc.DescribeTableRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) DescribeTimeToLiveRequest Uses

func (c *Client) DescribeTimeToLiveRequest(input *DescribeTimeToLiveInput) DescribeTimeToLiveRequest

DescribeTimeToLiveRequest returns a request value for making API operation for Amazon DynamoDB.

Gives a description of the Time to Live (TTL) status on the specified table.

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

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

func (*Client) GetItemRequest Uses

func (c *Client) GetItemRequest(input *GetItemInput) GetItemRequest

GetItemRequest returns a request value for making API operation for Amazon DynamoDB.

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

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

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

To read an item from a table

This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.GetItemInput{
    Key: map[string]dynamodb.AttributeValue{
        "Artist": {
            S: aws.String("Acme Band"),
        },
        "SongTitle": {
            S: aws.String("Happy Day"),
        },
    },
    TableName: aws.String("Music"),
}

req := svc.GetItemRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) ListBackupsRequest Uses

func (c *Client) ListBackupsRequest(input *ListBackupsInput) ListBackupsRequest

ListBackupsRequest returns a request value for making API operation for Amazon DynamoDB.

List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

In the request, start time is inclusive, but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

You can call ListBackups a maximum of five times per second.

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

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

func (*Client) ListContributorInsightsRequest Uses

func (c *Client) ListContributorInsightsRequest(input *ListContributorInsightsInput) ListContributorInsightsRequest

ListContributorInsightsRequest returns a request value for making API operation for Amazon DynamoDB.

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

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

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

func (*Client) ListGlobalTablesRequest Uses

func (c *Client) ListGlobalTablesRequest(input *ListGlobalTablesInput) ListGlobalTablesRequest

ListGlobalTablesRequest returns a request value for making API operation for Amazon DynamoDB.

Lists all global tables that have a replica in the specified Region.

This method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.

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

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

func (*Client) ListTablesRequest Uses

func (c *Client) ListTablesRequest(input *ListTablesInput) ListTablesRequest

ListTablesRequest returns a request value for making API operation for Amazon DynamoDB.

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

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

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

To list tables

This example lists all of the tables associated with the current AWS account and endpoint.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.ListTablesInput{}

req := svc.ListTablesRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) ListTagsOfResourceRequest Uses

func (c *Client) ListTagsOfResourceRequest(input *ListTagsOfResourceInput) ListTagsOfResourceRequest

ListTagsOfResourceRequest returns a request value for making API operation for Amazon DynamoDB.

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the Amazon DynamoDB Developer Guide.

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

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

func (*Client) PutItemRequest Uses

func (c *Client) PutItemRequest(input *PutItemInput) PutItemRequest

PutItemRequest returns a request value for making API operation for Amazon DynamoDB.

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter.

This topic provides general information about the PutItem API.

For information on how to call the PutItem API using the AWS SDK in specific languages, see the following:

* PutItem in the AWS Command Line Interface (http://docs.aws.amazon.com/goto/aws-cli/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for .NET (http://docs.aws.amazon.com/goto/DotNetSDKV3/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for C++ (http://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for Go (http://docs.aws.amazon.com/goto/SdkForGoV1/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for Java (http://docs.aws.amazon.com/goto/SdkForJava/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for JavaScript (http://docs.aws.amazon.com/goto/AWSJavaScriptSDK/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for PHP V3 (http://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for Python (http://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutItem)

* PutItem in the AWS SDK for Ruby V2 (http://docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem)

When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.

To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.

For more information about PutItem, see Working with Items (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html) in the Amazon DynamoDB Developer Guide.

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

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

To add an item to a table

This example adds a new item to the Music table.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.PutItemInput{
    Item: map[string]dynamodb.AttributeValue{
        "AlbumTitle": {
            S: aws.String("Somewhat Famous"),
        },
        "Artist": {
            S: aws.String("No One You Know"),
        },
        "SongTitle": {
            S: aws.String("Call Me Today"),
        },
    },
    ReturnConsumedCapacity: dynamodb.ReturnConsumedCapacityTotal,
    TableName:              aws.String("Music"),
}

req := svc.PutItemRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeConditionalCheckFailedException:
            fmt.Println(dynamodb.ErrCodeConditionalCheckFailedException, aerr.Error())
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
            fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
        case dynamodb.ErrCodeTransactionConflictException:
            fmt.Println(dynamodb.ErrCodeTransactionConflictException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) QueryRequest Uses

func (c *Client) QueryRequest(input *QueryInput) QueryRequest

QueryRequest returns a request value for making API operation for Amazon DynamoDB.

The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.

A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.

Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.

A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination) in the Amazon DynamoDB Developer Guide.

FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

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

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

To query an item

This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named "No One You Know".

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.QueryInput{
    ExpressionAttributeValues: map[string]dynamodb.AttributeValue{
        ":v1": {
            S: aws.String("No One You Know"),
        },
    },
    KeyConditionExpression: aws.String("Artist = :v1"),
    ProjectionExpression:   aws.String("SongTitle"),
    TableName:              aws.String("Music"),
}

req := svc.QueryRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) RestoreTableFromBackupRequest Uses

func (c *Client) RestoreTableFromBackupRequest(input *RestoreTableFromBackupInput) RestoreTableFromBackupRequest

RestoreTableFromBackupRequest returns a request value for making API operation for Amazon DynamoDB.

Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

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

You must manually set up the following on the restored table:

* Auto scaling policies

* IAM policies

* Amazon CloudWatch metrics and alarms

* Tags

* Stream settings

* Time to Live (TTL) settings

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

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

func (*Client) RestoreTableToPointInTimeRequest Uses

func (c *Client) RestoreTableToPointInTimeRequest(input *RestoreTableToPointInTimeInput) RestoreTableToPointInTimeRequest

RestoreTableToPointInTimeRequest returns a request value for making API operation for Amazon DynamoDB.

Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

Along with data, the following are also included on the new restored table using point in time recovery:

* Global secondary indexes (GSIs)

* Local secondary indexes (LSIs)

* Provisioned read and write capacity

* Encryption settings All these settings come from the current settings
of the source table at the time of restore.

You must manually set up the following on the restored table:

* Auto scaling policies

* IAM policies

* Amazon CloudWatch metrics and alarms

* Tags

* Stream settings

* Time to Live (TTL) settings

* Point in time recovery settings

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

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

func (*Client) ScanRequest Uses

func (c *Client) ScanRequest(input *ScanInput) ScanRequest

ScanRequest returns a request value for making API operation for Amazon DynamoDB.

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination) in the Amazon DynamoDB Developer Guide.

Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan) in the Amazon DynamoDB Developer Guide.

Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.

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

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

To scan a table

This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.ScanInput{
    ExpressionAttributeNames: map[string]string{
        "#AT": "AlbumTitle",
        "#ST": "SongTitle",
    },
    ExpressionAttributeValues: map[string]dynamodb.AttributeValue{
        ":a": {
            S: aws.String("No One You Know"),
        },
    },
    FilterExpression:     aws.String("Artist = :a"),
    ProjectionExpression: aws.String("#ST, #AT"),
    TableName:            aws.String("Music"),
}

req := svc.ScanRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) TagResourceRequest Uses

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon DynamoDB.

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the Amazon DynamoDB Developer Guide.

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

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

func (*Client) TransactGetItemsRequest Uses

func (c *Client) TransactGetItemsRequest(input *TransactGetItemsInput) TransactGetItemsRequest

TransactGetItemsRequest returns a request value for making API operation for Amazon DynamoDB.

TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 25 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.

DynamoDB rejects the entire TransactGetItems request if any of the following is true:

* A conflicting operation is in the process of updating an item to be
read.

* There is insufficient provisioned capacity for the transaction to be
completed.

* There is a user error, such as an invalid data format.

* The aggregate size of the items in the transaction cannot exceed 4 MB.

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

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

func (*Client) TransactWriteItemsRequest Uses

func (c *Client) TransactWriteItemsRequest(input *TransactWriteItemsInput) TransactWriteItemsRequest

TransactWriteItemsRequest returns a request value for making API operation for Amazon DynamoDB.

TransactWriteItems is a synchronous write operation that groups up to 25 action requests. These actions can target items in different tables, but not in different AWS accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.

The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:

* Put — Initiates a PutItem operation to write a new item. This structure
specifies the primary key of the item to be written, the name of the table
to write it in, an optional condition expression that must be satisfied
for the write to succeed, a list of the item's attributes, and a field
indicating whether to retrieve the item's attributes if the condition
is not met.

* Update — Initiates an UpdateItem operation to update an existing item.
This structure specifies the primary key of the item to be updated, the
name of the table where it resides, an optional condition expression that
must be satisfied for the update to succeed, an expression that defines
one or more attributes to be updated, and a field indicating whether to
retrieve the item's attributes if the condition is not met.

* Delete — Initiates a DeleteItem operation to delete an existing item.
This structure specifies the primary key of the item to be deleted, the
name of the table where it resides, an optional condition expression that
must be satisfied for the deletion to succeed, and a field indicating
whether to retrieve the item's attributes if the condition is not met.

* ConditionCheck — Applies a condition to an item that is not being
modified by the transaction. This structure specifies the primary key
of the item to be checked, the name of the table where it resides, a condition
expression that must be satisfied for the transaction to succeed, and
a field indicating whether to retrieve the item's attributes if the condition
is not met.

DynamoDB rejects the entire TransactWriteItems request if any of the following is true:

* A condition in one of the condition expressions is not met.

* An ongoing operation is in the process of updating the same item.

* There is insufficient provisioned capacity for the transaction to be
completed.

* An item size becomes too large (bigger than 400 KB), a local secondary
index (LSI) becomes too large, or a similar validation error occurs because
of changes made by the transaction.

* The aggregate size of the items in the transaction exceeds 4 MB.

* There is a user error, such as an invalid data format.

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

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

func (*Client) UntagResourceRequest Uses

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon DynamoDB.

Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the Amazon DynamoDB Developer Guide.

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

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

func (*Client) UpdateContinuousBackupsRequest Uses

func (c *Client) UpdateContinuousBackupsRequest(input *UpdateContinuousBackupsInput) UpdateContinuousBackupsRequest

UpdateContinuousBackupsRequest returns a request value for making API operation for Amazon DynamoDB.

UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

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

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

func (*Client) UpdateContributorInsightsRequest Uses

func (c *Client) UpdateContributorInsightsRequest(input *UpdateContributorInsightsInput) UpdateContributorInsightsRequest

UpdateContributorInsightsRequest returns a request value for making API operation for Amazon DynamoDB.

Updates the status for contributor insights for a specific table or index.

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

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

func (*Client) UpdateGlobalTableRequest Uses

func (c *Client) UpdateGlobalTableRequest(input *UpdateGlobalTableInput) UpdateGlobalTableRequest

UpdateGlobalTableRequest returns a request value for making API operation for Amazon DynamoDB.

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

* The global secondary indexes must have the same name.

* The global secondary indexes must have the same hash key and sort key
(if present).

* The global secondary indexes must have the same provisioned and maximum
write capacity units.

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

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

func (*Client) UpdateGlobalTableSettingsRequest Uses

func (c *Client) UpdateGlobalTableSettingsRequest(input *UpdateGlobalTableSettingsInput) UpdateGlobalTableSettingsRequest

UpdateGlobalTableSettingsRequest returns a request value for making API operation for Amazon DynamoDB.

Updates settings for a global table.

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

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

func (*Client) UpdateItemRequest Uses

func (c *Client) UpdateItemRequest(input *UpdateItemInput) UpdateItemRequest

UpdateItemRequest returns a request value for making API operation for Amazon DynamoDB.

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

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

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

To update an item in a table

This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.UpdateItemInput{
    ExpressionAttributeNames: map[string]string{
        "#AT": "AlbumTitle",
        "#Y":  "Year",
    },
    ExpressionAttributeValues: map[string]dynamodb.AttributeValue{
        ":t": {
            S: aws.String("Louder Than Ever"),
        },
        ":y": {
            N: aws.String("2015"),
        },
    },
    Key: map[string]dynamodb.AttributeValue{
        "Artist": {
            S: aws.String("Acme Band"),
        },
        "SongTitle": {
            S: aws.String("Happy Day"),
        },
    },
    ReturnValues:     dynamodb.ReturnValueAllNew,
    TableName:        aws.String("Music"),
    UpdateExpression: aws.String("SET #Y = :y, #AT = :t"),
}

req := svc.UpdateItemRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeConditionalCheckFailedException:
            fmt.Println(dynamodb.ErrCodeConditionalCheckFailedException, aerr.Error())
        case dynamodb.ErrCodeProvisionedThroughputExceededException:
            fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
            fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
        case dynamodb.ErrCodeTransactionConflictException:
            fmt.Println(dynamodb.ErrCodeTransactionConflictException, aerr.Error())
        case dynamodb.ErrCodeRequestLimitExceeded:
            fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) UpdateTableReplicaAutoScalingRequest Uses

func (c *Client) UpdateTableReplicaAutoScalingRequest(input *UpdateTableReplicaAutoScalingInput) UpdateTableReplicaAutoScalingRequest

UpdateTableReplicaAutoScalingRequest returns a request value for making API operation for Amazon DynamoDB.

Updates auto scaling settings on your global tables at once.

This method only applies to Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global tables.

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

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

func (*Client) UpdateTableRequest Uses

func (c *Client) UpdateTableRequest(input *UpdateTableInput) UpdateTableRequest

UpdateTableRequest returns a request value for making API operation for Amazon DynamoDB.

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

* Modify the provisioned throughput settings of the table.

* Enable or disable DynamoDB Streams on the table.

* Remove a global secondary index from the table.

* Create a new global secondary index on the table. After the index begins
backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

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

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

To modify a table's provisioned throughput

This example increases the provisioned read and write capacity on the Music table.

Code:

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

svc := dynamodb.New(cfg)
input := &dynamodb.UpdateTableInput{
    ProvisionedThroughput: &dynamodb.ProvisionedThroughput{
        ReadCapacityUnits:  aws.Int64(10),
        WriteCapacityUnits: aws.Int64(10),
    },
    TableName: aws.String("MusicCollection"),
}

req := svc.UpdateTableRequest(input)
result, err := req.Send(context.Background())
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case dynamodb.ErrCodeResourceInUseException:
            fmt.Println(dynamodb.ErrCodeResourceInUseException, aerr.Error())
        case dynamodb.ErrCodeResourceNotFoundException:
            fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
        case dynamodb.ErrCodeLimitExceededException:
            fmt.Println(dynamodb.ErrCodeLimitExceededException, aerr.Error())
        case dynamodb.ErrCodeInternalServerError:
            fmt.Println(dynamodb.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)

func (*Client) UpdateTimeToLiveRequest Uses

func (c *Client) UpdateTimeToLiveRequest(input *UpdateTimeToLiveInput) UpdateTimeToLiveRequest

UpdateTimeToLiveRequest returns a request value for making API operation for Amazon DynamoDB.

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) in the Amazon DynamoDB Developer Guide.

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

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

func (*Client) WaitUntilTableExists Uses

func (c *Client) WaitUntilTableExists(ctx context.Context, input *DescribeTableInput, opts ...aws.WaiterOption) error

WaitUntilTableExists uses the DynamoDB API operation DescribeTable to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilTableNotExists Uses

func (c *Client) WaitUntilTableNotExists(ctx context.Context, input *DescribeTableInput, opts ...aws.WaiterOption) error

WaitUntilTableNotExists uses the DynamoDB API operation DescribeTable to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ComparisonOperator Uses

type ComparisonOperator string
const (
    ComparisonOperatorEq          ComparisonOperator = "EQ"
    ComparisonOperatorNe          ComparisonOperator = "NE"
    ComparisonOperatorIn          ComparisonOperator = "IN"
    ComparisonOperatorLe          ComparisonOperator = "LE"
    ComparisonOperatorLt          ComparisonOperator = "LT"
    ComparisonOperatorGe          ComparisonOperator = "GE"
    ComparisonOperatorGt          ComparisonOperator = "GT"
    ComparisonOperatorBetween     ComparisonOperator = "BETWEEN"
    ComparisonOperatorNotNull     ComparisonOperator = "NOT_NULL"
    ComparisonOperatorNull        ComparisonOperator = "NULL"
    ComparisonOperatorContains    ComparisonOperator = "CONTAINS"
    ComparisonOperatorNotContains ComparisonOperator = "NOT_CONTAINS"
    ComparisonOperatorBeginsWith  ComparisonOperator = "BEGINS_WITH"
)

Enum values for ComparisonOperator

func (ComparisonOperator) MarshalValue Uses

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

func (ComparisonOperator) MarshalValueBuf Uses

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

type Condition Uses

type Condition struct {

    // One or more values to evaluate against the supplied attribute. The number
    // of values in the list depends on the ComparisonOperator being used.
    //
    // For type Number, value comparisons are numeric.
    //
    // String value comparisons for greater than, equals, or less than are based
    // on ASCII character code values. For example, a is greater than A, and a is
    // greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters
    // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters).
    //
    // For Binary, DynamoDB treats each byte of the binary data as unsigned when
    // it compares binary values.
    AttributeValueList []AttributeValue `type:"list"`

    // A comparator for evaluating attributes. For example, equals, greater than,
    // less than, etc.
    //
    // The following comparison operators are available:
    //
    // EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |
    // BEGINS_WITH | IN | BETWEEN
    //
    // The following are descriptions of each comparison operator.
    //
    //    * EQ : Equal. EQ is supported for all data types, including lists and
    //    maps. AttributeValueList can contain only one AttributeValue element of
    //    type String, Number, Binary, String Set, Number Set, or Binary Set. If
    //    an item contains an AttributeValue element of a different type than the
    //    one provided in the request, the value does not match. For example, {"S":"6"}
    //    does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2",
    //    "1"]}.
    //
    //    * NE : Not equal. NE is supported for all data types, including lists
    //    and maps. AttributeValueList can contain only one AttributeValue of type
    //    String, Number, Binary, String Set, Number Set, or Binary Set. If an item
    //    contains an AttributeValue of a different type than the one provided in
    //    the request, the value does not match. For example, {"S":"6"} does not
    //    equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
    //
    //    * LE : Less than or equal. AttributeValueList can contain only one AttributeValue
    //    element of type String, Number, or Binary (not a set type). If an item
    //    contains an AttributeValue element of a different type than the one provided
    //    in the request, the value does not match. For example, {"S":"6"} does
    //    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
    //    "1"]}.
    //
    //    * LT : Less than. AttributeValueList can contain only one AttributeValue
    //    of type String, Number, or Binary (not a set type). If an item contains
    //    an AttributeValue element of a different type than the one provided in
    //    the request, the value does not match. For example, {"S":"6"} does not
    //    equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
    //    "1"]}.
    //
    //    * GE : Greater than or equal. AttributeValueList can contain only one
    //    AttributeValue element of type String, Number, or Binary (not a set type).
    //    If an item contains an AttributeValue element of a different type than
    //    the one provided in the request, the value does not match. For example,
    //    {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to
    //    {"NS":["6", "2", "1"]}.
    //
    //    * GT : Greater than. AttributeValueList can contain only one AttributeValue
    //    element of type String, Number, or Binary (not a set type). If an item
    //    contains an AttributeValue element of a different type than the one provided
    //    in the request, the value does not match. For example, {"S":"6"} does
    //    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
    //    "1"]}.
    //
    //    * NOT_NULL : The attribute exists. NOT_NULL is supported for all data
    //    types, including lists and maps. This operator tests for the existence
    //    of an attribute, not its data type. If the data type of attribute "a"
    //    is null, and you evaluate it using NOT_NULL, the result is a Boolean true.
    //    This result is because the attribute "a" exists; its data type is not
    //    relevant to the NOT_NULL comparison operator.
    //
    //    * NULL : The attribute does not exist. NULL is supported for all data
    //    types, including lists and maps. This operator tests for the nonexistence
    //    of an attribute, not its data type. If the data type of attribute "a"
    //    is null, and you evaluate it using NULL, the result is a Boolean false.
    //    This is because the attribute "a" exists; its data type is not relevant
    //    to the NULL comparison operator.
    //
    //    * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList
    //    can contain only one AttributeValue element of type String, Number, or
    //    Binary (not a set type). If the target attribute of the comparison is
    //    of type String, then the operator checks for a substring match. If the
    //    target attribute of the comparison is of type Binary, then the operator
    //    looks for a subsequence of the target that matches the input. If the target
    //    attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator
    //    evaluates to true if it finds an exact match with any member of the set.
    //    CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can
    //    be a list; however, "b" cannot be a set, a map, or a list.
    //
    //    * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a
    //    value in a set. AttributeValueList can contain only one AttributeValue
    //    element of type String, Number, or Binary (not a set type). If the target
    //    attribute of the comparison is a String, then the operator checks for
    //    the absence of a substring match. If the target attribute of the comparison
    //    is Binary, then the operator checks for the absence of a subsequence of
    //    the target that matches the input. If the target attribute of the comparison
    //    is a set ("SS", "NS", or "BS"), then the operator evaluates to true if
    //    it does not find an exact match with any member of the set. NOT_CONTAINS
    //    is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be
    //    a list; however, "b" cannot be a set, a map, or a list.
    //
    //    * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only
    //    one AttributeValue of type String or Binary (not a Number or a set type).
    //    The target attribute of the comparison must be of type String or Binary
    //    (not a Number or a set type).
    //
    //    * IN : Checks for matching elements in a list. AttributeValueList can
    //    contain one or more AttributeValue elements of type String, Number, or
    //    Binary. These attributes are compared against an existing attribute of
    //    an item. If any elements of the input are equal to the item attribute,
    //    the expression evaluates to true.
    //
    //    * BETWEEN : Greater than or equal to the first value, and less than or
    //    equal to the second value. AttributeValueList must contain two AttributeValue
    //    elements of the same type, either String, Number, or Binary (not a set
    //    type). A target attribute matches if the target value is greater than,
    //    or equal to, the first element and less than, or equal to, the second
    //    element. If an item contains an AttributeValue element of a different
    //    type than the one provided in the request, the value does not match. For
    //    example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does
    //    not compare to {"NS":["6", "2", "1"]}
    //
    // For usage examples of AttributeValueList and ComparisonOperator, see Legacy
    // Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html)
    // in the Amazon DynamoDB Developer Guide.
    //
    // ComparisonOperator is a required field
    ComparisonOperator ComparisonOperator `type:"string" required:"true" enum:"true"`
    // contains filtered or unexported fields
}

Represents the selection criteria for a Query or Scan operation:

* For a Query operation, Condition is used for specifying the KeyConditions
to use when querying a table or an index. For KeyConditions, only the
following comparison operators are supported: EQ | LE | LT | GE | GT |
BEGINS_WITH | BETWEEN Condition is also used in a QueryFilter, which evaluates
the query results and returns only the desired values.

* For a Scan operation, Condition is used in a ScanFilter, which evaluates
the scan results and returns only the desired values.

func (Condition) String Uses

func (s Condition) String() string

String returns the string representation

func (*Condition) Validate Uses

func (s *Condition) Validate() error

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

type ConditionCheck Uses

type ConditionCheck struct {

    // A condition that must be satisfied in order for a conditional update to succeed.
    //
    // ConditionExpression is a required field
    ConditionExpression *string `type:"string" required:"true"`

    // One or more substitution tokens for attribute names in an expression.
    ExpressionAttributeNames map[string]string `type:"map"`

    // One or more values that can be substituted in an expression.
    ExpressionAttributeValues map[string]AttributeValue `type:"map"`

    // The primary key of the item to be checked. Each element consists of an attribute
    // name and a value for that attribute.
    //
    // Key is a required field
    Key map[string]AttributeValue `type:"map" required:"true"`

    // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
    // ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure,
    // the valid values are: NONE and ALL_OLD.
    ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure `type:"string" enum:"true"`

    // Name of the table for the check item request.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

func (ConditionCheck) String Uses

func (s ConditionCheck) String() string

String returns the string representation

func (*ConditionCheck) Validate Uses

func (s *ConditionCheck) Validate() error

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

type ConditionalOperator Uses

type ConditionalOperator string
const (
    ConditionalOperatorAnd ConditionalOperator = "AND"
    ConditionalOperatorOr  ConditionalOperator = "OR"
)

Enum values for ConditionalOperator

func (ConditionalOperator) MarshalValue Uses

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

func (ConditionalOperator) MarshalValueBuf Uses

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

type ConsumedCapacity Uses

type ConsumedCapacity struct {

    // The total number of capacity units consumed by the operation.
    CapacityUnits *float64 `type:"double"`

    // The amount of throughput consumed on each global index affected by the operation.
    GlobalSecondaryIndexes map[string]Capacity `type:"map"`

    // The amount of throughput consumed on each local index affected by the operation.
    LocalSecondaryIndexes map[string]Capacity `type:"map"`

    // The total number of read capacity units consumed by the operation.
    ReadCapacityUnits *float64 `type:"double"`

    // The amount of throughput consumed on the table affected by the operation.
    Table *Capacity `type:"structure"`

    // The name of the table that was affected by the operation.
    TableName *string `min:"3" type:"string"`

    // The total number of write capacity units consumed by the operation.
    WriteCapacityUnits *float64 `type:"double"`
    // contains filtered or unexported fields
}

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) in the Amazon DynamoDB Developer Guide.

func (ConsumedCapacity) String Uses

func (s ConsumedCapacity) String() string

String returns the string representation

type ContinuousBackupsDescription Uses

type ContinuousBackupsDescription struct {

    // ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
    //
    // ContinuousBackupsStatus is a required field
    ContinuousBackupsStatus ContinuousBackupsStatus `type:"string" required:"true" enum:"true"`

    // The description of the point in time recovery settings applied to the table.
    PointInTimeRecoveryDescription *PointInTimeRecoveryDescription `type:"structure"`
    // contains filtered or unexported fields
}

Represents the continuous backups and point in time recovery settings on the table.

func (ContinuousBackupsDescription) String Uses

func (s ContinuousBackupsDescription) String() string

String returns the string representation

type ContinuousBackupsStatus Uses

type ContinuousBackupsStatus string
const (
    ContinuousBackupsStatusEnabled  ContinuousBackupsStatus = "ENABLED"
    ContinuousBackupsStatusDisabled ContinuousBackupsStatus = "DISABLED"
)

Enum values for ContinuousBackupsStatus

func (ContinuousBackupsStatus) MarshalValue Uses

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

func (ContinuousBackupsStatus) MarshalValueBuf Uses

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

type ContributorInsightsAction Uses

type ContributorInsightsAction string
const (
    ContributorInsightsActionEnable  ContributorInsightsAction = "ENABLE"
    ContributorInsightsActionDisable ContributorInsightsAction = "DISABLE"
)

Enum values for ContributorInsightsAction

func (ContributorInsightsAction) MarshalValue Uses

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

func (ContributorInsightsAction) MarshalValueBuf Uses

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

type ContributorInsightsStatus Uses

type ContributorInsightsStatus string
const (
    ContributorInsightsStatusEnabling  ContributorInsightsStatus = "ENABLING"
    ContributorInsightsStatusEnabled   ContributorInsightsStatus = "ENABLED"
    ContributorInsightsStatusDisabling ContributorInsightsStatus = "DISABLING"
    ContributorInsightsStatusDisabled  ContributorInsightsStatus = "DISABLED"
    ContributorInsightsStatusFailed    ContributorInsightsStatus = "FAILED"
)

Enum values for ContributorInsightsStatus

func (ContributorInsightsStatus) MarshalValue Uses

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

func (ContributorInsightsStatus) MarshalValueBuf Uses

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

type ContributorInsightsSummary Uses

type ContributorInsightsSummary struct {

    // Describes the current status for contributor insights for the given table
    // and index, if applicable.
    ContributorInsightsStatus ContributorInsightsStatus `type:"string" enum:"true"`

    // Name of the index associated with the summary, if any.
    IndexName *string `min:"3" type:"string"`

    // Name of the table associated with the summary.
    TableName *string `min:"3" type:"string"`
    // contains filtered or unexported fields
}

Represents a Contributor Insights summary entry..

func (ContributorInsightsSummary) String Uses

func (s ContributorInsightsSummary) String() string

String returns the string representation

type CreateBackupInput Uses

type CreateBackupInput struct {

    // Specified name for the backup.
    //
    // BackupName is a required field
    BackupName *string `min:"3" type:"string" required:"true"`

    // The name of the table.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateBackupInput) String Uses

func (s CreateBackupInput) String() string

String returns the string representation

func (*CreateBackupInput) Validate Uses

func (s *CreateBackupInput) Validate() error

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

type CreateBackupOutput Uses

type CreateBackupOutput struct {

    // Contains the details of the backup created for the table.
    BackupDetails *BackupDetails `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateBackupOutput) String Uses

func (s CreateBackupOutput) String() string

String returns the string representation

type CreateBackupRequest Uses

type CreateBackupRequest struct {
    *aws.Request
    Input *CreateBackupInput
    Copy  func(*CreateBackupInput) CreateBackupRequest
}

CreateBackupRequest is the request type for the CreateBackup API operation.

func (CreateBackupRequest) Send Uses

func (r CreateBackupRequest) Send(ctx context.Context) (*CreateBackupResponse, error)

Send marshals and sends the CreateBackup API request.

type CreateBackupResponse Uses

type CreateBackupResponse struct {
    *CreateBackupOutput
    // contains filtered or unexported fields
}

CreateBackupResponse is the response type for the CreateBackup API operation.

func (*CreateBackupResponse) SDKResponseMetdata Uses

func (r *CreateBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateBackup request.

type CreateGlobalSecondaryIndexAction Uses

type CreateGlobalSecondaryIndexAction struct {

    // The name of the global secondary index to be created.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`

    // The key schema for the global secondary index.
    //
    // KeySchema is a required field
    KeySchema []KeySchemaElement `min:"1" type:"list" required:"true"`

    // Represents attributes that are copied (projected) from the table into an
    // index. These are in addition to the primary key attributes and index key
    // attributes, which are automatically projected.
    //
    // Projection is a required field
    Projection *Projection `type:"structure" required:"true"`

    // Represents the provisioned throughput settings for the specified global secondary
    // index.
    //
    // For current minimum and maximum provisioned throughput values, see Limits
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
    // in the Amazon DynamoDB Developer Guide.
    ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
    // contains filtered or unexported fields
}

Represents a new global secondary index to be added to an existing table.

func (CreateGlobalSecondaryIndexAction) String Uses

func (s CreateGlobalSecondaryIndexAction) String() string

String returns the string representation

func (*CreateGlobalSecondaryIndexAction) Validate Uses

func (s *CreateGlobalSecondaryIndexAction) Validate() error

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

type CreateGlobalTableInput Uses

type CreateGlobalTableInput struct {

    // The global table name.
    //
    // GlobalTableName is a required field
    GlobalTableName *string `min:"3" type:"string" required:"true"`

    // The Regions where the global table needs to be created.
    //
    // ReplicationGroup is a required field
    ReplicationGroup []Replica `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (CreateGlobalTableInput) String Uses

func (s CreateGlobalTableInput) String() string

String returns the string representation

func (*CreateGlobalTableInput) Validate Uses

func (s *CreateGlobalTableInput) Validate() error

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

type CreateGlobalTableOutput Uses

type CreateGlobalTableOutput struct {

    // Contains the details of the global table.
    GlobalTableDescription *GlobalTableDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateGlobalTableOutput) String Uses

func (s CreateGlobalTableOutput) String() string

String returns the string representation

type CreateGlobalTableRequest Uses

type CreateGlobalTableRequest struct {
    *aws.Request
    Input *CreateGlobalTableInput
    Copy  func(*CreateGlobalTableInput) CreateGlobalTableRequest
}

CreateGlobalTableRequest is the request type for the CreateGlobalTable API operation.

func (CreateGlobalTableRequest) Send Uses

func (r CreateGlobalTableRequest) Send(ctx context.Context) (*CreateGlobalTableResponse, error)

Send marshals and sends the CreateGlobalTable API request.

type CreateGlobalTableResponse Uses

type CreateGlobalTableResponse struct {
    *CreateGlobalTableOutput
    // contains filtered or unexported fields
}

CreateGlobalTableResponse is the response type for the CreateGlobalTable API operation.

func (*CreateGlobalTableResponse) SDKResponseMetdata Uses

func (r *CreateGlobalTableResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateGlobalTable request.

type CreateReplicaAction Uses

type CreateReplicaAction struct {

    // The Region of the replica to be added.
    //
    // RegionName is a required field
    RegionName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a replica to be added.

func (CreateReplicaAction) String Uses

func (s CreateReplicaAction) String() string

String returns the string representation

func (*CreateReplicaAction) Validate Uses

func (s *CreateReplicaAction) Validate() error

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

type CreateReplicationGroupMemberAction Uses

type CreateReplicationGroupMemberAction struct {

    // Replica-specific global secondary index settings.
    GlobalSecondaryIndexes []ReplicaGlobalSecondaryIndex `min:"1" type:"list"`

    // The AWS KMS customer master key (CMK) that should be used for AWS KMS encryption
    // in the new replica. To specify a CMK, use its key ID, Amazon Resource Name
    // (ARN), alias name, or alias ARN. Note that you should only provide this parameter
    // if the key is different from the default DynamoDB KMS master key alias/aws/dynamodb.
    KMSMasterKeyId *string `type:"string"`

    // Replica-specific provisioned throughput. If not specified, uses the source
    // table's provisioned throughput settings.
    ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`

    // The Region where the new replica will be created.
    //
    // RegionName is a required field
    RegionName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a replica to be created.

func (CreateReplicationGroupMemberAction) String Uses

func (s CreateReplicationGroupMemberAction) String() string

String returns the string representation

func (*CreateReplicationGroupMemberAction) Validate Uses

func (s *CreateReplicationGroupMemberAction) Validate() error

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

type CreateTableInput Uses

type CreateTableInput struct {

    // An array of attributes that describe the key schema for the table and indexes.
    //
    // AttributeDefinitions is a required field
    AttributeDefinitions []AttributeDefinition `type:"list" required:"true"`

    // Controls how you are charged for read and write throughput and how you manage
    // capacity. This setting can be changed later.
    //
    //    * PROVISIONED - We recommend using PROVISIONED for predictable workloads.
    //    PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).
    //
    //    * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
    //    workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).
    BillingMode BillingMode `type:"string" enum:"true"`

    // One or more global secondary indexes (the maximum is 20) to be created on
    // the table. Each global secondary index in the array includes the following:
    //
    //    * IndexName - The name of the global secondary index. Must be unique only
    //    for this table.
    //
    //    * KeySchema - Specifies the key schema for the global secondary index.
    //
    //    * Projection - Specifies attributes that are copied (projected) from the
    //    table into the index. These are in addition to the primary key attributes
    //    and index key attributes, which are automatically projected. Each attribute
    //    specification is composed of: ProjectionType - One of the following: KEYS_ONLY
    //    - Only the index and primary keys are projected into the index. INCLUDE
    //    - Only the specified table attributes are projected into the index. The
    //    list of projected attributes is in NonKeyAttributes. ALL - All of the
    //    table attributes are projected into the index. NonKeyAttributes - A list
    //    of one or more non-key attribute names that are projected into the secondary
    //    index. The total count of attributes provided in NonKeyAttributes, summed
    //    across all of the secondary indexes, must not exceed 100. If you project
    //    the same attribute into two different indexes, this counts as two distinct
    //    attributes when determining the total.
    //
    //    * ProvisionedThroughput - The provisioned throughput settings for the
    //    global secondary index, consisting of read and write capacity units.
    GlobalSecondaryIndexes []GlobalSecondaryIndex `type:"list"`

    // Specifies the attributes that make up the primary key for a table or an index.
    // The attributes in KeySchema must also be defined in the AttributeDefinitions
    // array. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html)
    // in the Amazon DynamoDB Developer Guide.
    //
    // Each KeySchemaElement in the array is composed of:
    //
    //    * AttributeName - The name of this key attribute.
    //
    //    * KeyType - The role that the key attribute will assume: HASH - partition
    //    key RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from the DynamoDB usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    //
    // For a simple primary key (partition key), you must provide exactly one element
    // with a KeyType of HASH.
    //
    // For a composite primary key (partition key and sort key), you must provide
    // exactly two elements, in this order: The first element must have a KeyType
    // of HASH, and the second element must have a KeyType of RANGE.
    //
    // For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)
    // in the Amazon DynamoDB Developer Guide.
    //
    // KeySchema is a required field
    KeySchema []KeySchemaElement `min:"1" type:"list" required:"true"`

    // One or more local secondary indexes (the maximum is 5) to be created on the
    // table. Each index is scoped to a given partition key value. There is a 10
    // GB size limit per partition key value; otherwise, the size of a local secondary
    // index is unconstrained.
    //
    // Each local secondary index in the array includes the following:
    //
    //    * IndexName - The name of the local secondary index. Must be unique only
    //    for this table.
    //
    //    * KeySchema - Specifies the key schema for the local secondary index.
    //    The key schema must begin with the same partition key as the table.
    //
    //    * Projection - Specifies attributes that are copied (projected) from the
    //    table into the index. These are in addition to the primary key attributes
    //    and index key attributes, which are automatically projected. Each attribute
    //    specification is composed of: ProjectionType - One of the following: KEYS_ONLY
    //    - Only the index and primary keys are projected into the index. INCLUDE
    //    - Only the specified table attributes are projected into the index. The
    //    list of projected attributes is in NonKeyAttributes. ALL - All of the
    //    table attributes are projected into the index. NonKeyAttributes - A list
    //    of one or more non-key attribute names that are projected into the secondary
    //    index. The total count of attributes provided in NonKeyAttributes, summed
    //    across all of the secondary indexes, must not exceed 100. If you project
    //    the same attribute into two different indexes, this counts as two distinct
    //    attributes when determining the total.
    LocalSecondaryIndexes []LocalSecondaryIndex `type:"list"`

    // Represents the provisioned throughput settings for a specified table or index.
    // The settings can be modified using the UpdateTable operation.
    //
    // If you set BillingMode as PROVISIONED, you must specify this property. If
    // you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.
    //
    // For current minimum and maximum provisioned throughput values, see Limits
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
    // in the Amazon DynamoDB Developer Guide.
    ProvisionedThroughput *ProvisionedThroughput `type:"structure"`

    // Represents the settings used to enable server-side encryption.
    SSESpecification *SSESpecification `type:"structure"`

    // The settings for DynamoDB Streams on the table. These settings consist of:
    //
    //    * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled
    //    (true) or disabled (false).
    //
    //    * StreamViewType - When an item in the table is modified, StreamViewType
    //    determines what information is written to the table's stream. Valid values
    //    for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified
    //    item are written to the stream. NEW_IMAGE - The entire item, as it appears
    //    after it was modified, is written to the stream. OLD_IMAGE - The entire
    //    item, as it appeared before it was modified, is written to the stream.
    //    NEW_AND_OLD_IMAGES - Both the new and the old item images of the item
    //    are written to the stream.
    StreamSpecification *StreamSpecification `type:"structure"`

    // The name of the table to create.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`

    // A list of key-value pairs to label the table. For more information, see Tagging
    // for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html).
    Tags []Tag `type:"list"`
    // contains filtered or unexported fields
}

Represents the input of a CreateTable operation.

func (CreateTableInput) String Uses

func (s CreateTableInput) String() string

String returns the string representation

func (*CreateTableInput) Validate Uses

func (s *CreateTableInput) Validate() error

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

type CreateTableOutput Uses

type CreateTableOutput struct {

    // Represents the properties of the table.
    TableDescription *TableDescription `type:"structure"`
    // contains filtered or unexported fields
}

Represents the output of a CreateTable operation.

func (CreateTableOutput) String Uses

func (s CreateTableOutput) String() string

String returns the string representation

type CreateTableRequest Uses

type CreateTableRequest struct {
    *aws.Request
    Input *CreateTableInput
    Copy  func(*CreateTableInput) CreateTableRequest
}

CreateTableRequest is the request type for the CreateTable API operation.

func (CreateTableRequest) Send Uses

func (r CreateTableRequest) Send(ctx context.Context) (*CreateTableResponse, error)

Send marshals and sends the CreateTable API request.

type CreateTableResponse Uses

type CreateTableResponse struct {
    *CreateTableOutput
    // contains filtered or unexported fields
}

CreateTableResponse is the response type for the CreateTable API operation.

func (*CreateTableResponse) SDKResponseMetdata Uses

func (r *CreateTableResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateTable request.

type Delete Uses

type Delete struct {

    // A condition that must be satisfied in order for a conditional delete to succeed.
    ConditionExpression *string `type:"string"`

    // One or more substitution tokens for attribute names in an expression.
    ExpressionAttributeNames map[string]string `type:"map"`

    // One or more values that can be substituted in an expression.
    ExpressionAttributeValues map[string]AttributeValue `type:"map"`

    // The primary key of the item to be deleted. Each element consists of an attribute
    // name and a value for that attribute.
    //
    // Key is a required field
    Key map[string]AttributeValue `type:"map" required:"true"`

    // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
    // Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid
    // values are: NONE and ALL_OLD.
    ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure `type:"string" enum:"true"`

    // Name of the table in which the item to be deleted resides.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a request to perform a DeleteItem operation.

func (Delete) String Uses

func (s Delete) String() string

String returns the string representation

func (*Delete) Validate Uses

func (s *Delete) Validate() error

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

type DeleteBackupInput Uses

type DeleteBackupInput struct {

    // The ARN associated with the backup.
    //
    // BackupArn is a required field
    BackupArn *string `min:"37" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteBackupInput) String Uses

func (s DeleteBackupInput) String() string

String returns the string representation

func (*DeleteBackupInput) Validate Uses

func (s *DeleteBackupInput) Validate() error

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

type DeleteBackupOutput Uses

type DeleteBackupOutput struct {

    // Contains the description of the backup created for the table.
    BackupDescription *BackupDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (DeleteBackupOutput) String Uses

func (s DeleteBackupOutput) String() string

String returns the string representation

type DeleteBackupRequest Uses

type DeleteBackupRequest struct {
    *aws.Request
    Input *DeleteBackupInput
    Copy  func(*DeleteBackupInput) DeleteBackupRequest
}

DeleteBackupRequest is the request type for the DeleteBackup API operation.

func (DeleteBackupRequest) Send Uses

func (r DeleteBackupRequest) Send(ctx context.Context) (*DeleteBackupResponse, error)

Send marshals and sends the DeleteBackup API request.

type DeleteBackupResponse Uses

type DeleteBackupResponse struct {
    *DeleteBackupOutput
    // contains filtered or unexported fields
}

DeleteBackupResponse is the response type for the DeleteBackup API operation.

func (*DeleteBackupResponse) SDKResponseMetdata Uses

func (r *DeleteBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBackup request.

type DeleteGlobalSecondaryIndexAction Uses

type DeleteGlobalSecondaryIndexAction struct {

    // The name of the global secondary index to be deleted.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a global secondary index to be deleted from an existing table.

func (DeleteGlobalSecondaryIndexAction) String Uses

func (s DeleteGlobalSecondaryIndexAction) String() string

String returns the string representation

func (*DeleteGlobalSecondaryIndexAction) Validate Uses

func (s *DeleteGlobalSecondaryIndexAction) Validate() error

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

type DeleteItemInput Uses

type DeleteItemInput struct {

    // A condition that must be satisfied in order for a conditional DeleteItem
    // to succeed.
    //
    // An expression can contain any of the following:
    //
    //    * Functions: attribute_exists | attribute_not_exists | attribute_type
    //    | contains | begins_with | size These function names are case-sensitive.
    //
    //    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    //
    //    * Logical operators: AND | OR | NOT
    //
    // For more information about condition expressions, see Condition Expressions
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
    // in the Amazon DynamoDB Developer Guide.
    ConditionExpression *string `type:"string"`

    // This is a legacy parameter. Use ConditionExpression instead. For more information,
    // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
    // in the Amazon DynamoDB Developer Guide.
    ConditionalOperator ConditionalOperator `type:"string" enum:"true"`

    // This is a legacy parameter. Use ConditionExpression instead. For more information,
    // see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
    // in the Amazon DynamoDB Developer Guide.
    Expected map[string]ExpectedAttributeValue `type:"map"`

    // One or more substitution tokens for attribute names in an expression. The
    // following are some use cases for using ExpressionAttributeNames:
    //
    //    * To access an attribute whose name conflicts with a DynamoDB reserved
    //    word.
    //
    //    * To create a placeholder for repeating occurrences of an attribute name
    //    in an expression.
    //
    //    * To prevent special characters in an attribute name from being misinterpreted
    //    in an expression.
    //
    // Use the # character in an expression to dereference an attribute name. For
    // example, consider the following attribute name:
    //
    //    * Percentile
    //
    // The name of this attribute conflicts with a reserved word, so it cannot be
    // used directly in an expression. (For the complete list of reserved words,
    // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    // in the Amazon DynamoDB Developer Guide). To work around this, you could specify
    // the following for ExpressionAttributeNames:
    //
    //    * {"#P":"Percentile"}
    //
    // You could then use this substitution in an expression, as in this example:
    //
    //    * #P = :val
    //
    // Tokens that begin with the : character are expression attribute values, which
    // are placeholders for the actual value at runtime.
    //
    // For more information on expression attribute names, see Specifying Item Attributes
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeNames map[string]string `type:"map"`

    // One or more values that can be substituted in an expression.
    //
    // Use the : (colon) character in an expression to dereference an attribute
    // value. For example, suppose that you wanted to check whether the value of
    // the ProductStatus attribute was one of the following:
    //
    // Available | Backordered | Discontinued
    //
    // You would first need to specify ExpressionAttributeValues as follows:
    //
    // { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
    // }
    //
    // You could then use these values in an expression, such as this:
    //
    // ProductStatus IN (:avail, :back, :disc)
    //
    // For more information on expression attribute values, see Condition Expressions
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeValues map[string]AttributeValue `type:"map"`

    // A map of attribute names to AttributeValue objects, representing the primary
    // key of the item to delete.
    //
    // For the primary key, you must provide all of the attributes. For example,
    // with a simple primary key, you only need to provide a value for the partition
    // key. For a composite primary key, you must provide values for both the partition
    // key and the sort key.
    //
    // Key is a required field
    Key map[string]AttributeValue `type:"map" required:"true"`

    // Determines the level of detail about provisioned throughput consumption that
    // is returned in the response:
    //
    //    * INDEXES - The response includes the aggregate ConsumedCapacity for the
    //    operation, together with ConsumedCapacity for each table and secondary
    //    index that was accessed. Note that some operations, such as GetItem and
    //    BatchGetItem, do not access any indexes at all. In these cases, specifying
    //    INDEXES will only return ConsumedCapacity information for table(s).
    //
    //    * TOTAL - The response includes only the aggregate ConsumedCapacity for
    //    the operation.
    //
    //    * NONE - No ConsumedCapacity details are included in the response.
    ReturnConsumedCapacity ReturnConsumedCapacity `type:"string" enum:"true"`

    // Determines whether item collection metrics are returned. If set to SIZE,
    // the response includes statistics about item collections, if any, that were
    // modified during the operation are returned in the response. If set to NONE
    // (the default), no statistics are returned.
    ReturnItemCollectionMetrics ReturnItemCollectionMetrics `type:"string" enum:"true"`

    // Use ReturnValues if you want to get the item attributes as they appeared
    // before they were deleted. For DeleteItem, the valid values are:
    //
    //    * NONE - If ReturnValues is not specified, or if its value is NONE, then
    //    nothing is returned. (This setting is the default for ReturnValues.)
    //
    //    * ALL_OLD - The content of the old item is returned.
    //
    // The ReturnValues parameter is used by several DynamoDB operations; however,
    // DeleteItem does not recognize any values other than NONE or ALL_OLD.
    ReturnValues ReturnValue `type:"string" enum:"true"`

    // The name of the table from which to delete the item.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents the input of a DeleteItem operation.

func (DeleteItemInput) String Uses

func (s DeleteItemInput) String() string

String returns the string representation

func (*DeleteItemInput) Validate Uses

func (s *DeleteItemInput) Validate() error

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

type DeleteItemOutput Uses

type DeleteItemOutput struct {

    // A map of attribute names to AttributeValue objects, representing the item
    // as it appeared before the DeleteItem operation. This map appears in the response
    // only if ReturnValues was specified as ALL_OLD in the request.
    Attributes map[string]AttributeValue `type:"map"`

    // The capacity units consumed by the DeleteItem operation. The data returned
    // includes the total provisioned throughput consumed, along with statistics
    // for the table and any indexes involved in the operation. ConsumedCapacity
    // is only returned if the ReturnConsumedCapacity parameter was specified. For
    // more information, see Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
    // in the Amazon DynamoDB Developer Guide.
    ConsumedCapacity *ConsumedCapacity `type:"structure"`

    // Information about item collections, if any, that were affected by the DeleteItem
    // operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics
    // parameter was specified. If the table does not have any local secondary indexes,
    // this information is not returned in the response.
    //
    // Each ItemCollectionMetrics element consists of:
    //
    //    * ItemCollectionKey - The partition key value of the item collection.
    //    This is the same as the partition key value of the item itself.
    //
    //    * SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
    //    This value is a two-element array containing a lower bound and an upper
    //    bound for the estimate. The estimate includes the size of all the items
    //    in the table, plus the size of all attributes projected into all of the
    //    local secondary indexes on that table. Use this estimate to measure whether
    //    a local secondary index is approaching its size limit. The estimate is
    //    subject to change over time; therefore, do not rely on the precision or
    //    accuracy of the estimate.
    ItemCollectionMetrics *ItemCollectionMetrics `type:"structure"`
    // contains filtered or unexported fields
}

Represents the output of a DeleteItem operation.

func (DeleteItemOutput) String Uses

func (s DeleteItemOutput) String() string

String returns the string representation

type DeleteItemRequest Uses

type DeleteItemRequest struct {
    *aws.Request
    Input *DeleteItemInput
    Copy  func(*DeleteItemInput) DeleteItemRequest
}

DeleteItemRequest is the request type for the DeleteItem API operation.

func (DeleteItemRequest) Send Uses

func (r DeleteItemRequest) Send(ctx context.Context) (*DeleteItemResponse, error)

Send marshals and sends the DeleteItem API request.

type DeleteItemResponse Uses

type DeleteItemResponse struct {
    *DeleteItemOutput
    // contains filtered or unexported fields
}

DeleteItemResponse is the response type for the DeleteItem API operation.

func (*DeleteItemResponse) SDKResponseMetdata Uses

func (r *DeleteItemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteItem request.

type DeleteReplicaAction Uses

type DeleteReplicaAction struct {

    // The Region of the replica to be removed.
    //
    // RegionName is a required field
    RegionName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a replica to be removed.

func (DeleteReplicaAction) String Uses

func (s DeleteReplicaAction) String() string

String returns the string representation

func (*DeleteReplicaAction) Validate Uses

func (s *DeleteReplicaAction) Validate() error

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

type DeleteReplicationGroupMemberAction Uses

type DeleteReplicationGroupMemberAction struct {

    // The Region where the replica exists.
    //
    // RegionName is a required field
    RegionName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a replica to be deleted.

func (DeleteReplicationGroupMemberAction) String Uses

func (s DeleteReplicationGroupMemberAction) String() string

String returns the string representation

func (*DeleteReplicationGroupMemberAction) Validate Uses

func (s *DeleteReplicationGroupMemberAction) Validate() error

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

type DeleteRequest Uses

type DeleteRequest struct {

    // A map of attribute name to attribute values, representing the primary key
    // of the item to delete. All of the table's primary key attributes must be
    // specified, and their data types must match those of the table's key schema.
    //
    // Key is a required field
    Key map[string]AttributeValue `type:"map" required:"true"`
    // contains filtered or unexported fields
}

Represents a request to perform a DeleteItem operation on an item.

func (DeleteRequest) String Uses

func (s DeleteRequest) String() string

String returns the string representation

type DeleteTableInput Uses

type DeleteTableInput struct {

    // The name of the table to delete.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents the input of a DeleteTable operation.

func (DeleteTableInput) String Uses

func (s DeleteTableInput) String() string

String returns the string representation

func (*DeleteTableInput) Validate Uses

func (s *DeleteTableInput) Validate() error

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

type DeleteTableOutput Uses

type DeleteTableOutput struct {

    // Represents the properties of a table.
    TableDescription *TableDescription `type:"structure"`
    // contains filtered or unexported fields
}

Represents the output of a DeleteTable operation.

func (DeleteTableOutput) String Uses

func (s DeleteTableOutput) String() string

String returns the string representation

type DeleteTableRequest Uses

type DeleteTableRequest struct {
    *aws.Request
    Input *DeleteTableInput
    Copy  func(*DeleteTableInput) DeleteTableRequest
}

DeleteTableRequest is the request type for the DeleteTable API operation.

func (DeleteTableRequest) Send Uses

func (r DeleteTableRequest) Send(ctx context.Context) (*DeleteTableResponse, error)

Send marshals and sends the DeleteTable API request.

type DeleteTableResponse Uses

type DeleteTableResponse struct {
    *DeleteTableOutput
    // contains filtered or unexported fields
}

DeleteTableResponse is the response type for the DeleteTable API operation.

func (*DeleteTableResponse) SDKResponseMetdata Uses

func (r *DeleteTableResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteTable request.

type DescribeBackupInput Uses

type DescribeBackupInput struct {

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

func (DescribeBackupInput) String Uses

func (s DescribeBackupInput) String() string

String returns the string representation

func (*DescribeBackupInput) Validate Uses

func (s *DescribeBackupInput) Validate() error

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

type DescribeBackupOutput Uses

type DescribeBackupOutput struct {

    // Contains the description of the backup created for the table.
    BackupDescription *BackupDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeBackupOutput) String Uses

func (s DescribeBackupOutput) String() string

String returns the string representation

type DescribeBackupRequest Uses

type DescribeBackupRequest struct {
    *aws.Request
    Input *DescribeBackupInput
    Copy  func(*DescribeBackupInput) DescribeBackupRequest
}

DescribeBackupRequest is the request type for the DescribeBackup API operation.

func (DescribeBackupRequest) Send Uses

func (r DescribeBackupRequest) Send(ctx context.Context) (*DescribeBackupResponse, error)

Send marshals and sends the DescribeBackup API request.

type DescribeBackupResponse Uses

type DescribeBackupResponse struct {
    *DescribeBackupOutput
    // contains filtered or unexported fields
}

DescribeBackupResponse is the response type for the DescribeBackup API operation.

func (*DescribeBackupResponse) SDKResponseMetdata Uses

func (r *DescribeBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeBackup request.

type DescribeContinuousBackupsInput Uses

type DescribeContinuousBackupsInput struct {

    // Name of the table for which the customer wants to check the continuous backups
    // and point in time recovery settings.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeContinuousBackupsInput) String Uses

func (s DescribeContinuousBackupsInput) String() string

String returns the string representation

func (*DescribeContinuousBackupsInput) Validate Uses

func (s *DescribeContinuousBackupsInput) Validate() error

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

type DescribeContinuousBackupsOutput Uses

type DescribeContinuousBackupsOutput struct {

    // Represents the continuous backups and point in time recovery settings on
    // the table.
    ContinuousBackupsDescription *ContinuousBackupsDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeContinuousBackupsOutput) String Uses

func (s DescribeContinuousBackupsOutput) String() string

String returns the string representation

type DescribeContinuousBackupsRequest Uses

type DescribeContinuousBackupsRequest struct {
    *aws.Request
    Input *DescribeContinuousBackupsInput
    Copy  func(*DescribeContinuousBackupsInput) DescribeContinuousBackupsRequest
}

DescribeContinuousBackupsRequest is the request type for the DescribeContinuousBackups API operation.

func (DescribeContinuousBackupsRequest) Send Uses

func (r DescribeContinuousBackupsRequest) Send(ctx context.Context) (*DescribeContinuousBackupsResponse, error)

Send marshals and sends the DescribeContinuousBackups API request.

type DescribeContinuousBackupsResponse Uses

type DescribeContinuousBackupsResponse struct {
    *DescribeContinuousBackupsOutput
    // contains filtered or unexported fields
}

DescribeContinuousBackupsResponse is the response type for the DescribeContinuousBackups API operation.

func (*DescribeContinuousBackupsResponse) SDKResponseMetdata Uses

func (r *DescribeContinuousBackupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeContinuousBackups request.

type DescribeContributorInsightsInput Uses

type DescribeContributorInsightsInput struct {

    // The name of the global secondary index to describe, if applicable.
    IndexName *string `min:"3" type:"string"`

    // The name of the table to describe.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeContributorInsightsInput) String Uses

func (s DescribeContributorInsightsInput) String() string

String returns the string representation

func (*DescribeContributorInsightsInput) Validate Uses

func (s *DescribeContributorInsightsInput) Validate() error

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

type DescribeContributorInsightsOutput Uses

type DescribeContributorInsightsOutput struct {

    // List of names of the associated Alpine rules.
    ContributorInsightsRuleList []string `type:"list"`

    // Current Status contributor insights.
    ContributorInsightsStatus ContributorInsightsStatus `type:"string" enum:"true"`

    // Returns information about the last failure that encountered.
    //
    // The most common exceptions for a FAILED status are:
    //
    //    * LimitExceededException - Per-account Amazon CloudWatch Contributor Insights
    //    rule limit reached. Please disable Contributor Insights for other tables/indexes
    //    OR disable Contributor Insights rules before retrying.
    //
    //    * AccessDeniedException - Amazon CloudWatch Contributor Insights rules
    //    cannot be modified due to insufficient permissions.
    //
    //    * AccessDeniedException - Failed to create service-linked role for Contributor
    //    Insights due to insufficient permissions.
    //
    //    * InternalServerError - Failed to create Amazon CloudWatch Contributor
    //    Insights rules. Please retry request.
    FailureException *FailureException `type:"structure"`

    // The name of the global secondary index being described.
    IndexName *string `min:"3" type:"string"`

    // Timestamp of the last time the status was changed.
    LastUpdateDateTime *time.Time `type:"timestamp"`

    // The name of the table being described.
    TableName *string `min:"3" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeContributorInsightsOutput) String Uses

func (s DescribeContributorInsightsOutput) String() string

String returns the string representation

type DescribeContributorInsightsRequest Uses

type DescribeContributorInsightsRequest struct {
    *aws.Request
    Input *DescribeContributorInsightsInput
    Copy  func(*DescribeContributorInsightsInput) DescribeContributorInsightsRequest
}

DescribeContributorInsightsRequest is the request type for the DescribeContributorInsights API operation.

func (DescribeContributorInsightsRequest) Send Uses

func (r DescribeContributorInsightsRequest) Send(ctx context.Context) (*DescribeContributorInsightsResponse, error)

Send marshals and sends the DescribeContributorInsights API request.

type DescribeContributorInsightsResponse Uses

type DescribeContributorInsightsResponse struct {
    *DescribeContributorInsightsOutput
    // contains filtered or unexported fields
}

DescribeContributorInsightsResponse is the response type for the DescribeContributorInsights API operation.

func (*DescribeContributorInsightsResponse) SDKResponseMetdata Uses

func (r *DescribeContributorInsightsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeContributorInsights request.

type DescribeEndpointsInput Uses

type DescribeEndpointsInput struct {
    // contains filtered or unexported fields
}

func (DescribeEndpointsInput) String Uses

func (s DescribeEndpointsInput) String() string

String returns the string representation

type DescribeEndpointsOutput Uses

type DescribeEndpointsOutput struct {

    // List of endpoints.
    //
    // Endpoints is a required field
    Endpoints []Endpoint `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeEndpointsOutput) String Uses

func (s DescribeEndpointsOutput) String() string

String returns the string representation

type DescribeEndpointsRequest Uses

type DescribeEndpointsRequest struct {
    *aws.Request
    Input *DescribeEndpointsInput
    Copy  func(*DescribeEndpointsInput) DescribeEndpointsRequest
}

DescribeEndpointsRequest is the request type for the DescribeEndpoints API operation.

func (DescribeEndpointsRequest) Send Uses

func (r DescribeEndpointsRequest) Send(ctx context.Context) (*DescribeEndpointsResponse, error)

Send marshals and sends the DescribeEndpoints API request.

type DescribeEndpointsResponse Uses

type DescribeEndpointsResponse struct {
    *DescribeEndpointsOutput
    // contains filtered or unexported fields
}

DescribeEndpointsResponse is the response type for the DescribeEndpoints API operation.

func (*DescribeEndpointsResponse) SDKResponseMetdata Uses

func (r *DescribeEndpointsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEndpoints request.

type DescribeGlobalTableInput Uses

type DescribeGlobalTableInput struct {

    // The name of the global table.
    //
    // GlobalTableName is a required field
    GlobalTableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeGlobalTableInput) String Uses

func (s DescribeGlobalTableInput) String() string

String returns the string representation

func (*DescribeGlobalTableInput) Validate Uses

func (s *DescribeGlobalTableInput) Validate() error

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

type DescribeGlobalTableOutput Uses

type DescribeGlobalTableOutput struct {

    // Contains the details of the global table.
    GlobalTableDescription *GlobalTableDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeGlobalTableOutput) String Uses

func (s DescribeGlobalTableOutput) String() string

String returns the string representation

type DescribeGlobalTableRequest Uses

type DescribeGlobalTableRequest struct {
    *aws.Request
    Input *DescribeGlobalTableInput
    Copy  func(*DescribeGlobalTableInput) DescribeGlobalTableRequest
}

DescribeGlobalTableRequest is the request type for the DescribeGlobalTable API operation.

func (DescribeGlobalTableRequest) Send Uses

func (r DescribeGlobalTableRequest) Send(ctx context.Context) (*DescribeGlobalTableResponse, error)

Send marshals and sends the DescribeGlobalTable API request.

type DescribeGlobalTableResponse Uses

type DescribeGlobalTableResponse struct {
    *DescribeGlobalTableOutput
    // contains filtered or unexported fields
}

DescribeGlobalTableResponse is the response type for the DescribeGlobalTable API operation.

func (*DescribeGlobalTableResponse) SDKResponseMetdata Uses

func (r *DescribeGlobalTableResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeGlobalTable request.

type DescribeGlobalTableSettingsInput Uses

type DescribeGlobalTableSettingsInput struct {

    // The name of the global table to describe.
    //
    // GlobalTableName is a required field
    GlobalTableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeGlobalTableSettingsInput) String Uses

func (s DescribeGlobalTableSettingsInput) String() string

String returns the string representation

func (*DescribeGlobalTableSettingsInput) Validate Uses

func (s *DescribeGlobalTableSettingsInput) Validate() error

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

type DescribeGlobalTableSettingsOutput Uses

type DescribeGlobalTableSettingsOutput struct {

    // The name of the global table.
    GlobalTableName *string `min:"3" type:"string"`

    // The Region-specific settings for the global table.
    ReplicaSettings []ReplicaSettingsDescription `type:"list"`
    // contains filtered or unexported fields
}

func (DescribeGlobalTableSettingsOutput) String Uses

func (s DescribeGlobalTableSettingsOutput) String() string

String returns the string representation

type DescribeGlobalTableSettingsRequest Uses

type DescribeGlobalTableSettingsRequest struct {
    *aws.Request
    Input *DescribeGlobalTableSettingsInput
    Copy  func(*DescribeGlobalTableSettingsInput) DescribeGlobalTableSettingsRequest
}

DescribeGlobalTableSettingsRequest is the request type for the DescribeGlobalTableSettings API operation.

func (DescribeGlobalTableSettingsRequest) Send Uses

func (r DescribeGlobalTableSettingsRequest) Send(ctx context.Context) (*DescribeGlobalTableSettingsResponse, error)

Send marshals and sends the DescribeGlobalTableSettings API request.

type DescribeGlobalTableSettingsResponse Uses

type DescribeGlobalTableSettingsResponse struct {
    *DescribeGlobalTableSettingsOutput
    // contains filtered or unexported fields
}

DescribeGlobalTableSettingsResponse is the response type for the DescribeGlobalTableSettings API operation.

func (*DescribeGlobalTableSettingsResponse) SDKResponseMetdata Uses

func (r *DescribeGlobalTableSettingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeGlobalTableSettings request.

type DescribeLimitsInput Uses

type DescribeLimitsInput struct {
    // contains filtered or unexported fields
}

Represents the input of a DescribeLimits operation. Has no content.

func (DescribeLimitsInput) String Uses

func (s DescribeLimitsInput) String() string

String returns the string representation

type DescribeLimitsOutput Uses

type DescribeLimitsOutput struct {

    // The maximum total read capacity units that your account allows you to provision
    // across all of your tables in this Region.
    AccountMaxReadCapacityUnits *int64 `min:"1" type:"long"`

    // The maximum total write capacity units that your account allows you to provision
    // across all of your tables in this Region.
    AccountMaxWriteCapacityUnits *int64 `min:"1" type:"long"`

    // The maximum read capacity units that your account allows you to provision
    // for a new table that you are creating in this Region, including the read
    // capacity units provisioned for its global secondary indexes (GSIs).
    TableMaxReadCapacityUnits *int64 `min:"1" type:"long"`

    // The maximum write capacity units that your account allows you to provision
    // for a new table that you are creating in this Region, including the write
    // capacity units provisioned for its global secondary indexes (GSIs).
    TableMaxWriteCapacityUnits *int64 `min:"1" type:"long"`
    // contains filtered or unexported fields
}

Represents the output of a DescribeLimits operation.

func (DescribeLimitsOutput) String Uses

func (s DescribeLimitsOutput) String() string

String returns the string representation

type DescribeLimitsRequest Uses

type DescribeLimitsRequest struct {
    *aws.Request
    Input *DescribeLimitsInput
    Copy  func(*DescribeLimitsInput) DescribeLimitsRequest
}

DescribeLimitsRequest is the request type for the DescribeLimits API operation.

func (DescribeLimitsRequest) Send Uses

func (r DescribeLimitsRequest) Send(ctx context.Context) (*DescribeLimitsResponse, error)

Send marshals and sends the DescribeLimits API request.

type DescribeLimitsResponse Uses

type DescribeLimitsResponse struct {
    *DescribeLimitsOutput
    // contains filtered or unexported fields
}

DescribeLimitsResponse is the response type for the DescribeLimits API operation.

func (*DescribeLimitsResponse) SDKResponseMetdata Uses

func (r *DescribeLimitsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLimits request.

type DescribeTableInput Uses

type DescribeTableInput struct {

    // The name of the table to describe.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents the input of a DescribeTable operation.

func (DescribeTableInput) String Uses

func (s DescribeTableInput) String() string

String returns the string representation

func (*DescribeTableInput) Validate Uses

func (s *DescribeTableInput) Validate() error

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

type DescribeTableOutput Uses

type DescribeTableOutput struct {

    // The properties of the table.
    Table *TableDescription `type:"structure"`
    // contains filtered or unexported fields
}

Represents the output of a DescribeTable operation.

func (DescribeTableOutput) String Uses

func (s DescribeTableOutput) String() string

String returns the string representation

type DescribeTableReplicaAutoScalingInput Uses

type DescribeTableReplicaAutoScalingInput struct {

    // The name of the table.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeTableReplicaAutoScalingInput) String Uses

func (s DescribeTableReplicaAutoScalingInput) String() string

String returns the string representation

func (*DescribeTableReplicaAutoScalingInput) Validate Uses

func (s *DescribeTableReplicaAutoScalingInput) Validate() error

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

type DescribeTableReplicaAutoScalingOutput Uses

type DescribeTableReplicaAutoScalingOutput struct {

    // Represents the auto scaling properties of the table.
    TableAutoScalingDescription *TableAutoScalingDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeTableReplicaAutoScalingOutput) String Uses

func (s DescribeTableReplicaAutoScalingOutput) String() string

String returns the string representation

type DescribeTableReplicaAutoScalingRequest Uses

type DescribeTableReplicaAutoScalingRequest struct {
    *aws.Request
    Input *DescribeTableReplicaAutoScalingInput
    Copy  func(*DescribeTableReplicaAutoScalingInput) DescribeTableReplicaAutoScalingRequest
}

DescribeTableReplicaAutoScalingRequest is the request type for the DescribeTableReplicaAutoScaling API operation.

func (DescribeTableReplicaAutoScalingRequest) Send Uses

func (r DescribeTableReplicaAutoScalingRequest) Send(ctx context.Context) (*DescribeTableReplicaAutoScalingResponse, error)

Send marshals and sends the DescribeTableReplicaAutoScaling API request.

type DescribeTableReplicaAutoScalingResponse Uses

type DescribeTableReplicaAutoScalingResponse struct {
    *DescribeTableReplicaAutoScalingOutput
    // contains filtered or unexported fields
}

DescribeTableReplicaAutoScalingResponse is the response type for the DescribeTableReplicaAutoScaling API operation.

func (*DescribeTableReplicaAutoScalingResponse) SDKResponseMetdata Uses

func (r *DescribeTableReplicaAutoScalingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTableReplicaAutoScaling request.

type DescribeTableRequest Uses

type DescribeTableRequest struct {
    *aws.Request
    Input *DescribeTableInput
    Copy  func(*DescribeTableInput) DescribeTableRequest
}

DescribeTableRequest is the request type for the DescribeTable API operation.

func (DescribeTableRequest) Send Uses

func (r DescribeTableRequest) Send(ctx context.Context) (*DescribeTableResponse, error)

Send marshals and sends the DescribeTable API request.

type DescribeTableResponse Uses

type DescribeTableResponse struct {
    *DescribeTableOutput
    // contains filtered or unexported fields
}

DescribeTableResponse is the response type for the DescribeTable API operation.

func (*DescribeTableResponse) SDKResponseMetdata Uses

func (r *DescribeTableResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTable request.

type DescribeTimeToLiveInput Uses

type DescribeTimeToLiveInput struct {

    // The name of the table to be described.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeTimeToLiveInput) String Uses

func (s DescribeTimeToLiveInput) String() string

String returns the string representation

func (*DescribeTimeToLiveInput) Validate Uses

func (s *DescribeTimeToLiveInput) Validate() error

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

type DescribeTimeToLiveOutput Uses

type DescribeTimeToLiveOutput struct {

    // The description of the Time to Live (TTL) status on the specified table.
    TimeToLiveDescription *TimeToLiveDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeTimeToLiveOutput) String Uses

func (s DescribeTimeToLiveOutput) String() string

String returns the string representation

type DescribeTimeToLiveRequest Uses

type DescribeTimeToLiveRequest struct {
    *aws.Request
    Input *DescribeTimeToLiveInput
    Copy  func(*DescribeTimeToLiveInput) DescribeTimeToLiveRequest
}

DescribeTimeToLiveRequest is the request type for the DescribeTimeToLive API operation.

func (DescribeTimeToLiveRequest) Send Uses

func (r DescribeTimeToLiveRequest) Send(ctx context.Context) (*DescribeTimeToLiveResponse, error)

Send marshals and sends the DescribeTimeToLive API request.

type DescribeTimeToLiveResponse Uses

type DescribeTimeToLiveResponse struct {
    *DescribeTimeToLiveOutput
    // contains filtered or unexported fields
}

DescribeTimeToLiveResponse is the response type for the DescribeTimeToLive API operation.

func (*DescribeTimeToLiveResponse) SDKResponseMetdata Uses

func (r *DescribeTimeToLiveResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTimeToLive request.

type Endpoint Uses

type Endpoint struct {

    // IP address of the endpoint.
    //
    // Address is a required field
    Address *string `type:"string" required:"true"`

    // Endpoint cache time to live (TTL) value.
    //
    // CachePeriodInMinutes is a required field
    CachePeriodInMinutes *int64 `type:"long" required:"true"`
    // contains filtered or unexported fields
}

An endpoint information details.

func (Endpoint) String Uses

func (s Endpoint) String() string

String returns the string representation

type ExpectedAttributeValue Uses

type ExpectedAttributeValue struct {

    // One or more values to evaluate against the supplied attribute. The number
    // of values in the list depends on the ComparisonOperator being used.
    //
    // For type Number, value comparisons are numeric.
    //
    // String value comparisons for greater than, equals, or less than are based
    // on ASCII character code values. For example, a is greater than A, and a is
    // greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters
    // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters).
    //
    // For Binary, DynamoDB treats each byte of the binary data as unsigned when
    // it compares binary values.
    //
    // For information on specifying data types in JSON, see JSON Data Format (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html)
    // in the Amazon DynamoDB Developer Guide.
    AttributeValueList []AttributeValue `type:"list"`

    // A comparator for evaluating attributes in the AttributeValueList. For example,
    // equals, greater than, less than, etc.
    //
    // The following comparison operators are available:
    //
    // EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |
    // BEGINS_WITH | IN | BETWEEN
    //
    // The following are descriptions of each comparison operator.
    //
    //    * EQ : Equal. EQ is supported for all data types, including lists and
    //    maps. AttributeValueList can contain only one AttributeValue element of
    //    type String, Number, Binary, String Set, Number Set, or Binary Set. If
    //    an item contains an AttributeValue element of a different type than the
    //    one provided in the request, the value does not match. For example, {"S":"6"}
    //    does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2",
    //    "1"]}.
    //
    //    * NE : Not equal. NE is supported for all data types, including lists
    //    and maps. AttributeValueList can contain only one AttributeValue of type
    //    String, Number, Binary, String Set, Number Set, or Binary Set. If an item
    //    contains an AttributeValue of a different type than the one provided in
    //    the request, the value does not match. For example, {"S":"6"} does not
    //    equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
    //
    //    * LE : Less than or equal. AttributeValueList can contain only one AttributeValue
    //    element of type String, Number, or Binary (not a set type). If an item
    //    contains an AttributeValue element of a different type than the one provided
    //    in the request, the value does not match. For example, {"S":"6"} does
    //    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
    //    "1"]}.
    //
    //    * LT : Less than. AttributeValueList can contain only one AttributeValue
    //    of type String, Number, or Binary (not a set type). If an item contains
    //    an AttributeValue element of a different type than the one provided in
    //    the request, the value does not match. For example, {"S":"6"} does not
    //    equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
    //    "1"]}.
    //
    //    * GE : Greater than or equal. AttributeValueList can contain only one
    //    AttributeValue element of type String, Number, or Binary (not a set type).
    //    If an item contains an AttributeValue element of a different type than
    //    the one provided in the request, the value does not match. For example,
    //    {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to
    //    {"NS":["6", "2", "1"]}.
    //
    //    * GT : Greater than. AttributeValueList can contain only one AttributeValue
    //    element of type String, Number, or Binary (not a set type). If an item
    //    contains an AttributeValue element of a different type than the one provided
    //    in the request, the value does not match. For example, {"S":"6"} does
    //    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
    //    "1"]}.
    //
    //    * NOT_NULL : The attribute exists. NOT_NULL is supported for all data
    //    types, including lists and maps. This operator tests for the existence
    //    of an attribute, not its data type. If the data type of attribute "a"
    //    is null, and you evaluate it using NOT_NULL, the result is a Boolean true.
    //    This result is because the attribute "a" exists; its data type is not
    //    relevant to the NOT_NULL comparison operator.
    //
    //    * NULL : The attribute does not exist. NULL is supported for all data
    //    types, including lists and maps. This operator tests for the nonexistence
    //    of an attribute, not its data type. If the data type of attribute "a"
    //    is null, and you evaluate it using NULL, the result is a Boolean false.
    //    This is because the attribute "a" exists; its data type is not relevant
    //    to the NULL comparison operator.
    //
    //    * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList
    //    can contain only one AttributeValue element of type String, Number, or
    //    Binary (not a set type). If the target attribute of the comparison is
    //    of type String, then the operator checks for a substring match. If the
    //    target attribute of the comparison is of type Binary, then the operator
    //    looks for a subsequence of the target that matches the input. If the target
    //    attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator
    //    evaluates to true if it finds an exact match with any member of the set.
    //    CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can
    //    be a list; however, "b" cannot be a set, a map, or a list.
    //
    //    * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a
    //    value in a set. AttributeValueList can contain only one AttributeValue
    //    element of type String, Number, or Binary (not a set type). If the target
    //    attribute of the comparison is a String, then the operator checks for
    //    the absence of a substring match. If the target attribute of the comparison
    //    is Binary, then the operator checks for the absence of a subsequence of
    //    the target that matches the input. If the target attribute of the comparison
    //    is a set ("SS", "NS", or "BS"), then the operator evaluates to true if
    //    it does not find an exact match with any member of the set. NOT_CONTAINS
    //    is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be
    //    a list; however, "b" cannot be a set, a map, or a list.
    //
    //    * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only
    //    one AttributeValue of type String or Binary (not a Number or a set type).
    //    The target attribute of the comparison must be of type String or Binary
    //    (not a Number or a set type).
    //
    //    * IN : Checks for matching elements in a list. AttributeValueList can
    //    contain one or more AttributeValue elements of type String, Number, or
    //    Binary. These attributes are compared against an existing attribute of
    //    an item. If any elements of the input are equal to the item attribute,
    //    the expression evaluates to true.
    //
    //    * BETWEEN : Greater than or equal to the first value, and less than or
    //    equal to the second value. AttributeValueList must contain two AttributeValue
    //    elements of the same type, either String, Number, or Binary (not a set
    //    type). A target attribute matches if the target value is greater than,
    //    or equal to, the first element and less than, or equal to, the second
    //    element. If an item contains an AttributeValue element of a different
    //    type than the one provided in the request, the value does not match. For
    //    example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does
    //    not compare to {"NS":["6", "2", "1"]}
    ComparisonOperator ComparisonOperator `type:"string" enum:"true"`

    // Causes DynamoDB to evaluate the value before attempting a conditional operation:
    //
    //    * If Exists is true, DynamoDB will check to see if that attribute value
    //    already exists in the table. If it is found, then the operation succeeds.
    //    If it is not found, the operation fails with a ConditionCheckFailedException.
    //
    //    * If Exists is false, DynamoDB assumes that the attribute value does not
    //    exist in the table. If in fact the value does not exist, then the assumption
    //    is valid and the operation succeeds. If the value is found, despite the
    //    assumption that it does not exist, the operation fails with a ConditionCheckFailedException.
    //
    // The default setting for Exists is true. If you supply a Value all by itself,
    // DynamoDB assumes the attribute exists: You don't have to set Exists to true,
    // because it is implied.
    //
    // DynamoDB returns a ValidationException if:
    //
    //    * Exists is true but there is no Value to check. (You expect a value to
    //    exist, but don't specify what that value is.)
    //
    //    * Exists is false but you also provide a Value. (You cannot expect an
    //    attribute to have a value, while also expecting it not to exist.)
    Exists *bool `type:"boolean"`

    // Represents the data for the expected attribute.
    //
    // Each attribute value is described as a name-value pair. The name is the data
    // type, and the value is the data itself.
    //
    // For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes)
    // in the Amazon DynamoDB Developer Guide.
    Value *AttributeValue `type:"structure"`
    // contains filtered or unexported fields
}

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem, or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

* Use AttributeValueList to specify one or more values to compare against
an attribute. Use ComparisonOperator to specify how you want to perform
the comparison. If the comparison evaluates to true, then the conditional
operation succeeds.

* Use Value to specify a value that DynamoDB will compare against an attribute.
If the values match, then ExpectedAttributeValue evaluates to true and
the conditional operation succeeds. Optionally, you can also set Exists
to false, indicating that you do not expect to find the attribute value
in the table. In this case, the conditional operation succeeds only if
the comparison evaluates to false.

Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

func (ExpectedAttributeValue) String Uses

func (s ExpectedAttributeValue) String() string

String returns the string representation

type FailureException Uses

type FailureException struct {

    // Description of the failure.
    ExceptionDescription *string `type:"string"`

    // Exception name.
    ExceptionName *string `type:"string"`
    // contains filtered or unexported fields
}

Represents a failure a contributor insights operation.

func (FailureException) String Uses

func (s FailureException) String() string

String returns the string representation

type Get Uses

type Get struct {

    // One or more substitution tokens for attribute names in the ProjectionExpression
    // parameter.
    ExpressionAttributeNames map[string]string `type:"map"`

    // A map of attribute names to AttributeValue objects that specifies the primary
    // key of the item to retrieve.
    //
    // Key is a required field
    Key map[string]AttributeValue `type:"map" required:"true"`

    // A string that identifies one or more attributes of the specified item to
    // retrieve from the table. The attributes in the expression must be separated
    // by commas. If no attribute names are specified, then all attributes of the
    // specified item are returned. If any of the requested attributes are not found,
    // they do not appear in the result.
    ProjectionExpression *string `type:"string"`

    // The name of the table from which to retrieve the specified item.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Specifies an item and related attribute values to retrieve in a TransactGetItem object.

func (Get) String Uses

func (s Get) String() string

String returns the string representation

func (*Get) Validate Uses

func (s *Get) Validate() error

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

type GetItemInput Uses

type GetItemInput struct {

    // This is a legacy parameter. Use ProjectionExpression instead. For more information,
    // see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
    // in the Amazon DynamoDB Developer Guide.
    AttributesToGet []string `min:"1" type:"list"`

    // Determines the read consistency model: If set to true, then the operation
    // uses strongly consistent reads; otherwise, the operation uses eventually
    // consistent reads.
    ConsistentRead *bool `type:"boolean"`

    // One or more substitution tokens for attribute names in an expression. The
    // following are some use cases for using ExpressionAttributeNames:
    //
    //    * To access an attribute whose name conflicts with a DynamoDB reserved
    //    word.
    //
    //    * To create a placeholder for repeating occurrences of an attribute name
    //    in an expression.
    //
    //    * To prevent special characters in an attribute name from being misinterpreted
    //    in an expression.
    //
    // Use the # character in an expression to dereference an attribute name. For
    // example, consider the following attribute name:
    //
    //    * Percentile
    //
    // The name of this attribute conflicts with a reserved word, so it cannot be
    // used directly in an expression. (For the complete list of reserved words,
    // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    // in the Amazon DynamoDB Developer Guide). To work around this, you could specify
    // the following for ExpressionAttributeNames:
    //
    //    * {"#P":"Percentile"}
    //
    // You could then use this substitution in an expression, as in this example:
    //
    //    * #P = :val
    //
    // Tokens that begin with the : character are expression attribute values, which
    // are placeholders for the actual value at runtime.
    //
    // For more information on expression attribute names, see Specifying Item Attributes
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeNames map[string]string `type:"map"`

    // A map of attribute names to AttributeValue objects, representing the primary
    // key of the item to retrieve.
    //
    // For the primary key, you must provide all of the attributes. For example,
    // with a simple primary key, you only need to provide a value for the partition
    // key. For a composite primary key, you must provide values for both the partition
    // key and the sort key.
    //
    // Key is a required field
    Key map[string]AttributeValue `type:"map" required:"true"`

    // A string that identifies one or more attributes to retrieve from the table.
    // These attributes can include scalars, sets, or elements of a JSON document.
    // The attributes in the expression must be separated by commas.
    //
    // If no attribute names are specified, then all attributes are returned. If
    // any of the requested attributes are not found, they do not appear in the
    // result.
    //
    // For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ProjectionExpression *string `type:"string"`

    // Determines the level of detail about provisioned throughput consumption that
    // is returned in the response:
    //
    //    * INDEXES - The response includes the aggregate ConsumedCapacity for the
    //    operation, together with ConsumedCapacity for each table and secondary
    //    index that was accessed. Note that some operations, such as GetItem and
    //    BatchGetItem, do not access any indexes at all. In these cases, specifying
    //    INDEXES will only return ConsumedCapacity information for table(s).
    //
    //    * TOTAL - The response includes only the aggregate ConsumedCapacity for
    //    the operation.
    //
    //    * NONE - No ConsumedCapacity details are included in the response.
    ReturnConsumedCapacity ReturnConsumedCapacity `type:"string" enum:"true"`

    // The name of the table containing the requested item.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents the input of a GetItem operation.

func (GetItemInput) String Uses

func (s GetItemInput) String() string

String returns the string representation

func (*GetItemInput) Validate Uses

func (s *GetItemInput) Validate() error

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

type GetItemOutput Uses

type GetItemOutput struct {

    // The capacity units consumed by the GetItem operation. The data returned includes
    // the total provisioned throughput consumed, along with statistics for the
    // table and any indexes involved in the operation. ConsumedCapacity is only
    // returned if the ReturnConsumedCapacity parameter was specified. For more
    // information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
    // in the Amazon DynamoDB Developer Guide.
    ConsumedCapacity *ConsumedCapacity `type:"structure"`

    // A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.
    Item map[string]AttributeValue `type:"map"`
    // contains filtered or unexported fields
}

Represents the output of a GetItem operation.

func (GetItemOutput) String Uses

func (s GetItemOutput) String() string

String returns the string representation

type GetItemRequest Uses

type GetItemRequest struct {
    *aws.Request
    Input *GetItemInput
    Copy  func(*GetItemInput) GetItemRequest
}

GetItemRequest is the request type for the GetItem API operation.

func (GetItemRequest) Send Uses

func (r GetItemRequest) Send(ctx context.Context) (*GetItemResponse, error)

Send marshals and sends the GetItem API request.

type GetItemResponse Uses

type GetItemResponse struct {
    *GetItemOutput
    // contains filtered or unexported fields
}

GetItemResponse is the response type for the GetItem API operation.

func (*GetItemResponse) SDKResponseMetdata Uses

func (r *GetItemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetItem request.

type GlobalSecondaryIndex Uses

type GlobalSecondaryIndex struct {

    // The name of the global secondary index. The name must be unique among all
    // other indexes on this table.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`

    // The complete key schema for a global secondary index, which consists of one
    // or more pairs of attribute names and key types:
    //
    //    * HASH - partition key
    //
    //    * RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from DynamoDB's usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    //
    // KeySchema is a required field
    KeySchema []KeySchemaElement `min:"1" type:"list" required:"true"`

    // Represents attributes that are copied (projected) from the table into the
    // global secondary index. These are in addition to the primary key attributes
    // and index key attributes, which are automatically projected.
    //
    // Projection is a required field
    Projection *Projection `type:"structure" required:"true"`

    // Represents the provisioned throughput settings for the specified global secondary
    // index.
    //
    // For current minimum and maximum provisioned throughput values, see Limits
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
    // in the Amazon DynamoDB Developer Guide.
    ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of a global secondary index.

func (GlobalSecondaryIndex) String Uses

func (s GlobalSecondaryIndex) String() string

String returns the string representation

func (*GlobalSecondaryIndex) Validate Uses

func (s *GlobalSecondaryIndex) Validate() error

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

type GlobalSecondaryIndexAutoScalingUpdate Uses

type GlobalSecondaryIndexAutoScalingUpdate struct {

    // The name of the global secondary index.
    IndexName *string `min:"3" type:"string"`

    // Represents the auto scaling settings to be modified for a global table or
    // global secondary index.
    ProvisionedWriteCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"`
    // contains filtered or unexported fields
}

Represents the auto scaling settings of a global secondary index for a global table that will be modified.

func (GlobalSecondaryIndexAutoScalingUpdate) String Uses

func (s GlobalSecondaryIndexAutoScalingUpdate) String() string

String returns the string representation

func (*GlobalSecondaryIndexAutoScalingUpdate) Validate Uses

func (s *GlobalSecondaryIndexAutoScalingUpdate) Validate() error

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

type GlobalSecondaryIndexDescription Uses

type GlobalSecondaryIndexDescription struct {

    // Indicates whether the index is currently backfilling. Backfilling is the
    // process of reading items from the table and determining whether they can
    // be added to the index. (Not all items will qualify: For example, a partition
    // key cannot have any duplicate values.) If an item can be added to the index,
    // DynamoDB will do so. After all items have been processed, the backfilling
    // operation is complete and Backfilling is false.
    //
    // You can delete an index that is being created during the Backfilling phase
    // when IndexStatus is set to CREATING and Backfilling is true. You can't delete
    // the index that is being created when IndexStatus is set to CREATING and Backfilling
    // is false.
    //
    // For indexes that were created during a CreateTable operation, the Backfilling
    // attribute does not appear in the DescribeTable output.
    Backfilling *bool `type:"boolean"`

    // The Amazon Resource Name (ARN) that uniquely identifies the index.
    IndexArn *string `type:"string"`

    // The name of the global secondary index.
    IndexName *string `min:"3" type:"string"`

    // The total size of the specified index, in bytes. DynamoDB updates this value
    // approximately every six hours. Recent changes might not be reflected in this
    // value.
    IndexSizeBytes *int64 `type:"long"`

    // The current state of the global secondary index:
    //
    //    * CREATING - The index is being created.
    //
    //    * UPDATING - The index is being updated.
    //
    //    * DELETING - The index is being deleted.
    //
    //    * ACTIVE - The index is ready for use.
    IndexStatus IndexStatus `type:"string" enum:"true"`

    // The number of items in the specified index. DynamoDB updates this value approximately
    // every six hours. Recent changes might not be reflected in this value.
    ItemCount *int64 `type:"long"`

    // The complete key schema for a global secondary index, which consists of one
    // or more pairs of attribute names and key types:
    //
    //    * HASH - partition key
    //
    //    * RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from DynamoDB's usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    KeySchema []KeySchemaElement `min:"1" type:"list"`

    // Represents attributes that are copied (projected) from the table into the
    // global secondary index. These are in addition to the primary key attributes
    // and index key attributes, which are automatically projected.
    Projection *Projection `type:"structure"`

    // Represents the provisioned throughput settings for the specified global secondary
    // index.
    //
    // For current minimum and maximum provisioned throughput values, see Limits
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
    // in the Amazon DynamoDB Developer Guide.
    ProvisionedThroughput *ProvisionedThroughputDescription `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of a global secondary index.

func (GlobalSecondaryIndexDescription) String Uses

func (s GlobalSecondaryIndexDescription) String() string

String returns the string representation

type GlobalSecondaryIndexInfo Uses

type GlobalSecondaryIndexInfo struct {

    // The name of the global secondary index.
    IndexName *string `min:"3" type:"string"`

    // The complete key schema for a global secondary index, which consists of one
    // or more pairs of attribute names and key types:
    //
    //    * HASH - partition key
    //
    //    * RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from DynamoDB's usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    KeySchema []KeySchemaElement `min:"1" type:"list"`

    // Represents attributes that are copied (projected) from the table into the
    // global secondary index. These are in addition to the primary key attributes
    // and index key attributes, which are automatically projected.
    Projection *Projection `type:"structure"`

    // Represents the provisioned throughput settings for the specified global secondary
    // index.
    ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of a global secondary index for the table when the backup was created.

func (GlobalSecondaryIndexInfo) String Uses

func (s GlobalSecondaryIndexInfo) String() string

String returns the string representation

type GlobalSecondaryIndexUpdate Uses

type GlobalSecondaryIndexUpdate struct {

    // The parameters required for creating a global secondary index on an existing
    // table:
    //
    //    * IndexName
    //
    //    * KeySchema
    //
    //    * AttributeDefinitions
    //
    //    * Projection
    //
    //    * ProvisionedThroughput
    Create *CreateGlobalSecondaryIndexAction `type:"structure"`

    // The name of an existing global secondary index to be removed.
    Delete *DeleteGlobalSecondaryIndexAction `type:"structure"`

    // The name of an existing global secondary index, along with new provisioned
    // throughput settings to be applied to that index.
    Update *UpdateGlobalSecondaryIndexAction `type:"structure"`
    // contains filtered or unexported fields
}

Represents one of the following:

* A new global secondary index to be added to an existing table.

* New provisioned throughput parameters for an existing global secondary
index.

* An existing global secondary index to be removed from an existing table.

func (GlobalSecondaryIndexUpdate) String Uses

func (s GlobalSecondaryIndexUpdate) String() string

String returns the string representation

func (*GlobalSecondaryIndexUpdate) Validate Uses

func (s *GlobalSecondaryIndexUpdate) Validate() error

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

type GlobalTable Uses

type GlobalTable struct {

    // The global table name.
    GlobalTableName *string `min:"3" type:"string"`

    // The Regions where the global table has replicas.
    ReplicationGroup []Replica `type:"list"`
    // contains filtered or unexported fields
}

Represents the properties of a global table.

func (GlobalTable) String Uses

func (s GlobalTable) String() string

String returns the string representation

type GlobalTableDescription Uses

type GlobalTableDescription struct {

    // The creation time of the global table.
    CreationDateTime *time.Time `type:"timestamp"`

    // The unique identifier of the global table.
    GlobalTableArn *string `type:"string"`

    // The global table name.
    GlobalTableName *string `min:"3" type:"string"`

    // The current state of the global table:
    //
    //    * CREATING - The global table is being created.
    //
    //    * UPDATING - The global table is being updated.
    //
    //    * DELETING - The global table is being deleted.
    //
    //    * ACTIVE - The global table is ready for use.
    GlobalTableStatus GlobalTableStatus `type:"string" enum:"true"`

    // The Regions where the global table has replicas.
    ReplicationGroup []ReplicaDescription `type:"list"`
    // contains filtered or unexported fields
}

Contains details about the global table.

func (GlobalTableDescription) String Uses

func (s GlobalTableDescription) String() string

String returns the string representation

type GlobalTableGlobalSecondaryIndexSettingsUpdate Uses

type GlobalTableGlobalSecondaryIndexSettingsUpdate struct {

    // The name of the global secondary index. The name must be unique among all
    // other indexes on this table.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`

    // Auto scaling settings for managing a global secondary index's write capacity
    // units.
    ProvisionedWriteCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"`

    // The maximum number of writes consumed per second before DynamoDB returns
    // a ThrottlingException.
    ProvisionedWriteCapacityUnits *int64 `min:"1" type:"long"`
    // contains filtered or unexported fields
}

Represents the settings of a global secondary index for a global table that will be modified.

func (GlobalTableGlobalSecondaryIndexSettingsUpdate) String Uses

func (s GlobalTableGlobalSecondaryIndexSettingsUpdate) String() string

String returns the string representation

func (*GlobalTableGlobalSecondaryIndexSettingsUpdate) Validate Uses

func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) Validate() error

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

type GlobalTableStatus Uses

type GlobalTableStatus string
const (
    GlobalTableStatusCreating GlobalTableStatus = "CREATING"
    GlobalTableStatusActive   GlobalTableStatus = "ACTIVE"
    GlobalTableStatusDeleting GlobalTableStatus = "DELETING"
    GlobalTableStatusUpdating GlobalTableStatus = "UPDATING"
)

Enum values for GlobalTableStatus

func (GlobalTableStatus) MarshalValue Uses

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

func (GlobalTableStatus) MarshalValueBuf Uses

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

type IndexStatus Uses

type IndexStatus string
const (
    IndexStatusCreating IndexStatus = "CREATING"
    IndexStatusUpdating IndexStatus = "UPDATING"
    IndexStatusDeleting IndexStatus = "DELETING"
    IndexStatusActive   IndexStatus = "ACTIVE"
)

Enum values for IndexStatus

func (IndexStatus) MarshalValue Uses

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

func (IndexStatus) MarshalValueBuf Uses

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

type ItemCollectionMetrics Uses

type ItemCollectionMetrics struct {

    // The partition key value of the item collection. This value is the same as
    // the partition key value of the item.
    ItemCollectionKey map[string]AttributeValue `type:"map"`

    // An estimate of item collection size, in gigabytes. This value is a two-element
    // array containing a lower bound and an upper bound for the estimate. The estimate
    // includes the size of all the items in the table, plus the size of all attributes
    // projected into all of the local secondary indexes on that table. Use this
    // estimate to measure whether a local secondary index is approaching its size
    // limit.
    //
    // The estimate is subject to change over time; therefore, do not rely on the
    // precision or accuracy of the estimate.
    SizeEstimateRangeGB []float64 `type:"list"`
    // contains filtered or unexported fields
}

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

func (ItemCollectionMetrics) String Uses

func (s ItemCollectionMetrics) String() string

String returns the string representation

type ItemResponse Uses

type ItemResponse struct {

    // Map of attribute data consisting of the data type and attribute value.
    Item map[string]AttributeValue `type:"map"`
    // contains filtered or unexported fields
}

Details for the requested item.

func (ItemResponse) String Uses

func (s ItemResponse) String() string

String returns the string representation

type KeySchemaElement Uses

type KeySchemaElement struct {

    // The name of a key attribute.
    //
    // AttributeName is a required field
    AttributeName *string `min:"1" type:"string" required:"true"`

    // The role that this key attribute will assume:
    //
    //    * HASH - partition key
    //
    //    * RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from DynamoDB's usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    //
    // KeyType is a required field
    KeyType KeyType `type:"string" required:"true" enum:"true"`
    // contains filtered or unexported fields
}

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

func (KeySchemaElement) String Uses

func (s KeySchemaElement) String() string

String returns the string representation

func (*KeySchemaElement) Validate Uses

func (s *KeySchemaElement) Validate() error

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

type KeyType Uses

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

Enum values for KeyType

func (KeyType) MarshalValue Uses

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

func (KeyType) MarshalValueBuf Uses

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

type KeysAndAttributes Uses

type KeysAndAttributes struct {

    // This is a legacy parameter. Use ProjectionExpression instead. For more information,
    // see Legacy Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html)
    // in the Amazon DynamoDB Developer Guide.
    AttributesToGet []string `min:"1" type:"list"`

    // The consistency of a read operation. If set to true, then a strongly consistent
    // read is used; otherwise, an eventually consistent read is used.
    ConsistentRead *bool `type:"boolean"`

    // One or more substitution tokens for attribute names in an expression. The
    // following are some use cases for using ExpressionAttributeNames:
    //
    //    * To access an attribute whose name conflicts with a DynamoDB reserved
    //    word.
    //
    //    * To create a placeholder for repeating occurrences of an attribute name
    //    in an expression.
    //
    //    * To prevent special characters in an attribute name from being misinterpreted
    //    in an expression.
    //
    // Use the # character in an expression to dereference an attribute name. For
    // example, consider the following attribute name:
    //
    //    * Percentile
    //
    // The name of this attribute conflicts with a reserved word, so it cannot be
    // used directly in an expression. (For the complete list of reserved words,
    // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    // in the Amazon DynamoDB Developer Guide). To work around this, you could specify
    // the following for ExpressionAttributeNames:
    //
    //    * {"#P":"Percentile"}
    //
    // You could then use this substitution in an expression, as in this example:
    //
    //    * #P = :val
    //
    // Tokens that begin with the : character are expression attribute values, which
    // are placeholders for the actual value at runtime.
    //
    // For more information on expression attribute names, see Accessing Item Attributes
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeNames map[string]string `type:"map"`

    // The primary key attribute values that define the items and the attributes
    // associated with the items.
    //
    // Keys is a required field
    Keys []map[string]AttributeValue `min:"1" type:"list" required:"true"`

    // A string that identifies one or more attributes to retrieve from the table.
    // These attributes can include scalars, sets, or elements of a JSON document.
    // The attributes in the ProjectionExpression must be separated by commas.
    //
    // If no attribute names are specified, then all attributes will be returned.
    // If any of the requested attributes are not found, they will not appear in
    // the result.
    //
    // For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ProjectionExpression *string `type:"string"`
    // contains filtered or unexported fields
}

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

func (KeysAndAttributes) String Uses

func (s KeysAndAttributes) String() string

String returns the string representation

func (*KeysAndAttributes) Validate Uses

func (s *KeysAndAttributes) Validate() error

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

type ListBackupsInput Uses

type ListBackupsInput struct {

    // The backups from the table specified by BackupType are listed.
    //
    // Where BackupType can be:
    //
    //    * USER - On-demand backup created by you.
    //
    //    * SYSTEM - On-demand backup automatically created by DynamoDB.
    //
    //    * ALL - All types of on-demand backups (USER and SYSTEM).
    BackupType BackupTypeFilter `type:"string" enum:"true"`

    // LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last
    // evaluated when the current page of results was returned, inclusive of the
    // current page of results. This value may be specified as the ExclusiveStartBackupArn
    // of a new ListBackups operation in order to fetch the next page of results.
    ExclusiveStartBackupArn *string `min:"37" type:"string"`

    // Maximum number of backups to return at once.
    Limit *int64 `min:"1" type:"integer"`

    // The backups from the table specified by TableName are listed.
    TableName *string `min:"3" type:"string"`

    // Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
    TimeRangeLowerBound *time.Time `type:"timestamp"`

    // Only backups created before this time are listed. TimeRangeUpperBound is
    // exclusive.
    TimeRangeUpperBound *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

func (ListBackupsInput) String Uses

func (s ListBackupsInput) String() string

String returns the string representation

func (*ListBackupsInput) Validate Uses

func (s *ListBackupsInput) Validate() error

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

type ListBackupsOutput Uses

type ListBackupsOutput struct {

    // List of BackupSummary objects.
    BackupSummaries []BackupSummary `type:"list"`

    // The ARN of the backup last evaluated when the current page of results was
    // returned, inclusive of the current page of results. This value may be specified
    // as the ExclusiveStartBackupArn of a new ListBackups operation in order to
    // fetch the next page of results.
    //
    // If LastEvaluatedBackupArn is empty, then the last page of results has been
    // processed and there are no more results to be retrieved.
    //
    // If LastEvaluatedBackupArn is not empty, this may or may not indicate that
    // there is more data to be returned. All results are guaranteed to have been
    // returned if and only if no value for LastEvaluatedBackupArn is returned.
    LastEvaluatedBackupArn *string `min:"37" type:"string"`
    // contains filtered or unexported fields
}

func (ListBackupsOutput) String Uses

func (s ListBackupsOutput) String() string

String returns the string representation

type ListBackupsRequest Uses

type ListBackupsRequest struct {
    *aws.Request
    Input *ListBackupsInput
    Copy  func(*ListBackupsInput) ListBackupsRequest
}

ListBackupsRequest is the request type for the ListBackups API operation.

func (ListBackupsRequest) Send Uses

func (r ListBackupsRequest) Send(ctx context.Context) (*ListBackupsResponse, error)

Send marshals and sends the ListBackups API request.

type ListBackupsResponse Uses

type ListBackupsResponse struct {
    *ListBackupsOutput
    // contains filtered or unexported fields
}

ListBackupsResponse is the response type for the ListBackups API operation.

func (*ListBackupsResponse) SDKResponseMetdata Uses

func (r *ListBackupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListBackups request.

type ListContributorInsightsInput Uses

type ListContributorInsightsInput struct {

    // Maximum number of results to return per page.
    MaxResults *int64 `type:"integer"`

    // A token to for the desired page, if there is one.
    NextToken *string `type:"string"`

    // The name of the table.
    TableName *string `min:"3" type:"string"`
    // contains filtered or unexported fields
}

func (ListContributorInsightsInput) String Uses

func (s ListContributorInsightsInput) String() string

String returns the string representation

func (*ListContributorInsightsInput) Validate Uses

func (s *ListContributorInsightsInput) Validate() error

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

type ListContributorInsightsOutput Uses

type ListContributorInsightsOutput struct {

    // A list of ContributorInsightsSummary.
    ContributorInsightsSummaries []ContributorInsightsSummary `type:"list"`

    // A token to go to the next page if there is one.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (ListContributorInsightsOutput) String Uses

func (s ListContributorInsightsOutput) String() string

String returns the string representation

type ListContributorInsightsPaginator Uses

type ListContributorInsightsPaginator struct {
    aws.Pager
}

ListContributorInsightsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListContributorInsightsPaginator Uses

func NewListContributorInsightsPaginator(req ListContributorInsightsRequest) ListContributorInsightsPaginator

NewListContributorInsightsRequestPaginator returns a paginator for ListContributorInsights. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListContributorInsightsRequest(input)
p := dynamodb.NewListContributorInsightsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListContributorInsightsPaginator) CurrentPage Uses

func (p *ListContributorInsightsPaginator) CurrentPage() *ListContributorInsightsOutput

type ListContributorInsightsRequest Uses

type ListContributorInsightsRequest struct {
    *aws.Request
    Input *ListContributorInsightsInput
    Copy  func(*ListContributorInsightsInput) ListContributorInsightsRequest
}

ListContributorInsightsRequest is the request type for the ListContributorInsights API operation.

func (ListContributorInsightsRequest) Send Uses

func (r ListContributorInsightsRequest) Send(ctx context.Context) (*ListContributorInsightsResponse, error)

Send marshals and sends the ListContributorInsights API request.

type ListContributorInsightsResponse Uses

type ListContributorInsightsResponse struct {
    *ListContributorInsightsOutput
    // contains filtered or unexported fields
}

ListContributorInsightsResponse is the response type for the ListContributorInsights API operation.

func (*ListContributorInsightsResponse) SDKResponseMetdata Uses

func (r *ListContributorInsightsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListContributorInsights request.

type ListGlobalTablesInput Uses

type ListGlobalTablesInput struct {

    // The first global table name that this operation will evaluate.
    ExclusiveStartGlobalTableName *string `min:"3" type:"string"`

    // The maximum number of table names to return, if the parameter is not specified
    // DynamoDB defaults to 100.
    //
    // If the number of global tables DynamoDB finds reaches this limit, it stops
    // the operation and returns the table names collected up to that point, with
    // a table name in the LastEvaluatedGlobalTableName to apply in a subsequent
    // operation to the ExclusiveStartGlobalTableName parameter.
    Limit *int64 `min:"1" type:"integer"`

    // Lists the global tables in a specific Region.
    RegionName *string `type:"string"`
    // contains filtered or unexported fields
}

func (ListGlobalTablesInput) String Uses

func (s ListGlobalTablesInput) String() string

String returns the string representation

func (*ListGlobalTablesInput) Validate Uses

func (s *ListGlobalTablesInput) Validate() error

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

type ListGlobalTablesOutput Uses

type ListGlobalTablesOutput struct {

    // List of global table names.
    GlobalTables []GlobalTable `type:"list"`

    // Last evaluated global table name.
    LastEvaluatedGlobalTableName *string `min:"3" type:"string"`
    // contains filtered or unexported fields
}

func (ListGlobalTablesOutput) String Uses

func (s ListGlobalTablesOutput) String() string

String returns the string representation

type ListGlobalTablesRequest Uses

type ListGlobalTablesRequest struct {
    *aws.Request
    Input *ListGlobalTablesInput
    Copy  func(*ListGlobalTablesInput) ListGlobalTablesRequest
}

ListGlobalTablesRequest is the request type for the ListGlobalTables API operation.

func (ListGlobalTablesRequest) Send Uses

func (r ListGlobalTablesRequest) Send(ctx context.Context) (*ListGlobalTablesResponse, error)

Send marshals and sends the ListGlobalTables API request.

type ListGlobalTablesResponse Uses

type ListGlobalTablesResponse struct {
    *ListGlobalTablesOutput
    // contains filtered or unexported fields
}

ListGlobalTablesResponse is the response type for the ListGlobalTables API operation.

func (*ListGlobalTablesResponse) SDKResponseMetdata Uses

func (r *ListGlobalTablesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListGlobalTables request.

type ListTablesInput Uses

type ListTablesInput struct {

    // The first table name that this operation will evaluate. Use the value that
    // was returned for LastEvaluatedTableName in a previous operation, so that
    // you can obtain the next page of results.
    ExclusiveStartTableName *string `min:"3" type:"string"`

    // A maximum number of table names to return. If this parameter is not specified,
    // the limit is 100.
    Limit *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

Represents the input of a ListTables operation.

func (ListTablesInput) String Uses

func (s ListTablesInput) String() string

String returns the string representation

func (*ListTablesInput) Validate Uses

func (s *ListTablesInput) Validate() error

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

type ListTablesOutput Uses

type ListTablesOutput struct {

    // The name of the last table in the current page of results. Use this value
    // as the ExclusiveStartTableName in a new request to obtain the next page of
    // results, until all the table names are returned.
    //
    // If you do not receive a LastEvaluatedTableName value in the response, this
    // means that there are no more table names to be retrieved.
    LastEvaluatedTableName *string `min:"3" type:"string"`

    // The names of the tables associated with the current account at the current
    // endpoint. The maximum size of this array is 100.
    //
    // If LastEvaluatedTableName also appears in the output, you can use this value
    // as the ExclusiveStartTableName parameter in a subsequent ListTables request
    // and obtain the next page of results.
    TableNames []string `type:"list"`
    // contains filtered or unexported fields
}

Represents the output of a ListTables operation.

func (ListTablesOutput) String Uses

func (s ListTablesOutput) String() string

String returns the string representation

type ListTablesPaginator Uses

type ListTablesPaginator struct {
    aws.Pager
}

ListTablesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTablesPaginator Uses

func NewListTablesPaginator(req ListTablesRequest) ListTablesPaginator

NewListTablesRequestPaginator returns a paginator for ListTables. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListTablesRequest(input)
p := dynamodb.NewListTablesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTablesPaginator) CurrentPage Uses

func (p *ListTablesPaginator) CurrentPage() *ListTablesOutput

type ListTablesRequest Uses

type ListTablesRequest struct {
    *aws.Request
    Input *ListTablesInput
    Copy  func(*ListTablesInput) ListTablesRequest
}

ListTablesRequest is the request type for the ListTables API operation.

func (ListTablesRequest) Send Uses

func (r ListTablesRequest) Send(ctx context.Context) (*ListTablesResponse, error)

Send marshals and sends the ListTables API request.

type ListTablesResponse Uses

type ListTablesResponse struct {
    *ListTablesOutput
    // contains filtered or unexported fields
}

ListTablesResponse is the response type for the ListTables API operation.

func (*ListTablesResponse) SDKResponseMetdata Uses

func (r *ListTablesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTables request.

type ListTagsOfResourceInput Uses

type ListTagsOfResourceInput struct {

    // An optional string that, if supplied, must be copied from the output of a
    // previous call to ListTagOfResource. When provided in this manner, this API
    // fetches the next page of results.
    NextToken *string `type:"string"`

    // The Amazon DynamoDB resource with tags to be listed. This value is an Amazon
    // Resource Name (ARN).
    //
    // ResourceArn is a required field
    ResourceArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsOfResourceInput) String Uses

func (s ListTagsOfResourceInput) String() string

String returns the string representation

func (*ListTagsOfResourceInput) Validate Uses

func (s *ListTagsOfResourceInput) Validate() error

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

type ListTagsOfResourceOutput Uses

type ListTagsOfResourceOutput struct {

    // If this value is returned, there are additional results to be displayed.
    // To retrieve them, call ListTagsOfResource again, with NextToken set to this
    // value.
    NextToken *string `type:"string"`

    // The tags currently associated with the Amazon DynamoDB resource.
    Tags []Tag `type:"list"`
    // contains filtered or unexported fields
}

func (ListTagsOfResourceOutput) String Uses

func (s ListTagsOfResourceOutput) String() string

String returns the string representation

type ListTagsOfResourceRequest Uses

type ListTagsOfResourceRequest struct {
    *aws.Request
    Input *ListTagsOfResourceInput
    Copy  func(*ListTagsOfResourceInput) ListTagsOfResourceRequest
}

ListTagsOfResourceRequest is the request type for the ListTagsOfResource API operation.

func (ListTagsOfResourceRequest) Send Uses

func (r ListTagsOfResourceRequest) Send(ctx context.Context) (*ListTagsOfResourceResponse, error)

Send marshals and sends the ListTagsOfResource API request.

type ListTagsOfResourceResponse Uses

type ListTagsOfResourceResponse struct {
    *ListTagsOfResourceOutput
    // contains filtered or unexported fields
}

ListTagsOfResourceResponse is the response type for the ListTagsOfResource API operation.

func (*ListTagsOfResourceResponse) SDKResponseMetdata Uses

func (r *ListTagsOfResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsOfResource request.

type LocalSecondaryIndex Uses

type LocalSecondaryIndex struct {

    // The name of the local secondary index. The name must be unique among all
    // other indexes on this table.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`

    // The complete key schema for the local secondary index, consisting of one
    // or more pairs of attribute names and key types:
    //
    //    * HASH - partition key
    //
    //    * RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from DynamoDB's usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    //
    // KeySchema is a required field
    KeySchema []KeySchemaElement `min:"1" type:"list" required:"true"`

    // Represents attributes that are copied (projected) from the table into the
    // local secondary index. These are in addition to the primary key attributes
    // and index key attributes, which are automatically projected.
    //
    // Projection is a required field
    Projection *Projection `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Represents the properties of a local secondary index.

func (LocalSecondaryIndex) String Uses

func (s LocalSecondaryIndex) String() string

String returns the string representation

func (*LocalSecondaryIndex) Validate Uses

func (s *LocalSecondaryIndex) Validate() error

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

type LocalSecondaryIndexDescription Uses

type LocalSecondaryIndexDescription struct {

    // The Amazon Resource Name (ARN) that uniquely identifies the index.
    IndexArn *string `type:"string"`

    // Represents the name of the local secondary index.
    IndexName *string `min:"3" type:"string"`

    // The total size of the specified index, in bytes. DynamoDB updates this value
    // approximately every six hours. Recent changes might not be reflected in this
    // value.
    IndexSizeBytes *int64 `type:"long"`

    // The number of items in the specified index. DynamoDB updates this value approximately
    // every six hours. Recent changes might not be reflected in this value.
    ItemCount *int64 `type:"long"`

    // The complete key schema for the local secondary index, consisting of one
    // or more pairs of attribute names and key types:
    //
    //    * HASH - partition key
    //
    //    * RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from DynamoDB's usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    KeySchema []KeySchemaElement `min:"1" type:"list"`

    // Represents attributes that are copied (projected) from the table into the
    // global secondary index. These are in addition to the primary key attributes
    // and index key attributes, which are automatically projected.
    Projection *Projection `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of a local secondary index.

func (LocalSecondaryIndexDescription) String Uses

func (s LocalSecondaryIndexDescription) String() string

String returns the string representation

type LocalSecondaryIndexInfo Uses

type LocalSecondaryIndexInfo struct {

    // Represents the name of the local secondary index.
    IndexName *string `min:"3" type:"string"`

    // The complete key schema for a local secondary index, which consists of one
    // or more pairs of attribute names and key types:
    //
    //    * HASH - partition key
    //
    //    * RANGE - sort key
    //
    // The partition key of an item is also known as its hash attribute. The term
    // "hash attribute" derives from DynamoDB's usage of an internal hash function
    // to evenly distribute data items across partitions, based on their partition
    // key values.
    //
    // The sort key of an item is also known as its range attribute. The term "range
    // attribute" derives from the way DynamoDB stores items with the same partition
    // key physically close together, in sorted order by the sort key value.
    KeySchema []KeySchemaElement `min:"1" type:"list"`

    // Represents attributes that are copied (projected) from the table into the
    // global secondary index. These are in addition to the primary key attributes
    // and index key attributes, which are automatically projected.
    Projection *Projection `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of a local secondary index for the table when the backup was created.

func (LocalSecondaryIndexInfo) String Uses

func (s LocalSecondaryIndexInfo) String() string

String returns the string representation

type PointInTimeRecoveryDescription Uses

type PointInTimeRecoveryDescription struct {

    // Specifies the earliest point in time you can restore your table to. You can
    // restore your table to any point in time during the last 35 days.
    EarliestRestorableDateTime *time.Time `type:"timestamp"`

    // LatestRestorableDateTime is typically 5 minutes before the current time.
    LatestRestorableDateTime *time.Time `type:"timestamp"`

    // The current state of point in time recovery:
    //
    //    * ENABLING - Point in time recovery is being enabled.
    //
    //    * ENABLED - Point in time recovery is enabled.
    //
    //    * DISABLED - Point in time recovery is disabled.
    PointInTimeRecoveryStatus PointInTimeRecoveryStatus `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

The description of the point in time settings applied to the table.

func (PointInTimeRecoveryDescription) String Uses

func (s PointInTimeRecoveryDescription) String() string

String returns the string representation

type PointInTimeRecoverySpecification Uses

type PointInTimeRecoverySpecification struct {

    // Indicates whether point in time recovery is enabled (true) or disabled (false)
    // on the table.
    //
    // PointInTimeRecoveryEnabled is a required field
    PointInTimeRecoveryEnabled *bool `type:"boolean" required:"true"`
    // contains filtered or unexported fields
}

Represents the settings used to enable point in time recovery.

func (PointInTimeRecoverySpecification) String Uses

func (s PointInTimeRecoverySpecification) String() string

String returns the string representation

func (*PointInTimeRecoverySpecification) Validate Uses

func (s *PointInTimeRecoverySpecification) Validate() error

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

type PointInTimeRecoveryStatus Uses

type PointInTimeRecoveryStatus string
const (
    PointInTimeRecoveryStatusEnabled  PointInTimeRecoveryStatus = "ENABLED"
    PointInTimeRecoveryStatusDisabled PointInTimeRecoveryStatus = "DISABLED"
)

Enum values for PointInTimeRecoveryStatus

func (PointInTimeRecoveryStatus) MarshalValue Uses

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

func (PointInTimeRecoveryStatus) MarshalValueBuf Uses

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

type Projection Uses

type Projection struct {

    // Represents the non-key attribute names which will be projected into the index.
    //
    // For local secondary indexes, the total count of NonKeyAttributes summed across
    // all of the local secondary indexes, must not exceed 20. If you project the
    // same attribute into two different indexes, this counts as two distinct attributes
    // when determining the total.
    NonKeyAttributes []string `min:"1" type:"list"`

    // The set of attributes that are projected into the index:
    //
    //    * KEYS_ONLY - Only the index and primary keys are projected into the index.
    //
    //    * INCLUDE - Only the specified table attributes are projected into the
    //    index. The list of projected attributes is in NonKeyAttributes.
    //
    //    * ALL - All of the table attributes are projected into the index.
    ProjectionType ProjectionType `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

func (Projection) String Uses

func (s Projection) String() string

String returns the string representation

func (*Projection) Validate Uses

func (s *Projection) Validate() error

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

type ProjectionType Uses

type ProjectionType string
const (
    ProjectionTypeAll      ProjectionType = "ALL"
    ProjectionTypeKeysOnly ProjectionType = "KEYS_ONLY"
    ProjectionTypeInclude  ProjectionType = "INCLUDE"
)

Enum values for ProjectionType

func (ProjectionType) MarshalValue Uses

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

func (ProjectionType) MarshalValueBuf Uses

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

type ProvisionedThroughput Uses

type ProvisionedThroughput struct {

    // The maximum number of strongly consistent reads consumed per second before
    // DynamoDB returns a ThrottlingException. For more information, see Specifying
    // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
    // in the Amazon DynamoDB Developer Guide.
    //
    // If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
    //
    // ReadCapacityUnits is a required field
    ReadCapacityUnits *int64 `min:"1" type:"long" required:"true"`

    // The maximum number of writes consumed per second before DynamoDB returns
    // a ThrottlingException. For more information, see Specifying Read and Write
    // Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
    // in the Amazon DynamoDB Developer Guide.
    //
    // If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
    //
    // WriteCapacityUnits is a required field
    WriteCapacityUnits *int64 `min:"1" type:"long" required:"true"`
    // contains filtered or unexported fields
}

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.

func (ProvisionedThroughput) String Uses

func (s ProvisionedThroughput) String() string

String returns the string representation

func (*ProvisionedThroughput) Validate Uses

func (s *ProvisionedThroughput) Validate() error

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

type ProvisionedThroughputDescription Uses

type ProvisionedThroughputDescription struct {

    // The date and time of the last provisioned throughput decrease for this table.
    LastDecreaseDateTime *time.Time `type:"timestamp"`

    // The date and time of the last provisioned throughput increase for this table.
    LastIncreaseDateTime *time.Time `type:"timestamp"`

    // The number of provisioned throughput decreases for this table during this
    // UTC calendar day. For current maximums on provisioned throughput decreases,
    // see Limits (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
    // in the Amazon DynamoDB Developer Guide.
    NumberOfDecreasesToday *int64 `min:"1" type:"long"`

    // The maximum number of strongly consistent reads consumed per second before
    // DynamoDB returns a ThrottlingException. Eventually consistent reads require
    // less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits
    // per second provides 100 eventually consistent ReadCapacityUnits per second.
    ReadCapacityUnits *int64 `type:"long"`

    // The maximum number of writes consumed per second before DynamoDB returns
    // a ThrottlingException.
    WriteCapacityUnits *int64 `type:"long"`
    // contains filtered or unexported fields
}

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

func (ProvisionedThroughputDescription) String Uses

func (s ProvisionedThroughputDescription) String() string

String returns the string representation

type ProvisionedThroughputOverride Uses

type ProvisionedThroughputOverride struct {

    // Replica-specific read capacity units. If not specified, uses the source table's
    // read capacity settings.
    ReadCapacityUnits *int64 `min:"1" type:"long"`
    // contains filtered or unexported fields
}

Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.

func (ProvisionedThroughputOverride) String Uses

func (s ProvisionedThroughputOverride) String() string

String returns the string representation

func (*ProvisionedThroughputOverride) Validate Uses

func (s *ProvisionedThroughputOverride) Validate() error

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

type Put Uses

type Put struct {

    // A condition that must be satisfied in order for a conditional update to succeed.
    ConditionExpression *string `type:"string"`

    // One or more substitution tokens for attribute names in an expression.
    ExpressionAttributeNames map[string]string `type:"map"`

    // One or more values that can be substituted in an expression.
    ExpressionAttributeValues map[string]AttributeValue `type:"map"`

    // A map of attribute name to attribute values, representing the primary key
    // of the item to be written by PutItem. All of the table's primary key attributes
    // must be specified, and their data types must match those of the table's key
    // schema. If any attributes are present in the item that are part of an index
    // key schema for the table, their types must match the index key schema.
    //
    // Item is a required field
    Item map[string]AttributeValue `type:"map" required:"true"`

    // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
    // Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values
    // are: NONE and ALL_OLD.
    ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure `type:"string" enum:"true"`

    // Name of the table in which to write the item.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents a request to perform a PutItem operation.

func (Put) String Uses

func (s Put) String() string

String returns the string representation

func (*Put) Validate Uses

func (s *Put) Validate() error

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

type PutItemInput Uses

type PutItemInput struct {

    // A condition that must be satisfied in order for a conditional PutItem operation
    // to succeed.
    //
    // An expression can contain any of the following:
    //
    //    * Functions: attribute_exists | attribute_not_exists | attribute_type
    //    | contains | begins_with | size These function names are case-sensitive.
    //
    //    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    //
    //    * Logical operators: AND | OR | NOT
    //
    // For more information on condition expressions, see Condition Expressions
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
    // in the Amazon DynamoDB Developer Guide.
    ConditionExpression *string `type:"string"`

    // This is a legacy parameter. Use ConditionExpression instead. For more information,
    // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
    // in the Amazon DynamoDB Developer Guide.
    ConditionalOperator ConditionalOperator `type:"string" enum:"true"`

    // This is a legacy parameter. Use ConditionExpression instead. For more information,
    // see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
    // in the Amazon DynamoDB Developer Guide.
    Expected map[string]ExpectedAttributeValue `type:"map"`

    // One or more substitution tokens for attribute names in an expression. The
    // following are some use cases for using ExpressionAttributeNames:
    //
    //    * To access an attribute whose name conflicts with a DynamoDB reserved
    //    word.
    //
    //    * To create a placeholder for repeating occurrences of an attribute name
    //    in an expression.
    //
    //    * To prevent special characters in an attribute name from being misinterpreted
    //    in an expression.
    //
    // Use the # character in an expression to dereference an attribute name. For
    // example, consider the following attribute name:
    //
    //    * Percentile
    //
    // The name of this attribute conflicts with a reserved word, so it cannot be
    // used directly in an expression. (For the complete list of reserved words,
    // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    // in the Amazon DynamoDB Developer Guide). To work around this, you could specify
    // the following for ExpressionAttributeNames:
    //
    //    * {"#P":"Percentile"}
    //
    // You could then use this substitution in an expression, as in this example:
    //
    //    * #P = :val
    //
    // Tokens that begin with the : character are expression attribute values, which
    // are placeholders for the actual value at runtime.
    //
    // For more information on expression attribute names, see Specifying Item Attributes
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeNames map[string]string `type:"map"`

    // One or more values that can be substituted in an expression.
    //
    // Use the : (colon) character in an expression to dereference an attribute
    // value. For example, suppose that you wanted to check whether the value of
    // the ProductStatus attribute was one of the following:
    //
    // Available | Backordered | Discontinued
    //
    // You would first need to specify ExpressionAttributeValues as follows:
    //
    // { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
    // }
    //
    // You could then use these values in an expression, such as this:
    //
    // ProductStatus IN (:avail, :back, :disc)
    //
    // For more information on expression attribute values, see Condition Expressions
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeValues map[string]AttributeValue `type:"map"`

    // A map of attribute name/value pairs, one for each attribute. Only the primary
    // key attributes are required; you can optionally provide other attribute name-value
    // pairs for the item.
    //
    // You must provide all of the attributes for the primary key. For example,
    // with a simple primary key, you only need to provide a value for the partition
    // key. For a composite primary key, you must provide both values for both the
    // partition key and the sort key.
    //
    // If you specify any attributes that are part of an index key, then the data
    // types for those attributes must match those of the schema in the table's
    // attribute definition.
    //
    // For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey)
    // in the Amazon DynamoDB Developer Guide.
    //
    // Each element in the Item map is an AttributeValue object.
    //
    // Item is a required field
    Item map[string]AttributeValue `type:"map" required:"true"`

    // Determines the level of detail about provisioned throughput consumption that
    // is returned in the response:
    //
    //    * INDEXES - The response includes the aggregate ConsumedCapacity for the
    //    operation, together with ConsumedCapacity for each table and secondary
    //    index that was accessed. Note that some operations, such as GetItem and
    //    BatchGetItem, do not access any indexes at all. In these cases, specifying
    //    INDEXES will only return ConsumedCapacity information for table(s).
    //
    //    * TOTAL - The response includes only the aggregate ConsumedCapacity for
    //    the operation.
    //
    //    * NONE - No ConsumedCapacity details are included in the response.
    ReturnConsumedCapacity ReturnConsumedCapacity `type:"string" enum:"true"`

    // Determines whether item collection metrics are returned. If set to SIZE,
    // the response includes statistics about item collections, if any, that were
    // modified during the operation are returned in the response. If set to NONE
    // (the default), no statistics are returned.
    ReturnItemCollectionMetrics ReturnItemCollectionMetrics `type:"string" enum:"true"`

    // Use ReturnValues if you want to get the item attributes as they appeared
    // before they were updated with the PutItem request. For PutItem, the valid
    // values are:
    //
    //    * NONE - If ReturnValues is not specified, or if its value is NONE, then
    //    nothing is returned. (This setting is the default for ReturnValues.)
    //
    //    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the
    //    content of the old item is returned.
    //
    // The ReturnValues parameter is used by several DynamoDB operations; however,
    // PutItem does not recognize any values other than NONE or ALL_OLD.
    ReturnValues ReturnValue `type:"string" enum:"true"`

    // The name of the table to contain the item.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents the input of a PutItem operation.

func (PutItemInput) String Uses

func (s PutItemInput) String() string

String returns the string representation

func (*PutItemInput) Validate Uses

func (s *PutItemInput) Validate() error

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

type PutItemOutput Uses

type PutItemOutput struct {

    // The attribute values as they appeared before the PutItem operation, but only
    // if ReturnValues is specified as ALL_OLD in the request. Each element consists
    // of an attribute name and an attribute value.
    Attributes map[string]AttributeValue `type:"map"`

    // The capacity units consumed by the PutItem operation. The data returned includes
    // the total provisioned throughput consumed, along with statistics for the
    // table and any indexes involved in the operation. ConsumedCapacity is only
    // returned if the ReturnConsumedCapacity parameter was specified. For more
    // information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
    // in the Amazon DynamoDB Developer Guide.
    ConsumedCapacity *ConsumedCapacity `type:"structure"`

    // Information about item collections, if any, that were affected by the PutItem
    // operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics
    // parameter was specified. If the table does not have any local secondary indexes,
    // this information is not returned in the response.
    //
    // Each ItemCollectionMetrics element consists of:
    //
    //    * ItemCollectionKey - The partition key value of the item collection.
    //    This is the same as the partition key value of the item itself.
    //
    //    * SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
    //    This value is a two-element array containing a lower bound and an upper
    //    bound for the estimate. The estimate includes the size of all the items
    //    in the table, plus the size of all attributes projected into all of the
    //    local secondary indexes on that table. Use this estimate to measure whether
    //    a local secondary index is approaching its size limit. The estimate is
    //    subject to change over time; therefore, do not rely on the precision or
    //    accuracy of the estimate.
    ItemCollectionMetrics *ItemCollectionMetrics `type:"structure"`
    // contains filtered or unexported fields
}

Represents the output of a PutItem operation.

func (PutItemOutput) String Uses

func (s PutItemOutput) String() string

String returns the string representation

type PutItemRequest Uses

type PutItemRequest struct {
    *aws.Request
    Input *PutItemInput
    Copy  func(*PutItemInput) PutItemRequest
}

PutItemRequest is the request type for the PutItem API operation.

func (PutItemRequest) Send Uses

func (r PutItemRequest) Send(ctx context.Context) (*PutItemResponse, error)

Send marshals and sends the PutItem API request.

type PutItemResponse Uses

type PutItemResponse struct {
    *PutItemOutput
    // contains filtered or unexported fields
}

PutItemResponse is the response type for the PutItem API operation.

func (*PutItemResponse) SDKResponseMetdata Uses

func (r *PutItemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutItem request.

type PutRequest Uses

type PutRequest struct {

    // A map of attribute name to attribute values, representing the primary key
    // of an item to be processed by PutItem. All of the table's primary key attributes
    // must be specified, and their data types must match those of the table's key
    // schema. If any attributes are present in the item that are part of an index
    // key schema for the table, their types must match the index key schema.
    //
    // Item is a required field
    Item map[string]AttributeValue `type:"map" required:"true"`
    // contains filtered or unexported fields
}

Represents a request to perform a PutItem operation on an item.

func (PutRequest) String Uses

func (s PutRequest) String() string

String returns the string representation

type QueryInput Uses

type QueryInput struct {

    // This is a legacy parameter. Use ProjectionExpression instead. For more information,
    // see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
    // in the Amazon DynamoDB Developer Guide.
    AttributesToGet []string `min:"1" type:"list"`

    // This is a legacy parameter. Use FilterExpression instead. For more information,
    // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
    // in the Amazon DynamoDB Developer Guide.
    ConditionalOperator ConditionalOperator `type:"string" enum:"true"`

    // Determines the read consistency model: If set to true, then the operation
    // uses strongly consistent reads; otherwise, the operation uses eventually
    // consistent reads.
    //
    // Strongly consistent reads are not supported on global secondary indexes.
    // If you query a global secondary index with ConsistentRead set to true, you
    // will receive a ValidationException.
    ConsistentRead *bool `type:"boolean"`

    // The primary key of the first item that this operation will evaluate. Use
    // the value that was returned for LastEvaluatedKey in the previous operation.
    //
    // The data type for ExclusiveStartKey must be String, Number, or Binary. No
    // set data types are allowed.
    ExclusiveStartKey map[string]AttributeValue `type:"map"`

    // One or more substitution tokens for attribute names in an expression. The
    // following are some use cases for using ExpressionAttributeNames:
    //
    //    * To access an attribute whose name conflicts with a DynamoDB reserved
    //    word.
    //
    //    * To create a placeholder for repeating occurrences of an attribute name
    //    in an expression.
    //
    //    * To prevent special characters in an attribute name from being misinterpreted
    //    in an expression.
    //
    // Use the # character in an expression to dereference an attribute name. For
    // example, consider the following attribute name:
    //
    //    * Percentile
    //
    // The name of this attribute conflicts with a reserved word, so it cannot be
    // used directly in an expression. (For the complete list of reserved words,
    // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    // in the Amazon DynamoDB Developer Guide). To work around this, you could specify
    // the following for ExpressionAttributeNames:
    //
    //    * {"#P":"Percentile"}
    //
    // You could then use this substitution in an expression, as in this example:
    //
    //    * #P = :val
    //
    // Tokens that begin with the : character are expression attribute values, which
    // are placeholders for the actual value at runtime.
    //
    // For more information on expression attribute names, see Specifying Item Attributes
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeNames map[string]string `type:"map"`

    // One or more values that can be substituted in an expression.
    //
    // Use the : (colon) character in an expression to dereference an attribute
    // value. For example, suppose that you wanted to check whether the value of
    // the ProductStatus attribute was one of the following:
    //
    // Available | Backordered | Discontinued
    //
    // You would first need to specify ExpressionAttributeValues as follows:
    //
    // { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
    // }
    //
    // You could then use these values in an expression, such as this:
    //
    // ProductStatus IN (:avail, :back, :disc)
    //
    // For more information on expression attribute values, see Specifying Conditions
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeValues map[string]AttributeValue `type:"map"`

    // A string that contains conditions that DynamoDB applies after the Query operation,
    // but before the data is returned to you. Items that do not satisfy the FilterExpression
    // criteria are not returned.
    //
    // A FilterExpression does not allow key attributes. You cannot define a filter
    // expression based on a partition key or a sort key.
    //
    // A FilterExpression is applied after the items have already been read; the
    // process of filtering does not consume any additional read capacity units.
    //
    // For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults)
    // in the Amazon DynamoDB Developer Guide.
    FilterExpression *string `type:"string"`

    // The name of an index to query. This index can be any local secondary index
    // or global secondary index on the table. Note that if you use the IndexName
    // parameter, you must also provide TableName.
    IndexName *string `min:"3" type:"string"`

    // The condition that specifies the key values for items to be retrieved by
    // the Query action.
    //
    // The condition must perform an equality test on a single partition key value.
    //
    // The condition can optionally perform one of several comparison tests on a
    // single sort key value. This allows Query to retrieve one item with a given
    // partition key value and sort key value, or several items that have the same
    // partition key value but different sort key values.
    //
    // The partition key equality test is required, and must be specified in the
    // following format:
    //
    // partitionKeyName = :partitionkeyval
    //
    // If you also want to provide a condition for the sort key, it must be combined
    // using AND with the condition for the sort key. Following is an example, using
    // the = comparison operator for the sort key:
    //
    // partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval
    //
    // Valid comparisons for the sort key condition are as follows:
    //
    //    * sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.
    //
    //    * sortKeyName < :sortkeyval - true if the sort key value is less than
    //    :sortkeyval.
    //
    //    * sortKeyName <= :sortkeyval - true if the sort key value is less than
    //    or equal to :sortkeyval.
    //
    //    * sortKeyName > :sortkeyval - true if the sort key value is greater than
    //    :sortkeyval.
    //
    //    * sortKeyName >= :sortkeyval - true if the sort key value is greater than
    //    or equal to :sortkeyval.
    //
    //    * sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort
    //    key value is greater than or equal to :sortkeyval1, and less than or equal
    //    to :sortkeyval2.
    //
    //    * begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value
    //    begins with a particular operand. (You cannot use this function with a
    //    sort key that is of type Number.) Note that the function name begins_with
    //    is case-sensitive.
    //
    // Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
    // and :sortval with actual values at runtime.
    //
    // You can optionally use the ExpressionAttributeNames parameter to replace
    // the names of the partition key and sort key with placeholder tokens. This
    // option might be necessary if an attribute name conflicts with a DynamoDB
    // reserved word. For example, the following KeyConditionExpression parameter
    // causes an error because Size is a reserved word:
    //
    //    * Size = :myval
    //
    // To work around this, define a placeholder (such a #S) to represent the attribute
    // name Size. KeyConditionExpression then is as follows:
    //
    //    * #S = :myval
    //
    // For a list of reserved words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    // in the Amazon DynamoDB Developer Guide.
    //
    // For more information on ExpressionAttributeNames and ExpressionAttributeValues,
    // see Using Placeholders for Attribute Names and Values (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html)
    // in the Amazon DynamoDB Developer Guide.
    KeyConditionExpression *string `type:"string"`

    // This is a legacy parameter. Use KeyConditionExpression instead. For more
    // information, see KeyConditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html)
    // in the Amazon DynamoDB Developer Guide.
    KeyConditions map[string]Condition `type:"map"`

    // The maximum number of items to evaluate (not necessarily the number of matching
    // items). If DynamoDB processes the number of items up to the limit while processing
    // the results, it stops the operation and returns the matching values up to
    // that point, and a key in LastEvaluatedKey to apply in a subsequent operation,
    // so that you can pick up where you left off. Also, if the processed dataset
    // size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation
    // and returns the matching values up to the limit, and a key in LastEvaluatedKey
    // to apply in a subsequent operation to continue the operation. For more information,
    // see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
    // in the Amazon DynamoDB Developer Guide.
    Limit *int64 `min:"1" type:"integer"`

    // A string that identifies one or more attributes to retrieve from the table.
    // These attributes can include scalars, sets, or elements of a JSON document.
    // The attributes in the expression must be separated by commas.
    //
    // If no attribute names are specified, then all attributes will be returned.
    // If any of the requested attributes are not found, they will not appear in
    // the result.
    //
    // For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ProjectionExpression *string `type:"string"`

    // This is a legacy parameter. Use FilterExpression instead. For more information,
    // see QueryFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html)
    // in the Amazon DynamoDB Developer Guide.
    QueryFilter map[string]Condition `type:"map"`

    // Determines the level of detail about provisioned throughput consumption that
    // is returned in the response:
    //
    //    * INDEXES - The response includes the aggregate ConsumedCapacity for the
    //    operation, together with ConsumedCapacity for each table and secondary
    //    index that was accessed. Note that some operations, such as GetItem and
    //    BatchGetItem, do not access any indexes at all. In these cases, specifying
    //    INDEXES will only return ConsumedCapacity information for table(s).
    //
    //    * TOTAL - The response includes only the aggregate ConsumedCapacity for
    //    the operation.
    //
    //    * NONE - No ConsumedCapacity details are included in the response.
    ReturnConsumedCapacity ReturnConsumedCapacity `type:"string" enum:"true"`

    // Specifies the order for index traversal: If true (default), the traversal
    // is performed in ascending order; if false, the traversal is performed in
    // descending order.
    //
    // Items with the same partition key value are stored in sorted order by sort
    // key. If the sort key data type is Number, the results are stored in numeric
    // order. For type String, the results are stored in order of UTF-8 bytes. For
    // type Binary, DynamoDB treats each byte of the binary data as unsigned.
    //
    // If ScanIndexForward is true, DynamoDB returns the results in the order in
    // which they are stored (by sort key value). This is the default behavior.
    // If ScanIndexForward is false, DynamoDB reads the results in reverse order
    // by sort key value, and then returns the results to the client.
    ScanIndexForward *bool `type:"boolean"`

    // The attributes to be returned in the result. You can retrieve all item attributes,
    // specific item attributes, the count of matching items, or in the case of
    // an index, some or all of the attributes projected into the index.
    //
    //    * ALL_ATTRIBUTES - Returns all of the item attributes from the specified
    //    table or index. If you query a local secondary index, then for each matching
    //    item in the index, DynamoDB fetches the entire item from the parent table.
    //    If the index is configured to project all item attributes, then all of
    //    the data can be obtained from the local secondary index, and no fetching
    //    is required.
    //
    //    * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves
    //    all attributes that have been projected into the index. If the index is
    //    configured to project all attributes, this return value is equivalent
    //    to specifying ALL_ATTRIBUTES.
    //
    //    * COUNT - Returns the number of matching items, rather than the matching
    //    items themselves.
    //
    //    * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet.
    //    This return value is equivalent to specifying AttributesToGet without
    //    specifying any value for Select. If you query or scan a local secondary
    //    index and request only attributes that are projected into that index,
    //    the operation will read only the index and not the table. If any of the
    //    requested attributes are not projected into the local secondary index,
    //    DynamoDB fetches each of these attributes from the parent table. This
    //    extra fetching incurs additional throughput cost and latency. If you query
    //    or scan a global secondary index, you can only request attributes that
    //    are projected into the index. Global secondary index queries cannot fetch
    //    attributes from the parent table.
    //
    // If neither Select nor AttributesToGet are specified, DynamoDB defaults to
    // ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
    // accessing an index. You cannot use both Select and AttributesToGet together
    // in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
    // (This usage is equivalent to specifying AttributesToGet without any value
    // for Select.)
    //
    // If you use the ProjectionExpression parameter, then the value for Select
    // can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an
    // error.
    Select Select `type:"string" enum:"true"`

    // The name of the table containing the requested items.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents the input of a Query operation.

func (QueryInput) String Uses

func (s QueryInput) String() string

String returns the string representation

func (*QueryInput) Validate Uses

func (s *QueryInput) Validate() error

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

type QueryOutput Uses

type QueryOutput struct {

    // The capacity units consumed by the Query operation. The data returned includes
    // the total provisioned throughput consumed, along with statistics for the
    // table and any indexes involved in the operation. ConsumedCapacity is only
    // returned if the ReturnConsumedCapacity parameter was specified. For more
    // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
    // in the Amazon DynamoDB Developer Guide.
    ConsumedCapacity *ConsumedCapacity `type:"structure"`

    // The number of items in the response.
    //
    // If you used a QueryFilter in the request, then Count is the number of items
    // returned after the filter was applied, and ScannedCount is the number of
    // matching items before the filter was applied.
    //
    // If you did not use a filter in the request, then Count and ScannedCount are
    // the same.
    Count *int64 `type:"integer"`

    // An array of item attributes that match the query criteria. Each element in
    // this array consists of an attribute name and the value for that attribute.
    Items []map[string]AttributeValue `type:"list"`

    // The primary key 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 LastEvaluatedKey is empty, then the "last page" of results has been processed
    // and there is no more data to be retrieved.
    //
    // If LastEvaluatedKey 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 LastEvaluatedKey is empty.
    LastEvaluatedKey map[string]AttributeValue `type:"map"`

    // The number of items evaluated, before any QueryFilter is applied. A high
    // ScannedCount value with few, or no, Count results indicates an inefficient
    // Query operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count)
    // in the Amazon DynamoDB Developer Guide.
    //
    // If you did not use a filter in the request, then ScannedCount is the same
    // as Count.
    ScannedCount *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Represents the output of a Query operation.

func (QueryOutput) String Uses

func (s QueryOutput) String() string

String returns the string representation

type QueryPaginator Uses

type QueryPaginator struct {
    aws.Pager
}

QueryPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewQueryPaginator Uses

func NewQueryPaginator(req QueryRequest) QueryPaginator

NewQueryRequestPaginator returns a paginator for Query. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.QueryRequest(input)
p := dynamodb.NewQueryRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*QueryPaginator) CurrentPage Uses

func (p *QueryPaginator) CurrentPage() *QueryOutput

type QueryRequest Uses

type QueryRequest struct {
    *aws.Request
    Input *QueryInput
    Copy  func(*QueryInput) QueryRequest
}

QueryRequest is the request type for the Query API operation.

func (QueryRequest) Send Uses

func (r QueryRequest) Send(ctx context.Context) (*QueryResponse, error)

Send marshals and sends the Query API request.

type QueryResponse Uses

type QueryResponse struct {
    *QueryOutput
    // contains filtered or unexported fields
}

QueryResponse is the response type for the Query API operation.

func (*QueryResponse) SDKResponseMetdata Uses

func (r *QueryResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the Query request.

type Replica Uses

type Replica struct {

    // The Region where the replica needs to be created.
    RegionName *string `type:"string"`
    // contains filtered or unexported fields
}

Represents the properties of a replica.

func (Replica) String Uses

func (s Replica) String() string

String returns the string representation

type ReplicaAutoScalingDescription Uses

type ReplicaAutoScalingDescription struct {

    // Replica-specific global secondary index auto scaling settings.
    GlobalSecondaryIndexes []ReplicaGlobalSecondaryIndexAutoScalingDescription `type:"list"`

    // The Region where the replica exists.
    RegionName *string `type:"string"`

    // Represents the auto scaling settings for a global table or global secondary
    // index.
    ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

    // Represents the auto scaling settings for a global table or global secondary
    // index.
    ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

    // The current state of the replica:
    //
    //    * CREATING - The replica is being created.
    //
    //    * UPDATING - The replica is being updated.
    //
    //    * DELETING - The replica is being deleted.
    //
    //    * ACTIVE - The replica is ready for use.
    ReplicaStatus ReplicaStatus `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

Represents the auto scaling settings of the replica.

func (ReplicaAutoScalingDescription) String Uses

func (s ReplicaAutoScalingDescription) String() string

String returns the string representation

type ReplicaAutoScalingUpdate Uses

type ReplicaAutoScalingUpdate struct {

    // The Region where the replica exists.
    //
    // RegionName is a required field
    RegionName *string `type:"string" required:"true"`

    // Represents the auto scaling settings of global secondary indexes that will
    // be modified.
    ReplicaGlobalSecondaryIndexUpdates []ReplicaGlobalSecondaryIndexAutoScalingUpdate `type:"list"`

    // Represents the auto scaling settings to be modified for a global table or
    // global secondary index.
    ReplicaProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"`
    // contains filtered or unexported fields
}

Represents the auto scaling settings of a replica that will be modified.

func (ReplicaAutoScalingUpdate) String Uses

func (s ReplicaAutoScalingUpdate) String() string

String returns the string representation

func (*ReplicaAutoScalingUpdate) Validate Uses

func (s *ReplicaAutoScalingUpdate) Validate() error

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

type ReplicaDescription Uses

type ReplicaDescription struct {

    // Replica-specific global secondary index settings.
    GlobalSecondaryIndexes []ReplicaGlobalSecondaryIndexDescription `type:"list"`

    // The AWS KMS customer master key (CMK) of the replica that will be used for
    // AWS KMS encryption.
    KMSMasterKeyId *string `type:"string"`

    // Replica-specific provisioned throughput. If not described, uses the source
    // table's provisioned throughput settings.
    ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`

    // The name of the Region.
    RegionName *string `type:"string"`

    // The current state of the replica:
    //
    //    * CREATING - The replica is being created.
    //
    //    * UPDATING - The replica is being updated.
    //
    //    * DELETING - The replica is being deleted.
    //
    //    * ACTIVE - The replica is ready for use.
    ReplicaStatus ReplicaStatus `type:"string" enum:"true"`

    // Detailed information about the replica status.
    ReplicaStatusDescription *string `type:"string"`

    // Specifies the progress of a Create, Update, or Delete action on the replica
    // as a percentage.
    ReplicaStatusPercentProgress *string `type:"string"`
    // contains filtered or unexported fields
}

Contains the details of the replica.

func (ReplicaDescription) String Uses

func (s ReplicaDescription) String() string

String returns the string representation

type ReplicaGlobalSecondaryIndex Uses

type ReplicaGlobalSecondaryIndex struct {

    // The name of the global secondary index.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`

    // Replica table GSI-specific provisioned throughput. If not specified, uses
    // the source table GSI's read capacity settings.
    ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of a replica global secondary index.

func (ReplicaGlobalSecondaryIndex) String Uses

func (s ReplicaGlobalSecondaryIndex) String() string

String returns the string representation

func (*ReplicaGlobalSecondaryIndex) Validate Uses

func (s *ReplicaGlobalSecondaryIndex) Validate() error

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

type ReplicaGlobalSecondaryIndexAutoScalingDescription Uses

type ReplicaGlobalSecondaryIndexAutoScalingDescription struct {

    // The name of the global secondary index.
    IndexName *string `min:"3" type:"string"`

    // The current state of the replica global secondary index:
    //
    //    * CREATING - The index is being created.
    //
    //    * UPDATING - The index is being updated.
    //
    //    * DELETING - The index is being deleted.
    //
    //    * ACTIVE - The index is ready for use.
    IndexStatus IndexStatus `type:"string" enum:"true"`

    // Represents the auto scaling settings for a global table or global secondary
    // index.
    ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

    // Represents the auto scaling settings for a global table or global secondary
    // index.
    ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`
    // contains filtered or unexported fields
}

Represents the auto scaling configuration for a replica global secondary index.

func (ReplicaGlobalSecondaryIndexAutoScalingDescription) String Uses

func (s ReplicaGlobalSecondaryIndexAutoScalingDescription) String() string

String returns the string representation

type ReplicaGlobalSecondaryIndexAutoScalingUpdate Uses

type ReplicaGlobalSecondaryIndexAutoScalingUpdate struct {

    // The name of the global secondary index.
    IndexName *string `min:"3" type:"string"`

    // Represents the auto scaling settings to be modified for a global table or
    // global secondary index.
    ProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"`
    // contains filtered or unexported fields
}

Represents the auto scaling settings of a global secondary index for a replica that will be modified.

func (ReplicaGlobalSecondaryIndexAutoScalingUpdate) String Uses

func (s ReplicaGlobalSecondaryIndexAutoScalingUpdate) String() string

String returns the string representation

func (*ReplicaGlobalSecondaryIndexAutoScalingUpdate) Validate Uses

func (s *ReplicaGlobalSecondaryIndexAutoScalingUpdate) Validate() error

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

type ReplicaGlobalSecondaryIndexDescription Uses

type ReplicaGlobalSecondaryIndexDescription struct {

    // The name of the global secondary index.
    IndexName *string `min:"3" type:"string"`

    // If not described, uses the source table GSI's read capacity settings.
    ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`
    // contains filtered or unexported fields
}

Represents the properties of a replica global secondary index.

func (ReplicaGlobalSecondaryIndexDescription) String Uses

func (s ReplicaGlobalSecondaryIndexDescription) String() string

String returns the string representation

type ReplicaGlobalSecondaryIndexSettingsDescription Uses

type ReplicaGlobalSecondaryIndexSettingsDescription struct {

    // The name of the global secondary index. The name must be unique among all
    // other indexes on this table.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`

    // The current status of the global secondary index:
    //
    //    * CREATING - The global secondary index is being created.
    //
    //    * UPDATING - The global secondary index is being updated.
    //
    //    * DELETING - The global secondary index is being deleted.
    //
    //    * ACTIVE - The global secondary index is ready for use.
    IndexStatus IndexStatus `type:"string" enum:"true"`

    // Auto scaling settings for a global secondary index replica's read capacity
    // units.
    ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

    // The maximum number of strongly consistent reads consumed per second before
    // DynamoDB returns a ThrottlingException.
    ProvisionedReadCapacityUnits *int64 `min:"1" type:"long"`

    // Auto scaling settings for a global secondary index replica's write capacity
    // units.
    ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

    // The maximum number of writes consumed per second before DynamoDB returns
    // a ThrottlingException.
    ProvisionedWriteCapacityUnits *int64 `min:"1" type:"long"`
    // contains filtered or unexported fields
}

Represents the properties of a global secondary index.

func (ReplicaGlobalSecondaryIndexSettingsDescription) String Uses

func (s ReplicaGlobalSecondaryIndexSettingsDescription) String() string

String returns the string representation

type ReplicaGlobalSecondaryIndexSettingsUpdate Uses

type ReplicaGlobalSecondaryIndexSettingsUpdate struct {

    // The name of the global secondary index. The name must be unique among all
    // other indexes on this table.
    //
    // IndexName is a required field
    IndexName *string `min:"3" type:"string" required:"true"`

    // Auto scaling settings for managing a global secondary index replica's read
    // capacity units.
    ProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"`

    // The maximum number of strongly consistent reads consumed per second before
    // DynamoDB returns a ThrottlingException.
    ProvisionedReadCapacityUnits *int64 `min:"1" type:"long"`
    // contains filtered or unexported fields
}

Represents the settings of a global secondary index for a global table that will be modified.

func (ReplicaGlobalSecondaryIndexSettingsUpdate) String Uses

func (s ReplicaGlobalSecondaryIndexSettingsUpdate) String() string

String returns the string representation

func (*ReplicaGlobalSecondaryIndexSettingsUpdate) Validate Uses

func (s *ReplicaGlobalSecondaryIndexSettingsUpdate) Validate() error

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

type ReplicaSettingsDescription Uses

type ReplicaSettingsDescription struct {

    // The Region name of the replica.
    //
    // RegionName is a required field
    RegionName *string `type:"string" required:"true"`

    // The read/write capacity mode of the replica.
    ReplicaBillingModeSummary *BillingModeSummary `type:"structure"`

    // Replica global secondary index settings for the global table.
    ReplicaGlobalSecondaryIndexSettings []ReplicaGlobalSecondaryIndexSettingsDescription `type:"list"`

    // Auto scaling settings for a global table replica's read capacity units.
    ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

    // The maximum number of strongly consistent reads consumed per second before
    // DynamoDB returns a ThrottlingException. For more information, see Specifying
    // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
    // in the Amazon DynamoDB Developer Guide.
    ReplicaProvisionedReadCapacityUnits *int64 `type:"long"`

    // Auto scaling settings for a global table replica's write capacity units.
    ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

    // The maximum number of writes consumed per second before DynamoDB returns
    // a ThrottlingException. For more information, see Specifying Read and Write
    // Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
    // in the Amazon DynamoDB Developer Guide.
    ReplicaProvisionedWriteCapacityUnits *int64 `type:"long"`

    // The current state of the Region:
    //
    //    * CREATING - The Region is being created.
    //
    //    * UPDATING - The Region is being updated.
    //
    //    * DELETING - The Region is being deleted.
    //
    //    * ACTIVE - The Region is ready for use.
    ReplicaStatus ReplicaStatus `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

Represents the properties of a replica.

func (ReplicaSettingsDescription) String Uses

func (s ReplicaSettingsDescription) String() string

String returns the string representation

type ReplicaSettingsUpdate Uses

type ReplicaSettingsUpdate struct {

    // The Region of the replica to be added.
    //
    // RegionName is a required field
    RegionName *string `type:"string" required:"true"`

    // Represents the settings of a global secondary index for a global table that
    // will be modified.
    ReplicaGlobalSecondaryIndexSettingsUpdate []ReplicaGlobalSecondaryIndexSettingsUpdate `min:"1" type:"list"`

    // Auto scaling settings for managing a global table replica's read capacity
    // units.
    ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"`

    // The maximum number of strongly consistent reads consumed per second before
    // DynamoDB returns a ThrottlingException. For more information, see Specifying
    // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
    // in the Amazon DynamoDB Developer Guide.
    ReplicaProvisionedReadCapacityUnits *int64 `min:"1" type:"long"`
    // contains filtered or unexported fields
}

Represents the settings for a global table in a Region that will be modified.

func (ReplicaSettingsUpdate) String Uses

func (s ReplicaSettingsUpdate) String() string

String returns the string representation

func (*ReplicaSettingsUpdate) Validate Uses

func (s *ReplicaSettingsUpdate) Validate() error

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

type ReplicaStatus Uses

type ReplicaStatus string
const (
    ReplicaStatusCreating       ReplicaStatus = "CREATING"
    ReplicaStatusCreationFailed ReplicaStatus = "CREATION_FAILED"
    ReplicaStatusUpdating       ReplicaStatus = "UPDATING"
    ReplicaStatusDeleting       ReplicaStatus = "DELETING"
    ReplicaStatusActive         ReplicaStatus = "ACTIVE"
)

Enum values for ReplicaStatus

func (ReplicaStatus) MarshalValue Uses

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

func (ReplicaStatus) MarshalValueBuf Uses

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

type ReplicaUpdate Uses

type ReplicaUpdate struct {

    // The parameters required for creating a replica on an existing global table.
    Create *CreateReplicaAction `type:"structure"`

    // The name of the existing replica to be removed.
    Delete *DeleteReplicaAction `type:"structure"`
    // contains filtered or unexported fields
}

Represents one of the following:

* A new replica to be added to an existing global table.

* New parameters for an existing replica.

* An existing replica to be removed from an existing global table.

func (ReplicaUpdate) String Uses

func (s ReplicaUpdate) String() string

String returns the string representation

func (*ReplicaUpdate) Validate Uses

func (s *ReplicaUpdate) Validate() error

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

type ReplicationGroupUpdate Uses

type ReplicationGroupUpdate struct {

    // The parameters required for creating a replica for the table.
    Create *CreateReplicationGroupMemberAction `type:"structure"`

    // The parameters required for deleting a replica for the table.
    Delete *DeleteReplicationGroupMemberAction `type:"structure"`

    // The parameters required for updating a replica for the table.
    Update *UpdateReplicationGroupMemberAction `type:"structure"`
    // contains filtered or unexported fields
}

Represents one of the following:

* A new replica to be added to an existing regional table or global table.
This request invokes the CreateTableReplica action in the destination
Region.

* New parameters for an existing replica. This request invokes the UpdateTable
action in the destination Region.

* An existing replica to be deleted. The request invokes the DeleteTableReplica
action in the destination Region, deleting the replica and all if its
items in the destination Region.

func (ReplicationGroupUpdate) String Uses

func (s ReplicationGroupUpdate) String() string

String returns the string representation

func (*ReplicationGroupUpdate) Validate Uses

func (s *ReplicationGroupUpdate) Validate() error

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

type RestoreSummary Uses

type RestoreSummary struct {

    // Point in time or source backup time.
    //
    // RestoreDateTime is a required field
    RestoreDateTime *time.Time `type:"timestamp" required:"true"`

    // Indicates if a restore is in progress or not.
    //
    // RestoreInProgress is a required field
    RestoreInProgress *bool `type:"boolean" required:"true"`

    // The Amazon Resource Name (ARN) of the backup from which the table was restored.
    SourceBackupArn *string `min:"37" type:"string"`

    // The ARN of the source table of the backup that is being restored.
    SourceTableArn *string `type:"string"`
    // contains filtered or unexported fields
}

Contains details for the restore.

func (RestoreSummary) String Uses

func (s RestoreSummary) String() string

String returns the string representation

type RestoreTableFromBackupInput Uses

type RestoreTableFromBackupInput struct {

    // The Amazon Resource Name (ARN) associated with the backup.
    //
    // BackupArn is a required field
    BackupArn *string `min:"37" type:"string" required:"true"`

    // The billing mode of the restored table.
    BillingModeOverride BillingMode `type:"string" enum:"true"`

    // List of global secondary indexes for the restored table. The indexes provided
    // should match existing secondary indexes. You can choose to exclude some or
    // all of the indexes at the time of restore.
    GlobalSecondaryIndexOverride []GlobalSecondaryIndex `type:"list"`

    // List of local secondary indexes for the restored table. The indexes provided
    // should match existing secondary indexes. You can choose to exclude some or
    // all of the indexes at the time of restore.
    LocalSecondaryIndexOverride []LocalSecondaryIndex `type:"list"`

    // Provisioned throughput settings for the restored table.
    ProvisionedThroughputOverride *ProvisionedThroughput `type:"structure"`

    // The new server-side encryption settings for the restored table.
    SSESpecificationOverride *SSESpecification `type:"structure"`

    // The name of the new table to which the backup must be restored.
    //
    // TargetTableName is a required field
    TargetTableName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (RestoreTableFromBackupInput) String Uses

func (s RestoreTableFromBackupInput) String() string

String returns the string representation

func (*RestoreTableFromBackupInput) Validate Uses

func (s *RestoreTableFromBackupInput) Validate() error

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

type RestoreTableFromBackupOutput Uses

type RestoreTableFromBackupOutput struct {

    // The description of the table created from an existing backup.
    TableDescription *TableDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (RestoreTableFromBackupOutput) String Uses

func (s RestoreTableFromBackupOutput) String() string

String returns the string representation

type RestoreTableFromBackupRequest Uses

type RestoreTableFromBackupRequest struct {
    *aws.Request
    Input *RestoreTableFromBackupInput
    Copy  func(*RestoreTableFromBackupInput) RestoreTableFromBackupRequest
}

RestoreTableFromBackupRequest is the request type for the RestoreTableFromBackup API operation.

func (RestoreTableFromBackupRequest) Send Uses

func (r RestoreTableFromBackupRequest) Send(ctx context.Context) (*RestoreTableFromBackupResponse, error)

Send marshals and sends the RestoreTableFromBackup API request.

type RestoreTableFromBackupResponse Uses

type RestoreTableFromBackupResponse struct {
    *RestoreTableFromBackupOutput
    // contains filtered or unexported fields
}

RestoreTableFromBackupResponse is the response type for the RestoreTableFromBackup API operation.

func (*RestoreTableFromBackupResponse) SDKResponseMetdata Uses

func (r *RestoreTableFromBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreTableFromBackup request.

type RestoreTableToPointInTimeInput Uses

type RestoreTableToPointInTimeInput struct {

    // The billing mode of the restored table.
    BillingModeOverride BillingMode `type:"string" enum:"true"`

    // List of global secondary indexes for the restored table. The indexes provided
    // should match existing secondary indexes. You can choose to exclude some or
    // all of the indexes at the time of restore.
    GlobalSecondaryIndexOverride []GlobalSecondaryIndex `type:"list"`

    // List of local secondary indexes for the restored table. The indexes provided
    // should match existing secondary indexes. You can choose to exclude some or
    // all of the indexes at the time of restore.
    LocalSecondaryIndexOverride []LocalSecondaryIndex `type:"list"`

    // Provisioned throughput settings for the restored table.
    ProvisionedThroughputOverride *ProvisionedThroughput `type:"structure"`

    // Time in the past to restore the table to.
    RestoreDateTime *time.Time `type:"timestamp"`

    // The new server-side encryption settings for the restored table.
    SSESpecificationOverride *SSESpecification `type:"structure"`

    // The DynamoDB table that will be restored. This value is an Amazon Resource
    // Name (ARN).
    SourceTableArn *string `type:"string"`

    // Name of the source table that is being restored.
    SourceTableName *string `min:"3" type:"string"`

    // The name of the new table to which it must be restored to.
    //
    // TargetTableName is a required field
    TargetTableName *string `min:"3" type:"string" required:"true"`

    // Restore the table to the latest possible time. LatestRestorableDateTime is
    // typically 5 minutes before the current time.
    UseLatestRestorableTime *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (RestoreTableToPointInTimeInput) String Uses

func (s RestoreTableToPointInTimeInput) String() string

String returns the string representation

func (*RestoreTableToPointInTimeInput) Validate Uses

func (s *RestoreTableToPointInTimeInput) Validate() error

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

type RestoreTableToPointInTimeOutput Uses

type RestoreTableToPointInTimeOutput struct {

    // Represents the properties of a table.
    TableDescription *TableDescription `type:"structure"`
    // contains filtered or unexported fields
}

func (RestoreTableToPointInTimeOutput) String Uses

func (s RestoreTableToPointInTimeOutput) String() string

String returns the string representation

type RestoreTableToPointInTimeRequest Uses

type RestoreTableToPointInTimeRequest struct {
    *aws.Request
    Input *RestoreTableToPointInTimeInput
    Copy  func(*RestoreTableToPointInTimeInput) RestoreTableToPointInTimeRequest
}

RestoreTableToPointInTimeRequest is the request type for the RestoreTableToPointInTime API operation.

func (RestoreTableToPointInTimeRequest) Send Uses

func (r RestoreTableToPointInTimeRequest) Send(ctx context.Context) (*RestoreTableToPointInTimeResponse, error)

Send marshals and sends the RestoreTableToPointInTime API request.

type RestoreTableToPointInTimeResponse Uses

type RestoreTableToPointInTimeResponse struct {
    *RestoreTableToPointInTimeOutput
    // contains filtered or unexported fields
}

RestoreTableToPointInTimeResponse is the response type for the RestoreTableToPointInTime API operation.

func (*RestoreTableToPointInTimeResponse) SDKResponseMetdata Uses

func (r *RestoreTableToPointInTimeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreTableToPointInTime request.

type ReturnConsumedCapacity Uses

type ReturnConsumedCapacity string

Determines the level of detail about provisioned throughput consumption that is returned in the response:

* INDEXES - The response includes the aggregate ConsumedCapacity for the
operation, together with ConsumedCapacity for each table and secondary
index that was accessed. Note that some operations, such as GetItem and
BatchGetItem, do not access any indexes at all. In these cases, specifying
INDEXES will only return ConsumedCapacity information for table(s).

* TOTAL - The response includes only the aggregate ConsumedCapacity for
the operation.

* NONE - No ConsumedCapacity details are included in the response.
const (
    ReturnConsumedCapacityIndexes ReturnConsumedCapacity = "INDEXES"
    ReturnConsumedCapacityTotal   ReturnConsumedCapacity = "TOTAL"
    ReturnConsumedCapacityNone    ReturnConsumedCapacity = "NONE"
)

Enum values for ReturnConsumedCapacity

func (ReturnConsumedCapacity) MarshalValue Uses

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

func (ReturnConsumedCapacity) MarshalValueBuf Uses

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

type ReturnItemCollectionMetrics Uses

type ReturnItemCollectionMetrics string
const (
    ReturnItemCollectionMetricsSize ReturnItemCollectionMetrics = "SIZE"
    ReturnItemCollectionMetricsNone ReturnItemCollectionMetrics = "NONE"
)

Enum values for ReturnItemCollectionMetrics

func (ReturnItemCollectionMetrics) MarshalValue Uses

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

func (ReturnItemCollectionMetrics) MarshalValueBuf Uses

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

type ReturnValue Uses

type ReturnValue string
const (
    ReturnValueNone       ReturnValue = "NONE"
    ReturnValueAllOld     ReturnValue = "ALL_OLD"
    ReturnValueUpdatedOld ReturnValue = "UPDATED_OLD"
    ReturnValueAllNew     ReturnValue = "ALL_NEW"
    ReturnValueUpdatedNew ReturnValue = "UPDATED_NEW"
)

Enum values for ReturnValue

func (ReturnValue) MarshalValue Uses

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

func (ReturnValue) MarshalValueBuf Uses

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

type ReturnValuesOnConditionCheckFailure Uses

type ReturnValuesOnConditionCheckFailure string
const (
    ReturnValuesOnConditionCheckFailureAllOld ReturnValuesOnConditionCheckFailure = "ALL_OLD"
    ReturnValuesOnConditionCheckFailureNone   ReturnValuesOnConditionCheckFailure = "NONE"
)

Enum values for ReturnValuesOnConditionCheckFailure

func (ReturnValuesOnConditionCheckFailure) MarshalValue Uses

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

func (ReturnValuesOnConditionCheckFailure) MarshalValueBuf Uses

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

type SSEDescription Uses

type SSEDescription struct {

    // Indicates the time, in UNIX epoch date format, when DynamoDB detected that
    // the table's AWS KMS key was inaccessible. This attribute will automatically
    // be cleared when DynamoDB detects that the table's AWS KMS key is accessible
    // again. DynamoDB will initiate the table archival process when table's AWS
    // KMS key remains inaccessible for more than seven days from this date.
    InaccessibleEncryptionDateTime *time.Time `type:"timestamp"`

    // The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.
    KMSMasterKeyArn *string `type:"string"`

    // Server-side encryption type. The only supported value is:
    //
    //    * KMS - Server-side encryption that uses AWS Key Management Service. The
    //    key is stored in your account and is managed by AWS KMS (AWS KMS charges
    //    apply).
    SSEType SSEType `type:"string" enum:"true"`

    // Represents the current state of server-side encryption. The only supported
    // values are:
    //
    //    * ENABLED - Server-side encryption is enabled.
    //
    //    * UPDATING - Server-side encryption is being updated.
    Status SSEStatus `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

The description of the server-side encryption status on the specified table.

func (SSEDescription) String Uses

func (s SSEDescription) String() string

String returns the string representation

type SSESpecification Uses

type SSESpecification struct {

    // Indicates whether server-side encryption is done using an AWS managed CMK
    // or an AWS owned CMK. If enabled (true), server-side encryption type is set
    // to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled
    // (false) or not specified, server-side encryption is set to AWS owned CMK.
    Enabled *bool `type:"boolean"`

    // The AWS KMS customer master key (CMK) that should be used for the AWS KMS
    // encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN),
    // alias name, or alias ARN. Note that you should only provide this parameter
    // if the key is different from the default DynamoDB customer master key alias/aws/dynamodb.
    KMSMasterKeyId *string `type:"string"`

    // Server-side encryption type. The only supported value is:
    //
    //    * KMS - Server-side encryption that uses AWS Key Management Service. The
    //    key is stored in your account and is managed by AWS KMS (AWS KMS charges
    //    apply).
    SSEType SSEType `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

Represents the settings used to enable server-side encryption.

func (SSESpecification) String Uses

func (s SSESpecification) String() string

String returns the string representation

type SSEStatus Uses

type SSEStatus string
const (
    SSEStatusEnabling  SSEStatus = "ENABLING"
    SSEStatusEnabled   SSEStatus = "ENABLED"
    SSEStatusDisabling SSEStatus = "DISABLING"
    SSEStatusDisabled  SSEStatus = "DISABLED"
    SSEStatusUpdating  SSEStatus = "UPDATING"
)

Enum values for SSEStatus

func (SSEStatus) MarshalValue Uses

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

func (SSEStatus) MarshalValueBuf Uses

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

type SSEType Uses

type SSEType string
const (
    SSETypeAes256 SSEType = "AES256"
    SSETypeKms    SSEType = "KMS"
)

Enum values for SSEType

func (SSEType) MarshalValue Uses

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

func (SSEType) MarshalValueBuf Uses

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

type ScalarAttributeType Uses

type ScalarAttributeType string
const (
    ScalarAttributeTypeS ScalarAttributeType = "S"
    ScalarAttributeTypeN ScalarAttributeType = "N"
    ScalarAttributeTypeB ScalarAttributeType = "B"
)

Enum values for ScalarAttributeType

func (ScalarAttributeType) MarshalValue Uses

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

func (ScalarAttributeType) MarshalValueBuf Uses

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

type ScanInput Uses

type ScanInput struct {

    // This is a legacy parameter. Use ProjectionExpression instead. For more information,
    // see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
    // in the Amazon DynamoDB Developer Guide.
    AttributesToGet []string `min:"1" type:"list"`

    // This is a legacy parameter. Use FilterExpression instead. For more information,
    // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
    // in the Amazon DynamoDB Developer Guide.
    ConditionalOperator ConditionalOperator `type:"string" enum:"true"`

    // A Boolean value that determines the read consistency model during the scan:
    //
    //    * If ConsistentRead is false, then the data returned from Scan might not
    //    contain the results from other recently completed write operations (PutItem,
    //    UpdateItem, or DeleteItem).
    //
    //    * If ConsistentRead is true, then all of the write operations that completed
    //    before the Scan began are guaranteed to be contained in the Scan response.
    //
    // The default setting for ConsistentRead is false.
    //
    // The ConsistentRead parameter is not supported on global secondary indexes.
    // If you scan a global secondary index with ConsistentRead set to true, you
    // will receive a ValidationException.
    ConsistentRead *bool `type:"boolean"`

    // The primary key of the first item that this operation will evaluate. Use
    // the value that was returned for LastEvaluatedKey in the previous operation.
    //
    // The data type for ExclusiveStartKey must be String, Number or Binary. No
    // set data types are allowed.
    //
    // In a parallel scan, a Scan request that includes ExclusiveStartKey must specify
    // the same segment whose previous Scan returned the corresponding value of
    // LastEvaluatedKey.
    ExclusiveStartKey map[string]AttributeValue `type:"map"`

    // One or more substitution tokens for attribute names in an expression. The
    // following are some use cases for using ExpressionAttributeNames:
    //
    //    * To access an attribute whose name conflicts with a DynamoDB reserved
    //    word.
    //
    //    * To create a placeholder for repeating occurrences of an attribute name
    //    in an expression.
    //
    //    * To prevent special characters in an attribute name from being misinterpreted
    //    in an expression.
    //
    // Use the # character in an expression to dereference an attribute name. For
    // example, consider the following attribute name:
    //
    //    * Percentile
    //
    // The name of this attribute conflicts with a reserved word, so it cannot be
    // used directly in an expression. (For the complete list of reserved words,
    // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
    // in the Amazon DynamoDB Developer Guide). To work around this, you could specify
    // the following for ExpressionAttributeNames:
    //
    //    * {"#P":"Percentile"}
    //
    // You could then use this substitution in an expression, as in this example:
    //
    //    * #P = :val
    //
    // Tokens that begin with the : character are expression attribute values, which
    // are placeholders for the actual value at runtime.
    //
    // For more information on expression attribute names, see Specifying Item Attributes
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeNames map[string]string `type:"map"`

    // One or more values that can be substituted in an expression.
    //
    // Use the : (colon) character in an expression to dereference an attribute
    // value. For example, suppose that you wanted to check whether the value of
    // the ProductStatus attribute was one of the following:
    //
    // Available | Backordered | Discontinued
    //
    // You would first need to specify ExpressionAttributeValues as follows:
    //
    // { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
    // }
    //
    // You could then use these values in an expression, such as this:
    //
    // ProductStatus IN (:avail, :back, :disc)
    //
    // For more information on expression attribute values, see Condition Expressions
    // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
    // in the Amazon DynamoDB Developer Guide.
    ExpressionAttributeValues map[string]AttributeValue `type:"map"`

    // A string that contains conditions that DynamoDB applies after the Scan operation,
    // but before the data is returned to you. Items that do not satisfy the FilterExpression
    // criteria are not returned.
    //
    // A FilterExpression is applied after the items have already been read; the
    // process of filtering does not consume any additional read capacity units.
    //
    // For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults)
    // in the Amazon DynamoDB Developer Guide.
    FilterExpression *string `type:"string"`

    // The name of a secondary index to scan. This index can be any local secondary
    // index or global secondary index. Note that if you use the IndexName parameter,
    // you must also provide TableName.
    IndexName *string `min:"3" type:"string"`

    // The maximum number of items to evaluate (not necessarily the number of matching
    // items). If DynamoDB processes the number of items up to the limit while processing
    // the results, it stops the operation and returns the matching values up to
    // that point, and a key in LastEvaluatedKey to apply in a subsequent operation,
    // so that you can pick up where you left off. Also, if the processed dataset
    // size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation
    // and returns the matching values up to the limit, and a key in LastEvaluatedKey
    // to apply in a subsequent operation to continue the operation. For more information,
    // see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
    // in the Amazon DynamoDB Developer Guide.
    Limit *int64 `min:"1" type:"integer"`

    // A string that identifies one or more attributes to retrieve from the specified
    // table or index. These attributes can include scalars, sets, or elements of
    // a JSON document. The attributes in the expression must be separated by commas.
    //
    // If no attribute names are specified, then all attributes will be returned.
    // If any of the requested attributes are not found, they will not appear in
    // the result.
    //
    // For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
    // in the Amazon DynamoDB Developer Guide.
    ProjectionExpression *string `type:"string"`

    // Determines the level of detail about provisioned throughput consumption that
    // is returned in the response:
    //
    //    * INDEXES - The response includes the aggregate ConsumedCapacity for the
    //    operation, together with ConsumedCapacity for each table and secondary
    //    index that was accessed. Note that some operations, such as GetItem and
    //    BatchGetItem, do not access any indexes at all. In these cases, specifying
    //    INDEXES will only return ConsumedCapacity information for table(s).
    //
    //    * TOTAL - The response includes only the aggregate ConsumedCapacity for
    //    the operation.
    //
    //    * NONE - No ConsumedCapacity details are included in the response.
    ReturnConsumedCapacity ReturnConsumedCapacity `type:"string" enum:"true"`

    // This is a legacy parameter. Use FilterExpression instead. For more information,
    // see ScanFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html)
    // in the Amazon DynamoDB Developer Guide.
    ScanFilter map[string]Condition `type:"map"`

    // For a parallel Scan request, Segment identifies an individual segment to
    // be scanned by an application worker.
    //
    // Segment IDs are zero-based, so the first segment is always 0. For example,
    // if you want to use four application threads to scan a table or an index,
    // then the first thread specifies a Segment value of 0, the second thread specifies
    // 1, and so on.
    //
    // The value of LastEvaluatedKey returned from a parallel Scan request must
    // be used as ExclusiveStartKey with the same segment ID in a subsequent Scan
    // operation.
    //
    // The value for Segment must be greater than or equal to 0, and less than the
    // value provided for TotalSegments.
    //
    // If you provide Segment, you must also provide TotalSegments.
    Segment *int64 `type:"integer"`

    // The attributes to be returned in the result. You can retrieve all item attributes,
    // specific item attributes, the count of matching items, or in the case of
    // an index, some or all of the attributes projected into the index.
    //
    //    * ALL_ATTRIBUTES - Returns all of the item attributes from the specified
    //    table or index. If you query a local secondary index, then for each matching
    //    item in the index, DynamoDB fetches the entire item from the parent table.
    //    If the index is configured to project all item attributes, then all of
    //    the data can be obtained from the local secondary index, and no fetching
    //    is required.
    //
    //    * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves
    //    all attributes that have been projected into the index. If the index is
    //    configured to project all attributes, this return value is equivalent
    //    to specifying ALL_ATTRIBUTES.
    //
    //    * COUNT - Returns the number of matching items, rather than the matching
    //    items themselves.
    //
    //    * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet.
    //    This return value is equivalent to specifying AttributesToGet without
    //    specifying any value for Select. If you query or scan a local secondary
    //    index and request only attributes that are projected into that index,
    //    the operation reads only the index and not the table. If any of the requested
    //    attributes are not projected into the local secondary index, DynamoDB
    //    fetches each of these attributes from the parent table. This extra fetching
    //    incurs additional throughput cost and latency. If you query or scan a
    //    global secondary index, you can only request attributes that are projected
    //    into the index. Global secondary index queries cannot fetch attributes
    //    from the parent table.
    //
    // If neither Select nor AttributesToGet are specified, DynamoDB defaults to
    // ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
    // accessing an index. You cannot use both Select and AttributesToGet together
    // in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
    // (This usage is equivalent to specifying AttributesToGet without any value
    // for Select.)
    //
    // If you use the ProjectionExpression parameter, then the value for Select
    // can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an
    // error.
    Select Select `type:"string" enum:"true"`

    // The name of the table containing the requested items; or, if you provide
    // IndexName, the name of the table to which that index belongs.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`

    // For a parallel Scan request, TotalSegments represents the total number of
    // segments into which the Scan operation will be divided. The value of TotalSegments
    // corresponds to the number of application workers that will perform the parallel
    // scan. For example, if you want to use four application threads to scan a
    // table or an index, specify a TotalSegments value of 4.
    //
    // The value for TotalSegments must be greater than or equal to 1, and less
    // than or equal to 1000000. If you specify a TotalSegments value of 1, the
    // Scan operation will be sequential rather than parallel.
    //
    // If you specify TotalSegments, you must also specify Segment.
    TotalSegments *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

Represents the input of a Scan operation.

func (ScanInput) String Uses

func (s ScanInput) String() string

String returns the string representation

func (*ScanInput) Validate Uses

func (s *ScanInput) Validate() error

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

type ScanOutput Uses

type ScanOutput struct {

    // The capacity units consumed by the Scan operation. The data returned includes
    // the total provisioned throughput consumed, along with statistics for the
    // table and any indexes involved in the operation. ConsumedCapacity is only
    // returned if the ReturnConsumedCapacity parameter was specified. For more
    // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
    // in the Amazon DynamoDB Developer Guide.
    ConsumedCapacity *ConsumedCapacity `type:"structure"`

    // The number of items in the response.
    //
    // If you set ScanFilter in the request, then Count is the number of items returned
    // after the filter was applied, and ScannedCount is the number of matching
    // items before the filter was applied.
    //
    // If you did not use a filter in the request, then Count is the same as ScannedCount.
    Count *int64 `type:"integer"`

    // An array of item attributes that match the scan criteria. Each element in
    // this array consists of an attribute name and the value for that attribute.
    Items []map[string]AttributeValue `type:"list"`

    // The primary key 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 LastEvaluatedKey is empty, then the "last page" of results has been processed
    // and there is no more data to be retrieved.
    //
    // If LastEvaluatedKey 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 LastEvaluatedKey is empty.
    LastEvaluatedKey map[string]AttributeValue `type:"map"`

    // The number of items evaluated, before any ScanFilter is applied. A high ScannedCount
    // value with few, or no, Count results indicates an inefficient Scan operation.
    // For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count)
    // in the Amazon DynamoDB Developer Guide.
    //
    // If you did not use a filter in the request, then ScannedCount is the same
    // as Count.
    ScannedCount *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Represents the output of a Scan operation.

func (ScanOutput) String Uses

func (s ScanOutput) String() string

String returns the string representation

type ScanPaginator Uses

type ScanPaginator struct {
    aws.Pager
}

ScanPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewScanPaginator Uses

func NewScanPaginator(req ScanRequest) ScanPaginator

NewScanRequestPaginator returns a paginator for Scan. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ScanRequest(input)
p := dynamodb.NewScanRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ScanPaginator) CurrentPage Uses

func (p *ScanPaginator) CurrentPage() *ScanOutput

type ScanRequest Uses

type ScanRequest struct {
    *aws.Request
    Input *ScanInput
    Copy  func(*ScanInput) ScanRequest
}

ScanRequest is the request type for the Scan API operation.

func (ScanRequest) Send Uses

func (r ScanRequest) Send(ctx context.Context) (*ScanResponse, error)

Send marshals and sends the Scan API request.

type ScanResponse Uses

type ScanResponse struct {
    *ScanOutput
    // contains filtered or unexported fields
}

ScanResponse is the response type for the Scan API operation.

func (*ScanResponse) SDKResponseMetdata Uses

func (r *ScanResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the Scan request.

type Select Uses

type Select string
const (
    SelectAllAttributes          Select = "ALL_ATTRIBUTES"
    SelectAllProjectedAttributes Select = "ALL_PROJECTED_ATTRIBUTES"
    SelectSpecificAttributes     Select = "SPECIFIC_ATTRIBUTES"
    SelectCount                  Select = "COUNT"
)

Enum values for Select

func (Select) MarshalValue Uses

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

func (Select) MarshalValueBuf Uses

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

type SourceTableDetails Uses

type SourceTableDetails struct {

    // Controls how you are charged for read and write throughput and how you manage
    // capacity. This setting can be changed later.
    //
    //    * PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend
    //    using PROVISIONED for predictable workloads.
    //
    //    * PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST.
    //    We recommend using PAY_PER_REQUEST for unpredictable workloads.
    BillingMode BillingMode `type:"string" enum:"true"`

    // Number of items in the table. Note that this is an approximate value.
    ItemCount *int64 `type:"long"`

    // Schema of the table.
    //
    // KeySchema is a required field
    KeySchema []KeySchemaElement `min:"1" type:"list" required:"true"`

    // Read IOPs and Write IOPS on the table when the backup was created.
    //
    // ProvisionedThroughput is a required field
    ProvisionedThroughput *ProvisionedThroughput `type:"structure" required:"true"`

    // ARN of the table for which backup was created.
    TableArn *string `type:"string"`

    // Time when the source table was created.
    //
    // TableCreationDateTime is a required field
    TableCreationDateTime *time.Time `type:"timestamp" required:"true"`

    // Unique identifier for the table for which the backup was created.
    //
    // TableId is a required field
    TableId *string `type:"string" required:"true"`

    // The name of the table for which the backup was created.
    //
    // TableName is a required field
    TableName *string `min:"3" type:"string" required:"true"`

    // Size of the table in bytes. Note that this is an approximate value.
    TableSizeBytes *int64 `type:"long"`
    // contains filtered or unexported fields
}

Contains the details of the table when the backup was created.

func (SourceTableDetails) String Uses

func (s SourceTableDetails) String() string

String returns the string representation

type SourceTableFeatureDetails Uses

type SourceTableFeatureDetails struct {

    // Represents the GSI properties for the table when the backup was created.
    // It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput
    // for the GSIs on the table at the time of backup.
    GlobalSecondaryIndexes []GlobalSecondaryIndexInfo `type:"list"`

    // Represents the LSI properties for the table when the backup was created.
    // It includes the IndexName, KeySchema and Projection for the LSIs on the table
    // at the time of backup.
    LocalSecondaryIndexes []LocalSecondaryIndexInfo `type:"list"`

    // The description of the server-side encryption status on the table when the
    // backup was created.
    SSEDescription *SSEDescription `type:"structure"`

    // Stream settings on the table when the backup was created.
    StreamDescription *StreamSpecification `type:"structure"`

    // Time to Live settings on the table when the backup was c