Table of Contents

Namespace DynaSharp.Requests

Classes

AttributeDefinition

The type of a key attribute.

BatchGetItemRequest

Reads items from one or more tables by primary key in a single call (DynamoDB BatchGetItem).

BatchGetItemResponse

The result of BatchGetItemRequest: the items that were read and the keys that were not.

BatchWriteItemRequest

Puts or deletes items in one or more tables in a single call (DynamoDB BatchWriteItem).

BatchWriteItemResponse

The result of BatchWriteItemRequest: which writes were not processed, and the optional metrics.

BillingModeSummary

How a table is billed and when it last switched to on-demand capacity.

CreateTableRequest

Creates a table (DynamoDB CreateTable).

CreateTableResponse

The result of CreateTableRequest.

DeleteGlobalSecondaryIndexAction

Deletes a global secondary index, as part of a GlobalSecondaryIndexUpdate.

DeleteItemRequest

Deletes a single item by its full primary key (DynamoDB DeleteItem).

DeleteItemResponse

The result of DeleteItemRequest.

DeleteRequest

Deletes an item as part of a WriteRequest, with the effect of DeleteItem without a condition.

DeleteTableRequest

Deletes a table and all its items (DynamoDB DeleteTable).

DeleteTableResponse

The result of DeleteTableRequest.

DescribeTableRequest

Reads the definition and state of a table (DynamoDB DescribeTable).

DescribeTableResponse

The result of DescribeTableRequest.

DescribeTimeToLiveRequest

Reads the Time to Live setting of a table (DynamoDB DescribeTimeToLive).

DescribeTimeToLiveResponse

The result of DescribeTimeToLiveRequest.

DynamoDbRequests

The request API of DynamoDB: one method per DynamoDB operation, as an extension method on DynamoDbClient. Each takes the request record of the operation and returns its response record, so requests and responses mirror the service and items are dictionaries of AttributeValue. The methods are in scope with using DynaSharp.Requests;.

GetItemRequest

Reads a single item by its full primary key (DynamoDB GetItem).

GetItemResponse

The result of GetItemRequest.

GlobalSecondaryIndex

A global secondary index of a table that is created: its own partition key and optional sort key, possibly other attributes than those of the table.

GlobalSecondaryIndexDescription

A global secondary index as DynamoDB reports it. Only the commonly needed subset of what DynamoDB returns.

GlobalSecondaryIndexUpdate

One change to the global secondary indexes of a table, in an UpdateTableRequest: an index to create, to update or to delete.

IndexProjection

The attributes a secondary index copies from the table.

ItemResponse

The result of one TransactGetItem.

KeySchemaElement

One attribute of a primary key.

KeysAndAttributes

The items to read from one table in a BatchGetItemRequest, and how to read them. DynamoDB returns the same structure as UnprocessedKeys, so a value from there can be sent back unchanged.

ListTablesRequest

Lists the names of the tables of the account in the region (DynamoDB ListTables).

ListTablesResponse

One page of the result of ListTablesRequest.

LocalSecondaryIndex

A local secondary index of a table that is created: the same partition key as the table, a different sort key.

LocalSecondaryIndexDescription

A local secondary index as DynamoDB reports it. Only the commonly needed subset of what DynamoDB returns.

OnDemandThroughput

The maximum throughput of a table or a global secondary index with PayPerRequest capacity: requests above it are throttled.

ProvisionedThroughput

The read and write capacity of a table or global secondary index with Provisioned capacity.

ProvisionedThroughputDescription

The read and write capacity of a table or global secondary index as DynamoDB reports it. Only the commonly needed subset of what DynamoDB returns.

PutItemRequest

Creates an item or replaces an existing item with the same primary key entirely (DynamoDB PutItem).

PutItemResponse

The result of PutItemRequest.

PutRequest

Writes an item as part of a WriteRequest, with the effect of PutItem without a condition.

QueryRequest

Reads the items of one partition, optionally narrowed by a sort key condition, from a table or an index (DynamoDB Query).

QueryResponse

One page of the result of QueryRequest.

SSEDescription

The server-side encryption of a table with an AWS KMS key, as DynamoDB reports it.

SSESpecification

The server-side encryption of a table, in CreateTableRequest and UpdateTableRequest.

ScanRequest

Reads every item of a table or index, optionally filtered (DynamoDB Scan).

ScanResponse

One page of the result of ScanRequest.

StreamSpecification

Whether a table has a stream and what its records contain.

TableDescription

The definition and state of a table. Only the commonly needed subset of what DynamoDB returns.

TableTag

A key-value label attached to a table, for billing reports and access control.

TimeToLiveDescription

The Time to Live state of a table as DynamoDB reports it.

TimeToLiveSpecification

The Time to Live setting of a table: whether DynamoDB deletes expired items, and which attribute holds the expiry time.

TransactConditionCheck

Requires a condition on an item that the transaction does not modify, as part of a TransactWriteItemsRequest. Named ConditionCheck in the DynamoDB service model.

TransactDelete

Deletes an item as part of a TransactWriteItemsRequest, with the effect of DeleteItem. Named Delete in the DynamoDB service model.

TransactGet

Reads one item as part of a TransactGetItemsRequest. Named Get in the DynamoDB service model.

TransactGetItem

One action of a TransactGetItemsRequest.

TransactGetItemsRequest

Reads up to 100 items from one or more tables as one consistent snapshot (DynamoDB TransactGetItems).

TransactGetItemsResponse

The result of TransactGetItemsRequest.

TransactPut

Creates an item or replaces an existing item as part of a TransactWriteItemsRequest, with the effect of PutItem. Named Put in the DynamoDB service model.

TransactUpdate

Changes the attributes of an existing item, or creates the item if no item has the key, as part of a TransactWriteItemsRequest, with the effect of UpdateItem. Named Update in the DynamoDB service model.

TransactWriteItem

One action of a TransactWriteItemsRequest: a put, a delete, an update or a condition check.

TransactWriteItemsRequest

Applies up to 100 puts, updates, deletes and condition checks to one or more tables, all or nothing (DynamoDB TransactWriteItems).

TransactWriteItemsResponse

The result of TransactWriteItemsRequest. DynamoDB confirms a transaction without further data; the members are the optional metrics.

UpdateGlobalSecondaryIndexAction

Changes the capacity or the on-demand maximums of a global secondary index, as part of a GlobalSecondaryIndexUpdate.

UpdateItemRequest

Changes the attributes of an existing item, or creates the item if no item has the key (DynamoDB UpdateItem).

UpdateItemResponse

The result of UpdateItemRequest.

UpdateTableRequest

Changes the settings of a table: its billing mode, capacity and on-demand maximums, its stream, its global secondary indexes, its server-side encryption, its storage class and its deletion protection (DynamoDB UpdateTable).

UpdateTableResponse

The result of UpdateTableRequest.

UpdateTimeToLiveRequest

Turns Time to Live on a table on or off (DynamoDB UpdateTimeToLive).

UpdateTimeToLiveResponse

The result of UpdateTimeToLiveRequest.

WriteRequest

One write of a BatchWriteItemRequest: either a put or a delete. DynamoDB returns the writes it did not process in the same form as UnprocessedItems.

Enums

BillingMode

How a table is charged for reads and writes.

IndexStatus

The lifecycle state of a global secondary index. Local secondary indexes have none: they exist from the creation of the table.

KeyType

The role of an attribute in a primary key.

ProjectionType

Which attributes of the table a secondary index copies, besides the key attributes of the table and of the index.

SSEStatus

The state of the server-side encryption of a table with an AWS KMS key.

SSEType

The type of server-side encryption of a table.

ScalarAttributeType

The type of a key attribute. Keys can only be strings, numbers or binary, which DynamoDB and the AWS SDKs call S, N and B.

StreamViewType

What a stream record contains about the item that changed.

TableClass

The storage class of a table, which trades storage cost against the cost of reads and writes.

TimeToLiveStatus

The state of Time to Live on a table.