CreateTable | Request parameters | Required parameter: AttributeDefinitions | Yes | N/A |
Required parameter: KeySchema | Yes | N/A |
Required parameter: TableName | Yes | - It cannot contain the following special characters: dollar sign ($).
- It cannot start with the
system. prefix. - It must be 1 to 100 characters in length.
|
Optional parameter: BillingMode | No | N/A |
Optional parameter: GlobalSecondaryIndexes | Yes | N/A |
Optional parameter: LocalSecondaryIndexes | Yes | N/A |
Optional parameter: ProvisionedThroughput | No | N/A |
Optional parameter: SSESpecification | No | N/A |
Optional parameter: StreamSpecification | Yes | The StreamViewType parameter supports only the following values:- KEYS_ONLY
Note KEYS_ONLY supports only partition keys, but does not support sort keys. - NEW_IMAGE
|
Optional parameter: Tags | No | N/A |
Response parameters | TableDescription | Yes | N/A |
UpdateTable | Request parameters | Optional parameter: AttributeDefinitions | Yes | N/A |
Optional parameter: BillingMode | No | N/A |
Required parameter: GlobalSecondaryIndexesUpdates | Yes | CREATE and DELETE are supported. UPDATE is not supported. |
Optional parameter: ProvisionedThroughput | No | N/A |
Optional parameter: ReplicaUpdates | No | N/A |
Optional parameter: SSESpecification | No | N/A |
Optional parameter: StreamSpecification | Yes | The StreamViewType parameter supports only the following values:- KEYS_ONLY
Note KEYS_ONLY supports only partition keys, but does not support sort keys. - NEW_IMAGE
|
Required parameter: TableName | Yes | N/A |
Response parameters | TableDescription | Yes | For more information, see TableDescription. |
DescribeTable | Request parameters | Required parameter: TableName | Yes | N/A |
Response parameters | Table | Yes | For more information, see TableDescription. |
ListTables | Request parameters | Optional parameter: ExclusiveStartTableName | No | Records in different pages are not supported. No limit is imposed on the number of returned records. |
Optional parameter: Limit | No | Records in different pages are not supported. No limit is imposed on the number of returned records. |
Response parameters | LastEvaluatedTableName | No | N/A |
TableNames | Yes | N/A |
DeleteTable | Request parameters | Required parameter: TableName | Yes | N/A |
Response parameters | TableDescription | Yes | For more information, see TableDescription. |
PutItem | Request parameters | Required parameter: Item | Yes | N/A |
Required parameter: TableName | Yes | N/A |
Optional parameter: ConditionalOperator | No | N/A |
Optional parameter: ConditionExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: Expected | No | N/A |
Optional parameter: ExpressionAttributeNames | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ExpressionAttributeValues | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Optional parameter: ReturnItemCollectionMetrics | No | N/A |
Optional parameter: ReturnValues | Yes | N/A |
Response parameters | Attributes | Yes | N/A |
ConsumedCapacity | No | N/A |
ItemCollectionMetrics | No | N/A |
UpdateItem | Request parameters | Required parameter: Key | Yes | N/A |
Required parameter: TableName | Yes | N/A |
Optional parameter: AttributeUpdates | No | N/A |
Optional parameter: ConditionalOperator | No | N/A |
Optional parameter: ConditionExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: Expected | No | N/A |
Optional parameter: ExpressionAttributeNames | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ExpressionAttributeValues | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Optional parameter: ReturnItemCollectionMetrics | No | N/A |
Optional parameter: ReturnValues | Yes | N/A |
Optional parameter: UpdateExpression | Yes | For more information, see Compatibility details of expressions. |
Response parameters | Attributes | Yes | N/A |
ConsumedCapacity | No | N/A |
ItemCollectionMetrics | No | N/A |
GetItem | Request parameters | Required parameter: Key | Yes | N/A |
Required parameter: TableName | Yes | N/A |
Optional parameter: AttributesToGet | No | N/A |
Optional parameter: ConsistentRead | No | N/A |
Optional parameter: ExpressionAttributeNames | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ProjectionExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Response parameters | ConsumedCapacity | No | N/A |
Item | Yes | N/A |
DeleteItem | Request parameters | Required parameter: Key | Yes | N/A |
Required parameter: TableName | Yes | N/A |
Optional parameter: ConditionalOperator | No | N/A |
Optional parameter: ConditionExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: Expected | No | N/A |
Optional parameter: ExpressionAttributeNames | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ExpressionAttributeValues | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Optional parameter: ReturnItemCollectionMetrics | No | N/A |
Optional parameter: ReturnValues | Yes | N/A |
Response parameters | Attributes | Yes | N/A |
ConsumedCapacity | No | N/A |
ItemCollectionMetrics | No | N/A |
BatchWriteItem | Request parameters | Required parameter: RequestItems | Yes | N/A |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Optional parameter: ReturnItemCollectionMetrics | No | N/A |
Response parameters | ConsumedCapacity | No | N/A |
ItemCollectionMetrics | No | N/A |
UnprocessedItems | Yes | N/A |
BatchGetItem | Request parameters | Required parameter: RequestItems | Yes | Item does not support AttributesToGet and ConsistentRead parameters. |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Response parameters | ConsumedCapacity | No | N/A |
Responses | Yes | N/A |
UnprocessedKeys | Yes | N/A |
Query | Request parameters | Required parameter: TableName | Yes | N/A |
Optional parameter: AttributesToGet | No | N/A |
Optional parameter: ConditionalOperator | No | N/A |
Optional parameter: ConsistentRead | No | N/A |
Optional parameter: ExclusiveStartKey | Yes | N/A |
Optional parameter: ExpressionAttributeNames | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ExpressionAttributeValues | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: FilterExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: IndexName | Yes | N/A |
Optional parameter: KeyConditionExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: KeyConditions | No | N/A |
Optional parameter: Limit | Yes | N/A |
Optional parameter: ProjectionExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: QueryFilter | No | N/A |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Optional parameter: ScanIndexForward | Yes | N/A |
Optional parameter: Select | No | N/A |
Response parameters | ConsumedCapacity | No | N/A |
Count | Yes | N/A |
Items | Yes | N/A |
LastEvaluatedKey | Yes | N/A |
ScannedCount | Yes | N/A |
Scan | Request parameters | Required parameter: TableName | Yes | N/A |
Optional parameter: AttributesToGet | No | N/A |
Optional parameter: ConditionalOperator | No | N/A |
Optional parameter: ConsistentRead | No | N/A |
Optional parameter: ExclusiveStartKey | Yes | N/A |
Optional parameter: ExpressionAttributeNames | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ExpressionAttributeValues | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: FilterExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: IndexName | Yes | N/A |
Optional parameter: Limit | Yes | N/A |
Optional parameter: ProjectionExpression | Yes | For more information, see Compatibility details of expressions. |
Optional parameter: ReturnConsumedCapacity | No | N/A |
Optional parameter: ScanFilter | No | N/A |
Optional parameter: Segment | Yes | N/A |
Optional parameter: Select | No | N/A |
Optional parameter: TotalSegments | Yes | N/A |
Response parameters | ConsumedCapacity | No | N/A |
Count | Yes | N/A |
Items | Yes | N/A |
LastEvaluatedKey | Yes | N/A |
ScannedCount | Yes | N/A |