# Data Types
<a name="API_Types"></a>

The following data types are supported by Amazon DynamoDB:
+  [ArchivalSummary](API_ArchivalSummary.md) 
+  [AttributeDefinition](API_AttributeDefinition.md) 
+  [AttributeValue](API_AttributeValue.md) 
+  [AttributeValueUpdate](API_AttributeValueUpdate.md) 
+  [AutoScalingPolicyDescription](API_AutoScalingPolicyDescription.md) 
+  [AutoScalingPolicyUpdate](API_AutoScalingPolicyUpdate.md) 
+  [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) 
+  [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) 
+  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription](API_AutoScalingTargetTrackingScalingPolicyConfigurationDescription.md) 
+  [AutoScalingTargetTrackingScalingPolicyConfigurationUpdate](API_AutoScalingTargetTrackingScalingPolicyConfigurationUpdate.md) 
+  [BackupDescription](API_BackupDescription.md) 
+  [BackupDetails](API_BackupDetails.md) 
+  [BackupSummary](API_BackupSummary.md) 
+  [BatchStatementError](API_BatchStatementError.md) 
+  [BatchStatementRequest](API_BatchStatementRequest.md) 
+  [BatchStatementResponse](API_BatchStatementResponse.md) 
+  [BillingModeSummary](API_BillingModeSummary.md) 
+  [CancellationReason](API_CancellationReason.md) 
+  [Capacity](API_Capacity.md) 
+  [Condition](API_Condition.md) 
+  [ConditionCheck](API_ConditionCheck.md) 
+  [ConsumedCapacity](API_ConsumedCapacity.md) 
+  [ContinuousBackupsDescription](API_ContinuousBackupsDescription.md) 
+  [ContributorInsightsSummary](API_ContributorInsightsSummary.md) 
+  [CreateGlobalSecondaryIndexAction](API_CreateGlobalSecondaryIndexAction.md) 
+  [CreateGlobalTableWitnessGroupMemberAction](API_CreateGlobalTableWitnessGroupMemberAction.md) 
+  [CreateReplicaAction](API_CreateReplicaAction.md) 
+  [CreateReplicationGroupMemberAction](API_CreateReplicationGroupMemberAction.md) 
+  [CsvOptions](API_CsvOptions.md) 
+  [Delete](API_Delete.md) 
+  [DeleteGlobalSecondaryIndexAction](API_DeleteGlobalSecondaryIndexAction.md) 
+  [DeleteGlobalTableWitnessGroupMemberAction](API_DeleteGlobalTableWitnessGroupMemberAction.md) 
+  [DeleteReplicaAction](API_DeleteReplicaAction.md) 
+  [DeleteReplicationGroupMemberAction](API_DeleteReplicationGroupMemberAction.md) 
+  [DeleteRequest](API_DeleteRequest.md) 
+  [EnableKinesisStreamingConfiguration](API_EnableKinesisStreamingConfiguration.md) 
+  [Endpoint](API_Endpoint.md) 
+  [ExpectedAttributeValue](API_ExpectedAttributeValue.md) 
+  [ExportDescription](API_ExportDescription.md) 
+  [ExportSummary](API_ExportSummary.md) 
+  [FailureException](API_FailureException.md) 
+  [Get](API_Get.md) 
+  [GlobalSecondaryIndex](API_GlobalSecondaryIndex.md) 
+  [GlobalSecondaryIndexAutoScalingUpdate](API_GlobalSecondaryIndexAutoScalingUpdate.md) 
+  [GlobalSecondaryIndexDescription](API_GlobalSecondaryIndexDescription.md) 
+  [GlobalSecondaryIndexInfo](API_GlobalSecondaryIndexInfo.md) 
+  [GlobalSecondaryIndexUpdate](API_GlobalSecondaryIndexUpdate.md) 
+  [GlobalSecondaryIndexWarmThroughputDescription](API_GlobalSecondaryIndexWarmThroughputDescription.md) 
+  [GlobalTable](API_GlobalTable.md) 
+  [GlobalTableDescription](API_GlobalTableDescription.md) 
+  [GlobalTableGlobalSecondaryIndexSettingsUpdate](API_GlobalTableGlobalSecondaryIndexSettingsUpdate.md) 
+  [GlobalTableWitnessDescription](API_GlobalTableWitnessDescription.md) 
+  [GlobalTableWitnessGroupUpdate](API_GlobalTableWitnessGroupUpdate.md) 
+  [ImportSummary](API_ImportSummary.md) 
+  [ImportTableDescription](API_ImportTableDescription.md) 
+  [IncrementalExportSpecification](API_IncrementalExportSpecification.md) 
+  [InputFormatOptions](API_InputFormatOptions.md) 
+  [ItemCollectionMetrics](API_ItemCollectionMetrics.md) 
+  [ItemResponse](API_ItemResponse.md) 
+  [KeysAndAttributes](API_KeysAndAttributes.md) 
+  [KeySchemaElement](API_KeySchemaElement.md) 
+  [KinesisDataStreamDestination](API_KinesisDataStreamDestination.md) 
+  [LocalSecondaryIndex](API_LocalSecondaryIndex.md) 
+  [LocalSecondaryIndexDescription](API_LocalSecondaryIndexDescription.md) 
+  [LocalSecondaryIndexInfo](API_LocalSecondaryIndexInfo.md) 
+  [OnDemandThroughput](API_OnDemandThroughput.md) 
+  [OnDemandThroughputOverride](API_OnDemandThroughputOverride.md) 
+  [ParameterizedStatement](API_ParameterizedStatement.md) 
+  [PointInTimeRecoveryDescription](API_PointInTimeRecoveryDescription.md) 
+  [PointInTimeRecoverySpecification](API_PointInTimeRecoverySpecification.md) 
+  [Projection](API_Projection.md) 
+  [ProvisionedThroughput](API_ProvisionedThroughput.md) 
+  [ProvisionedThroughputDescription](API_ProvisionedThroughputDescription.md) 
+  [ProvisionedThroughputOverride](API_ProvisionedThroughputOverride.md) 
+  [Put](API_Put.md) 
+  [PutRequest](API_PutRequest.md) 
+  [Replica](API_Replica.md) 
+  [ReplicaAutoScalingDescription](API_ReplicaAutoScalingDescription.md) 
+  [ReplicaAutoScalingUpdate](API_ReplicaAutoScalingUpdate.md) 
+  [ReplicaDescription](API_ReplicaDescription.md) 
+  [ReplicaGlobalSecondaryIndex](API_ReplicaGlobalSecondaryIndex.md) 
+  [ReplicaGlobalSecondaryIndexAutoScalingDescription](API_ReplicaGlobalSecondaryIndexAutoScalingDescription.md) 
+  [ReplicaGlobalSecondaryIndexAutoScalingUpdate](API_ReplicaGlobalSecondaryIndexAutoScalingUpdate.md) 
+  [ReplicaGlobalSecondaryIndexDescription](API_ReplicaGlobalSecondaryIndexDescription.md) 
+  [ReplicaGlobalSecondaryIndexSettingsDescription](API_ReplicaGlobalSecondaryIndexSettingsDescription.md) 
+  [ReplicaGlobalSecondaryIndexSettingsUpdate](API_ReplicaGlobalSecondaryIndexSettingsUpdate.md) 
+  [ReplicaSettingsDescription](API_ReplicaSettingsDescription.md) 
+  [ReplicaSettingsUpdate](API_ReplicaSettingsUpdate.md) 
+  [ReplicationGroupUpdate](API_ReplicationGroupUpdate.md) 
+  [ReplicaUpdate](API_ReplicaUpdate.md) 
+  [RestoreSummary](API_RestoreSummary.md) 
+  [S3BucketSource](API_S3BucketSource.md) 
+  [SourceTableDetails](API_SourceTableDetails.md) 
+  [SourceTableFeatureDetails](API_SourceTableFeatureDetails.md) 
+  [SSEDescription](API_SSEDescription.md) 
+  [SSESpecification](API_SSESpecification.md) 
+  [StreamSpecification](API_StreamSpecification.md) 
+  [TableAutoScalingDescription](API_TableAutoScalingDescription.md) 
+  [TableClassSummary](API_TableClassSummary.md) 
+  [TableCreationParameters](API_TableCreationParameters.md) 
+  [TableDescription](API_TableDescription.md) 
+  [TableWarmThroughputDescription](API_TableWarmThroughputDescription.md) 
+  [Tag](API_Tag.md) 
+  [ThrottlingReason](API_ThrottlingReason.md) 
+  [TimeToLiveDescription](API_TimeToLiveDescription.md) 
+  [TimeToLiveSpecification](API_TimeToLiveSpecification.md) 
+  [TransactGetItem](API_TransactGetItem.md) 
+  [TransactWriteItem](API_TransactWriteItem.md) 
+  [Update](API_Update.md) 
+  [UpdateGlobalSecondaryIndexAction](API_UpdateGlobalSecondaryIndexAction.md) 
+  [UpdateKinesisStreamingConfiguration](API_UpdateKinesisStreamingConfiguration.md) 
+  [UpdateReplicationGroupMemberAction](API_UpdateReplicationGroupMemberAction.md) 
+  [WarmThroughput](API_WarmThroughput.md) 
+  [WriteRequest](API_WriteRequest.md) 

The following data types are supported by DynamoDB Accelerator:
+  [Cluster](API_dax_Cluster.md) 
+  [Endpoint](API_dax_Endpoint.md) 
+  [Event](API_dax_Event.md) 
+  [Node](API_dax_Node.md) 
+  [NodeTypeSpecificValue](API_dax_NodeTypeSpecificValue.md) 
+  [NotificationConfiguration](API_dax_NotificationConfiguration.md) 
+  [Parameter](API_dax_Parameter.md) 
+  [ParameterGroup](API_dax_ParameterGroup.md) 
+  [ParameterGroupStatus](API_dax_ParameterGroupStatus.md) 
+  [ParameterNameValue](API_dax_ParameterNameValue.md) 
+  [SecurityGroupMembership](API_dax_SecurityGroupMembership.md) 
+  [SSEDescription](API_dax_SSEDescription.md) 
+  [SSESpecification](API_dax_SSESpecification.md) 
+  [Subnet](API_dax_Subnet.md) 
+  [SubnetGroup](API_dax_SubnetGroup.md) 
+  [Tag](API_dax_Tag.md) 

The following data types are supported by Amazon DynamoDB Streams:
+  [AttributeValue](API_streams_AttributeValue.md) 
+  [Identity](API_streams_Identity.md) 
+  [KeySchemaElement](API_streams_KeySchemaElement.md) 
+  [Record](API_streams_Record.md) 
+  [SequenceNumberRange](API_streams_SequenceNumberRange.md) 
+  [Shard](API_streams_Shard.md) 
+  [ShardFilter](API_streams_ShardFilter.md) 
+  [Stream](API_streams_Stream.md) 
+  [StreamDescription](API_streams_StreamDescription.md) 
+  [StreamRecord](API_streams_StreamRecord.md) 

# Amazon DynamoDB
<a name="API_Types_Amazon_DynamoDB"></a>

The following data types are supported by Amazon DynamoDB:
+  [ArchivalSummary](API_ArchivalSummary.md) 
+  [AttributeDefinition](API_AttributeDefinition.md) 
+  [AttributeValue](API_AttributeValue.md) 
+  [AttributeValueUpdate](API_AttributeValueUpdate.md) 
+  [AutoScalingPolicyDescription](API_AutoScalingPolicyDescription.md) 
+  [AutoScalingPolicyUpdate](API_AutoScalingPolicyUpdate.md) 
+  [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) 
+  [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) 
+  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription](API_AutoScalingTargetTrackingScalingPolicyConfigurationDescription.md) 
+  [AutoScalingTargetTrackingScalingPolicyConfigurationUpdate](API_AutoScalingTargetTrackingScalingPolicyConfigurationUpdate.md) 
+  [BackupDescription](API_BackupDescription.md) 
+  [BackupDetails](API_BackupDetails.md) 
+  [BackupSummary](API_BackupSummary.md) 
+  [BatchStatementError](API_BatchStatementError.md) 
+  [BatchStatementRequest](API_BatchStatementRequest.md) 
+  [BatchStatementResponse](API_BatchStatementResponse.md) 
+  [BillingModeSummary](API_BillingModeSummary.md) 
+  [CancellationReason](API_CancellationReason.md) 
+  [Capacity](API_Capacity.md) 
+  [Condition](API_Condition.md) 
+  [ConditionCheck](API_ConditionCheck.md) 
+  [ConsumedCapacity](API_ConsumedCapacity.md) 
+  [ContinuousBackupsDescription](API_ContinuousBackupsDescription.md) 
+  [ContributorInsightsSummary](API_ContributorInsightsSummary.md) 
+  [CreateGlobalSecondaryIndexAction](API_CreateGlobalSecondaryIndexAction.md) 
+  [CreateGlobalTableWitnessGroupMemberAction](API_CreateGlobalTableWitnessGroupMemberAction.md) 
+  [CreateReplicaAction](API_CreateReplicaAction.md) 
+  [CreateReplicationGroupMemberAction](API_CreateReplicationGroupMemberAction.md) 
+  [CsvOptions](API_CsvOptions.md) 
+  [Delete](API_Delete.md) 
+  [DeleteGlobalSecondaryIndexAction](API_DeleteGlobalSecondaryIndexAction.md) 
+  [DeleteGlobalTableWitnessGroupMemberAction](API_DeleteGlobalTableWitnessGroupMemberAction.md) 
+  [DeleteReplicaAction](API_DeleteReplicaAction.md) 
+  [DeleteReplicationGroupMemberAction](API_DeleteReplicationGroupMemberAction.md) 
+  [DeleteRequest](API_DeleteRequest.md) 
+  [EnableKinesisStreamingConfiguration](API_EnableKinesisStreamingConfiguration.md) 
+  [Endpoint](API_Endpoint.md) 
+  [ExpectedAttributeValue](API_ExpectedAttributeValue.md) 
+  [ExportDescription](API_ExportDescription.md) 
+  [ExportSummary](API_ExportSummary.md) 
+  [FailureException](API_FailureException.md) 
+  [Get](API_Get.md) 
+  [GlobalSecondaryIndex](API_GlobalSecondaryIndex.md) 
+  [GlobalSecondaryIndexAutoScalingUpdate](API_GlobalSecondaryIndexAutoScalingUpdate.md) 
+  [GlobalSecondaryIndexDescription](API_GlobalSecondaryIndexDescription.md) 
+  [GlobalSecondaryIndexInfo](API_GlobalSecondaryIndexInfo.md) 
+  [GlobalSecondaryIndexUpdate](API_GlobalSecondaryIndexUpdate.md) 
+  [GlobalSecondaryIndexWarmThroughputDescription](API_GlobalSecondaryIndexWarmThroughputDescription.md) 
+  [GlobalTable](API_GlobalTable.md) 
+  [GlobalTableDescription](API_GlobalTableDescription.md) 
+  [GlobalTableGlobalSecondaryIndexSettingsUpdate](API_GlobalTableGlobalSecondaryIndexSettingsUpdate.md) 
+  [GlobalTableWitnessDescription](API_GlobalTableWitnessDescription.md) 
+  [GlobalTableWitnessGroupUpdate](API_GlobalTableWitnessGroupUpdate.md) 
+  [ImportSummary](API_ImportSummary.md) 
+  [ImportTableDescription](API_ImportTableDescription.md) 
+  [IncrementalExportSpecification](API_IncrementalExportSpecification.md) 
+  [InputFormatOptions](API_InputFormatOptions.md) 
+  [ItemCollectionMetrics](API_ItemCollectionMetrics.md) 
+  [ItemResponse](API_ItemResponse.md) 
+  [KeysAndAttributes](API_KeysAndAttributes.md) 
+  [KeySchemaElement](API_KeySchemaElement.md) 
+  [KinesisDataStreamDestination](API_KinesisDataStreamDestination.md) 
+  [LocalSecondaryIndex](API_LocalSecondaryIndex.md) 
+  [LocalSecondaryIndexDescription](API_LocalSecondaryIndexDescription.md) 
+  [LocalSecondaryIndexInfo](API_LocalSecondaryIndexInfo.md) 
+  [OnDemandThroughput](API_OnDemandThroughput.md) 
+  [OnDemandThroughputOverride](API_OnDemandThroughputOverride.md) 
+  [ParameterizedStatement](API_ParameterizedStatement.md) 
+  [PointInTimeRecoveryDescription](API_PointInTimeRecoveryDescription.md) 
+  [PointInTimeRecoverySpecification](API_PointInTimeRecoverySpecification.md) 
+  [Projection](API_Projection.md) 
+  [ProvisionedThroughput](API_ProvisionedThroughput.md) 
+  [ProvisionedThroughputDescription](API_ProvisionedThroughputDescription.md) 
+  [ProvisionedThroughputOverride](API_ProvisionedThroughputOverride.md) 
+  [Put](API_Put.md) 
+  [PutRequest](API_PutRequest.md) 
+  [Replica](API_Replica.md) 
+  [ReplicaAutoScalingDescription](API_ReplicaAutoScalingDescription.md) 
+  [ReplicaAutoScalingUpdate](API_ReplicaAutoScalingUpdate.md) 
+  [ReplicaDescription](API_ReplicaDescription.md) 
+  [ReplicaGlobalSecondaryIndex](API_ReplicaGlobalSecondaryIndex.md) 
+  [ReplicaGlobalSecondaryIndexAutoScalingDescription](API_ReplicaGlobalSecondaryIndexAutoScalingDescription.md) 
+  [ReplicaGlobalSecondaryIndexAutoScalingUpdate](API_ReplicaGlobalSecondaryIndexAutoScalingUpdate.md) 
+  [ReplicaGlobalSecondaryIndexDescription](API_ReplicaGlobalSecondaryIndexDescription.md) 
+  [ReplicaGlobalSecondaryIndexSettingsDescription](API_ReplicaGlobalSecondaryIndexSettingsDescription.md) 
+  [ReplicaGlobalSecondaryIndexSettingsUpdate](API_ReplicaGlobalSecondaryIndexSettingsUpdate.md) 
+  [ReplicaSettingsDescription](API_ReplicaSettingsDescription.md) 
+  [ReplicaSettingsUpdate](API_ReplicaSettingsUpdate.md) 
+  [ReplicationGroupUpdate](API_ReplicationGroupUpdate.md) 
+  [ReplicaUpdate](API_ReplicaUpdate.md) 
+  [RestoreSummary](API_RestoreSummary.md) 
+  [S3BucketSource](API_S3BucketSource.md) 
+  [SourceTableDetails](API_SourceTableDetails.md) 
+  [SourceTableFeatureDetails](API_SourceTableFeatureDetails.md) 
+  [SSEDescription](API_SSEDescription.md) 
+  [SSESpecification](API_SSESpecification.md) 
+  [StreamSpecification](API_StreamSpecification.md) 
+  [TableAutoScalingDescription](API_TableAutoScalingDescription.md) 
+  [TableClassSummary](API_TableClassSummary.md) 
+  [TableCreationParameters](API_TableCreationParameters.md) 
+  [TableDescription](API_TableDescription.md) 
+  [TableWarmThroughputDescription](API_TableWarmThroughputDescription.md) 
+  [Tag](API_Tag.md) 
+  [ThrottlingReason](API_ThrottlingReason.md) 
+  [TimeToLiveDescription](API_TimeToLiveDescription.md) 
+  [TimeToLiveSpecification](API_TimeToLiveSpecification.md) 
+  [TransactGetItem](API_TransactGetItem.md) 
+  [TransactWriteItem](API_TransactWriteItem.md) 
+  [Update](API_Update.md) 
+  [UpdateGlobalSecondaryIndexAction](API_UpdateGlobalSecondaryIndexAction.md) 
+  [UpdateKinesisStreamingConfiguration](API_UpdateKinesisStreamingConfiguration.md) 
+  [UpdateReplicationGroupMemberAction](API_UpdateReplicationGroupMemberAction.md) 
+  [WarmThroughput](API_WarmThroughput.md) 
+  [WriteRequest](API_WriteRequest.md) 

# ArchivalSummary
<a name="API_ArchivalSummary"></a>

Contains details of a table archival operation.

## Contents
<a name="API_ArchivalSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ArchivalBackupArn **   <a name="DDB-Type-ArchivalSummary-ArchivalBackupArn"></a>
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.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** ArchivalDateTime **   <a name="DDB-Type-ArchivalSummary-ArchivalDateTime"></a>
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.  
Type: Timestamp  
Required: No

 ** ArchivalReason **   <a name="DDB-Type-ArchivalSummary-ArchivalReason"></a>
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.
Type: String  
Required: No

## See Also
<a name="API_ArchivalSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ArchivalSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ArchivalSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ArchivalSummary) 

# AttributeDefinition
<a name="API_AttributeDefinition"></a>

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

## Contents
<a name="API_AttributeDefinition_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AttributeName **   <a name="DDB-Type-AttributeDefinition-AttributeName"></a>
A name for the attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** AttributeType **   <a name="DDB-Type-AttributeDefinition-AttributeType"></a>
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
Type: String  
Valid Values: `S | N | B`   
Required: Yes

## See Also
<a name="API_AttributeDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AttributeDefinition) 

# AttributeValue
<a name="API_AttributeValue"></a>

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*.

## Contents
<a name="API_AttributeValue_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** B **   <a name="DDB-Type-AttributeValue-B"></a>
An attribute of type Binary. For example:  
 `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`   
Type: Base64-encoded binary data object  
Required: No

 ** BOOL **   <a name="DDB-Type-AttributeValue-BOOL"></a>
An attribute of type Boolean. For example:  
 `"BOOL": true`   
Type: Boolean  
Required: No

 ** BS **   <a name="DDB-Type-AttributeValue-BS"></a>
An attribute of type Binary Set. For example:  
 `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`   
Type: Array of Base64-encoded binary data objects  
Required: No

 ** L **   <a name="DDB-Type-AttributeValue-L"></a>
An attribute of type List. For example:  
 `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]`   
Type: Array of [AttributeValue](#API_AttributeValue) objects  
Required: No

 ** M **   <a name="DDB-Type-AttributeValue-M"></a>
An attribute of type Map. For example:  
 `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`   
Type: String to [AttributeValue](#API_AttributeValue) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** N **   <a name="DDB-Type-AttributeValue-N"></a>
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.  
Type: String  
Required: No

 ** NS **   <a name="DDB-Type-AttributeValue-NS"></a>
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.  
Type: Array of strings  
Required: No

 ** NULL **   <a name="DDB-Type-AttributeValue-NULL"></a>
An attribute of type Null. For example:  
 `"NULL": true`   
Type: Boolean  
Required: No

 ** S **   <a name="DDB-Type-AttributeValue-S"></a>
An attribute of type String. For example:  
 `"S": "Hello"`   
Type: String  
Required: No

 ** SS **   <a name="DDB-Type-AttributeValue-SS"></a>
An attribute of type String Set. For example:  
 `"SS": ["Giraffe", "Hippo" ,"Zebra"]`   
Type: Array of strings  
Required: No

## See Also
<a name="API_AttributeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AttributeValue) 

# AttributeValueUpdate
<a name="API_AttributeValueUpdate"></a>

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

**Note**  
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.

## Contents
<a name="API_AttributeValueUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Action **   <a name="DDB-Type-AttributeValueUpdate-Action"></a>
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.
**Note**  
 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 a new item with the supplied primary key and number (or set) for the attribute value. The only data types allowed are number, number set, string set or binary set.
Type: String  
Valid Values: `ADD | PUT | DELETE`   
Required: No

 ** Value **   <a name="DDB-Type-AttributeValueUpdate-Value"></a>
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*.   
Type: [AttributeValue](API_AttributeValue.md) object  
Required: No

## See Also
<a name="API_AttributeValueUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AttributeValueUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AttributeValueUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AttributeValueUpdate) 

# AutoScalingPolicyDescription
<a name="API_AutoScalingPolicyDescription"></a>

Represents the properties of the scaling policy.

## Contents
<a name="API_AutoScalingPolicyDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** PolicyName **   <a name="DDB-Type-AutoScalingPolicyDescription-PolicyName"></a>
The name of the scaling policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\p{Print}+`   
Required: No

 ** TargetTrackingScalingPolicyConfiguration **   <a name="DDB-Type-AutoScalingPolicyDescription-TargetTrackingScalingPolicyConfiguration"></a>
Represents a target tracking scaling policy configuration.  
Type: [AutoScalingTargetTrackingScalingPolicyConfigurationDescription](API_AutoScalingTargetTrackingScalingPolicyConfigurationDescription.md) object  
Required: No

## See Also
<a name="API_AutoScalingPolicyDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AutoScalingPolicyDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AutoScalingPolicyDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AutoScalingPolicyDescription) 

# AutoScalingPolicyUpdate
<a name="API_AutoScalingPolicyUpdate"></a>

Represents the auto scaling policy to be modified.

## Contents
<a name="API_AutoScalingPolicyUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** TargetTrackingScalingPolicyConfiguration **   <a name="DDB-Type-AutoScalingPolicyUpdate-TargetTrackingScalingPolicyConfiguration"></a>
Represents a target tracking scaling policy configuration.  
Type: [AutoScalingTargetTrackingScalingPolicyConfigurationUpdate](API_AutoScalingTargetTrackingScalingPolicyConfigurationUpdate.md) object  
Required: Yes

 ** PolicyName **   <a name="DDB-Type-AutoScalingPolicyUpdate-PolicyName"></a>
The name of the scaling policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\p{Print}+`   
Required: No

## See Also
<a name="API_AutoScalingPolicyUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AutoScalingPolicyUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AutoScalingPolicyUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AutoScalingPolicyUpdate) 

# AutoScalingSettingsDescription
<a name="API_AutoScalingSettingsDescription"></a>

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

## Contents
<a name="API_AutoScalingSettingsDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AutoScalingDisabled **   <a name="DDB-Type-AutoScalingSettingsDescription-AutoScalingDisabled"></a>
Disabled auto scaling for this global table or global secondary index.  
Type: Boolean  
Required: No

 ** AutoScalingRoleArn **   <a name="DDB-Type-AutoScalingSettingsDescription-AutoScalingRoleArn"></a>
Role ARN used for configuring the auto scaling policy.  
Type: String  
Required: No

 ** MaximumUnits **   <a name="DDB-Type-AutoScalingSettingsDescription-MaximumUnits"></a>
The maximum capacity units that a global table or global secondary index should be scaled up to.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** MinimumUnits **   <a name="DDB-Type-AutoScalingSettingsDescription-MinimumUnits"></a>
The minimum capacity units that a global table or global secondary index should be scaled down to.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** ScalingPolicies **   <a name="DDB-Type-AutoScalingSettingsDescription-ScalingPolicies"></a>
Information about the scaling policies.  
Type: Array of [AutoScalingPolicyDescription](API_AutoScalingPolicyDescription.md) objects  
Required: No

## See Also
<a name="API_AutoScalingSettingsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AutoScalingSettingsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AutoScalingSettingsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AutoScalingSettingsDescription) 

# AutoScalingSettingsUpdate
<a name="API_AutoScalingSettingsUpdate"></a>

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

## Contents
<a name="API_AutoScalingSettingsUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AutoScalingDisabled **   <a name="DDB-Type-AutoScalingSettingsUpdate-AutoScalingDisabled"></a>
Disabled auto scaling for this global table or global secondary index.  
Type: Boolean  
Required: No

 ** AutoScalingRoleArn **   <a name="DDB-Type-AutoScalingSettingsUpdate-AutoScalingRoleArn"></a>
Role ARN used for configuring auto scaling policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`   
Required: No

 ** MaximumUnits **   <a name="DDB-Type-AutoScalingSettingsUpdate-MaximumUnits"></a>
The maximum capacity units that a global table or global secondary index should be scaled up to.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** MinimumUnits **   <a name="DDB-Type-AutoScalingSettingsUpdate-MinimumUnits"></a>
The minimum capacity units that a global table or global secondary index should be scaled down to.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** ScalingPolicyUpdate **   <a name="DDB-Type-AutoScalingSettingsUpdate-ScalingPolicyUpdate"></a>
The scaling policy to apply for scaling target global table or global secondary index capacity units.  
Type: [AutoScalingPolicyUpdate](API_AutoScalingPolicyUpdate.md) object  
Required: No

## See Also
<a name="API_AutoScalingSettingsUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AutoScalingSettingsUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AutoScalingSettingsUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AutoScalingSettingsUpdate) 

# AutoScalingTargetTrackingScalingPolicyConfigurationDescription
<a name="API_AutoScalingTargetTrackingScalingPolicyConfigurationDescription"></a>

Represents the properties of a target tracking scaling policy.

## Contents
<a name="API_AutoScalingTargetTrackingScalingPolicyConfigurationDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** TargetValue **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationDescription-TargetValue"></a>
The target value for the metric. The range is 8.515920e-109 to 1.174271e\$1108 (Base 10) or 2e-360 to 2e360 (Base 2).  
Type: Double  
Required: Yes

 ** DisableScaleIn **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationDescription-DisableScaleIn"></a>
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.  
Type: Boolean  
Required: No

 ** ScaleInCooldown **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationDescription-ScaleInCooldown"></a>
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.   
Type: Integer  
Required: No

 ** ScaleOutCooldown **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationDescription-ScaleOutCooldown"></a>
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.  
Type: Integer  
Required: No

## See Also
<a name="API_AutoScalingTargetTrackingScalingPolicyConfigurationDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AutoScalingTargetTrackingScalingPolicyConfigurationDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AutoScalingTargetTrackingScalingPolicyConfigurationDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AutoScalingTargetTrackingScalingPolicyConfigurationDescription) 

# AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
<a name="API_AutoScalingTargetTrackingScalingPolicyConfigurationUpdate"></a>

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

## Contents
<a name="API_AutoScalingTargetTrackingScalingPolicyConfigurationUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** TargetValue **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationUpdate-TargetValue"></a>
The target value for the metric. The range is 8.515920e-109 to 1.174271e\$1108 (Base 10) or 2e-360 to 2e360 (Base 2).  
Type: Double  
Required: Yes

 ** DisableScaleIn **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationUpdate-DisableScaleIn"></a>
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.  
Type: Boolean  
Required: No

 ** ScaleInCooldown **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationUpdate-ScaleInCooldown"></a>
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.   
Type: Integer  
Required: No

 ** ScaleOutCooldown **   <a name="DDB-Type-AutoScalingTargetTrackingScalingPolicyConfigurationUpdate-ScaleOutCooldown"></a>
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.  
Type: Integer  
Required: No

## See Also
<a name="API_AutoScalingTargetTrackingScalingPolicyConfigurationUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) 

# BackupDescription
<a name="API_BackupDescription"></a>

Contains the description of the backup created for the table.

## Contents
<a name="API_BackupDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** BackupDetails **   <a name="DDB-Type-BackupDescription-BackupDetails"></a>
Contains the details of the backup created for the table.   
Type: [BackupDetails](API_BackupDetails.md) object  
Required: No

 ** SourceTableDetails **   <a name="DDB-Type-BackupDescription-SourceTableDetails"></a>
Contains the details of the table when the backup was created.   
Type: [SourceTableDetails](API_SourceTableDetails.md) object  
Required: No

 ** SourceTableFeatureDetails **   <a name="DDB-Type-BackupDescription-SourceTableFeatureDetails"></a>
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.  
Type: [SourceTableFeatureDetails](API_SourceTableFeatureDetails.md) object  
Required: No

## See Also
<a name="API_BackupDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BackupDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BackupDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BackupDescription) 

# BackupDetails
<a name="API_BackupDetails"></a>

Contains the details of the backup created for the table.

## Contents
<a name="API_BackupDetails_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** BackupArn **   <a name="DDB-Type-BackupDetails-BackupArn"></a>
ARN associated with the backup.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: Yes

 ** BackupCreationDateTime **   <a name="DDB-Type-BackupDetails-BackupCreationDateTime"></a>
Time at which the backup was created. This is the request time of the backup.   
Type: Timestamp  
Required: Yes

 ** BackupName **   <a name="DDB-Type-BackupDetails-BackupName"></a>
Name of the requested backup.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** BackupStatus **   <a name="DDB-Type-BackupDetails-BackupStatus"></a>
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.   
Type: String  
Valid Values: `CREATING | DELETED | AVAILABLE`   
Required: Yes

 ** BackupType **   <a name="DDB-Type-BackupDetails-BackupType"></a>
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.
Type: String  
Valid Values: `USER | SYSTEM | AWS_BACKUP`   
Required: Yes

 ** BackupExpiryDateTime **   <a name="DDB-Type-BackupDetails-BackupExpiryDateTime"></a>
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.  
Type: Timestamp  
Required: No

 ** BackupSizeBytes **   <a name="DDB-Type-BackupDetails-BackupSizeBytes"></a>
Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_BackupDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BackupDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BackupDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BackupDetails) 

# BackupSummary
<a name="API_BackupSummary"></a>

Contains details for the backup.

## Contents
<a name="API_BackupSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** BackupArn **   <a name="DDB-Type-BackupSummary-BackupArn"></a>
ARN associated with the backup.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** BackupCreationDateTime **   <a name="DDB-Type-BackupSummary-BackupCreationDateTime"></a>
Time at which the backup was created.  
Type: Timestamp  
Required: No

 ** BackupExpiryDateTime **   <a name="DDB-Type-BackupSummary-BackupExpiryDateTime"></a>
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.  
Type: Timestamp  
Required: No

 ** BackupName **   <a name="DDB-Type-BackupSummary-BackupName"></a>
Name of the specified backup.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** BackupSizeBytes **   <a name="DDB-Type-BackupSummary-BackupSizeBytes"></a>
Size of the backup in bytes.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** BackupStatus **   <a name="DDB-Type-BackupSummary-BackupStatus"></a>
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.  
Type: String  
Valid Values: `CREATING | DELETED | AVAILABLE`   
Required: No

 ** BackupType **   <a name="DDB-Type-BackupSummary-BackupType"></a>
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.
Type: String  
Valid Values: `USER | SYSTEM | AWS_BACKUP`   
Required: No

 ** TableArn **   <a name="DDB-Type-BackupSummary-TableArn"></a>
ARN associated with the table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** TableId **   <a name="DDB-Type-BackupSummary-TableId"></a>
Unique identifier for the table.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** TableName **   <a name="DDB-Type-BackupSummary-TableName"></a>
Name of the table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## See Also
<a name="API_BackupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BackupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BackupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BackupSummary) 

# BatchStatementError
<a name="API_BatchStatementError"></a>

 An error associated with a statement in a PartiQL batch that was run. 

## Contents
<a name="API_BatchStatementError_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Code **   <a name="DDB-Type-BatchStatementError-Code"></a>
 The error code associated with the failed PartiQL batch statement.   
Type: String  
Valid Values: `ConditionalCheckFailed | ItemCollectionSizeLimitExceeded | RequestLimitExceeded | ValidationError | ProvisionedThroughputExceeded | TransactionConflict | ThrottlingError | InternalServerError | ResourceNotFound | AccessDenied | DuplicateItem`   
Required: No

 ** Item **   <a name="DDB-Type-BatchStatementError-Item"></a>
The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is specified as `ALL_OLD`.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** Message **   <a name="DDB-Type-BatchStatementError-Message"></a>
 The error message associated with the PartiQL batch response.   
Type: String  
Required: No

## See Also
<a name="API_BatchStatementError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BatchStatementError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BatchStatementError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BatchStatementError) 

# BatchStatementRequest
<a name="API_BatchStatementRequest"></a>

 A PartiQL batch statement request. 

## Contents
<a name="API_BatchStatementRequest_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Statement **   <a name="DDB-Type-BatchStatementRequest-Statement"></a>
 A valid PartiQL statement.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: Yes

 ** ConsistentRead **   <a name="DDB-Type-BatchStatementRequest-ConsistentRead"></a>
 The read consistency of the PartiQL batch request.   
Type: Boolean  
Required: No

 ** Parameters **   <a name="DDB-Type-BatchStatementRequest-Parameters"></a>
 The parameters associated with a PartiQL statement in the batch request.   
Type: Array of [AttributeValue](API_AttributeValue.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** ReturnValuesOnConditionCheckFailure **   <a name="DDB-Type-BatchStatementRequest-ReturnValuesOnConditionCheckFailure"></a>
An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.  
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.  
Type: String  
Valid Values: `ALL_OLD | NONE`   
Required: No

## See Also
<a name="API_BatchStatementRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BatchStatementRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BatchStatementRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BatchStatementRequest) 

# BatchStatementResponse
<a name="API_BatchStatementResponse"></a>

 A PartiQL batch statement response.. 

## Contents
<a name="API_BatchStatementResponse_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Error **   <a name="DDB-Type-BatchStatementResponse-Error"></a>
 The error associated with a failed PartiQL batch statement.   
Type: [BatchStatementError](API_BatchStatementError.md) object  
Required: No

 ** Item **   <a name="DDB-Type-BatchStatementResponse-Item"></a>
 A DynamoDB item associated with a BatchStatementResponse   
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** TableName **   <a name="DDB-Type-BatchStatementResponse-TableName"></a>
 The table name associated with a failed PartiQL batch statement.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## See Also
<a name="API_BatchStatementResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BatchStatementResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BatchStatementResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BatchStatementResponse) 

# BillingModeSummary
<a name="API_BillingModeSummary"></a>

Contains the details for the read/write capacity mode. This page talks about `PROVISIONED` and `PAY_PER_REQUEST` billing modes. For more information about these modes, see [Read/write capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html).

**Note**  
You may need to switch to on-demand mode at least once in order to return a `BillingModeSummary` response.

## Contents
<a name="API_BillingModeSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** BillingMode **   <a name="DDB-Type-BillingModeSummary-BillingMode"></a>
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. 
Type: String  
Valid Values: `PROVISIONED | PAY_PER_REQUEST`   
Required: No

 ** LastUpdateToPayPerRequestDateTime **   <a name="DDB-Type-BillingModeSummary-LastUpdateToPayPerRequestDateTime"></a>
Represents the time when `PAY_PER_REQUEST` was last set as the read/write capacity mode.  
Type: Timestamp  
Required: No

## See Also
<a name="API_BillingModeSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BillingModeSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BillingModeSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BillingModeSummary) 

# CancellationReason
<a name="API_CancellationReason"></a>

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. 

## Contents
<a name="API_CancellationReason_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Code **   <a name="DDB-Type-CancellationReason-Code"></a>
Status code for the result of the cancelled transaction.  
Type: String  
Required: No

 ** Item **   <a name="DDB-Type-CancellationReason-Item"></a>
Item in the request which caused the transaction to get cancelled.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** Message **   <a name="DDB-Type-CancellationReason-Message"></a>
Cancellation reason message description.  
Type: String  
Required: No

## See Also
<a name="API_CancellationReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CancellationReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CancellationReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CancellationReason) 

# Capacity
<a name="API_Capacity"></a>

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

## Contents
<a name="API_Capacity_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** CapacityUnits **   <a name="DDB-Type-Capacity-CapacityUnits"></a>
The total number of capacity units consumed on a table or an index.  
Type: Double  
Required: No

 ** ReadCapacityUnits **   <a name="DDB-Type-Capacity-ReadCapacityUnits"></a>
The total number of read capacity units consumed on a table or an index.  
Type: Double  
Required: No

 ** WriteCapacityUnits **   <a name="DDB-Type-Capacity-WriteCapacityUnits"></a>
The total number of write capacity units consumed on a table or an index.  
Type: Double  
Required: No

## See Also
<a name="API_Capacity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Capacity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Capacity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Capacity) 

# Condition
<a name="API_Condition"></a>

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.

## Contents
<a name="API_Condition_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ComparisonOperator **   <a name="DDB-Type-Condition-ComparisonOperator"></a>
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.
**Note**  
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.
**Note**  
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\$1CONTAINS 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*.  
Type: String  
Valid Values: `EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH`   
Required: Yes

 ** AttributeValueList **   <a name="DDB-Type-Condition-AttributeValueList"></a>
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\$1ASCII\$1printable\$1characters](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.  
Type: Array of [AttributeValue](API_AttributeValue.md) objects  
Required: No

## See Also
<a name="API_Condition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Condition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Condition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Condition) 

# ConditionCheck
<a name="API_ConditionCheck"></a>

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

## Contents
<a name="API_ConditionCheck_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ConditionExpression **   <a name="DDB-Type-ConditionCheck-ConditionExpression"></a>
A condition that must be satisfied in order for a conditional update to succeed. For more information, see [Condition expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) in the *Amazon DynamoDB Developer Guide*.  
Type: String  
Required: Yes

 ** Key **   <a name="DDB-Type-ConditionCheck-Key"></a>
The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

 ** TableName **   <a name="DDB-Type-ConditionCheck-TableName"></a>
Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ExpressionAttributeNames **   <a name="DDB-Type-ConditionCheck-ExpressionAttributeNames"></a>
One or more substitution tokens for attribute names in an expression. For more information, see [Expression attribute names](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html) in the *Amazon DynamoDB Developer Guide*.  
Type: String to string map  
Value Length Constraints: Maximum length of 65535.  
Required: No

 ** ExpressionAttributeValues **   <a name="DDB-Type-ConditionCheck-ExpressionAttributeValues"></a>
One or more values that can be substituted in an expression. For more information, see [Condition expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) in the *Amazon DynamoDB Developer Guide*.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Required: No

 ** ReturnValuesOnConditionCheckFailure **   <a name="DDB-Type-ConditionCheck-ReturnValuesOnConditionCheckFailure"></a>
Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails. For `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL\$1OLD.  
Type: String  
Valid Values: `ALL_OLD | NONE`   
Required: No

## See Also
<a name="API_ConditionCheck_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ConditionCheck) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ConditionCheck) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ConditionCheck) 

# ConsumedCapacity
<a name="API_ConsumedCapacity"></a>

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 capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html) in the *Amazon DynamoDB Developer Guide*.

## Contents
<a name="API_ConsumedCapacity_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** CapacityUnits **   <a name="DDB-Type-ConsumedCapacity-CapacityUnits"></a>
The total number of capacity units consumed by the operation.  
Type: Double  
Required: No

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-ConsumedCapacity-GlobalSecondaryIndexes"></a>
The amount of throughput consumed on each global index affected by the operation.  
Type: String to [Capacity](API_Capacity.md) object map  
Key Length Constraints: Minimum length of 3. Maximum length of 255.  
Key Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** LocalSecondaryIndexes **   <a name="DDB-Type-ConsumedCapacity-LocalSecondaryIndexes"></a>
The amount of throughput consumed on each local index affected by the operation.  
Type: String to [Capacity](API_Capacity.md) object map  
Key Length Constraints: Minimum length of 3. Maximum length of 255.  
Key Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** ReadCapacityUnits **   <a name="DDB-Type-ConsumedCapacity-ReadCapacityUnits"></a>
The total number of read capacity units consumed by the operation.  
Type: Double  
Required: No

 ** Table **   <a name="DDB-Type-ConsumedCapacity-Table"></a>
The amount of throughput consumed on the table affected by the operation.  
Type: [Capacity](API_Capacity.md) object  
Required: No

 ** TableName **   <a name="DDB-Type-ConsumedCapacity-TableName"></a>
The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** WriteCapacityUnits **   <a name="DDB-Type-ConsumedCapacity-WriteCapacityUnits"></a>
The total number of write capacity units consumed by the operation.  
Type: Double  
Required: No

## See Also
<a name="API_ConsumedCapacity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ConsumedCapacity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ConsumedCapacity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ConsumedCapacity) 

# ContinuousBackupsDescription
<a name="API_ContinuousBackupsDescription"></a>

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

## Contents
<a name="API_ContinuousBackupsDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ContinuousBackupsStatus **   <a name="DDB-Type-ContinuousBackupsDescription-ContinuousBackupsStatus"></a>
 `ContinuousBackupsStatus` can be one of the following states: ENABLED, DISABLED  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** PointInTimeRecoveryDescription **   <a name="DDB-Type-ContinuousBackupsDescription-PointInTimeRecoveryDescription"></a>
The description of the point in time recovery settings applied to the table.  
Type: [PointInTimeRecoveryDescription](API_PointInTimeRecoveryDescription.md) object  
Required: No

## See Also
<a name="API_ContinuousBackupsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ContinuousBackupsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ContinuousBackupsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ContinuousBackupsDescription) 

# ContributorInsightsSummary
<a name="API_ContributorInsightsSummary"></a>

Represents a Contributor Insights summary entry.

## Contents
<a name="API_ContributorInsightsSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ContributorInsightsMode **   <a name="DDB-Type-ContributorInsightsSummary-ContributorInsightsMode"></a>
Indicates the current mode of CloudWatch Contributor Insights, specifying whether it tracks all access and throttled events or throttled events only for the DynamoDB table or index.  
Type: String  
Valid Values: `ACCESSED_AND_THROTTLED_KEYS | THROTTLED_KEYS`   
Required: No

 ** ContributorInsightsStatus **   <a name="DDB-Type-ContributorInsightsSummary-ContributorInsightsStatus"></a>
Describes the current status for contributor insights for the given table and index, if applicable.  
Type: String  
Valid Values: `ENABLING | ENABLED | DISABLING | DISABLED | FAILED`   
Required: No

 ** IndexName **   <a name="DDB-Type-ContributorInsightsSummary-IndexName"></a>
Name of the index associated with the summary, if any.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** TableName **   <a name="DDB-Type-ContributorInsightsSummary-TableName"></a>
Name of the table associated with the summary.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## See Also
<a name="API_ContributorInsightsSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ContributorInsightsSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ContributorInsightsSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ContributorInsightsSummary) 

# CreateGlobalSecondaryIndexAction
<a name="API_CreateGlobalSecondaryIndexAction"></a>

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

## Contents
<a name="API_CreateGlobalSecondaryIndexAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-CreateGlobalSecondaryIndexAction-IndexName"></a>
The name of the global secondary index to be created.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** KeySchema **   <a name="DDB-Type-CreateGlobalSecondaryIndexAction-KeySchema"></a>
The key schema for the global secondary index. Global secondary index supports up to 4 partition and up to 4 sort keys.  
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** Projection **   <a name="DDB-Type-CreateGlobalSecondaryIndexAction-Projection"></a>
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.  
Type: [Projection](API_Projection.md) object  
Required: Yes

 ** OnDemandThroughput **   <a name="DDB-Type-CreateGlobalSecondaryIndexAction-OnDemandThroughput"></a>
The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both. You must use either `OnDemand Throughput` or `ProvisionedThroughput` based on your table's capacity mode.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** ProvisionedThroughput **   <a name="DDB-Type-CreateGlobalSecondaryIndexAction-ProvisionedThroughput"></a>
Represents the provisioned throughput settings for the specified global secondary index.  
For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.  
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object  
Required: No

 ** WarmThroughput **   <a name="DDB-Type-CreateGlobalSecondaryIndexAction-WarmThroughput"></a>
Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.  
Type: [WarmThroughput](API_WarmThroughput.md) object  
Required: No

## See Also
<a name="API_CreateGlobalSecondaryIndexAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CreateGlobalSecondaryIndexAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CreateGlobalSecondaryIndexAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CreateGlobalSecondaryIndexAction) 

# CreateGlobalTableWitnessGroupMemberAction
<a name="API_CreateGlobalTableWitnessGroupMemberAction"></a>

Specifies the action to add a new witness Region to a MRSC global table. A MRSC global table can be configured with either three replicas, or with two replicas and one witness.

## Contents
<a name="API_CreateGlobalTableWitnessGroupMemberAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-CreateGlobalTableWitnessGroupMemberAction-RegionName"></a>
The AWS Region name to be added as a witness Region for the MRSC global table. The witness must be in a different Region than the replicas and within the same Region set:  
+ US Region set: US East (N. Virginia), US East (Ohio), US West (Oregon)
+ EU Region set: Europe (Ireland), Europe (London), Europe (Paris), Europe (Frankfurt)
+ AP Region set: Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Osaka)
Type: String  
Required: Yes

## See Also
<a name="API_CreateGlobalTableWitnessGroupMemberAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CreateGlobalTableWitnessGroupMemberAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CreateGlobalTableWitnessGroupMemberAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CreateGlobalTableWitnessGroupMemberAction) 

# CreateReplicaAction
<a name="API_CreateReplicaAction"></a>

Represents a replica to be added.

## Contents
<a name="API_CreateReplicaAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-CreateReplicaAction-RegionName"></a>
The Region of the replica to be added.  
Type: String  
Required: Yes

## See Also
<a name="API_CreateReplicaAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CreateReplicaAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CreateReplicaAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CreateReplicaAction) 

# CreateReplicationGroupMemberAction
<a name="API_CreateReplicationGroupMemberAction"></a>

Represents a replica to be created.

## Contents
<a name="API_CreateReplicationGroupMemberAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-CreateReplicationGroupMemberAction-RegionName"></a>
The Region where the new replica will be created.  
Type: String  
Required: Yes

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-CreateReplicationGroupMemberAction-GlobalSecondaryIndexes"></a>
Replica-specific global secondary index settings.  
Type: Array of [ReplicaGlobalSecondaryIndex](API_ReplicaGlobalSecondaryIndex.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** KMSMasterKeyId **   <a name="DDB-Type-CreateReplicationGroupMemberAction-KMSMasterKeyId"></a>
The AWS KMS key that should be used for AWS KMS encryption in the new replica. To specify a key, 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 key `alias/aws/dynamodb`.  
Type: String  
Required: No

 ** OnDemandThroughputOverride **   <a name="DDB-Type-CreateReplicationGroupMemberAction-OnDemandThroughputOverride"></a>
The maximum on-demand throughput settings for the specified replica table being created. You can only modify `MaxReadRequestUnits`, because you can't modify `MaxWriteRequestUnits` for individual replica tables.   
Type: [OnDemandThroughputOverride](API_OnDemandThroughputOverride.md) object  
Required: No

 ** ProvisionedThroughputOverride **   <a name="DDB-Type-CreateReplicationGroupMemberAction-ProvisionedThroughputOverride"></a>
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.  
Type: [ProvisionedThroughputOverride](API_ProvisionedThroughputOverride.md) object  
Required: No

 ** TableClassOverride **   <a name="DDB-Type-CreateReplicationGroupMemberAction-TableClassOverride"></a>
Replica-specific table class. If not specified, uses the source table's table class.  
Type: String  
Valid Values: `STANDARD | STANDARD_INFREQUENT_ACCESS`   
Required: No

## See Also
<a name="API_CreateReplicationGroupMemberAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CreateReplicationGroupMemberAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CreateReplicationGroupMemberAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CreateReplicationGroupMemberAction) 

# CsvOptions
<a name="API_CsvOptions"></a>

 Processing options for the CSV file being imported. 

## Contents
<a name="API_CsvOptions_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Delimiter **   <a name="DDB-Type-CsvOptions-Delimiter"></a>
 The delimiter used for separating items in the CSV file being imported.   
Type: String  
Length Constraints: Fixed length of 1.  
Pattern: `[,;:|\t ]`   
Required: No

 ** HeaderList **   <a name="DDB-Type-CsvOptions-HeaderList"></a>
 List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 255 items.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[\x20-\x21\x23-\x2B\x2D-\x7E]*`   
Required: No

## See Also
<a name="API_CsvOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CsvOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CsvOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CsvOptions) 

# Delete
<a name="API_Delete"></a>

Represents a request to perform a `DeleteItem` operation.

## Contents
<a name="API_Delete_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Key **   <a name="DDB-Type-Delete-Key"></a>
The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

 ** TableName **   <a name="DDB-Type-Delete-TableName"></a>
Name of the table in which the item to be deleted resides. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ConditionExpression **   <a name="DDB-Type-Delete-ConditionExpression"></a>
A condition that must be satisfied in order for a conditional delete to succeed.  
Type: String  
Required: No

 ** ExpressionAttributeNames **   <a name="DDB-Type-Delete-ExpressionAttributeNames"></a>
One or more substitution tokens for attribute names in an expression.  
Type: String to string map  
Value Length Constraints: Maximum length of 65535.  
Required: No

 ** ExpressionAttributeValues **   <a name="DDB-Type-Delete-ExpressionAttributeValues"></a>
One or more values that can be substituted in an expression.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Required: No

 ** ReturnValuesOnConditionCheckFailure **   <a name="DDB-Type-Delete-ReturnValuesOnConditionCheckFailure"></a>
Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Delete` condition fails. For `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL\$1OLD.  
Type: String  
Valid Values: `ALL_OLD | NONE`   
Required: No

## See Also
<a name="API_Delete_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Delete) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Delete) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Delete) 

# DeleteGlobalSecondaryIndexAction
<a name="API_DeleteGlobalSecondaryIndexAction"></a>

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

## Contents
<a name="API_DeleteGlobalSecondaryIndexAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-DeleteGlobalSecondaryIndexAction-IndexName"></a>
The name of the global secondary index to be deleted.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

## See Also
<a name="API_DeleteGlobalSecondaryIndexAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteGlobalSecondaryIndexAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteGlobalSecondaryIndexAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteGlobalSecondaryIndexAction) 

# DeleteGlobalTableWitnessGroupMemberAction
<a name="API_DeleteGlobalTableWitnessGroupMemberAction"></a>

Specifies the action to remove a witness Region from a MRSC global table. You cannot delete a single witness from a MRSC global table - you must delete both a replica and the witness together. The deletion of both a witness and replica converts the remaining replica to a single-Region DynamoDB table. 

## Contents
<a name="API_DeleteGlobalTableWitnessGroupMemberAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-DeleteGlobalTableWitnessGroupMemberAction-RegionName"></a>
The witness Region name to be removed from the MRSC global table.  
Type: String  
Required: Yes

## See Also
<a name="API_DeleteGlobalTableWitnessGroupMemberAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteGlobalTableWitnessGroupMemberAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteGlobalTableWitnessGroupMemberAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteGlobalTableWitnessGroupMemberAction) 

# DeleteReplicaAction
<a name="API_DeleteReplicaAction"></a>

Represents a replica to be removed.

## Contents
<a name="API_DeleteReplicaAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-DeleteReplicaAction-RegionName"></a>
The Region of the replica to be removed.  
Type: String  
Required: Yes

## See Also
<a name="API_DeleteReplicaAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteReplicaAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteReplicaAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteReplicaAction) 

# DeleteReplicationGroupMemberAction
<a name="API_DeleteReplicationGroupMemberAction"></a>

Represents a replica to be deleted.

## Contents
<a name="API_DeleteReplicationGroupMemberAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-DeleteReplicationGroupMemberAction-RegionName"></a>
The Region where the replica exists.  
Type: String  
Required: Yes

## See Also
<a name="API_DeleteReplicationGroupMemberAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteReplicationGroupMemberAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteReplicationGroupMemberAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteReplicationGroupMemberAction) 

# DeleteRequest
<a name="API_DeleteRequest"></a>

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

## Contents
<a name="API_DeleteRequest_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Key **   <a name="DDB-Type-DeleteRequest-Key"></a>
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.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

## See Also
<a name="API_DeleteRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteRequest) 

# EnableKinesisStreamingConfiguration
<a name="API_EnableKinesisStreamingConfiguration"></a>

Enables setting the configuration for Kinesis Streaming.

## Contents
<a name="API_EnableKinesisStreamingConfiguration_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ApproximateCreationDateTimePrecision **   <a name="DDB-Type-EnableKinesisStreamingConfiguration-ApproximateCreationDateTimePrecision"></a>
Toggle for the precision of Kinesis data stream timestamp. The values are either `MILLISECOND` or `MICROSECOND`.  
Type: String  
Valid Values: `MILLISECOND | MICROSECOND`   
Required: No

## See Also
<a name="API_EnableKinesisStreamingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/EnableKinesisStreamingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/EnableKinesisStreamingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/EnableKinesisStreamingConfiguration) 

# Endpoint
<a name="API_Endpoint"></a>

An endpoint information details.

## Contents
<a name="API_Endpoint_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Address **   <a name="DDB-Type-Endpoint-Address"></a>
IP address of the endpoint.  
Type: String  
Required: Yes

 ** CachePeriodInMinutes **   <a name="DDB-Type-Endpoint-CachePeriodInMinutes"></a>
Endpoint cache time to live (TTL) value.  
Type: Long  
Required: Yes

## See Also
<a name="API_Endpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Endpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Endpoint) 

# ExpectedAttributeValue
<a name="API_ExpectedAttributeValue"></a>

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.

## Contents
<a name="API_ExpectedAttributeValue_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AttributeValueList **   <a name="DDB-Type-ExpectedAttributeValue-AttributeValueList"></a>
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\$1ASCII\$1printable\$1characters](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*.  
Type: Array of [AttributeValue](API_AttributeValue.md) objects  
Required: No

 ** ComparisonOperator **   <a name="DDB-Type-ExpectedAttributeValue-ComparisonOperator"></a>
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.
**Note**  
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.
**Note**  
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\$1CONTAINS 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"]}` 
Type: String  
Valid Values: `EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH`   
Required: No

 ** Exists **   <a name="DDB-Type-ExpectedAttributeValue-Exists"></a>
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.)
Type: Boolean  
Required: No

 ** Value **   <a name="DDB-Type-ExpectedAttributeValue-Value"></a>
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*.  
Type: [AttributeValue](API_AttributeValue.md) object  
Required: No

## See Also
<a name="API_ExpectedAttributeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ExpectedAttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ExpectedAttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ExpectedAttributeValue) 

# ExportDescription
<a name="API_ExportDescription"></a>

Represents the properties of the exported table.

## Contents
<a name="API_ExportDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** BilledSizeBytes **   <a name="DDB-Type-ExportDescription-BilledSizeBytes"></a>
The billable size of the table export.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ClientToken **   <a name="DDB-Type-ExportDescription-ClientToken"></a>
The client token that was provided for the export task. A client token makes calls to `ExportTableToPointInTimeInput` idempotent, meaning that multiple identical calls have the same effect as one single call.  
Type: String  
Pattern: `^[^\$]+$`   
Required: No

 ** EndTime **   <a name="DDB-Type-ExportDescription-EndTime"></a>
The time at which the export task completed.  
Type: Timestamp  
Required: No

 ** ExportArn **   <a name="DDB-Type-ExportDescription-ExportArn"></a>
The Amazon Resource Name (ARN) of the table export.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** ExportFormat **   <a name="DDB-Type-ExportDescription-ExportFormat"></a>
The format of the exported data. Valid values for `ExportFormat` are `DYNAMODB_JSON` or `ION`.  
Type: String  
Valid Values: `DYNAMODB_JSON | ION`   
Required: No

 ** ExportManifest **   <a name="DDB-Type-ExportDescription-ExportManifest"></a>
The name of the manifest file for the export task.  
Type: String  
Required: No

 ** ExportStatus **   <a name="DDB-Type-ExportDescription-ExportStatus"></a>
Export can be in one of the following states: IN\$1PROGRESS, COMPLETED, or FAILED.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | FAILED`   
Required: No

 ** ExportTime **   <a name="DDB-Type-ExportDescription-ExportTime"></a>
Point in time from which table data was exported.  
Type: Timestamp  
Required: No

 ** ExportType **   <a name="DDB-Type-ExportDescription-ExportType"></a>
The type of export that was performed. Valid values are `FULL_EXPORT` or `INCREMENTAL_EXPORT`.  
Type: String  
Valid Values: `FULL_EXPORT | INCREMENTAL_EXPORT`   
Required: No

 ** FailureCode **   <a name="DDB-Type-ExportDescription-FailureCode"></a>
Status code for the result of the failed export.  
Type: String  
Required: No

 ** FailureMessage **   <a name="DDB-Type-ExportDescription-FailureMessage"></a>
Export failure reason description.  
Type: String  
Required: No

 ** IncrementalExportSpecification **   <a name="DDB-Type-ExportDescription-IncrementalExportSpecification"></a>
Optional object containing the parameters specific to an incremental export.  
Type: [IncrementalExportSpecification](API_IncrementalExportSpecification.md) object  
Required: No

 ** ItemCount **   <a name="DDB-Type-ExportDescription-ItemCount"></a>
The number of items exported.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** S3Bucket **   <a name="DDB-Type-ExportDescription-S3Bucket"></a>
The name of the Amazon S3 bucket containing the export.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `^[a-z0-9A-Z]+[\.\-\w]*[a-z0-9A-Z]+$`   
Required: No

 ** S3BucketOwner **   <a name="DDB-Type-ExportDescription-S3BucketOwner"></a>
The ID of the AWS account that owns the bucket containing the export.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** S3Prefix **   <a name="DDB-Type-ExportDescription-S3Prefix"></a>
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** S3SseAlgorithm **   <a name="DDB-Type-ExportDescription-S3SseAlgorithm"></a>
Type of encryption used on the bucket where export data is stored. Valid values for `S3SseAlgorithm` are:  
+  `AES256` - server-side encryption with Amazon S3 managed keys
+  `KMS` - server-side encryption with AWS KMS managed keys
Type: String  
Valid Values: `AES256 | KMS`   
Required: No

 ** S3SseKmsKeyId **   <a name="DDB-Type-ExportDescription-S3SseKmsKeyId"></a>
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** StartTime **   <a name="DDB-Type-ExportDescription-StartTime"></a>
The time at which the export task began.  
Type: Timestamp  
Required: No

 ** TableArn **   <a name="DDB-Type-ExportDescription-TableArn"></a>
The Amazon Resource Name (ARN) of the table that was exported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** TableId **   <a name="DDB-Type-ExportDescription-TableId"></a>
Unique ID of the table that was exported.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

## See Also
<a name="API_ExportDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ExportDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ExportDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ExportDescription) 

# ExportSummary
<a name="API_ExportSummary"></a>

Summary information about an export task.

## Contents
<a name="API_ExportSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ExportArn **   <a name="DDB-Type-ExportSummary-ExportArn"></a>
The Amazon Resource Name (ARN) of the export.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** ExportStatus **   <a name="DDB-Type-ExportSummary-ExportStatus"></a>
Export can be in one of the following states: IN\$1PROGRESS, COMPLETED, or FAILED.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | FAILED`   
Required: No

 ** ExportType **   <a name="DDB-Type-ExportSummary-ExportType"></a>
The type of export that was performed. Valid values are `FULL_EXPORT` or `INCREMENTAL_EXPORT`.  
Type: String  
Valid Values: `FULL_EXPORT | INCREMENTAL_EXPORT`   
Required: No

## See Also
<a name="API_ExportSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ExportSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ExportSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ExportSummary) 

# FailureException
<a name="API_FailureException"></a>

Represents a failure a contributor insights operation.

## Contents
<a name="API_FailureException_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ExceptionDescription **   <a name="DDB-Type-FailureException-ExceptionDescription"></a>
Description of the failure.  
Type: String  
Required: No

 ** ExceptionName **   <a name="DDB-Type-FailureException-ExceptionName"></a>
Exception name.  
Type: String  
Required: No

## See Also
<a name="API_FailureException_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/FailureException) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/FailureException) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/FailureException) 

# Get
<a name="API_Get"></a>

Specifies an item and related attribute values to retrieve in a `TransactGetItem` object.

## Contents
<a name="API_Get_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Key **   <a name="DDB-Type-Get-Key"></a>
A map of attribute names to `AttributeValue` objects that specifies the primary key of the item to retrieve.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

 ** TableName **   <a name="DDB-Type-Get-TableName"></a>
The name of the table from which to retrieve the specified item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ExpressionAttributeNames **   <a name="DDB-Type-Get-ExpressionAttributeNames"></a>
One or more substitution tokens for attribute names in the ProjectionExpression parameter.  
Type: String to string map  
Value Length Constraints: Maximum length of 65535.  
Required: No

 ** ProjectionExpression **   <a name="DDB-Type-Get-ProjectionExpression"></a>
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.  
Type: String  
Required: No

## See Also
<a name="API_Get_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Get) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Get) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Get) 

# GlobalSecondaryIndex
<a name="API_GlobalSecondaryIndex"></a>

Represents the properties of a global secondary index.

## Contents
<a name="API_GlobalSecondaryIndex_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-GlobalSecondaryIndex-IndexName"></a>
The name of the global secondary index. The name must be unique among all other indexes on this table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** KeySchema **   <a name="DDB-Type-GlobalSecondaryIndex-KeySchema"></a>
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.
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** Projection **   <a name="DDB-Type-GlobalSecondaryIndex-Projection"></a>
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.   
Type: [Projection](API_Projection.md) object  
Required: Yes

 ** OnDemandThroughput **   <a name="DDB-Type-GlobalSecondaryIndex-OnDemandThroughput"></a>
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both. You must use either `OnDemandThroughput` or `ProvisionedThroughput` based on your table's capacity mode.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** ProvisionedThroughput **   <a name="DDB-Type-GlobalSecondaryIndex-ProvisionedThroughput"></a>
Represents the provisioned throughput settings for the specified global secondary index. You must use either `OnDemandThroughput` or `ProvisionedThroughput` based on your table's capacity mode.  
For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.  
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object  
Required: No

 ** WarmThroughput **   <a name="DDB-Type-GlobalSecondaryIndex-WarmThroughput"></a>
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify `ReadUnitsPerSecond`, `WriteUnitsPerSecond`, or both.  
Type: [WarmThroughput](API_WarmThroughput.md) object  
Required: No

## See Also
<a name="API_GlobalSecondaryIndex_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalSecondaryIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalSecondaryIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalSecondaryIndex) 

# GlobalSecondaryIndexAutoScalingUpdate
<a name="API_GlobalSecondaryIndexAutoScalingUpdate"></a>

Represents the auto scaling settings of a global secondary index for a global table that will be modified.

## Contents
<a name="API_GlobalSecondaryIndexAutoScalingUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-GlobalSecondaryIndexAutoScalingUpdate-IndexName"></a>
The name of the global secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** ProvisionedWriteCapacityAutoScalingUpdate **   <a name="DDB-Type-GlobalSecondaryIndexAutoScalingUpdate-ProvisionedWriteCapacityAutoScalingUpdate"></a>
Represents the auto scaling settings to be modified for a global table or global secondary index.  
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object  
Required: No

## See Also
<a name="API_GlobalSecondaryIndexAutoScalingUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalSecondaryIndexAutoScalingUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalSecondaryIndexAutoScalingUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalSecondaryIndexAutoScalingUpdate) 

# GlobalSecondaryIndexDescription
<a name="API_GlobalSecondaryIndexDescription"></a>

Represents the properties of a global secondary index.

## Contents
<a name="API_GlobalSecondaryIndexDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Backfilling **   <a name="DDB-Type-GlobalSecondaryIndexDescription-Backfilling"></a>
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.
Type: Boolean  
Required: No

 ** IndexArn **   <a name="DDB-Type-GlobalSecondaryIndexDescription-IndexArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the index.  
Type: String  
Required: No

 ** IndexName **   <a name="DDB-Type-GlobalSecondaryIndexDescription-IndexName"></a>
The name of the global secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** IndexSizeBytes **   <a name="DDB-Type-GlobalSecondaryIndexDescription-IndexSizeBytes"></a>
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.  
Type: Long  
Required: No

 ** IndexStatus **   <a name="DDB-Type-GlobalSecondaryIndexDescription-IndexStatus"></a>
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.
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE`   
Required: No

 ** ItemCount **   <a name="DDB-Type-GlobalSecondaryIndexDescription-ItemCount"></a>
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.  
Type: Long  
Required: No

 ** KeySchema **   <a name="DDB-Type-GlobalSecondaryIndexDescription-KeySchema"></a>
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.
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** OnDemandThroughput **   <a name="DDB-Type-GlobalSecondaryIndexDescription-OnDemandThroughput"></a>
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** Projection **   <a name="DDB-Type-GlobalSecondaryIndexDescription-Projection"></a>
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.   
Type: [Projection](API_Projection.md) object  
Required: No

 ** ProvisionedThroughput **   <a name="DDB-Type-GlobalSecondaryIndexDescription-ProvisionedThroughput"></a>
Represents the provisioned throughput settings for the specified global secondary index.  
For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.  
Type: [ProvisionedThroughputDescription](API_ProvisionedThroughputDescription.md) object  
Required: No

 ** WarmThroughput **   <a name="DDB-Type-GlobalSecondaryIndexDescription-WarmThroughput"></a>
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.  
Type: [GlobalSecondaryIndexWarmThroughputDescription](API_GlobalSecondaryIndexWarmThroughputDescription.md) object  
Required: No

## See Also
<a name="API_GlobalSecondaryIndexDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalSecondaryIndexDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalSecondaryIndexDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalSecondaryIndexDescription) 

# GlobalSecondaryIndexInfo
<a name="API_GlobalSecondaryIndexInfo"></a>

Represents the properties of a global secondary index for the table when the backup was created.

## Contents
<a name="API_GlobalSecondaryIndexInfo_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-GlobalSecondaryIndexInfo-IndexName"></a>
The name of the global secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** KeySchema **   <a name="DDB-Type-GlobalSecondaryIndexInfo-KeySchema"></a>
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.
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** OnDemandThroughput **   <a name="DDB-Type-GlobalSecondaryIndexInfo-OnDemandThroughput"></a>
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** Projection **   <a name="DDB-Type-GlobalSecondaryIndexInfo-Projection"></a>
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.   
Type: [Projection](API_Projection.md) object  
Required: No

 ** ProvisionedThroughput **   <a name="DDB-Type-GlobalSecondaryIndexInfo-ProvisionedThroughput"></a>
Represents the provisioned throughput settings for the specified global secondary index.   
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object  
Required: No

## See Also
<a name="API_GlobalSecondaryIndexInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalSecondaryIndexInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalSecondaryIndexInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalSecondaryIndexInfo) 

# GlobalSecondaryIndexUpdate
<a name="API_GlobalSecondaryIndexUpdate"></a>

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.

## Contents
<a name="API_GlobalSecondaryIndexUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Create **   <a name="DDB-Type-GlobalSecondaryIndexUpdate-Create"></a>
The parameters required for creating a global secondary index on an existing table:  
+  `IndexName ` 
+  `KeySchema ` 
+  `AttributeDefinitions ` 
+  `Projection ` 
+  `ProvisionedThroughput ` 
Type: [CreateGlobalSecondaryIndexAction](API_CreateGlobalSecondaryIndexAction.md) object  
Required: No

 ** Delete **   <a name="DDB-Type-GlobalSecondaryIndexUpdate-Delete"></a>
The name of an existing global secondary index to be removed.  
Type: [DeleteGlobalSecondaryIndexAction](API_DeleteGlobalSecondaryIndexAction.md) object  
Required: No

 ** Update **   <a name="DDB-Type-GlobalSecondaryIndexUpdate-Update"></a>
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.  
Type: [UpdateGlobalSecondaryIndexAction](API_UpdateGlobalSecondaryIndexAction.md) object  
Required: No

## See Also
<a name="API_GlobalSecondaryIndexUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalSecondaryIndexUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalSecondaryIndexUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalSecondaryIndexUpdate) 

# GlobalSecondaryIndexWarmThroughputDescription
<a name="API_GlobalSecondaryIndexWarmThroughputDescription"></a>

The description of the warm throughput value on a global secondary index.

## Contents
<a name="API_GlobalSecondaryIndexWarmThroughputDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ReadUnitsPerSecond **   <a name="DDB-Type-GlobalSecondaryIndexWarmThroughputDescription-ReadUnitsPerSecond"></a>
Represents warm throughput read units per second value for a global secondary index.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** Status **   <a name="DDB-Type-GlobalSecondaryIndexWarmThroughputDescription-Status"></a>
Represents the warm throughput status being created or updated on a global secondary index. The status can only be `UPDATING` or `ACTIVE`.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE`   
Required: No

 ** WriteUnitsPerSecond **   <a name="DDB-Type-GlobalSecondaryIndexWarmThroughputDescription-WriteUnitsPerSecond"></a>
Represents warm throughput write units per second value for a global secondary index.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_GlobalSecondaryIndexWarmThroughputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalSecondaryIndexWarmThroughputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalSecondaryIndexWarmThroughputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalSecondaryIndexWarmThroughputDescription) 

# GlobalTable
<a name="API_GlobalTable"></a>

Represents the properties of a global table.

## Contents
<a name="API_GlobalTable_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** GlobalTableName **   <a name="DDB-Type-GlobalTable-GlobalTableName"></a>
The global table name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** ReplicationGroup **   <a name="DDB-Type-GlobalTable-ReplicationGroup"></a>
The Regions where the global table has replicas.  
Type: Array of [Replica](API_Replica.md) objects  
Required: No

## See Also
<a name="API_GlobalTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalTable) 

# GlobalTableDescription
<a name="API_GlobalTableDescription"></a>

Contains details about the global table.

## Contents
<a name="API_GlobalTableDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** CreationDateTime **   <a name="DDB-Type-GlobalTableDescription-CreationDateTime"></a>
The creation time of the global table.  
Type: Timestamp  
Required: No

 ** GlobalTableArn **   <a name="DDB-Type-GlobalTableDescription-GlobalTableArn"></a>
The unique identifier of the global table.  
Type: String  
Required: No

 ** GlobalTableName **   <a name="DDB-Type-GlobalTableDescription-GlobalTableName"></a>
The global table name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** GlobalTableStatus **   <a name="DDB-Type-GlobalTableDescription-GlobalTableStatus"></a>
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.
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | UPDATING`   
Required: No

 ** ReplicationGroup **   <a name="DDB-Type-GlobalTableDescription-ReplicationGroup"></a>
The Regions where the global table has replicas.  
Type: Array of [ReplicaDescription](API_ReplicaDescription.md) objects  
Required: No

## See Also
<a name="API_GlobalTableDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalTableDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalTableDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalTableDescription) 

# GlobalTableGlobalSecondaryIndexSettingsUpdate
<a name="API_GlobalTableGlobalSecondaryIndexSettingsUpdate"></a>

Represents the settings of a global secondary index for a global table that will be modified.

## Contents
<a name="API_GlobalTableGlobalSecondaryIndexSettingsUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-GlobalTableGlobalSecondaryIndexSettingsUpdate-IndexName"></a>
The name of the global secondary index. The name must be unique among all other indexes on this table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** ProvisionedWriteCapacityAutoScalingSettingsUpdate **   <a name="DDB-Type-GlobalTableGlobalSecondaryIndexSettingsUpdate-ProvisionedWriteCapacityAutoScalingSettingsUpdate"></a>
Auto scaling settings for managing a global secondary index's write capacity units.  
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object  
Required: No

 ** ProvisionedWriteCapacityUnits **   <a name="DDB-Type-GlobalTableGlobalSecondaryIndexSettingsUpdate-ProvisionedWriteCapacityUnits"></a>
The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException.`   
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_GlobalTableGlobalSecondaryIndexSettingsUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalTableGlobalSecondaryIndexSettingsUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalTableGlobalSecondaryIndexSettingsUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalTableGlobalSecondaryIndexSettingsUpdate) 

# GlobalTableWitnessDescription
<a name="API_GlobalTableWitnessDescription"></a>

Represents the properties of a witness Region in a MRSC global table. 

## Contents
<a name="API_GlobalTableWitnessDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-GlobalTableWitnessDescription-RegionName"></a>
The name of the AWS Region that serves as a witness for the MRSC global table.  
Type: String  
Required: No

 ** WitnessStatus **   <a name="DDB-Type-GlobalTableWitnessDescription-WitnessStatus"></a>
The current status of the witness Region in the MRSC global table.  
Type: String  
Valid Values: `CREATING | DELETING | ACTIVE`   
Required: No

## See Also
<a name="API_GlobalTableWitnessDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalTableWitnessDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalTableWitnessDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalTableWitnessDescription) 

# GlobalTableWitnessGroupUpdate
<a name="API_GlobalTableWitnessGroupUpdate"></a>

Represents one of the following:
+ A new witness to be added to a new global table.
+ An existing witness to be removed from an existing global table.

You can configure one witness per MRSC global table.

## Contents
<a name="API_GlobalTableWitnessGroupUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Create **   <a name="DDB-Type-GlobalTableWitnessGroupUpdate-Create"></a>
Specifies a witness Region to be added to a new MRSC global table. The witness must be added when creating the MRSC global table.  
Type: [CreateGlobalTableWitnessGroupMemberAction](API_CreateGlobalTableWitnessGroupMemberAction.md) object  
Required: No

 ** Delete **   <a name="DDB-Type-GlobalTableWitnessGroupUpdate-Delete"></a>
Specifies a witness Region to be removed from an existing global table. Must be done in conjunction with removing a replica. The deletion of both a witness and replica converts the remaining replica to a single-Region DynamoDB table.  
Type: [DeleteGlobalTableWitnessGroupMemberAction](API_DeleteGlobalTableWitnessGroupMemberAction.md) object  
Required: No

## See Also
<a name="API_GlobalTableWitnessGroupUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GlobalTableWitnessGroupUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GlobalTableWitnessGroupUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GlobalTableWitnessGroupUpdate) 

# ImportSummary
<a name="API_ImportSummary"></a>

 Summary information about the source file for the import. 

## Contents
<a name="API_ImportSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** CloudWatchLogGroupArn **   <a name="DDB-Type-ImportSummary-CloudWatchLogGroupArn"></a>
 The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this import task.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** EndTime **   <a name="DDB-Type-ImportSummary-EndTime"></a>
 The time at which this import task ended. (Does this include the successful complete creation of the table it was imported to?)   
Type: Timestamp  
Required: No

 ** ImportArn **   <a name="DDB-Type-ImportSummary-ImportArn"></a>
 The Amazon Resource Number (ARN) corresponding to the import request.   
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** ImportStatus **   <a name="DDB-Type-ImportSummary-ImportStatus"></a>
 The status of the import operation.   
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | CANCELLING | CANCELLED | FAILED`   
Required: No

 ** InputFormat **   <a name="DDB-Type-ImportSummary-InputFormat"></a>
 The format of the source data. Valid values are `CSV`, `DYNAMODB_JSON` or `ION`.  
Type: String  
Valid Values: `DYNAMODB_JSON | ION | CSV`   
Required: No

 ** S3BucketSource **   <a name="DDB-Type-ImportSummary-S3BucketSource"></a>
 The path and S3 bucket of the source file that is being imported. This includes the S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is owned by the requester).   
Type: [S3BucketSource](API_S3BucketSource.md) object  
Required: No

 ** StartTime **   <a name="DDB-Type-ImportSummary-StartTime"></a>
 The time at which this import task began.   
Type: Timestamp  
Required: No

 ** TableArn **   <a name="DDB-Type-ImportSummary-TableArn"></a>
 The Amazon Resource Number (ARN) of the table being imported into.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_ImportSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ImportSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ImportSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ImportSummary) 

# ImportTableDescription
<a name="API_ImportTableDescription"></a>

 Represents the properties of the table being imported into. 

## Contents
<a name="API_ImportTableDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ClientToken **   <a name="DDB-Type-ImportTableDescription-ClientToken"></a>
 The client token that was provided for the import task. Reusing the client token on retry makes a call to `ImportTable` idempotent.   
Type: String  
Pattern: `^[^\$]+$`   
Required: No

 ** CloudWatchLogGroupArn **   <a name="DDB-Type-ImportTableDescription-CloudWatchLogGroupArn"></a>
 The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** EndTime **   <a name="DDB-Type-ImportTableDescription-EndTime"></a>
 The time at which the creation of the table associated with this import task completed.   
Type: Timestamp  
Required: No

 ** ErrorCount **   <a name="DDB-Type-ImportTableDescription-ErrorCount"></a>
 The number of errors occurred on importing the source file into the target table.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** FailureCode **   <a name="DDB-Type-ImportTableDescription-FailureCode"></a>
 The error code corresponding to the failure that the import job ran into during execution.   
Type: String  
Required: No

 ** FailureMessage **   <a name="DDB-Type-ImportTableDescription-FailureMessage"></a>
 The error message corresponding to the failure that the import job ran into during execution.   
Type: String  
Required: No

 ** ImportArn **   <a name="DDB-Type-ImportTableDescription-ImportArn"></a>
 The Amazon Resource Number (ARN) corresponding to the import request.   
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** ImportedItemCount **   <a name="DDB-Type-ImportTableDescription-ImportedItemCount"></a>
 The number of items successfully imported into the new table.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ImportStatus **   <a name="DDB-Type-ImportTableDescription-ImportStatus"></a>
 The status of the import.   
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | CANCELLING | CANCELLED | FAILED`   
Required: No

 ** InputCompressionType **   <a name="DDB-Type-ImportTableDescription-InputCompressionType"></a>
 The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.   
Type: String  
Valid Values: `GZIP | ZSTD | NONE`   
Required: No

 ** InputFormat **   <a name="DDB-Type-ImportTableDescription-InputFormat"></a>
 The format of the source data going into the target table.   
Type: String  
Valid Values: `DYNAMODB_JSON | ION | CSV`   
Required: No

 ** InputFormatOptions **   <a name="DDB-Type-ImportTableDescription-InputFormatOptions"></a>
 The format options for the data that was imported into the target table. There is one value, CsvOption.   
Type: [InputFormatOptions](API_InputFormatOptions.md) object  
Required: No

 ** ProcessedItemCount **   <a name="DDB-Type-ImportTableDescription-ProcessedItemCount"></a>
 The total number of items processed from the source file.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ProcessedSizeBytes **   <a name="DDB-Type-ImportTableDescription-ProcessedSizeBytes"></a>
 The total size of data processed from the source file, in Bytes.   
Type: Long  
Required: No

 ** S3BucketSource **   <a name="DDB-Type-ImportTableDescription-S3BucketSource"></a>
 Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).   
Type: [S3BucketSource](API_S3BucketSource.md) object  
Required: No

 ** StartTime **   <a name="DDB-Type-ImportTableDescription-StartTime"></a>
 The time when this import task started.   
Type: Timestamp  
Required: No

 ** TableArn **   <a name="DDB-Type-ImportTableDescription-TableArn"></a>
 The Amazon Resource Number (ARN) of the table being imported into.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** TableCreationParameters **   <a name="DDB-Type-ImportTableDescription-TableCreationParameters"></a>
 The parameters for the new table that is being imported into.   
Type: [TableCreationParameters](API_TableCreationParameters.md) object  
Required: No

 ** TableId **   <a name="DDB-Type-ImportTableDescription-TableId"></a>
 The table id corresponding to the table created by import table process.   
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

## See Also
<a name="API_ImportTableDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ImportTableDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ImportTableDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ImportTableDescription) 

# IncrementalExportSpecification
<a name="API_IncrementalExportSpecification"></a>

Optional object containing the parameters specific to an incremental export.

## Contents
<a name="API_IncrementalExportSpecification_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ExportFromTime **   <a name="DDB-Type-IncrementalExportSpecification-ExportFromTime"></a>
Time in the past which provides the inclusive start range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state including and after this point in time.  
Type: Timestamp  
Required: No

 ** ExportToTime **   <a name="DDB-Type-IncrementalExportSpecification-ExportToTime"></a>
Time in the past which provides the exclusive end range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state just prior to this point in time. If this is not provided, the latest time with data available will be used.  
Type: Timestamp  
Required: No

 ** ExportViewType **   <a name="DDB-Type-IncrementalExportSpecification-ExportViewType"></a>
The view type that was chosen for the export. Valid values are `NEW_AND_OLD_IMAGES` and `NEW_IMAGES`. The default value is `NEW_AND_OLD_IMAGES`.  
Type: String  
Valid Values: `NEW_IMAGE | NEW_AND_OLD_IMAGES`   
Required: No

## See Also
<a name="API_IncrementalExportSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/IncrementalExportSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/IncrementalExportSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/IncrementalExportSpecification) 

# InputFormatOptions
<a name="API_InputFormatOptions"></a>

 The format options for the data that was imported into the target table. There is one value, CsvOption.

## Contents
<a name="API_InputFormatOptions_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Csv **   <a name="DDB-Type-InputFormatOptions-Csv"></a>
 The options for imported source files in CSV format. The values are Delimiter and HeaderList.   
Type: [CsvOptions](API_CsvOptions.md) object  
Required: No

## See Also
<a name="API_InputFormatOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/InputFormatOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/InputFormatOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/InputFormatOptions) 

# ItemCollectionMetrics
<a name="API_ItemCollectionMetrics"></a>

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.

## Contents
<a name="API_ItemCollectionMetrics_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ItemCollectionKey **   <a name="DDB-Type-ItemCollectionMetrics-ItemCollectionKey"></a>
The partition key value of the item collection. This value is the same as the partition key value of the item.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** SizeEstimateRangeGB **   <a name="DDB-Type-ItemCollectionMetrics-SizeEstimateRangeGB"></a>
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.  
Type: Array of doubles  
Required: No

## See Also
<a name="API_ItemCollectionMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ItemCollectionMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ItemCollectionMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ItemCollectionMetrics) 

# ItemResponse
<a name="API_ItemResponse"></a>

Details for the requested item.

## Contents
<a name="API_ItemResponse_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Item **   <a name="DDB-Type-ItemResponse-Item"></a>
Map of attribute data consisting of the data type and attribute value.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

## See Also
<a name="API_ItemResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ItemResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ItemResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ItemResponse) 

# KeysAndAttributes
<a name="API_KeysAndAttributes"></a>

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.

## Contents
<a name="API_KeysAndAttributes_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Keys **   <a name="DDB-Type-KeysAndAttributes-Keys"></a>
The primary key attribute values that define the items and the attributes associated with the items.  
Type: Array of string to [AttributeValue](API_AttributeValue.md) object maps  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

 ** AttributesToGet **   <a name="DDB-Type-KeysAndAttributes-AttributesToGet"></a>
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*.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Maximum length of 65535.  
Required: No

 ** ConsistentRead **   <a name="DDB-Type-KeysAndAttributes-ConsistentRead"></a>
The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.  
Type: Boolean  
Required: No

 ** ExpressionAttributeNames **   <a name="DDB-Type-KeysAndAttributes-ExpressionAttributeNames"></a>
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 **\$1** 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*.  
Type: String to string map  
Value Length Constraints: Maximum length of 65535.  
Required: No

 ** ProjectionExpression **   <a name="DDB-Type-KeysAndAttributes-ProjectionExpression"></a>
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*.  
Type: String  
Required: No

## See Also
<a name="API_KeysAndAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/KeysAndAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/KeysAndAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/KeysAndAttributes) 

# KeySchemaElement
<a name="API_KeySchemaElement"></a>

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.

## Contents
<a name="API_KeySchemaElement_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AttributeName **   <a name="DDB-Type-KeySchemaElement-AttributeName"></a>
The name of a key attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** KeyType **   <a name="DDB-Type-KeySchemaElement-KeyType"></a>
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.
Type: String  
Valid Values: `HASH | RANGE`   
Required: Yes

## See Also
<a name="API_KeySchemaElement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/KeySchemaElement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/KeySchemaElement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/KeySchemaElement) 

# KinesisDataStreamDestination
<a name="API_KinesisDataStreamDestination"></a>

Describes a Kinesis data stream destination.

## Contents
<a name="API_KinesisDataStreamDestination_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ApproximateCreationDateTimePrecision **   <a name="DDB-Type-KinesisDataStreamDestination-ApproximateCreationDateTimePrecision"></a>
The precision of the Kinesis data stream timestamp. The values are either `MILLISECOND` or `MICROSECOND`.  
Type: String  
Valid Values: `MILLISECOND | MICROSECOND`   
Required: No

 ** DestinationStatus **   <a name="DDB-Type-KinesisDataStreamDestination-DestinationStatus"></a>
The current status of replication.  
Type: String  
Valid Values: `ENABLING | ACTIVE | DISABLING | DISABLED | ENABLE_FAILED | UPDATING`   
Required: No

 ** DestinationStatusDescription **   <a name="DDB-Type-KinesisDataStreamDestination-DestinationStatusDescription"></a>
The human-readable string that corresponds to the replica status.  
Type: String  
Required: No

 ** StreamArn **   <a name="DDB-Type-KinesisDataStreamDestination-StreamArn"></a>
The ARN for a specific Kinesis data stream.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

## See Also
<a name="API_KinesisDataStreamDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/KinesisDataStreamDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/KinesisDataStreamDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/KinesisDataStreamDestination) 

# LocalSecondaryIndex
<a name="API_LocalSecondaryIndex"></a>

Represents the properties of a local secondary index.

## Contents
<a name="API_LocalSecondaryIndex_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-LocalSecondaryIndex-IndexName"></a>
The name of the local secondary index. The name must be unique among all other indexes on this table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** KeySchema **   <a name="DDB-Type-LocalSecondaryIndex-KeySchema"></a>
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.
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** Projection **   <a name="DDB-Type-LocalSecondaryIndex-Projection"></a>
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.   
Type: [Projection](API_Projection.md) object  
Required: Yes

## See Also
<a name="API_LocalSecondaryIndex_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/LocalSecondaryIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/LocalSecondaryIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/LocalSecondaryIndex) 

# LocalSecondaryIndexDescription
<a name="API_LocalSecondaryIndexDescription"></a>

Represents the properties of a local secondary index.

## Contents
<a name="API_LocalSecondaryIndexDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexArn **   <a name="DDB-Type-LocalSecondaryIndexDescription-IndexArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the index.  
Type: String  
Required: No

 ** IndexName **   <a name="DDB-Type-LocalSecondaryIndexDescription-IndexName"></a>
Represents the name of the local secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** IndexSizeBytes **   <a name="DDB-Type-LocalSecondaryIndexDescription-IndexSizeBytes"></a>
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.  
Type: Long  
Required: No

 ** ItemCount **   <a name="DDB-Type-LocalSecondaryIndexDescription-ItemCount"></a>
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.  
Type: Long  
Required: No

 ** KeySchema **   <a name="DDB-Type-LocalSecondaryIndexDescription-KeySchema"></a>
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.
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** Projection **   <a name="DDB-Type-LocalSecondaryIndexDescription-Projection"></a>
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.   
Type: [Projection](API_Projection.md) object  
Required: No

## See Also
<a name="API_LocalSecondaryIndexDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/LocalSecondaryIndexDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/LocalSecondaryIndexDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/LocalSecondaryIndexDescription) 

# LocalSecondaryIndexInfo
<a name="API_LocalSecondaryIndexInfo"></a>

Represents the properties of a local secondary index for the table when the backup was created.

## Contents
<a name="API_LocalSecondaryIndexInfo_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-LocalSecondaryIndexInfo-IndexName"></a>
Represents the name of the local secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** KeySchema **   <a name="DDB-Type-LocalSecondaryIndexInfo-KeySchema"></a>
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.
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** Projection **   <a name="DDB-Type-LocalSecondaryIndexInfo-Projection"></a>
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.   
Type: [Projection](API_Projection.md) object  
Required: No

## See Also
<a name="API_LocalSecondaryIndexInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/LocalSecondaryIndexInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/LocalSecondaryIndexInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/LocalSecondaryIndexInfo) 

# OnDemandThroughput
<a name="API_OnDemandThroughput"></a>

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.

## Contents
<a name="API_OnDemandThroughput_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** MaxReadRequestUnits **   <a name="DDB-Type-OnDemandThroughput-MaxReadRequestUnits"></a>
Maximum number of read request units for the specified table.  
To specify a maximum `OnDemandThroughput` on your table, set the value of `MaxReadRequestUnits` as greater than or equal to 1. To remove the maximum `OnDemandThroughput` that is currently set on your table, set the value of `MaxReadRequestUnits` to -1.  
Type: Long  
Required: No

 ** MaxWriteRequestUnits **   <a name="DDB-Type-OnDemandThroughput-MaxWriteRequestUnits"></a>
Maximum number of write request units for the specified table.  
To specify a maximum `OnDemandThroughput` on your table, set the value of `MaxWriteRequestUnits` as greater than or equal to 1. To remove the maximum `OnDemandThroughput` that is currently set on your table, set the value of `MaxWriteRequestUnits` to -1.  
Type: Long  
Required: No

## See Also
<a name="API_OnDemandThroughput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/OnDemandThroughput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/OnDemandThroughput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/OnDemandThroughput) 

# OnDemandThroughputOverride
<a name="API_OnDemandThroughputOverride"></a>

Overrides the on-demand throughput settings for this replica table. If you don't specify a value for this parameter, it uses the source table's on-demand throughput settings.

## Contents
<a name="API_OnDemandThroughputOverride_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** MaxReadRequestUnits **   <a name="DDB-Type-OnDemandThroughputOverride-MaxReadRequestUnits"></a>
Maximum number of read request units for the specified replica table.  
Type: Long  
Required: No

## See Also
<a name="API_OnDemandThroughputOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/OnDemandThroughputOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/OnDemandThroughputOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/OnDemandThroughputOverride) 

# ParameterizedStatement
<a name="API_ParameterizedStatement"></a>

 Represents a PartiQL statement that uses parameters. 

## Contents
<a name="API_ParameterizedStatement_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Statement **   <a name="DDB-Type-ParameterizedStatement-Statement"></a>
 A PartiQL statement that uses parameters.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: Yes

 ** Parameters **   <a name="DDB-Type-ParameterizedStatement-Parameters"></a>
 The parameter values.   
Type: Array of [AttributeValue](API_AttributeValue.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** ReturnValuesOnConditionCheckFailure **   <a name="DDB-Type-ParameterizedStatement-ReturnValuesOnConditionCheckFailure"></a>
An optional parameter that returns the item attributes for a PartiQL `ParameterizedStatement` operation that failed a condition check.  
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.  
Type: String  
Valid Values: `ALL_OLD | NONE`   
Required: No

## See Also
<a name="API_ParameterizedStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ParameterizedStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ParameterizedStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ParameterizedStatement) 

# PointInTimeRecoveryDescription
<a name="API_PointInTimeRecoveryDescription"></a>

The description of the point in time settings applied to the table.

## Contents
<a name="API_PointInTimeRecoveryDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** EarliestRestorableDateTime **   <a name="DDB-Type-PointInTimeRecoveryDescription-EarliestRestorableDateTime"></a>
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.   
Type: Timestamp  
Required: No

 ** LatestRestorableDateTime **   <a name="DDB-Type-PointInTimeRecoveryDescription-LatestRestorableDateTime"></a>
 `LatestRestorableDateTime` is typically 5 minutes before the current time.   
Type: Timestamp  
Required: No

 ** PointInTimeRecoveryStatus **   <a name="DDB-Type-PointInTimeRecoveryDescription-PointInTimeRecoveryStatus"></a>
The current state of point in time recovery:  
+  `ENABLED` - Point in time recovery is enabled.
+  `DISABLED` - Point in time recovery is disabled.
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** RecoveryPeriodInDays **   <a name="DDB-Type-PointInTimeRecoveryDescription-RecoveryPeriodInDays"></a>
The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 35.  
Required: No

## See Also
<a name="API_PointInTimeRecoveryDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PointInTimeRecoveryDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/PointInTimeRecoveryDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/PointInTimeRecoveryDescription) 

# PointInTimeRecoverySpecification
<a name="API_PointInTimeRecoverySpecification"></a>

Represents the settings used to enable point in time recovery.

## Contents
<a name="API_PointInTimeRecoverySpecification_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** PointInTimeRecoveryEnabled **   <a name="DDB-Type-PointInTimeRecoverySpecification-PointInTimeRecoveryEnabled"></a>
Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.  
Type: Boolean  
Required: Yes

 ** RecoveryPeriodInDays **   <a name="DDB-Type-PointInTimeRecoverySpecification-RecoveryPeriodInDays"></a>
The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 35.  
Required: No

## See Also
<a name="API_PointInTimeRecoverySpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PointInTimeRecoverySpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/PointInTimeRecoverySpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/PointInTimeRecoverySpecification) 

# Projection
<a name="API_Projection"></a>

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.

## Contents
<a name="API_Projection_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** NonKeyAttributes **   <a name="DDB-Type-Projection-NonKeyAttributes"></a>
Represents the non-key attribute names which will be projected into the index.  
For global and local secondary indexes, the total count of `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. This limit only applies when you specify the ProjectionType of `INCLUDE`. You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** ProjectionType **   <a name="DDB-Type-Projection-ProjectionType"></a>
The set of attributes that are projected into the index:  
+  `KEYS_ONLY` - Only the index and primary keys are projected into the index.
+  `INCLUDE` - In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non-key attributes that you specify.
+  `ALL` - All of the table attributes are projected into the index.
When using the DynamoDB console, `ALL` is selected by default.  
Type: String  
Valid Values: `ALL | KEYS_ONLY | INCLUDE`   
Required: No

## See Also
<a name="API_Projection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Projection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Projection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Projection) 

# ProvisionedThroughput
<a name="API_ProvisionedThroughput"></a>

Represents the provisioned throughput settings for the specified global secondary index. You must use `ProvisionedThroughput` or `OnDemandThroughput` based on your table’s capacity mode.

For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.

## Contents
<a name="API_ProvisionedThroughput_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ReadCapacityUnits **   <a name="DDB-Type-ProvisionedThroughput-ReadCapacityUnits"></a>
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/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.  
If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

 ** WriteCapacityUnits **   <a name="DDB-Type-ProvisionedThroughput-WriteCapacityUnits"></a>
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/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.  
If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

## See Also
<a name="API_ProvisionedThroughput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ProvisionedThroughput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ProvisionedThroughput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ProvisionedThroughput) 

# ProvisionedThroughputDescription
<a name="API_ProvisionedThroughputDescription"></a>

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

## Contents
<a name="API_ProvisionedThroughputDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** LastDecreaseDateTime **   <a name="DDB-Type-ProvisionedThroughputDescription-LastDecreaseDateTime"></a>
The date and time of the last provisioned throughput decrease for this table.  
Type: Timestamp  
Required: No

 ** LastIncreaseDateTime **   <a name="DDB-Type-ProvisionedThroughputDescription-LastIncreaseDateTime"></a>
The date and time of the last provisioned throughput increase for this table.  
Type: Timestamp  
Required: No

 ** NumberOfDecreasesToday **   <a name="DDB-Type-ProvisionedThroughputDescription-NumberOfDecreasesToday"></a>
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** ReadCapacityUnits **   <a name="DDB-Type-ProvisionedThroughputDescription-ReadCapacityUnits"></a>
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.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** WriteCapacityUnits **   <a name="DDB-Type-ProvisionedThroughputDescription-WriteCapacityUnits"></a>
The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_ProvisionedThroughputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ProvisionedThroughputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ProvisionedThroughputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ProvisionedThroughputDescription) 

# ProvisionedThroughputOverride
<a name="API_ProvisionedThroughputOverride"></a>

Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.

## Contents
<a name="API_ProvisionedThroughputOverride_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ReadCapacityUnits **   <a name="DDB-Type-ProvisionedThroughputOverride-ReadCapacityUnits"></a>
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_ProvisionedThroughputOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ProvisionedThroughputOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ProvisionedThroughputOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ProvisionedThroughputOverride) 

# Put
<a name="API_Put"></a>

Represents a request to perform a `PutItem` operation.

## Contents
<a name="API_Put_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Item **   <a name="DDB-Type-Put-Item"></a>
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.   
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

 ** TableName **   <a name="DDB-Type-Put-TableName"></a>
Name of the table in which to write the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ConditionExpression **   <a name="DDB-Type-Put-ConditionExpression"></a>
A condition that must be satisfied in order for a conditional update to succeed.  
Type: String  
Required: No

 ** ExpressionAttributeNames **   <a name="DDB-Type-Put-ExpressionAttributeNames"></a>
One or more substitution tokens for attribute names in an expression.  
Type: String to string map  
Value Length Constraints: Maximum length of 65535.  
Required: No

 ** ExpressionAttributeValues **   <a name="DDB-Type-Put-ExpressionAttributeValues"></a>
One or more values that can be substituted in an expression.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Required: No

 ** ReturnValuesOnConditionCheckFailure **   <a name="DDB-Type-Put-ReturnValuesOnConditionCheckFailure"></a>
Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Put` condition fails. For `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL\$1OLD.  
Type: String  
Valid Values: `ALL_OLD | NONE`   
Required: No

## See Also
<a name="API_Put_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Put) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Put) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Put) 

# PutRequest
<a name="API_PutRequest"></a>

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

## Contents
<a name="API_PutRequest_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Item **   <a name="DDB-Type-PutRequest-Item"></a>
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.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

## See Also
<a name="API_PutRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/PutRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/PutRequest) 

# Replica
<a name="API_Replica"></a>

Represents the properties of a replica.

## Contents
<a name="API_Replica_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-Replica-RegionName"></a>
The Region where the replica needs to be created.  
Type: String  
Required: No

## See Also
<a name="API_Replica_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Replica) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Replica) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Replica) 

# ReplicaAutoScalingDescription
<a name="API_ReplicaAutoScalingDescription"></a>

Represents the auto scaling settings of the replica.

## Contents
<a name="API_ReplicaAutoScalingDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-ReplicaAutoScalingDescription-GlobalSecondaryIndexes"></a>
Replica-specific global secondary index auto scaling settings.  
Type: Array of [ReplicaGlobalSecondaryIndexAutoScalingDescription](API_ReplicaGlobalSecondaryIndexAutoScalingDescription.md) objects  
Required: No

 ** RegionName **   <a name="DDB-Type-ReplicaAutoScalingDescription-RegionName"></a>
The Region where the replica exists.  
Type: String  
Required: No

 ** ReplicaProvisionedReadCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaAutoScalingDescription-ReplicaProvisionedReadCapacityAutoScalingSettings"></a>
Represents the auto scaling settings for a global table or global secondary index.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

 ** ReplicaProvisionedWriteCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaAutoScalingDescription-ReplicaProvisionedWriteCapacityAutoScalingSettings"></a>
Represents the auto scaling settings for a global table or global secondary index.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

 ** ReplicaStatus **   <a name="DDB-Type-ReplicaAutoScalingDescription-ReplicaStatus"></a>
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.
Type: String  
Valid Values: `CREATING | CREATION_FAILED | UPDATING | DELETING | ACTIVE | REGION_DISABLED | INACCESSIBLE_ENCRYPTION_CREDENTIALS | ARCHIVING | ARCHIVED | REPLICATION_NOT_AUTHORIZED`   
Required: No

## See Also
<a name="API_ReplicaAutoScalingDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaAutoScalingDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaAutoScalingDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaAutoScalingDescription) 

# ReplicaAutoScalingUpdate
<a name="API_ReplicaAutoScalingUpdate"></a>

Represents the auto scaling settings of a replica that will be modified.

## Contents
<a name="API_ReplicaAutoScalingUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-ReplicaAutoScalingUpdate-RegionName"></a>
The Region where the replica exists.  
Type: String  
Required: Yes

 ** ReplicaGlobalSecondaryIndexUpdates **   <a name="DDB-Type-ReplicaAutoScalingUpdate-ReplicaGlobalSecondaryIndexUpdates"></a>
Represents the auto scaling settings of global secondary indexes that will be modified.  
Type: Array of [ReplicaGlobalSecondaryIndexAutoScalingUpdate](API_ReplicaGlobalSecondaryIndexAutoScalingUpdate.md) objects  
Required: No

 ** ReplicaProvisionedReadCapacityAutoScalingUpdate **   <a name="DDB-Type-ReplicaAutoScalingUpdate-ReplicaProvisionedReadCapacityAutoScalingUpdate"></a>
Represents the auto scaling settings to be modified for a global table or global secondary index.  
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object  
Required: No

## See Also
<a name="API_ReplicaAutoScalingUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaAutoScalingUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaAutoScalingUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaAutoScalingUpdate) 

# ReplicaDescription
<a name="API_ReplicaDescription"></a>

Contains the details of the replica.

## Contents
<a name="API_ReplicaDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-ReplicaDescription-GlobalSecondaryIndexes"></a>
Replica-specific global secondary index settings.  
Type: Array of [ReplicaGlobalSecondaryIndexDescription](API_ReplicaGlobalSecondaryIndexDescription.md) objects  
Required: No

 ** GlobalTableSettingsReplicationMode **   <a name="DDB-Type-ReplicaDescription-GlobalTableSettingsReplicationMode"></a>
Indicates one of the settings synchronization modes for the global table replica:  
+  `ENABLED`: Indicates that the settings synchronization mode for the global table replica is enabled.
+  `DISABLED`: Indicates that the settings synchronization mode for the global table replica is disabled.
+  `ENABLED_WITH_OVERRIDES`: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.
Type: String  
Valid Values: `ENABLED | DISABLED | ENABLED_WITH_OVERRIDES`   
Required: No

 ** KMSMasterKeyId **   <a name="DDB-Type-ReplicaDescription-KMSMasterKeyId"></a>
The AWS KMS key of the replica that will be used for AWS KMS encryption.  
Type: String  
Required: No

 ** OnDemandThroughputOverride **   <a name="DDB-Type-ReplicaDescription-OnDemandThroughputOverride"></a>
Overrides the maximum on-demand throughput settings for the specified replica table.  
Type: [OnDemandThroughputOverride](API_OnDemandThroughputOverride.md) object  
Required: No

 ** ProvisionedThroughputOverride **   <a name="DDB-Type-ReplicaDescription-ProvisionedThroughputOverride"></a>
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.  
Type: [ProvisionedThroughputOverride](API_ProvisionedThroughputOverride.md) object  
Required: No

 ** RegionName **   <a name="DDB-Type-ReplicaDescription-RegionName"></a>
The name of the Region.  
Type: String  
Required: No

 ** ReplicaArn **   <a name="DDB-Type-ReplicaDescription-ReplicaArn"></a>
The Amazon Resource Name (ARN) of the global table replica.  
Type: String  
Required: No

 ** ReplicaInaccessibleDateTime **   <a name="DDB-Type-ReplicaDescription-ReplicaInaccessibleDateTime"></a>
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the `ReplicaStatus` property.  
Type: Timestamp  
Required: No

 ** ReplicaStatus **   <a name="DDB-Type-ReplicaDescription-ReplicaStatus"></a>
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.
+  `REGION_DISABLED` - The replica is inaccessible because the AWS Region has been disabled.
**Note**  
If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
+  `INACCESSIBLE_ENCRYPTION_CREDENTIALS ` - The AWS KMS key used to encrypt the table is inaccessible.
**Note**  
If the AWS KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
Type: String  
Valid Values: `CREATING | CREATION_FAILED | UPDATING | DELETING | ACTIVE | REGION_DISABLED | INACCESSIBLE_ENCRYPTION_CREDENTIALS | ARCHIVING | ARCHIVED | REPLICATION_NOT_AUTHORIZED`   
Required: No

 ** ReplicaStatusDescription **   <a name="DDB-Type-ReplicaDescription-ReplicaStatusDescription"></a>
Detailed information about the replica status.  
Type: String  
Required: No

 ** ReplicaStatusPercentProgress **   <a name="DDB-Type-ReplicaDescription-ReplicaStatusPercentProgress"></a>
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.  
Type: String  
Required: No

 ** ReplicaTableClassSummary **   <a name="DDB-Type-ReplicaDescription-ReplicaTableClassSummary"></a>
Contains details of the table class.  
Type: [TableClassSummary](API_TableClassSummary.md) object  
Required: No

 ** WarmThroughput **   <a name="DDB-Type-ReplicaDescription-WarmThroughput"></a>
Represents the warm throughput value for this replica.  
Type: [TableWarmThroughputDescription](API_TableWarmThroughputDescription.md) object  
Required: No

## See Also
<a name="API_ReplicaDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaDescription) 

# ReplicaGlobalSecondaryIndex
<a name="API_ReplicaGlobalSecondaryIndex"></a>

Represents the properties of a replica global secondary index.

## Contents
<a name="API_ReplicaGlobalSecondaryIndex_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-ReplicaGlobalSecondaryIndex-IndexName"></a>
The name of the global secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** OnDemandThroughputOverride **   <a name="DDB-Type-ReplicaGlobalSecondaryIndex-OnDemandThroughputOverride"></a>
Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.  
Type: [OnDemandThroughputOverride](API_OnDemandThroughputOverride.md) object  
Required: No

 ** ProvisionedThroughputOverride **   <a name="DDB-Type-ReplicaGlobalSecondaryIndex-ProvisionedThroughputOverride"></a>
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.  
Type: [ProvisionedThroughputOverride](API_ProvisionedThroughputOverride.md) object  
Required: No

## See Also
<a name="API_ReplicaGlobalSecondaryIndex_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndex) 

# ReplicaGlobalSecondaryIndexAutoScalingDescription
<a name="API_ReplicaGlobalSecondaryIndexAutoScalingDescription"></a>

Represents the auto scaling configuration for a replica global secondary index.

## Contents
<a name="API_ReplicaGlobalSecondaryIndexAutoScalingDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexAutoScalingDescription-IndexName"></a>
The name of the global secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** IndexStatus **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexAutoScalingDescription-IndexStatus"></a>
The current state of the replica global secondary index:  
+  `CREATING` - The index is being created.
+  `UPDATING` - The table/index configuration is being updated. The table/index remains available for data operations when `UPDATING` 
+  `DELETING` - The index is being deleted.
+  `ACTIVE` - The index is ready for use.
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE`   
Required: No

 ** ProvisionedReadCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexAutoScalingDescription-ProvisionedReadCapacityAutoScalingSettings"></a>
Represents the auto scaling settings for a global table or global secondary index.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

 ** ProvisionedWriteCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexAutoScalingDescription-ProvisionedWriteCapacityAutoScalingSettings"></a>
Represents the auto scaling settings for a global table or global secondary index.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

## See Also
<a name="API_ReplicaGlobalSecondaryIndexAutoScalingDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexAutoScalingDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexAutoScalingDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexAutoScalingDescription) 

# ReplicaGlobalSecondaryIndexAutoScalingUpdate
<a name="API_ReplicaGlobalSecondaryIndexAutoScalingUpdate"></a>

Represents the auto scaling settings of a global secondary index for a replica that will be modified.

## Contents
<a name="API_ReplicaGlobalSecondaryIndexAutoScalingUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexAutoScalingUpdate-IndexName"></a>
The name of the global secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** ProvisionedReadCapacityAutoScalingUpdate **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexAutoScalingUpdate-ProvisionedReadCapacityAutoScalingUpdate"></a>
Represents the auto scaling settings to be modified for a global table or global secondary index.  
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object  
Required: No

## See Also
<a name="API_ReplicaGlobalSecondaryIndexAutoScalingUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexAutoScalingUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexAutoScalingUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexAutoScalingUpdate) 

# ReplicaGlobalSecondaryIndexDescription
<a name="API_ReplicaGlobalSecondaryIndexDescription"></a>

Represents the properties of a replica global secondary index.

## Contents
<a name="API_ReplicaGlobalSecondaryIndexDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexDescription-IndexName"></a>
The name of the global secondary index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** OnDemandThroughputOverride **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexDescription-OnDemandThroughputOverride"></a>
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.  
Type: [OnDemandThroughputOverride](API_OnDemandThroughputOverride.md) object  
Required: No

 ** ProvisionedThroughputOverride **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexDescription-ProvisionedThroughputOverride"></a>
If not described, uses the source table GSI's read capacity settings.  
Type: [ProvisionedThroughputOverride](API_ProvisionedThroughputOverride.md) object  
Required: No

 ** WarmThroughput **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexDescription-WarmThroughput"></a>
Represents the warm throughput of the global secondary index for this replica.  
Type: [GlobalSecondaryIndexWarmThroughputDescription](API_GlobalSecondaryIndexWarmThroughputDescription.md) object  
Required: No

## See Also
<a name="API_ReplicaGlobalSecondaryIndexDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexDescription) 

# ReplicaGlobalSecondaryIndexSettingsDescription
<a name="API_ReplicaGlobalSecondaryIndexSettingsDescription"></a>

Represents the properties of a global secondary index.

## Contents
<a name="API_ReplicaGlobalSecondaryIndexSettingsDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsDescription-IndexName"></a>
The name of the global secondary index. The name must be unique among all other indexes on this table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** IndexStatus **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsDescription-IndexStatus"></a>
 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.
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE`   
Required: No

 ** ProvisionedReadCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsDescription-ProvisionedReadCapacityAutoScalingSettings"></a>
Auto scaling settings for a global secondary index replica's read capacity units.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

 ** ProvisionedReadCapacityUnits **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsDescription-ProvisionedReadCapacityUnits"></a>
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** ProvisionedWriteCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsDescription-ProvisionedWriteCapacityAutoScalingSettings"></a>
Auto scaling settings for a global secondary index replica's write capacity units.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

 ** ProvisionedWriteCapacityUnits **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsDescription-ProvisionedWriteCapacityUnits"></a>
The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_ReplicaGlobalSecondaryIndexSettingsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexSettingsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexSettingsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexSettingsDescription) 

# ReplicaGlobalSecondaryIndexSettingsUpdate
<a name="API_ReplicaGlobalSecondaryIndexSettingsUpdate"></a>

Represents the settings of a global secondary index for a global table that will be modified.

## Contents
<a name="API_ReplicaGlobalSecondaryIndexSettingsUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsUpdate-IndexName"></a>
The name of the global secondary index. The name must be unique among all other indexes on this table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** ProvisionedReadCapacityAutoScalingSettingsUpdate **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsUpdate-ProvisionedReadCapacityAutoScalingSettingsUpdate"></a>
Auto scaling settings for managing a global secondary index replica's read capacity units.  
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object  
Required: No

 ** ProvisionedReadCapacityUnits **   <a name="DDB-Type-ReplicaGlobalSecondaryIndexSettingsUpdate-ProvisionedReadCapacityUnits"></a>
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_ReplicaGlobalSecondaryIndexSettingsUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexSettingsUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexSettingsUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaGlobalSecondaryIndexSettingsUpdate) 

# ReplicaSettingsDescription
<a name="API_ReplicaSettingsDescription"></a>

Represents the properties of a replica.

## Contents
<a name="API_ReplicaSettingsDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-ReplicaSettingsDescription-RegionName"></a>
The Region name of the replica.  
Type: String  
Required: Yes

 ** ReplicaBillingModeSummary **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaBillingModeSummary"></a>
The read/write capacity mode of the replica.  
Type: [BillingModeSummary](API_BillingModeSummary.md) object  
Required: No

 ** ReplicaGlobalSecondaryIndexSettings **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaGlobalSecondaryIndexSettings"></a>
Replica global secondary index settings for the global table.  
Type: Array of [ReplicaGlobalSecondaryIndexSettingsDescription](API_ReplicaGlobalSecondaryIndexSettingsDescription.md) objects  
Required: No

 ** ReplicaProvisionedReadCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaProvisionedReadCapacityAutoScalingSettings"></a>
Auto scaling settings for a global table replica's read capacity units.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

 ** ReplicaProvisionedReadCapacityUnits **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaProvisionedReadCapacityUnits"></a>
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*.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ReplicaProvisionedWriteCapacityAutoScalingSettings **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaProvisionedWriteCapacityAutoScalingSettings"></a>
Auto scaling settings for a global table replica's write capacity units.  
Type: [AutoScalingSettingsDescription](API_AutoScalingSettingsDescription.md) object  
Required: No

 ** ReplicaProvisionedWriteCapacityUnits **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaProvisionedWriteCapacityUnits"></a>
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*.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ReplicaStatus **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaStatus"></a>
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.
Type: String  
Valid Values: `CREATING | CREATION_FAILED | UPDATING | DELETING | ACTIVE | REGION_DISABLED | INACCESSIBLE_ENCRYPTION_CREDENTIALS | ARCHIVING | ARCHIVED | REPLICATION_NOT_AUTHORIZED`   
Required: No

 ** ReplicaTableClassSummary **   <a name="DDB-Type-ReplicaSettingsDescription-ReplicaTableClassSummary"></a>
Contains details of the table class.  
Type: [TableClassSummary](API_TableClassSummary.md) object  
Required: No

## See Also
<a name="API_ReplicaSettingsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaSettingsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaSettingsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaSettingsDescription) 

# ReplicaSettingsUpdate
<a name="API_ReplicaSettingsUpdate"></a>

Represents the settings for a global table in a Region that will be modified.

## Contents
<a name="API_ReplicaSettingsUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-ReplicaSettingsUpdate-RegionName"></a>
The Region of the replica to be added.  
Type: String  
Required: Yes

 ** ReplicaGlobalSecondaryIndexSettingsUpdate **   <a name="DDB-Type-ReplicaSettingsUpdate-ReplicaGlobalSecondaryIndexSettingsUpdate"></a>
Represents the settings of a global secondary index for a global table that will be modified.  
Type: Array of [ReplicaGlobalSecondaryIndexSettingsUpdate](API_ReplicaGlobalSecondaryIndexSettingsUpdate.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: No

 ** ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate **   <a name="DDB-Type-ReplicaSettingsUpdate-ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate"></a>
Auto scaling settings for managing a global table replica's read capacity units.  
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object  
Required: No

 ** ReplicaProvisionedReadCapacityUnits **   <a name="DDB-Type-ReplicaSettingsUpdate-ReplicaProvisionedReadCapacityUnits"></a>
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*.   
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** ReplicaTableClass **   <a name="DDB-Type-ReplicaSettingsUpdate-ReplicaTableClass"></a>
Replica-specific table class. If not specified, uses the source table's table class.  
Type: String  
Valid Values: `STANDARD | STANDARD_INFREQUENT_ACCESS`   
Required: No

## See Also
<a name="API_ReplicaSettingsUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaSettingsUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaSettingsUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaSettingsUpdate) 

# ReplicationGroupUpdate
<a name="API_ReplicationGroupUpdate"></a>

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.

**Note**  
When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.

## Contents
<a name="API_ReplicationGroupUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Create **   <a name="DDB-Type-ReplicationGroupUpdate-Create"></a>
The parameters required for creating a replica for the table.  
Type: [CreateReplicationGroupMemberAction](API_CreateReplicationGroupMemberAction.md) object  
Required: No

 ** Delete **   <a name="DDB-Type-ReplicationGroupUpdate-Delete"></a>
The parameters required for deleting a replica for the table.  
Type: [DeleteReplicationGroupMemberAction](API_DeleteReplicationGroupMemberAction.md) object  
Required: No

 ** Update **   <a name="DDB-Type-ReplicationGroupUpdate-Update"></a>
The parameters required for updating a replica for the table.  
Type: [UpdateReplicationGroupMemberAction](API_UpdateReplicationGroupMemberAction.md) object  
Required: No

## See Also
<a name="API_ReplicationGroupUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicationGroupUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicationGroupUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicationGroupUpdate) 

# ReplicaUpdate
<a name="API_ReplicaUpdate"></a>

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.

## Contents
<a name="API_ReplicaUpdate_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Create **   <a name="DDB-Type-ReplicaUpdate-Create"></a>
The parameters required for creating a replica on an existing global table.  
Type: [CreateReplicaAction](API_CreateReplicaAction.md) object  
Required: No

 ** Delete **   <a name="DDB-Type-ReplicaUpdate-Delete"></a>
The name of the existing replica to be removed.  
Type: [DeleteReplicaAction](API_DeleteReplicaAction.md) object  
Required: No

## See Also
<a name="API_ReplicaUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ReplicaUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ReplicaUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ReplicaUpdate) 

# RestoreSummary
<a name="API_RestoreSummary"></a>

Contains details for the restore.

## Contents
<a name="API_RestoreSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RestoreDateTime **   <a name="DDB-Type-RestoreSummary-RestoreDateTime"></a>
Point in time or source backup time.  
Type: Timestamp  
Required: Yes

 ** RestoreInProgress **   <a name="DDB-Type-RestoreSummary-RestoreInProgress"></a>
Indicates if a restore is in progress or not.  
Type: Boolean  
Required: Yes

 ** SourceBackupArn **   <a name="DDB-Type-RestoreSummary-SourceBackupArn"></a>
The Amazon Resource Name (ARN) of the backup from which the table was restored.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** SourceTableArn **   <a name="DDB-Type-RestoreSummary-SourceTableArn"></a>
The ARN of the source table of the backup that is being restored.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_RestoreSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/RestoreSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/RestoreSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/RestoreSummary) 

# S3BucketSource
<a name="API_S3BucketSource"></a>

 The S3 bucket that is being imported from. 

## Contents
<a name="API_S3BucketSource_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** S3Bucket **   <a name="DDB-Type-S3BucketSource-S3Bucket"></a>
 The S3 bucket that is being imported from.   
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `^[a-z0-9A-Z]+[\.\-\w]*[a-z0-9A-Z]+$`   
Required: Yes

 ** S3BucketOwner **   <a name="DDB-Type-S3BucketSource-S3BucketOwner"></a>
 The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.   
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** S3KeyPrefix **   <a name="DDB-Type-S3BucketSource-S3KeyPrefix"></a>
 The key prefix shared by all S3 Objects that are being imported.   
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## See Also
<a name="API_S3BucketSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/S3BucketSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/S3BucketSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/S3BucketSource) 

# SourceTableDetails
<a name="API_SourceTableDetails"></a>

Contains the details of the table when the backup was created. 

## Contents
<a name="API_SourceTableDetails_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** KeySchema **   <a name="DDB-Type-SourceTableDetails-KeySchema"></a>
Schema of the table.   
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** ProvisionedThroughput **   <a name="DDB-Type-SourceTableDetails-ProvisionedThroughput"></a>
Read IOPs and Write IOPS on the table when the backup was created.  
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object  
Required: Yes

 ** TableCreationDateTime **   <a name="DDB-Type-SourceTableDetails-TableCreationDateTime"></a>
Time when the source table was created.   
Type: Timestamp  
Required: Yes

 ** TableId **   <a name="DDB-Type-SourceTableDetails-TableId"></a>
Unique identifier for the table for which the backup was created.   
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** TableName **   <a name="DDB-Type-SourceTableDetails-TableName"></a>
The name of the table for which the backup was created.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** BillingMode **   <a name="DDB-Type-SourceTableDetails-BillingMode"></a>
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. 
Type: String  
Valid Values: `PROVISIONED | PAY_PER_REQUEST`   
Required: No

 ** ItemCount **   <a name="DDB-Type-SourceTableDetails-ItemCount"></a>
Number of items in the table. Note that this is an approximate value.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** OnDemandThroughput **   <a name="DDB-Type-SourceTableDetails-OnDemandThroughput"></a>
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** TableArn **   <a name="DDB-Type-SourceTableDetails-TableArn"></a>
ARN of the table for which backup was created.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** TableSizeBytes **   <a name="DDB-Type-SourceTableDetails-TableSizeBytes"></a>
Size of the table in bytes. Note that this is an approximate value.  
Type: Long  
Required: No

## See Also
<a name="API_SourceTableDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/SourceTableDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/SourceTableDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/SourceTableDetails) 

# SourceTableFeatureDetails
<a name="API_SourceTableFeatureDetails"></a>

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL. 

## Contents
<a name="API_SourceTableFeatureDetails_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-SourceTableFeatureDetails-GlobalSecondaryIndexes"></a>
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.   
Type: Array of [GlobalSecondaryIndexInfo](API_GlobalSecondaryIndexInfo.md) objects  
Required: No

 ** LocalSecondaryIndexes **   <a name="DDB-Type-SourceTableFeatureDetails-LocalSecondaryIndexes"></a>
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.   
Type: Array of [LocalSecondaryIndexInfo](API_LocalSecondaryIndexInfo.md) objects  
Required: No

 ** SSEDescription **   <a name="DDB-Type-SourceTableFeatureDetails-SSEDescription"></a>
The description of the server-side encryption status on the table when the backup was created.  
Type: [SSEDescription](API_SSEDescription.md) object  
Required: No

 ** StreamDescription **   <a name="DDB-Type-SourceTableFeatureDetails-StreamDescription"></a>
Stream settings on the table when the backup was created.  
Type: [StreamSpecification](API_StreamSpecification.md) object  
Required: No

 ** TimeToLiveDescription **   <a name="DDB-Type-SourceTableFeatureDetails-TimeToLiveDescription"></a>
Time to Live settings on the table when the backup was created.  
Type: [TimeToLiveDescription](API_TimeToLiveDescription.md) object  
Required: No

## See Also
<a name="API_SourceTableFeatureDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/SourceTableFeatureDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/SourceTableFeatureDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/SourceTableFeatureDetails) 

# SSEDescription
<a name="API_SSEDescription"></a>

The description of the server-side encryption status on the specified table.

## Contents
<a name="API_SSEDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** InaccessibleEncryptionDateTime **   <a name="DDB-Type-SSEDescription-InaccessibleEncryptionDateTime"></a>
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.  
Type: Timestamp  
Required: No

 ** KMSMasterKeyArn **   <a name="DDB-Type-SSEDescription-KMSMasterKeyArn"></a>
The AWS KMS key ARN used for the AWS KMS encryption.  
Type: String  
Required: No

 ** SSEType **   <a name="DDB-Type-SSEDescription-SSEType"></a>
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).
Type: String  
Valid Values: `AES256 | KMS`   
Required: No

 ** Status **   <a name="DDB-Type-SSEDescription-Status"></a>
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.
Type: String  
Valid Values: `ENABLING | ENABLED | DISABLING | DISABLED | UPDATING`   
Required: No

## See Also
<a name="API_SSEDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/SSEDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/SSEDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/SSEDescription) 

# SSESpecification
<a name="API_SSESpecification"></a>

Represents the settings used to enable server-side encryption.

## Contents
<a name="API_SSESpecification_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Enabled **   <a name="DDB-Type-SSESpecification-Enabled"></a>
Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to `KMS` and an AWS managed key is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.  
Type: Boolean  
Required: No

 ** KMSMasterKeyId **   <a name="DDB-Type-SSESpecification-KMSMasterKeyId"></a>
The AWS KMS key that should be used for the AWS KMS encryption. To specify a key, 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 key `alias/aws/dynamodb`.  
Type: String  
Required: No

 ** SSEType **   <a name="DDB-Type-SSESpecification-SSEType"></a>
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).
Type: String  
Valid Values: `AES256 | KMS`   
Required: No

## See Also
<a name="API_SSESpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/SSESpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/SSESpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/SSESpecification) 

# StreamSpecification
<a name="API_StreamSpecification"></a>

Represents the DynamoDB Streams configuration for a table in DynamoDB.

## Contents
<a name="API_StreamSpecification_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** StreamEnabled **   <a name="DDB-Type-StreamSpecification-StreamEnabled"></a>
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.  
Type: Boolean  
Required: Yes

 ** StreamViewType **   <a name="DDB-Type-StreamSpecification-StreamViewType"></a>
 When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table. 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.
Type: String  
Valid Values: `NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY`   
Required: No

## See Also
<a name="API_StreamSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/StreamSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/StreamSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/StreamSpecification) 

# TableAutoScalingDescription
<a name="API_TableAutoScalingDescription"></a>

Represents the auto scaling configuration for a global table.

## Contents
<a name="API_TableAutoScalingDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Replicas **   <a name="DDB-Type-TableAutoScalingDescription-Replicas"></a>
Represents replicas of the global table.  
Type: Array of [ReplicaAutoScalingDescription](API_ReplicaAutoScalingDescription.md) objects  
Required: No

 ** TableName **   <a name="DDB-Type-TableAutoScalingDescription-TableName"></a>
The name of the table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** TableStatus **   <a name="DDB-Type-TableAutoScalingDescription-TableStatus"></a>
The current state of the table:  
+  `CREATING` - The table is being created.
+  `UPDATING` - The table is being updated.
+  `DELETING` - The table is being deleted.
+  `ACTIVE` - The table is ready for use.
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | INACCESSIBLE_ENCRYPTION_CREDENTIALS | ARCHIVING | ARCHIVED | REPLICATION_NOT_AUTHORIZED`   
Required: No

## See Also
<a name="API_TableAutoScalingDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TableAutoScalingDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TableAutoScalingDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TableAutoScalingDescription) 

# TableClassSummary
<a name="API_TableClassSummary"></a>

Contains details of the table class.

## Contents
<a name="API_TableClassSummary_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** LastUpdateDateTime **   <a name="DDB-Type-TableClassSummary-LastUpdateDateTime"></a>
The date and time at which the table class was last updated.  
Type: Timestamp  
Required: No

 ** TableClass **   <a name="DDB-Type-TableClassSummary-TableClass"></a>
The table class of the specified table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`.  
Type: String  
Valid Values: `STANDARD | STANDARD_INFREQUENT_ACCESS`   
Required: No

## See Also
<a name="API_TableClassSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TableClassSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TableClassSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TableClassSummary) 

# TableCreationParameters
<a name="API_TableCreationParameters"></a>

 The parameters for the table created as part of the import operation. 

## Contents
<a name="API_TableCreationParameters_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AttributeDefinitions **   <a name="DDB-Type-TableCreationParameters-AttributeDefinitions"></a>
 The attributes of the table created as part of the import operation.   
Type: Array of [AttributeDefinition](API_AttributeDefinition.md) objects  
Required: Yes

 ** KeySchema **   <a name="DDB-Type-TableCreationParameters-KeySchema"></a>
 The primary key and option sort key of the table created as part of the import operation.   
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** TableName **   <a name="DDB-Type-TableCreationParameters-TableName"></a>
 The name of the table created as part of the import operation.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** BillingMode **   <a name="DDB-Type-TableCreationParameters-BillingMode"></a>
 The billing mode for provisioning the table created as part of the import operation.   
Type: String  
Valid Values: `PROVISIONED | PAY_PER_REQUEST`   
Required: No

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-TableCreationParameters-GlobalSecondaryIndexes"></a>
 The Global Secondary Indexes (GSI) of the table to be created as part of the import operation.   
Type: Array of [GlobalSecondaryIndex](API_GlobalSecondaryIndex.md) objects  
Required: No

 ** OnDemandThroughput **   <a name="DDB-Type-TableCreationParameters-OnDemandThroughput"></a>
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** ProvisionedThroughput **   <a name="DDB-Type-TableCreationParameters-ProvisionedThroughput"></a>
Represents the provisioned throughput settings for the specified global secondary index. You must use `ProvisionedThroughput` or `OnDemandThroughput` based on your table’s capacity mode.  
For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.  
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object  
Required: No

 ** SSESpecification **   <a name="DDB-Type-TableCreationParameters-SSESpecification"></a>
Represents the settings used to enable server-side encryption.  
Type: [SSESpecification](API_SSESpecification.md) object  
Required: No

## See Also
<a name="API_TableCreationParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TableCreationParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TableCreationParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TableCreationParameters) 

# TableDescription
<a name="API_TableDescription"></a>

Represents the properties of a table.

## Contents
<a name="API_TableDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ArchivalSummary **   <a name="DDB-Type-TableDescription-ArchivalSummary"></a>
Contains information about the table archive.  
Type: [ArchivalSummary](API_ArchivalSummary.md) object  
Required: No

 ** AttributeDefinitions **   <a name="DDB-Type-TableDescription-AttributeDefinitions"></a>
An array of `AttributeDefinition` objects. Each of these objects describes one attribute in the table and index key schema.  
Each `AttributeDefinition` object in this array is composed of:  
+  `AttributeName` - The name of the attribute.
+  `AttributeType` - The data type for the attribute.
Type: Array of [AttributeDefinition](API_AttributeDefinition.md) objects  
Required: No

 ** BillingModeSummary **   <a name="DDB-Type-TableDescription-BillingModeSummary"></a>
Contains the details for the read/write capacity mode.  
Type: [BillingModeSummary](API_BillingModeSummary.md) object  
Required: No

 ** CreationDateTime **   <a name="DDB-Type-TableDescription-CreationDateTime"></a>
The date and time when the table was created, in [UNIX epoch time](http://www.epochconverter.com/) format.  
Type: Timestamp  
Required: No

 ** DeletionProtectionEnabled **   <a name="DDB-Type-TableDescription-DeletionProtectionEnabled"></a>
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.  
Type: Boolean  
Required: No

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-TableDescription-GlobalSecondaryIndexes"></a>
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:  
+  `Backfilling` - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a `CreateTable` operation.) 

   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. (This attribute does not appear for indexes that were created during a `CreateTable` operation.)
+  `IndexName` - The name of the global secondary index.
+  `IndexSizeBytes` - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. 
+  `IndexStatus` - The current status 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.
+  `ItemCount` - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. 
+  `KeySchema` - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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` - In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non-key attributes that you specify.
    +  `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. This limit only applies when you specify the ProjectionType of `INCLUDE`. You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes.
+  `ProvisionedThroughput` - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. 
If the table is in the `DELETING` state, no information about indexes will be returned.  
Type: Array of [GlobalSecondaryIndexDescription](API_GlobalSecondaryIndexDescription.md) objects  
Required: No

 ** GlobalTableSettingsReplicationMode **   <a name="DDB-Type-TableDescription-GlobalTableSettingsReplicationMode"></a>
Indicates one of the settings synchronization modes for the global table:  
+  `ENABLED`: Indicates that the settings synchronization mode for the global table is enabled.
+  `DISABLED`: Indicates that the settings synchronization mode for the global table is disabled.
+  `ENABLED_WITH_OVERRIDES`: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.
Type: String  
Valid Values: `ENABLED | DISABLED | ENABLED_WITH_OVERRIDES`   
Required: No

 ** GlobalTableVersion **   <a name="DDB-Type-TableDescription-GlobalTableVersion"></a>
Represents the version of [global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) in use, if the table is replicated across AWS Regions.  
Type: String  
Required: No

 ** GlobalTableWitnesses **   <a name="DDB-Type-TableDescription-GlobalTableWitnesses"></a>
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.  
Type: Array of [GlobalTableWitnessDescription](API_GlobalTableWitnessDescription.md) objects  
Required: No

 ** ItemCount **   <a name="DDB-Type-TableDescription-ItemCount"></a>
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.  
Type: Long  
Required: No

 ** KeySchema **   <a name="DDB-Type-TableDescription-KeySchema"></a>
The primary key structure for the table. Each `KeySchemaElement` consists of:  
+  `AttributeName` - The name of the attribute.
+  `KeyType` - The role of the attribute:
  +  `HASH` - partition key
  +  `RANGE` - sort key
**Note**  
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.
For more information about primary keys, see [Primary Key](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey) in the *Amazon DynamoDB Developer Guide*.  
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** LatestStreamArn **   <a name="DDB-Type-TableDescription-LatestStreamArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** LatestStreamLabel **   <a name="DDB-Type-TableDescription-LatestStreamLabel"></a>
A timestamp, in ISO 8601 format, for this stream.  
Note that `LatestStreamLabel` is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:  
+  AWS customer ID
+ Table name
+  `StreamLabel` 
Type: String  
Required: No

 ** LocalSecondaryIndexes **   <a name="DDB-Type-TableDescription-LocalSecondaryIndexes"></a>
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:  
+  `IndexName` - The name of the local secondary index.
+  `KeySchema` - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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. This limit only applies when you specify the ProjectionType of `INCLUDE`. You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes.
+  `IndexSizeBytes` - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
+  `ItemCount` - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the `DELETING` state, no information about indexes will be returned.  
Type: Array of [LocalSecondaryIndexDescription](API_LocalSecondaryIndexDescription.md) objects  
Required: No

 ** MultiRegionConsistency **   <a name="DDB-Type-TableDescription-MultiRegionConsistency"></a>
Indicates one of the following consistency modes for a global table:  
+  `EVENTUAL`: Indicates that the global table is configured for multi-Region eventual consistency (MREC).
+  `STRONG`: Indicates that the global table is configured for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to `EVENTUAL`. For more information about global tables consistency modes, see [ Consistency modes](https://docs.aws.amazon.com/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes) in DynamoDB developer guide.   
Type: String  
Valid Values: `EVENTUAL | STRONG`   
Required: No

 ** OnDemandThroughput **   <a name="DDB-Type-TableDescription-OnDemandThroughput"></a>
The maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** ProvisionedThroughput **   <a name="DDB-Type-TableDescription-ProvisionedThroughput"></a>
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.  
Type: [ProvisionedThroughputDescription](API_ProvisionedThroughputDescription.md) object  
Required: No

 ** Replicas **   <a name="DDB-Type-TableDescription-Replicas"></a>
Represents replicas of the table.  
Type: Array of [ReplicaDescription](API_ReplicaDescription.md) objects  
Required: No

 ** RestoreSummary **   <a name="DDB-Type-TableDescription-RestoreSummary"></a>
Contains details for the restore.  
Type: [RestoreSummary](API_RestoreSummary.md) object  
Required: No

 ** SSEDescription **   <a name="DDB-Type-TableDescription-SSEDescription"></a>
The description of the server-side encryption status on the specified table.  
Type: [SSEDescription](API_SSEDescription.md) object  
Required: No

 ** StreamSpecification **   <a name="DDB-Type-TableDescription-StreamSpecification"></a>
The current DynamoDB Streams configuration for the table.  
Type: [StreamSpecification](API_StreamSpecification.md) object  
Required: No

 ** TableArn **   <a name="DDB-Type-TableDescription-TableArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the table.  
Type: String  
Required: No

 ** TableClassSummary **   <a name="DDB-Type-TableDescription-TableClassSummary"></a>
Contains details of the table class.  
Type: [TableClassSummary](API_TableClassSummary.md) object  
Required: No

 ** TableId **   <a name="DDB-Type-TableDescription-TableId"></a>
Unique identifier for the table for which the backup was created.   
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** TableName **   <a name="DDB-Type-TableDescription-TableName"></a>
The name of the table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** TableSizeBytes **   <a name="DDB-Type-TableDescription-TableSizeBytes"></a>
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.  
Type: Long  
Required: No

 ** TableStatus **   <a name="DDB-Type-TableDescription-TableStatus"></a>
The current state of the table:  
+  `CREATING` - The table is being created.
+  `UPDATING` - The table/index configuration is being updated. The table/index remains available for data operations when `UPDATING`.
+  `DELETING` - The table is being deleted.
+  `ACTIVE` - The table is ready for use.
+  `INACCESSIBLE_ENCRYPTION_CREDENTIALS` - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days. 
+  `ARCHIVING` - The table is being archived. Operations are not allowed until archival is complete. 
+  `ARCHIVED` - The table has been archived. See the ArchivalReason for more information. 
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | INACCESSIBLE_ENCRYPTION_CREDENTIALS | ARCHIVING | ARCHIVED | REPLICATION_NOT_AUTHORIZED`   
Required: No

 ** WarmThroughput **   <a name="DDB-Type-TableDescription-WarmThroughput"></a>
Describes the warm throughput value of the base table.  
Type: [TableWarmThroughputDescription](API_TableWarmThroughputDescription.md) object  
Required: No

## See Also
<a name="API_TableDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TableDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TableDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TableDescription) 

# TableWarmThroughputDescription
<a name="API_TableWarmThroughputDescription"></a>

Represents the warm throughput value (in read units per second and write units per second) of the table. Warm throughput is applicable for DynamoDB Standard-IA tables and specifies the minimum provisioned capacity maintained for immediate data access.

## Contents
<a name="API_TableWarmThroughputDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ReadUnitsPerSecond **   <a name="DDB-Type-TableWarmThroughputDescription-ReadUnitsPerSecond"></a>
Represents the base table's warm throughput value in read units per second.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** Status **   <a name="DDB-Type-TableWarmThroughputDescription-Status"></a>
Represents warm throughput value of the base table.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | INACCESSIBLE_ENCRYPTION_CREDENTIALS | ARCHIVING | ARCHIVED | REPLICATION_NOT_AUTHORIZED`   
Required: No

 ** WriteUnitsPerSecond **   <a name="DDB-Type-TableWarmThroughputDescription-WriteUnitsPerSecond"></a>
Represents the base table's warm throughput value in write units per second.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_TableWarmThroughputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TableWarmThroughputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TableWarmThroughputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TableWarmThroughputDescription) 

# Tag
<a name="API_Tag"></a>

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. 

 AWS-assigned tag names and values are automatically assigned the `aws:` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix `user:` in the Cost Allocation Report. You cannot backdate the application of a tag.

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*.

## Contents
<a name="API_Tag_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Key **   <a name="DDB-Type-Tag-Key"></a>
The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** Value **   <a name="DDB-Type-Tag-Value"></a>
The value of the tag. Tag values are case-sensitive and can be null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Tag) 

# ThrottlingReason
<a name="API_ThrottlingReason"></a>

Represents the specific reason why a DynamoDB request was throttled and the ARN of the impacted resource. This helps identify exactly what resource is being throttled, what type of operation caused it, and why the throttling occurred.

## Contents
<a name="API_ThrottlingReason_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** reason **   <a name="DDB-Type-ThrottlingReason-reason"></a>
The reason for throttling. The throttling reason follows a specific format: `ResourceType+OperationType+LimitType`:  
+ Resource Type (What is being throttled): Table or Index
+ Operation Type (What kind of operation): Read or Write
+ Limit Type (Why the throttling occurred):
  +  `ProvisionedThroughputExceeded`: The request rate is exceeding the [provisioned throughput capacity](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html) (read or write capacity units) configured for a table or a global secondary index (GSI) in provisioned capacity mode.
  +  `AccountLimitExceeded`: The request rate has caused a table or global secondary index (GSI) in on-demand mode to exceed the [per-table account-level service quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ServiceQuotas.html#default-limits-throughput) for read/write throughput in the current AWS Region. 
  +  `KeyRangeThroughputExceeded`: The request rate directed at a specific partition key value has exceeded the [internal partition-level throughput limits](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html), indicating uneven access patterns across the table's or GSI's key space.
  +  `MaxOnDemandThroughputExceeded`: The request rate has exceeded the [configured maximum throughput limits](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode-max-throughput.html) set for a table or index in on-demand capacity mode.
Examples of complete throttling reasons:  
+ TableReadProvisionedThroughputExceeded
+ IndexWriteAccountLimitExceeded
This helps identify exactly what resource is being throttled, what type of operation caused it, and why the throttling occurred.  
Type: String  
Required: No

 ** resource **   <a name="DDB-Type-ThrottlingReason-resource"></a>
The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the throttling event.  
Type: String  
Required: No

## See Also
<a name="API_ThrottlingReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ThrottlingReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ThrottlingReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ThrottlingReason) 

# TimeToLiveDescription
<a name="API_TimeToLiveDescription"></a>

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

## Contents
<a name="API_TimeToLiveDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AttributeName **   <a name="DDB-Type-TimeToLiveDescription-AttributeName"></a>
 The name of the TTL attribute for items in the table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** TimeToLiveStatus **   <a name="DDB-Type-TimeToLiveDescription-TimeToLiveStatus"></a>
 The TTL status for the table.  
Type: String  
Valid Values: `ENABLING | DISABLING | ENABLED | DISABLED`   
Required: No

## See Also
<a name="API_TimeToLiveDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TimeToLiveDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TimeToLiveDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TimeToLiveDescription) 

# TimeToLiveSpecification
<a name="API_TimeToLiveSpecification"></a>

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

## Contents
<a name="API_TimeToLiveSpecification_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AttributeName **   <a name="DDB-Type-TimeToLiveSpecification-AttributeName"></a>
The name of the TTL attribute used to store the expiration time for items in the table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** Enabled **   <a name="DDB-Type-TimeToLiveSpecification-Enabled"></a>
Indicates whether TTL is to be enabled (true) or disabled (false) on the table.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_TimeToLiveSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TimeToLiveSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TimeToLiveSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TimeToLiveSpecification) 

# TransactGetItem
<a name="API_TransactGetItem"></a>

Specifies an item to be retrieved as part of the transaction.

## Contents
<a name="API_TransactGetItem_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Get **   <a name="DDB-Type-TransactGetItem-Get"></a>
Contains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve.  
Type: [Get](API_Get.md) object  
Required: Yes

## See Also
<a name="API_TransactGetItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TransactGetItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TransactGetItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TransactGetItem) 

# TransactWriteItem
<a name="API_TransactWriteItem"></a>

A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.

## Contents
<a name="API_TransactWriteItem_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ConditionCheck **   <a name="DDB-Type-TransactWriteItem-ConditionCheck"></a>
A request to perform a check item operation.  
Type: [ConditionCheck](API_ConditionCheck.md) object  
Required: No

 ** Delete **   <a name="DDB-Type-TransactWriteItem-Delete"></a>
A request to perform a `DeleteItem` operation.  
Type: [Delete](API_Delete.md) object  
Required: No

 ** Put **   <a name="DDB-Type-TransactWriteItem-Put"></a>
A request to perform a `PutItem` operation.  
Type: [Put](API_Put.md) object  
Required: No

 ** Update **   <a name="DDB-Type-TransactWriteItem-Update"></a>
A request to perform an `UpdateItem` operation.  
Type: [Update](API_Update.md) object  
Required: No

## See Also
<a name="API_TransactWriteItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TransactWriteItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TransactWriteItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TransactWriteItem) 

# Update
<a name="API_Update"></a>

Represents a request to perform an `UpdateItem` operation.

## Contents
<a name="API_Update_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Key **   <a name="DDB-Type-Update-Key"></a>
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: Yes

 ** TableName **   <a name="DDB-Type-Update-TableName"></a>
Name of the table for the `UpdateItem` request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** UpdateExpression **   <a name="DDB-Type-Update-UpdateExpression"></a>
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.  
Type: String  
Required: Yes

 ** ConditionExpression **   <a name="DDB-Type-Update-ConditionExpression"></a>
A condition that must be satisfied in order for a conditional update to succeed.  
Type: String  
Required: No

 ** ExpressionAttributeNames **   <a name="DDB-Type-Update-ExpressionAttributeNames"></a>
One or more substitution tokens for attribute names in an expression.  
Type: String to string map  
Value Length Constraints: Maximum length of 65535.  
Required: No

 ** ExpressionAttributeValues **   <a name="DDB-Type-Update-ExpressionAttributeValues"></a>
One or more values that can be substituted in an expression.  
Type: String to [AttributeValue](API_AttributeValue.md) object map  
Required: No

 ** ReturnValuesOnConditionCheckFailure **   <a name="DDB-Type-Update-ReturnValuesOnConditionCheckFailure"></a>
Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Update` condition fails. For `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL\$1OLD.  
Type: String  
Valid Values: `ALL_OLD | NONE`   
Required: No

## See Also
<a name="API_Update_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Update) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Update) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Update) 

# UpdateGlobalSecondaryIndexAction
<a name="API_UpdateGlobalSecondaryIndexAction"></a>

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

## Contents
<a name="API_UpdateGlobalSecondaryIndexAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** IndexName **   <a name="DDB-Type-UpdateGlobalSecondaryIndexAction-IndexName"></a>
The name of the global secondary index to be updated.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** OnDemandThroughput **   <a name="DDB-Type-UpdateGlobalSecondaryIndexAction-OnDemandThroughput"></a>
Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.  
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object  
Required: No

 ** ProvisionedThroughput **   <a name="DDB-Type-UpdateGlobalSecondaryIndexAction-ProvisionedThroughput"></a>
Represents the provisioned throughput settings for the specified global secondary index.  
For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.  
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object  
Required: No

 ** WarmThroughput **   <a name="DDB-Type-UpdateGlobalSecondaryIndexAction-WarmThroughput"></a>
Represents the warm throughput value of the new provisioned throughput settings to be applied to a global secondary index.  
Type: [WarmThroughput](API_WarmThroughput.md) object  
Required: No

## See Also
<a name="API_UpdateGlobalSecondaryIndexAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateGlobalSecondaryIndexAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateGlobalSecondaryIndexAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateGlobalSecondaryIndexAction) 

# UpdateKinesisStreamingConfiguration
<a name="API_UpdateKinesisStreamingConfiguration"></a>

Enables updating the configuration for Kinesis Streaming.

## Contents
<a name="API_UpdateKinesisStreamingConfiguration_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ApproximateCreationDateTimePrecision **   <a name="DDB-Type-UpdateKinesisStreamingConfiguration-ApproximateCreationDateTimePrecision"></a>
Enables updating the precision of Kinesis data stream timestamp.   
Type: String  
Valid Values: `MILLISECOND | MICROSECOND`   
Required: No

## See Also
<a name="API_UpdateKinesisStreamingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateKinesisStreamingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateKinesisStreamingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateKinesisStreamingConfiguration) 

# UpdateReplicationGroupMemberAction
<a name="API_UpdateReplicationGroupMemberAction"></a>

Represents a replica to be modified.

## Contents
<a name="API_UpdateReplicationGroupMemberAction_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** RegionName **   <a name="DDB-Type-UpdateReplicationGroupMemberAction-RegionName"></a>
The Region where the replica exists.  
Type: String  
Required: Yes

 ** GlobalSecondaryIndexes **   <a name="DDB-Type-UpdateReplicationGroupMemberAction-GlobalSecondaryIndexes"></a>
Replica-specific global secondary index settings.  
Type: Array of [ReplicaGlobalSecondaryIndex](API_ReplicaGlobalSecondaryIndex.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** KMSMasterKeyId **   <a name="DDB-Type-UpdateReplicationGroupMemberAction-KMSMasterKeyId"></a>
The AWS KMS key of the replica that should be used for AWS KMS encryption. To specify a key, 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 key `alias/aws/dynamodb`.  
Type: String  
Required: No

 ** OnDemandThroughputOverride **   <a name="DDB-Type-UpdateReplicationGroupMemberAction-OnDemandThroughputOverride"></a>
Overrides the maximum on-demand throughput for the replica table.  
Type: [OnDemandThroughputOverride](API_OnDemandThroughputOverride.md) object  
Required: No

 ** ProvisionedThroughputOverride **   <a name="DDB-Type-UpdateReplicationGroupMemberAction-ProvisionedThroughputOverride"></a>
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.  
Type: [ProvisionedThroughputOverride](API_ProvisionedThroughputOverride.md) object  
Required: No

 ** TableClassOverride **   <a name="DDB-Type-UpdateReplicationGroupMemberAction-TableClassOverride"></a>
Replica-specific table class. If not specified, uses the source table's table class.  
Type: String  
Valid Values: `STANDARD | STANDARD_INFREQUENT_ACCESS`   
Required: No

## See Also
<a name="API_UpdateReplicationGroupMemberAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateReplicationGroupMemberAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateReplicationGroupMemberAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateReplicationGroupMemberAction) 

# WarmThroughput
<a name="API_WarmThroughput"></a>

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the `UpdateTable` operation to meet the throughput requirements of an upcoming peak event.

## Contents
<a name="API_WarmThroughput_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ReadUnitsPerSecond **   <a name="DDB-Type-WarmThroughput-ReadUnitsPerSecond"></a>
Represents the number of read operations your base table can instantaneously support.  
Type: Long  
Required: No

 ** WriteUnitsPerSecond **   <a name="DDB-Type-WarmThroughput-WriteUnitsPerSecond"></a>
Represents the number of write operations your base table can instantaneously support.  
Type: Long  
Required: No

## See Also
<a name="API_WarmThroughput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/WarmThroughput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/WarmThroughput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/WarmThroughput) 

# WriteRequest
<a name="API_WriteRequest"></a>

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 need to provide two separate `WriteRequest` objects.

## Contents
<a name="API_WriteRequest_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** DeleteRequest **   <a name="DDB-Type-WriteRequest-DeleteRequest"></a>
A request to perform a `DeleteItem` operation.  
Type: [DeleteRequest](API_DeleteRequest.md) object  
Required: No

 ** PutRequest **   <a name="DDB-Type-WriteRequest-PutRequest"></a>
A request to perform a `PutItem` operation.  
Type: [PutRequest](API_PutRequest.md) object  
Required: No

## See Also
<a name="API_WriteRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/WriteRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/WriteRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/WriteRequest) 

# DynamoDB Accelerator
<a name="API_Types_Amazon_DynamoDB_Accelerator__DAX_"></a>

The following data types are supported by DynamoDB Accelerator:
+  [Cluster](API_dax_Cluster.md) 
+  [Endpoint](API_dax_Endpoint.md) 
+  [Event](API_dax_Event.md) 
+  [Node](API_dax_Node.md) 
+  [NodeTypeSpecificValue](API_dax_NodeTypeSpecificValue.md) 
+  [NotificationConfiguration](API_dax_NotificationConfiguration.md) 
+  [Parameter](API_dax_Parameter.md) 
+  [ParameterGroup](API_dax_ParameterGroup.md) 
+  [ParameterGroupStatus](API_dax_ParameterGroupStatus.md) 
+  [ParameterNameValue](API_dax_ParameterNameValue.md) 
+  [SecurityGroupMembership](API_dax_SecurityGroupMembership.md) 
+  [SSEDescription](API_dax_SSEDescription.md) 
+  [SSESpecification](API_dax_SSESpecification.md) 
+  [Subnet](API_dax_Subnet.md) 
+  [SubnetGroup](API_dax_SubnetGroup.md) 
+  [Tag](API_dax_Tag.md) 

# Cluster
<a name="API_dax_Cluster"></a>

Contains all of the attributes of a specific DAX cluster.

## Contents
<a name="API_dax_Cluster_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ActiveNodes **   <a name="DDB-Type-dax_Cluster-ActiveNodes"></a>
The number of nodes in the cluster that are active (i.e., capable of serving requests).  
Type: Integer  
Required: No

 ** ClusterArn **   <a name="DDB-Type-dax_Cluster-ClusterArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the cluster.   
Type: String  
Required: No

 ** ClusterDiscoveryEndpoint **   <a name="DDB-Type-dax_Cluster-ClusterDiscoveryEndpoint"></a>
The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.  
Type: [Endpoint](API_dax_Endpoint.md) object  
Required: No

 ** ClusterEndpointEncryptionType **   <a name="DDB-Type-dax_Cluster-ClusterEndpointEncryptionType"></a>
The type of encryption supported by the cluster's endpoint. Values are:  
+  `NONE` for no encryption

   `TLS` for Transport Layer Security
Type: String  
Valid Values: `NONE | TLS`   
Required: No

 ** ClusterName **   <a name="DDB-Type-dax_Cluster-ClusterName"></a>
The name of the DAX cluster.  
Type: String  
Required: No

 ** Description **   <a name="DDB-Type-dax_Cluster-Description"></a>
The description of the cluster.  
Type: String  
Required: No

 ** IamRoleArn **   <a name="DDB-Type-dax_Cluster-IamRoleArn"></a>
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.  
Type: String  
Required: No

 ** NetworkType **   <a name="DDB-Type-dax_Cluster-NetworkType"></a>
The IP address type of the cluster. Values are:  
+  `ipv4` - IPv4 addresses only
+  `ipv6` - IPv6 addresses only
+  `dual_stack` - Both IPv4 and IPv6 addresses
Type: String  
Valid Values: `ipv4 | ipv6 | dual_stack`   
Required: No

 ** NodeIdsToRemove **   <a name="DDB-Type-dax_Cluster-NodeIdsToRemove"></a>
A list of nodes to be removed from the cluster.  
Type: Array of strings  
Required: No

 ** Nodes **   <a name="DDB-Type-dax_Cluster-Nodes"></a>
A list of nodes that are currently in the cluster.  
Type: Array of [Node](API_dax_Node.md) objects  
Required: No

 ** NodeType **   <a name="DDB-Type-dax_Cluster-NodeType"></a>
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)  
Type: String  
Required: No

 ** NotificationConfiguration **   <a name="DDB-Type-dax_Cluster-NotificationConfiguration"></a>
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).  
Type: [NotificationConfiguration](API_dax_NotificationConfiguration.md) object  
Required: No

 ** ParameterGroup **   <a name="DDB-Type-dax_Cluster-ParameterGroup"></a>
The parameter group being used by nodes in the cluster.  
Type: [ParameterGroupStatus](API_dax_ParameterGroupStatus.md) object  
Required: No

 ** PreferredMaintenanceWindow **   <a name="DDB-Type-dax_Cluster-PreferredMaintenanceWindow"></a>
A range of time when maintenance of DAX cluster software will be performed. For example: `sun:01:00-sun:09:00`. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.  
Type: String  
Required: No

 ** SecurityGroups **   <a name="DDB-Type-dax_Cluster-SecurityGroups"></a>
A list of security groups, and the status of each, for the nodes in the cluster.  
Type: Array of [SecurityGroupMembership](API_dax_SecurityGroupMembership.md) objects  
Required: No

 ** SSEDescription **   <a name="DDB-Type-dax_Cluster-SSEDescription"></a>
The description of the server-side encryption status on the specified DAX cluster.  
Type: [SSEDescription](API_dax_SSEDescription.md) object  
Required: No

 ** Status **   <a name="DDB-Type-dax_Cluster-Status"></a>
The current status of the cluster.  
Type: String  
Required: No

 ** SubnetGroup **   <a name="DDB-Type-dax_Cluster-SubnetGroup"></a>
The subnet group where the DAX cluster is running.  
Type: String  
Required: No

 ** TotalNodes **   <a name="DDB-Type-dax_Cluster-TotalNodes"></a>
The total number of nodes in the cluster.  
Type: Integer  
Required: No

## See Also
<a name="API_dax_Cluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/Cluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/Cluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/Cluster) 

# Endpoint
<a name="API_dax_Endpoint"></a>

Represents the information required for client programs to connect to the endpoint for a DAX cluster.

## Contents
<a name="API_dax_Endpoint_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Address **   <a name="DDB-Type-dax_Endpoint-Address"></a>
The DNS hostname of the endpoint.  
Type: String  
Required: No

 ** Port **   <a name="DDB-Type-dax_Endpoint-Port"></a>
The port number that applications should use to connect to the endpoint.  
Type: Integer  
Required: No

 ** URL **   <a name="DDB-Type-dax_Endpoint-URL"></a>
The URL that applications should use to connect to the endpoint. The default ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.  
Type: String  
Required: No

## See Also
<a name="API_dax_Endpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/Endpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/Endpoint) 

# Event
<a name="API_dax_Event"></a>

Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.

## Contents
<a name="API_dax_Event_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Date **   <a name="DDB-Type-dax_Event-Date"></a>
The date and time when the event occurred.  
Type: Timestamp  
Required: No

 ** Message **   <a name="DDB-Type-dax_Event-Message"></a>
A user-defined message associated with the event.  
Type: String  
Required: No

 ** SourceName **   <a name="DDB-Type-dax_Event-SourceName"></a>
The source of the event. For example, if the event occurred at the node level, the source would be the node ID.  
Type: String  
Required: No

 ** SourceType **   <a name="DDB-Type-dax_Event-SourceType"></a>
Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.  
Type: String  
Valid Values: `CLUSTER | PARAMETER_GROUP | SUBNET_GROUP`   
Required: No

## See Also
<a name="API_dax_Event_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/Event) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/Event) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/Event) 

# Node
<a name="API_dax_Node"></a>

Represents an individual node within a DAX cluster.

## Contents
<a name="API_dax_Node_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AvailabilityZone **   <a name="DDB-Type-dax_Node-AvailabilityZone"></a>
The Availability Zone (AZ) in which the node has been deployed.  
Type: String  
Required: No

 ** Endpoint **   <a name="DDB-Type-dax_Node-Endpoint"></a>
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.  
Type: [Endpoint](API_dax_Endpoint.md) object  
Required: No

 ** NodeCreateTime **   <a name="DDB-Type-dax_Node-NodeCreateTime"></a>
The date and time (in UNIX epoch format) when the node was launched.  
Type: Timestamp  
Required: No

 ** NodeId **   <a name="DDB-Type-dax_Node-NodeId"></a>
A system-generated identifier for the node.  
Type: String  
Required: No

 ** NodeStatus **   <a name="DDB-Type-dax_Node-NodeStatus"></a>
The current status of the node. For example: `available`.  
Type: String  
Required: No

 ** ParameterGroupStatus **   <a name="DDB-Type-dax_Node-ParameterGroupStatus"></a>
The status of the parameter group associated with this node. For example, `in-sync`.  
Type: String  
Required: No

## See Also
<a name="API_dax_Node_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/Node) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/Node) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/Node) 

# NodeTypeSpecificValue
<a name="API_dax_NodeTypeSpecificValue"></a>

Represents a parameter value that is applicable to a particular node type.

## Contents
<a name="API_dax_NodeTypeSpecificValue_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** NodeType **   <a name="DDB-Type-dax_NodeTypeSpecificValue-NodeType"></a>
A node type to which the parameter value applies.  
Type: String  
Required: No

 ** Value **   <a name="DDB-Type-dax_NodeTypeSpecificValue-Value"></a>
The parameter value for this node type.  
Type: String  
Required: No

## See Also
<a name="API_dax_NodeTypeSpecificValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/NodeTypeSpecificValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/NodeTypeSpecificValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/NodeTypeSpecificValue) 

# NotificationConfiguration
<a name="API_dax_NotificationConfiguration"></a>

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

## Contents
<a name="API_dax_NotificationConfiguration_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** TopicArn **   <a name="DDB-Type-dax_NotificationConfiguration-TopicArn"></a>
The Amazon Resource Name (ARN) that identifies the topic.  
Type: String  
Required: No

 ** TopicStatus **   <a name="DDB-Type-dax_NotificationConfiguration-TopicStatus"></a>
The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.  
Type: String  
Required: No

## See Also
<a name="API_dax_NotificationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/NotificationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/NotificationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/NotificationConfiguration) 

# Parameter
<a name="API_dax_Parameter"></a>

Describes an individual setting that controls some aspect of DAX behavior.

## Contents
<a name="API_dax_Parameter_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AllowedValues **   <a name="DDB-Type-dax_Parameter-AllowedValues"></a>
A range of values within which the parameter can be set.  
Type: String  
Required: No

 ** ChangeType **   <a name="DDB-Type-dax_Parameter-ChangeType"></a>
The conditions under which changes to this parameter can be applied. For example, `requires-reboot` indicates that a new value for this parameter will only take effect if a node is rebooted.  
Type: String  
Valid Values: `IMMEDIATE | REQUIRES_REBOOT`   
Required: No

 ** DataType **   <a name="DDB-Type-dax_Parameter-DataType"></a>
The data type of the parameter. For example, `integer`:  
Type: String  
Required: No

 ** Description **   <a name="DDB-Type-dax_Parameter-Description"></a>
A description of the parameter  
Type: String  
Required: No

 ** IsModifiable **   <a name="DDB-Type-dax_Parameter-IsModifiable"></a>
Whether the customer is allowed to modify the parameter.  
Type: String  
Valid Values: `TRUE | FALSE | CONDITIONAL`   
Required: No

 ** NodeTypeSpecificValues **   <a name="DDB-Type-dax_Parameter-NodeTypeSpecificValues"></a>
A list of node types, and specific parameter values for each node.  
Type: Array of [NodeTypeSpecificValue](API_dax_NodeTypeSpecificValue.md) objects  
Required: No

 ** ParameterName **   <a name="DDB-Type-dax_Parameter-ParameterName"></a>
The name of the parameter.  
Type: String  
Required: No

 ** ParameterType **   <a name="DDB-Type-dax_Parameter-ParameterType"></a>
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.  
Type: String  
Valid Values: `DEFAULT | NODE_TYPE_SPECIFIC`   
Required: No

 ** ParameterValue **   <a name="DDB-Type-dax_Parameter-ParameterValue"></a>
The value for the parameter.  
Type: String  
Required: No

 ** Source **   <a name="DDB-Type-dax_Parameter-Source"></a>
How the parameter is defined. For example, `system` denotes a system-defined parameter.  
Type: String  
Required: No

## See Also
<a name="API_dax_Parameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/Parameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/Parameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/Parameter) 

# ParameterGroup
<a name="API_dax_ParameterGroup"></a>

A named set of parameters that are applied to all of the nodes in a DAX cluster.

## Contents
<a name="API_dax_ParameterGroup_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Description **   <a name="DDB-Type-dax_ParameterGroup-Description"></a>
A description of the parameter group.  
Type: String  
Required: No

 ** ParameterGroupName **   <a name="DDB-Type-dax_ParameterGroup-ParameterGroupName"></a>
The name of the parameter group.  
Type: String  
Required: No

## See Also
<a name="API_dax_ParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/ParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/ParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/ParameterGroup) 

# ParameterGroupStatus
<a name="API_dax_ParameterGroupStatus"></a>

The status of a parameter group.

## Contents
<a name="API_dax_ParameterGroupStatus_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** NodeIdsToReboot **   <a name="DDB-Type-dax_ParameterGroupStatus-NodeIdsToReboot"></a>
The node IDs of one or more nodes to be rebooted.  
Type: Array of strings  
Required: No

 ** ParameterApplyStatus **   <a name="DDB-Type-dax_ParameterGroupStatus-ParameterApplyStatus"></a>
The status of parameter updates.   
Type: String  
Required: No

 ** ParameterGroupName **   <a name="DDB-Type-dax_ParameterGroupStatus-ParameterGroupName"></a>
The name of the parameter group.  
Type: String  
Required: No

## See Also
<a name="API_dax_ParameterGroupStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/ParameterGroupStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/ParameterGroupStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/ParameterGroupStatus) 

# ParameterNameValue
<a name="API_dax_ParameterNameValue"></a>

An individual DAX parameter.

## Contents
<a name="API_dax_ParameterNameValue_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ParameterName **   <a name="DDB-Type-dax_ParameterNameValue-ParameterName"></a>
The name of the parameter.  
Type: String  
Required: No

 ** ParameterValue **   <a name="DDB-Type-dax_ParameterNameValue-ParameterValue"></a>
The value of the parameter.  
Type: String  
Required: No

## See Also
<a name="API_dax_ParameterNameValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/ParameterNameValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/ParameterNameValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/ParameterNameValue) 

# SecurityGroupMembership
<a name="API_dax_SecurityGroupMembership"></a>

An individual VPC security group and its status.

## Contents
<a name="API_dax_SecurityGroupMembership_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** SecurityGroupIdentifier **   <a name="DDB-Type-dax_SecurityGroupMembership-SecurityGroupIdentifier"></a>
The unique ID for this security group.  
Type: String  
Required: No

 ** Status **   <a name="DDB-Type-dax_SecurityGroupMembership-Status"></a>
The status of this security group.  
Type: String  
Required: No

## See Also
<a name="API_dax_SecurityGroupMembership_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/SecurityGroupMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/SecurityGroupMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/SecurityGroupMembership) 

# SSEDescription
<a name="API_dax_SSEDescription"></a>

The description of the server-side encryption status on the specified DAX cluster.

## Contents
<a name="API_dax_SSEDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Status **   <a name="DDB-Type-dax_SSEDescription-Status"></a>
The current state of server-side encryption:  
+  `ENABLING` - Server-side encryption is being enabled.
+  `ENABLED` - Server-side encryption is enabled.
+  `DISABLING` - Server-side encryption is being disabled.
+  `DISABLED` - Server-side encryption is disabled.
Type: String  
Valid Values: `ENABLING | ENABLED | DISABLING | DISABLED`   
Required: No

## See Also
<a name="API_dax_SSEDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/SSEDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/SSEDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/SSEDescription) 

# SSESpecification
<a name="API_dax_SSESpecification"></a>

Represents the settings used to enable server-side encryption.

## Contents
<a name="API_dax_SSESpecification_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Enabled **   <a name="DDB-Type-dax_SSESpecification-Enabled"></a>
Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_dax_SSESpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/SSESpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/SSESpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/SSESpecification) 

# Subnet
<a name="API_dax_Subnet"></a>

Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.

## Contents
<a name="API_dax_Subnet_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** SubnetAvailabilityZone **   <a name="DDB-Type-dax_Subnet-SubnetAvailabilityZone"></a>
The Availability Zone (AZ) for the subnet.  
Type: String  
Required: No

 ** SubnetIdentifier **   <a name="DDB-Type-dax_Subnet-SubnetIdentifier"></a>
The system-assigned identifier for the subnet.  
Type: String  
Required: No

 ** SupportedNetworkTypes **   <a name="DDB-Type-dax_Subnet-SupportedNetworkTypes"></a>
The network types supported by this subnet. Returns an array of strings that can include `ipv4`, `ipv6`, or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.  
Type: Array of strings  
Valid Values: `ipv4 | ipv6 | dual_stack`   
Required: No

## See Also
<a name="API_dax_Subnet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/Subnet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/Subnet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/Subnet) 

# SubnetGroup
<a name="API_dax_SubnetGroup"></a>

Represents the output of one of the following actions:
+  *CreateSubnetGroup* 
+  *ModifySubnetGroup* 

## Contents
<a name="API_dax_SubnetGroup_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Description **   <a name="DDB-Type-dax_SubnetGroup-Description"></a>
The description of the subnet group.  
Type: String  
Required: No

 ** SubnetGroupName **   <a name="DDB-Type-dax_SubnetGroup-SubnetGroupName"></a>
The name of the subnet group.  
Type: String  
Required: No

 ** Subnets **   <a name="DDB-Type-dax_SubnetGroup-Subnets"></a>
A list of subnets associated with the subnet group.   
Type: Array of [Subnet](API_dax_Subnet.md) objects  
Required: No

 ** SupportedNetworkTypes **   <a name="DDB-Type-dax_SubnetGroup-SupportedNetworkTypes"></a>
The network types supported by this subnet. Returns an array of strings that can include `ipv4`, `ipv6`, or both, indicating whether the subnet group supports IPv4 only, IPv6 only, or dual-stack deployments.   
Type: Array of strings  
Valid Values: `ipv4 | ipv6 | dual_stack`   
Required: No

 ** VpcId **   <a name="DDB-Type-dax_SubnetGroup-VpcId"></a>
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.  
Type: String  
Required: No

## See Also
<a name="API_dax_SubnetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/SubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/SubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/SubnetGroup) 

# Tag
<a name="API_dax_Tag"></a>

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

 AWS-assigned tag names and values are automatically assigned the `aws:` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix `user:`.

You cannot backdate the application of a tag.

## Contents
<a name="API_dax_Tag_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** Key **   <a name="DDB-Type-dax_Tag-Key"></a>
The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.  
Type: String  
Required: No

 ** Value **   <a name="DDB-Type-dax_Tag-Value"></a>
The value of the tag. Tag values are case-sensitive and can be null.  
Type: String  
Required: No

## See Also
<a name="API_dax_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/Tag) 

# Amazon DynamoDB Streams
<a name="API_Types_Amazon_DynamoDB_Streams"></a>

The following data types are supported by Amazon DynamoDB Streams:
+  [AttributeValue](API_streams_AttributeValue.md) 
+  [Identity](API_streams_Identity.md) 
+  [KeySchemaElement](API_streams_KeySchemaElement.md) 
+  [Record](API_streams_Record.md) 
+  [SequenceNumberRange](API_streams_SequenceNumberRange.md) 
+  [Shard](API_streams_Shard.md) 
+  [ShardFilter](API_streams_ShardFilter.md) 
+  [Stream](API_streams_Stream.md) 
+  [StreamDescription](API_streams_StreamDescription.md) 
+  [StreamRecord](API_streams_StreamRecord.md) 

# AttributeValue
<a name="API_streams_AttributeValue"></a>

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*.

## Contents
<a name="API_streams_AttributeValue_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** B **   <a name="DDB-Type-streams_AttributeValue-B"></a>
An attribute of type Binary. For example:  
 `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`   
Type: Base64-encoded binary data object  
Required: No

 ** BOOL **   <a name="DDB-Type-streams_AttributeValue-BOOL"></a>
An attribute of type Boolean. For example:  
 `"BOOL": true`   
Type: Boolean  
Required: No

 ** BS **   <a name="DDB-Type-streams_AttributeValue-BS"></a>
An attribute of type Binary Set. For example:  
 `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`   
Type: Array of Base64-encoded binary data objects  
Required: No

 ** L **   <a name="DDB-Type-streams_AttributeValue-L"></a>
An attribute of type List. For example:  
 `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]`   
Type: Array of [AttributeValue](#API_streams_AttributeValue) objects  
Required: No

 ** M **   <a name="DDB-Type-streams_AttributeValue-M"></a>
An attribute of type Map. For example:  
 `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`   
Type: String to [AttributeValue](#API_streams_AttributeValue) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** N **   <a name="DDB-Type-streams_AttributeValue-N"></a>
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.  
Type: String  
Required: No

 ** NS **   <a name="DDB-Type-streams_AttributeValue-NS"></a>
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.  
Type: Array of strings  
Required: No

 ** NULL **   <a name="DDB-Type-streams_AttributeValue-NULL"></a>
An attribute of type Null. For example:  
 `"NULL": true`   
Type: Boolean  
Required: No

 ** S **   <a name="DDB-Type-streams_AttributeValue-S"></a>
An attribute of type String. For example:  
 `"S": "Hello"`   
Type: String  
Required: No

 ** SS **   <a name="DDB-Type-streams_AttributeValue-SS"></a>
An attribute of type String Set. For example:  
 `"SS": ["Giraffe", "Hippo" ,"Zebra"]`   
Type: Array of strings  
Required: No

## See Also
<a name="API_streams_AttributeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/AttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/AttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/AttributeValue) 

# Identity
<a name="API_streams_Identity"></a>

Contains details about the type of identity that made the request.

## Contents
<a name="API_streams_Identity_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** PrincipalId **   <a name="DDB-Type-streams_Identity-PrincipalId"></a>
A unique identifier for the entity that made the call. For Time To Live, the principalId is "dynamodb.amazonaws.com".  
Type: String  
Required: No

 ** Type **   <a name="DDB-Type-streams_Identity-Type"></a>
The type of the identity. For Time To Live, the type is "Service".  
Type: String  
Required: No

## See Also
<a name="API_streams_Identity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/Identity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/Identity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/Identity) 

# KeySchemaElement
<a name="API_streams_KeySchemaElement"></a>

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.

## Contents
<a name="API_streams_KeySchemaElement_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** AttributeName **   <a name="DDB-Type-streams_KeySchemaElement-AttributeName"></a>
The name of a key attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** KeyType **   <a name="DDB-Type-streams_KeySchemaElement-KeyType"></a>
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.
Type: String  
Valid Values: `HASH | RANGE`   
Required: Yes

## See Also
<a name="API_streams_KeySchemaElement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/KeySchemaElement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/KeySchemaElement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/KeySchemaElement) 

# Record
<a name="API_streams_Record"></a>

A description of a unique event within a stream.

## Contents
<a name="API_streams_Record_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** awsRegion **   <a name="DDB-Type-streams_Record-awsRegion"></a>
The region in which the `GetRecords` request was received.  
Type: String  
Required: No

 ** dynamodb **   <a name="DDB-Type-streams_Record-dynamodb"></a>
The main body of the stream record, containing all of the DynamoDB-specific fields.  
Type: [StreamRecord](API_streams_StreamRecord.md) object  
Required: No

 ** eventID **   <a name="DDB-Type-streams_Record-eventID"></a>
A globally unique identifier for the event that was recorded in this stream record.  
Type: String  
Required: No

 ** eventName **   <a name="DDB-Type-streams_Record-eventName"></a>
The type of data modification that was performed on the DynamoDB table:  
+  `INSERT` - a new item was added to the table.
+  `MODIFY` - one or more of an existing item's attributes were modified.
+  `REMOVE` - the item was deleted from the table
Type: String  
Valid Values: `INSERT | MODIFY | REMOVE`   
Required: No

 ** eventSource **   <a name="DDB-Type-streams_Record-eventSource"></a>
The AWS service from which the stream record originated. For DynamoDB Streams, this is `aws:dynamodb`.  
Type: String  
Required: No

 ** eventVersion **   <a name="DDB-Type-streams_Record-eventVersion"></a>
The version number of the stream record format. This number is updated whenever the structure of `Record` is modified.  
Client applications must not assume that `eventVersion` will remain at a particular value, as this number is subject to change at any time. In general, `eventVersion` will only increase as the low-level DynamoDB Streams API evolves.  
Type: String  
Required: No

 ** userIdentity **   <a name="DDB-Type-streams_Record-userIdentity"></a>
Items that are deleted by the Time to Live process after expiration have the following fields:   
+ Records[].userIdentity.type

  "Service"
+ Records[].userIdentity.principalId

  "dynamodb.amazonaws.com"
Type: [Identity](API_streams_Identity.md) object  
Required: No

## See Also
<a name="API_streams_Record_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/Record) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/Record) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/Record) 

# SequenceNumberRange
<a name="API_streams_SequenceNumberRange"></a>

The beginning and ending sequence numbers for the stream records contained within a shard.

## Contents
<a name="API_streams_SequenceNumberRange_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** EndingSequenceNumber **   <a name="DDB-Type-streams_SequenceNumberRange-EndingSequenceNumber"></a>
The last sequence number for the stream records contained within a shard. String contains numeric characters only.  
Type: String  
Length Constraints: Minimum length of 21. Maximum length of 40.  
Required: No

 ** StartingSequenceNumber **   <a name="DDB-Type-streams_SequenceNumberRange-StartingSequenceNumber"></a>
The first sequence number for the stream records contained within a shard. String contains numeric characters only.  
Type: String  
Length Constraints: Minimum length of 21. Maximum length of 40.  
Required: No

## See Also
<a name="API_streams_SequenceNumberRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/SequenceNumberRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/SequenceNumberRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/SequenceNumberRange) 

# Shard
<a name="API_streams_Shard"></a>

A uniquely identified group of stream records within a stream.

## Contents
<a name="API_streams_Shard_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ParentShardId **   <a name="DDB-Type-streams_Shard-ParentShardId"></a>
The shard ID of the current shard's parent.  
Type: String  
Length Constraints: Minimum length of 28. Maximum length of 65.  
Required: No

 ** SequenceNumberRange **   <a name="DDB-Type-streams_Shard-SequenceNumberRange"></a>
The range of possible sequence numbers for the shard.  
Type: [SequenceNumberRange](API_streams_SequenceNumberRange.md) object  
Required: No

 ** ShardId **   <a name="DDB-Type-streams_Shard-ShardId"></a>
The system-generated identifier for this shard.  
Type: String  
Length Constraints: Minimum length of 28. Maximum length of 65.  
Required: No

## See Also
<a name="API_streams_Shard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/Shard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/Shard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/Shard) 

# ShardFilter
<a name="API_streams_ShardFilter"></a>

This optional field contains the filter definition for the `DescribeStream` API.

## Contents
<a name="API_streams_ShardFilter_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ShardId **   <a name="DDB-Type-streams_ShardFilter-ShardId"></a>
Contains the `shardId` of the parent shard for which you are requesting child shards.  
 *Sample request:*   
Type: String  
Length Constraints: Minimum length of 28. Maximum length of 65.  
Required: No

 ** Type **   <a name="DDB-Type-streams_ShardFilter-Type"></a>
Contains the type of filter to be applied on the `DescribeStream` API. Currently, the only value this parameter accepts is `CHILD_SHARDS`.  
Type: String  
Valid Values: `CHILD_SHARDS`   
Required: No

## See Also
<a name="API_streams_ShardFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/ShardFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/ShardFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/ShardFilter) 

# Stream
<a name="API_streams_Stream"></a>

Represents all of the data describing a particular stream.

## Contents
<a name="API_streams_Stream_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** StreamArn **   <a name="DDB-Type-streams_Stream-StreamArn"></a>
The Amazon Resource Name (ARN) for the stream.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** StreamLabel **   <a name="DDB-Type-streams_Stream-StreamLabel"></a>
A timestamp, in ISO 8601 format, for this stream.  
Note that `LatestStreamLabel` is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:  
+ the AWS customer ID.
+ the table name
+ the `StreamLabel` 
Type: String  
Required: No

 ** TableName **   <a name="DDB-Type-streams_Stream-TableName"></a>
The DynamoDB table with which the stream is associated.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## See Also
<a name="API_streams_Stream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/Stream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/Stream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/Stream) 

# StreamDescription
<a name="API_streams_StreamDescription"></a>

Represents all of the data describing a particular stream.

## Contents
<a name="API_streams_StreamDescription_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** CreationRequestDateTime **   <a name="DDB-Type-streams_StreamDescription-CreationRequestDateTime"></a>
The date and time when the request to create this stream was issued.  
Type: Timestamp  
Required: No

 ** KeySchema **   <a name="DDB-Type-streams_StreamDescription-KeySchema"></a>
The key attribute(s) of the stream's DynamoDB table.  
Type: Array of [KeySchemaElement](API_streams_KeySchemaElement.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** LastEvaluatedShardId **   <a name="DDB-Type-streams_StreamDescription-LastEvaluatedShardId"></a>
The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.  
If `LastEvaluatedShardId` is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.  
If `LastEvaluatedShardId` is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when `LastEvaluatedShardId` is empty.  
Type: String  
Length Constraints: Minimum length of 28. Maximum length of 65.  
Required: No

 ** Shards **   <a name="DDB-Type-streams_StreamDescription-Shards"></a>
The shards that comprise the stream.  
Type: Array of [Shard](API_streams_Shard.md) objects  
Required: No

 ** StreamArn **   <a name="DDB-Type-streams_StreamDescription-StreamArn"></a>
The Amazon Resource Name (ARN) for the stream.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 1024.  
Required: No

 ** StreamLabel **   <a name="DDB-Type-streams_StreamDescription-StreamLabel"></a>
A timestamp, in ISO 8601 format, for this stream.  
Note that `LatestStreamLabel` is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:  
+ the AWS customer ID.
+ the table name
+ the `StreamLabel` 
Type: String  
Required: No

 ** StreamStatus **   <a name="DDB-Type-streams_StreamDescription-StreamStatus"></a>
Indicates the current status of the stream:  
+  `ENABLING` - Streams is currently being enabled on the DynamoDB table.
+  `ENABLED` - the stream is enabled.
+  `DISABLING` - Streams is currently being disabled on the DynamoDB table.
+  `DISABLED` - the stream is disabled.
Type: String  
Valid Values: `ENABLING | ENABLED | DISABLING | DISABLED`   
Required: No

 ** StreamViewType **   <a name="DDB-Type-streams_StreamDescription-StreamViewType"></a>
Indicates the format of the records within this stream:  
+  `KEYS_ONLY` - only the key attributes of items that were modified in the DynamoDB table.
+  `NEW_IMAGE` - entire items from the table, as they appeared after they were modified.
+  `OLD_IMAGE` - entire items from the table, as they appeared before they were modified.
+  `NEW_AND_OLD_IMAGES` - both the new and the old images of the items from the table.
Type: String  
Valid Values: `NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY`   
Required: No

 ** TableName **   <a name="DDB-Type-streams_StreamDescription-TableName"></a>
The DynamoDB table with which the stream is associated.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## See Also
<a name="API_streams_StreamDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/StreamDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/StreamDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/StreamDescription) 

# StreamRecord
<a name="API_streams_StreamRecord"></a>

A description of a single data modification that was performed on an item in a DynamoDB table.

## Contents
<a name="API_streams_StreamRecord_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** ApproximateCreationDateTime **   <a name="DDB-Type-streams_StreamRecord-ApproximateCreationDateTime"></a>
The approximate date and time when the stream record was created, in [UNIX epoch time](http://www.epochconverter.com/) format and rounded down to the closest second. Some tools and SDKs may convert this value to a different format, such as [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).  
Type: Timestamp  
Required: No

 ** Keys **   <a name="DDB-Type-streams_StreamRecord-Keys"></a>
The primary key attribute(s) for the DynamoDB item that was modified.  
Type: String to [AttributeValue](API_streams_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** NewImage **   <a name="DDB-Type-streams_StreamRecord-NewImage"></a>
The item in the DynamoDB table as it appeared after it was modified.  
Type: String to [AttributeValue](API_streams_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** OldImage **   <a name="DDB-Type-streams_StreamRecord-OldImage"></a>
The item in the DynamoDB table as it appeared before it was modified.  
Type: String to [AttributeValue](API_streams_AttributeValue.md) object map  
Key Length Constraints: Maximum length of 65535.  
Required: No

 ** SequenceNumber **   <a name="DDB-Type-streams_StreamRecord-SequenceNumber"></a>
The sequence number of the stream record.  
Type: String  
Length Constraints: Minimum length of 21. Maximum length of 40.  
Required: No

 ** SizeBytes **   <a name="DDB-Type-streams_StreamRecord-SizeBytes"></a>
The size of the stream record, in bytes.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** StreamViewType **   <a name="DDB-Type-streams_StreamRecord-StreamViewType"></a>
The type of data from the modified DynamoDB item that was captured in this stream record:  
+  `KEYS_ONLY` - only the key attributes of the modified item.
+  `NEW_IMAGE` - the entire item, as it appeared after it was modified.
+  `OLD_IMAGE` - the entire item, as it appeared before it was modified.
+  `NEW_AND_OLD_IMAGES` - both the new and the old item images of the item.
Type: String  
Valid Values: `NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY`   
Required: No

## See Also
<a name="API_streams_StreamRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/streams-dynamodb-2012-08-10/StreamRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/streams-dynamodb-2012-08-10/StreamRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/streams-dynamodb-2012-08-10/StreamRecord)