Crate rusoto_dynamodb [] [src]

Amazon DynamoDB

If you're using the service, you're probably looking for DynamoDbClient and DynamoDb.

Structs

AttributeDefinition

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

AttributeValue

Represents the data for an attribute. You can set one, and only one, of the elements.

Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

AttributeValueUpdate

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.

BatchGetItemInput

Represents the input of a BatchGetItem operation.

BatchGetItemOutput

Represents the output of a BatchGetItem operation.

BatchWriteItemInput

Represents the input of a BatchWriteItem operation.

BatchWriteItemOutput

Represents the output of a BatchWriteItem operation.

Capacity

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

Condition

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.

ConsumedCapacity

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 in the Amazon DynamoDB Developer Guide.

CreateGlobalSecondaryIndexAction

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

CreateTableInput

Represents the input of a CreateTable operation.

CreateTableOutput

Represents the output of a CreateTable operation.

DeleteGlobalSecondaryIndexAction

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

DeleteItemInput

Represents the input of a DeleteItem operation.

DeleteItemOutput

Represents the output of a DeleteItem operation.

DeleteRequest

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

DeleteTableInput

Represents the input of a DeleteTable operation.

DeleteTableOutput

Represents the output of a DeleteTable operation.

DescribeLimitsInput

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

DescribeLimitsOutput

Represents the output of a DescribeLimits operation.

DescribeTableInput

Represents the input of a DescribeTable operation.

DescribeTableOutput

Represents the output of a DescribeTable operation.

DynamoDbClient

A client for the DynamoDB API.

ExpectedAttributeValue

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.

GetItemInput

Represents the input of a GetItem operation.

GetItemOutput

Represents the output of a GetItem operation.

GlobalSecondaryIndex

Represents the properties of a global secondary index.

GlobalSecondaryIndexDescription

Represents the properties of a global secondary index.

GlobalSecondaryIndexUpdate

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.

ItemCollectionMetrics

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.

KeySchemaElement

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.

KeysAndAttributes

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.

ListTablesInput

Represents the input of a ListTables operation.

ListTablesOutput

Represents the output of a ListTables operation.

LocalSecondaryIndex

Represents the properties of a local secondary index.

LocalSecondaryIndexDescription

Represents the properties of a local secondary index.

Projection

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.

ProvisionedThroughput

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 in the Amazon DynamoDB Developer Guide.

ProvisionedThroughputDescription

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

PutItemInput

Represents the input of a PutItem operation.

PutItemOutput

Represents the output of a PutItem operation.

PutRequest

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

QueryInput

Represents the input of a Query operation.

QueryOutput

Represents the output of a Query operation.

ScanInput

Represents the input of a Scan operation.

ScanOutput

Represents the output of a Scan operation.

StreamSpecification

Represents the DynamoDB Streams configuration for a table in DynamoDB.

TableDescription

Represents the properties of a table.

UpdateGlobalSecondaryIndexAction

Represents the new provisioned throughput settings to be applied to a global secondary index.

UpdateItemInput

Represents the input of an UpdateItem operation.

UpdateItemOutput

Represents the output of an UpdateItem operation.

UpdateTableInput

Represents the input of an UpdateTable operation.

UpdateTableOutput

Represents the output of an UpdateTable operation.

WriteRequest

Represents an operation to perform - either DeleteItem or PutItem. You can only request one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to provide two separate WriteRequest objects.

Enums

BatchGetItemError

Errors returned by BatchGetItem

BatchWriteItemError

Errors returned by BatchWriteItem

CreateTableError

Errors returned by CreateTable

DeleteItemError

Errors returned by DeleteItem

DeleteTableError

Errors returned by DeleteTable

DescribeLimitsError

Errors returned by DescribeLimits

DescribeTableError

Errors returned by DescribeTable

GetItemError

Errors returned by GetItem

ListTablesError

Errors returned by ListTables

PutItemError

Errors returned by PutItem

QueryError

Errors returned by Query

ScanError

Errors returned by Scan

UpdateItemError

Errors returned by UpdateItem

UpdateTableError

Errors returned by UpdateTable

Traits

DynamoDb

Trait representing the capabilities of the DynamoDB API. DynamoDB clients implement this trait.

Type Definitions

AttributeAction
AttributeDefinitions
AttributeMap
AttributeName
AttributeNameList
AttributeUpdates
AttributeValueList
Backfilling
BatchGetRequestMap
BatchGetResponseMap
BatchWriteItemRequestMap
BinaryAttributeValue
BinarySetAttributeValue
BooleanAttributeValue
BooleanObject
ComparisonOperator
ConditionExpression
ConditionalOperator
ConsistentRead
ConsumedCapacityMultiple
ConsumedCapacityUnits
Date
ErrorMessage
ExpectedAttributeMap
ExpressionAttributeNameMap
ExpressionAttributeNameVariable
ExpressionAttributeValueMap
ExpressionAttributeValueVariable
FilterConditionMap
GlobalSecondaryIndexDescriptionList
GlobalSecondaryIndexList
GlobalSecondaryIndexUpdateList
IndexName
IndexStatus
Integer
ItemCollectionKeyAttributeMap
ItemCollectionMetricsMultiple
ItemCollectionMetricsPerTable
ItemCollectionSizeEstimateBound
ItemCollectionSizeEstimateRange
ItemList
Key
KeyConditions
KeyExpression
KeyList
KeySchema
KeySchemaAttributeName
KeyType
ListAttributeValue
ListTablesInputLimit
LocalSecondaryIndexDescriptionList
LocalSecondaryIndexList
Long
MapAttributeValue
NonKeyAttributeName
NonKeyAttributeNameList
NullAttributeValue
NumberAttributeValue
NumberSetAttributeValue
PositiveIntegerObject
PositiveLongObject
ProjectionExpression
ProjectionType
PutItemInputAttributeMap
ReturnConsumedCapacity

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.

ReturnItemCollectionMetrics
ReturnValue
ScalarAttributeType
ScanSegment
ScanTotalSegments
SecondaryIndexesCapacityMap
Select
StreamArn
StreamEnabled
StreamViewType
StringAttributeValue
StringSetAttributeValue
TableName
TableNameList
TableStatus
UpdateExpression
WriteRequests