diff --git a/aws-sdk/models/dynamodb.json b/aws-sdk/models/dynamodb.json index 8fabdfa9b0614b5406fd46bc4738ecdab35b1094..772dbe5ef2154dc3d7d1c54ad03453e5c4400fb1 100644 --- a/aws-sdk/models/dynamodb.json +++ b/aws-sdk/models/dynamodb.json @@ -63,13 +63,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ADD" + "value": "ADD", + "name": "ADD" }, { - "value": "PUT" + "value": "PUT", + "name": "PUT" }, { - "value": "DELETE" + "value": "DELETE", + "name": "DELETE" } ] } @@ -590,13 +593,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "DELETED" + "value": "DELETED", + "name": "DELETED" }, { - "value": "AVAILABLE" + "value": "AVAILABLE", + "name": "AVAILABLE" } ] } @@ -1102,10 +1108,12 @@ "traits": { "smithy.api#enum": [ { - "value": "PROVISIONED" + "value": "PROVISIONED", + "name": "PROVISIONED" }, { - "value": "PAY_PER_REQUEST" + "value": "PAY_PER_REQUEST", + "name": "PAY_PER_REQUEST" } ] } @@ -1235,43 +1243,56 @@ "traits": { "smithy.api#enum": [ { - "value": "EQ" + "value": "EQ", + "name": "EQ" }, { - "value": "NE" + "value": "NE", + "name": "NE" }, { - "value": "IN" + "value": "IN", + "name": "IN" }, { - "value": "LE" + "value": "LE", + "name": "LE" }, { - "value": "LT" + "value": "LT", + "name": "LT" }, { - "value": "GE" + "value": "GE", + "name": "GE" }, { - "value": "GT" + "value": "GT", + "name": "GT" }, { - "value": "BETWEEN" + "value": "BETWEEN", + "name": "BETWEEN" }, { - "value": "NOT_NULL" + "value": "NOT_NULL", + "name": "NOT_NULL" }, { - "value": "NULL" + "value": "NULL", + "name": "NULL" }, { - "value": "CONTAINS" + "value": "CONTAINS", + "name": "CONTAINS" }, { - "value": "NOT_CONTAINS" + "value": "NOT_CONTAINS", + "name": "NOT_CONTAINS" }, { - "value": "BEGINS_WITH" + "value": "BEGINS_WITH", + "name": "BEGINS_WITH" } ] } @@ -1367,10 +1388,12 @@ "traits": { "smithy.api#enum": [ { - "value": "AND" + "value": "AND", + "name": "AND" }, { - "value": "OR" + "value": "OR", + "name": "OR" } ] } @@ -1469,10 +1492,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" } ] } @@ -1494,10 +1519,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLE" + "value": "ENABLE", + "name": "ENABLE" }, { - "value": "DISABLE" + "value": "DISABLE", + "name": "DISABLE" } ] } @@ -1519,19 +1546,24 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLING" + "value": "ENABLING", + "name": "ENABLING" }, { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLING" + "value": "DISABLING", + "name": "DISABLING" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" } ] } @@ -2710,7 +2742,41 @@ } ], "traits": { - "smithy.api#documentation": "
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
\nIf you issue a DescribeTable
request immediately after a CreateTable
request, DynamoDB might\n return a ResourceNotFoundException
. This is because DescribeTable
uses an eventually\n consistent query, and the metadata for your table might not be available at that moment.\n Wait for a few seconds, and then try the DescribeTable
request again.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
\nIf you issue a DescribeTable
request immediately after a CreateTable
request, DynamoDB might\n return a ResourceNotFoundException
. This is because DescribeTable
uses an eventually\n consistent query, and the metadata for your table might not be available at that moment.\n Wait for a few seconds, and then try the DescribeTable
request again.
The Query
operation finds items based on primary key values.\n You can query any table or secondary index that has a composite primary key (a partition\n key and a sort key).\n
Use the KeyConditionExpression
parameter to provide a specific value\n for the partition key. The Query
operation will return all of the items\n from the table or index with that partition key value. You can optionally narrow the\n scope of the Query
operation by specifying a sort key value and a\n comparison operator in KeyConditionExpression
. To further refine the Query
results,\n you can optionally provide a FilterExpression
. A FilterExpression
determines which items\n within the results should be returned to you. All of the other results are discarded.\n
\n A Query
operation always returns a result set. If no matching items are found,\n the result set will be empty. Queries that do not return results consume the minimum number of\n read capacity units for that type of read operation.\n
\n DynamoDB calculates the number of read capacity units consumed based on item size,\n not on the amount of data that is returned to an application. The number of capacity\n units consumed will be the same whether you request all of the attributes (the default behavior)\n or just some of them (using a projection expression). The number will also be the same\n whether or not you use a FilterExpression
.\n
\n Query
results are always sorted by the sort key value. If the data type of the sort key is Number,\n the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes.\n By default, the sort order is ascending. To reverse the order, set the ScanIndexForward
parameter\n to false.\n
A single Query
operation will read up to the maximum number of items\n set (if using the Limit
parameter) or a maximum of 1 MB of data and then\n apply any filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.
\n FilterExpression
is applied after a Query
finishes, but before\n the results are returned.\n A FilterExpression
cannot contain partition key or sort key attributes.\n You need to specify those attributes in the KeyConditionExpression
.\n
\n A Query
operation can return an empty result set and a LastEvaluatedKey
\n if all the items read for the page of results are filtered out.\n
You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead
parameter to true
and obtain a\n strongly consistent result. Global secondary indexes support eventually consistent reads\n only, so do not specify ConsistentRead
when querying a global\n secondary index.
The Query
operation finds items based on primary key values.\n You can query any table or secondary index that has a composite primary key (a partition\n key and a sort key).\n
Use the KeyConditionExpression
parameter to provide a specific value\n for the partition key. The Query
operation will return all of the items\n from the table or index with that partition key value. You can optionally narrow the\n scope of the Query
operation by specifying a sort key value and a\n comparison operator in KeyConditionExpression
. To further refine the Query
results,\n you can optionally provide a FilterExpression
. A FilterExpression
determines which items\n within the results should be returned to you. All of the other results are discarded.\n
\n A Query
operation always returns a result set. If no matching items are found,\n the result set will be empty. Queries that do not return results consume the minimum number of\n read capacity units for that type of read operation.\n
\n DynamoDB calculates the number of read capacity units consumed based on item size,\n not on the amount of data that is returned to an application. The number of capacity\n units consumed will be the same whether you request all of the attributes (the default behavior)\n or just some of them (using a projection expression). The number will also be the same\n whether or not you use a FilterExpression
.\n
\n Query
results are always sorted by the sort key value. If the data type of the sort key is Number,\n the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes.\n By default, the sort order is ascending. To reverse the order, set the ScanIndexForward
parameter\n to false.\n
A single Query
operation will read up to the maximum number of items\n set (if using the Limit
parameter) or a maximum of 1 MB of data and then\n apply any filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.
\n FilterExpression
is applied after a Query
finishes, but before\n the results are returned.\n A FilterExpression
cannot contain partition key or sort key attributes.\n You need to specify those attributes in the KeyConditionExpression
.\n
\n A Query
operation can return an empty result set and a LastEvaluatedKey
\n if all the items read for the page of results are filtered out.\n
You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead
parameter to true
and obtain a\n strongly consistent result. Global secondary indexes support eventually consistent reads\n only, so do not specify ConsistentRead
when querying a global\n secondary index.
Determines the level of detail about provisioned throughput consumption that is returned in the response:
\n\n INDEXES
- The response includes the aggregate ConsumedCapacity
for the operation, together with ConsumedCapacity
for each table and secondary index that was accessed.
Note that some operations, such as GetItem
and BatchGetItem
, do not access any indexes at all. In these cases, specifying INDEXES
will only return ConsumedCapacity
information for table(s).
\n TOTAL
- The response includes only the aggregate ConsumedCapacity
for the operation.
\n NONE
- No ConsumedCapacity
details are included in the response.
The Scan
operation returns one or more items and item attributes by accessing every\n item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression
operation.
If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan stops and results are returned to the user as a LastEvaluatedKey
value\n to continue the scan in a subsequent operation. The results also include the number of\n items exceeding the limit. A scan can result in no table data meeting the filter\n criteria.
A single Scan
operation reads up to the maximum number of items set (if\n using the Limit
parameter) or a maximum of 1 MB of data and then apply any\n filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you need to paginate the\n result set. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.
\n Scan
operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan
\n operation by providing the Segment
and TotalSegments
\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.
\n Scan
uses eventually consistent reads when accessing the data in a\n table; therefore, the result set might not include the changes to data in the table\n immediately before the operation began. If you need a consistent copy of the data, as of\n the time that the Scan
begins, you can set the ConsistentRead
\n parameter to true
.
The Scan
operation returns one or more items and item attributes by accessing every\n item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression
operation.
If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan stops and results are returned to the user as a LastEvaluatedKey
value\n to continue the scan in a subsequent operation. The results also include the number of\n items exceeding the limit. A scan can result in no table data meeting the filter\n criteria.
A single Scan
operation reads up to the maximum number of items set (if\n using the Limit
parameter) or a maximum of 1 MB of data and then apply any\n filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you need to paginate the\n result set. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.
\n Scan
operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan
\n operation by providing the Segment
and TotalSegments
\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.
\n Scan
uses eventually consistent reads when accessing the data in a\n table; therefore, the result set might not include the changes to data in the table\n immediately before the operation began. If you need a consistent copy of the data, as of\n the time that the Scan
begins, you can set the ConsistentRead
\n parameter to true
.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
\nIf you issue a DescribeTable
request immediately after a CreateTable
request, DynamoDB might\n return a ResourceNotFoundException
. This is because DescribeTable
uses an eventually\n consistent query, and the metadata for your table might not be available at that moment.\n Wait for a few seconds, and then try the DescribeTable
request again.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
\nIf you issue a DescribeTable
request immediately after a CreateTable
request, DynamoDB might\n return a ResourceNotFoundException
. This is because DescribeTable
uses an eventually\n consistent query, and the metadata for your table might not be available at that moment.\n Wait for a few seconds, and then try the DescribeTable
request again.
The Query
operation finds items based on primary key values.\n You can query any table or secondary index that has a composite primary key (a partition\n key and a sort key).\n
Use the KeyConditionExpression
parameter to provide a specific value\n for the partition key. The Query
operation will return all of the items\n from the table or index with that partition key value. You can optionally narrow the\n scope of the Query
operation by specifying a sort key value and a\n comparison operator in KeyConditionExpression
. To further refine the Query
results,\n you can optionally provide a FilterExpression
. A FilterExpression
determines which items\n within the results should be returned to you. All of the other results are discarded.\n
\n A Query
operation always returns a result set. If no matching items are found,\n the result set will be empty. Queries that do not return results consume the minimum number of\n read capacity units for that type of read operation.\n
\n DynamoDB calculates the number of read capacity units consumed based on item size,\n not on the amount of data that is returned to an application. The number of capacity\n units consumed will be the same whether you request all of the attributes (the default behavior)\n or just some of them (using a projection expression). The number will also be the same\n whether or not you use a FilterExpression
.\n
\n Query
results are always sorted by the sort key value. If the data type of the sort key is Number,\n the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes.\n By default, the sort order is ascending. To reverse the order, set the ScanIndexForward
parameter\n to false.\n
A single Query
operation will read up to the maximum number of items\n set (if using the Limit
parameter) or a maximum of 1 MB of data and then\n apply any filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.
\n FilterExpression
is applied after a Query
finishes, but before\n the results are returned.\n A FilterExpression
cannot contain partition key or sort key attributes.\n You need to specify those attributes in the KeyConditionExpression
.\n
\n A Query
operation can return an empty result set and a LastEvaluatedKey
\n if all the items read for the page of results are filtered out.\n
You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead
parameter to true
and obtain a\n strongly consistent result. Global secondary indexes support eventually consistent reads\n only, so do not specify ConsistentRead
when querying a global\n secondary index.
The Query
operation finds items based on primary key values.\n You can query any table or secondary index that has a composite primary key (a partition\n key and a sort key).\n
Use the KeyConditionExpression
parameter to provide a specific value\n for the partition key. The Query
operation will return all of the items\n from the table or index with that partition key value. You can optionally narrow the\n scope of the Query
operation by specifying a sort key value and a\n comparison operator in KeyConditionExpression
. To further refine the Query
results,\n you can optionally provide a FilterExpression
. A FilterExpression
determines which items\n within the results should be returned to you. All of the other results are discarded.\n
\n A Query
operation always returns a result set. If no matching items are found,\n the result set will be empty. Queries that do not return results consume the minimum number of\n read capacity units for that type of read operation.\n
\n DynamoDB calculates the number of read capacity units consumed based on item size,\n not on the amount of data that is returned to an application. The number of capacity\n units consumed will be the same whether you request all of the attributes (the default behavior)\n or just some of them (using a projection expression). The number will also be the same\n whether or not you use a FilterExpression
.\n
\n Query
results are always sorted by the sort key value. If the data type of the sort key is Number,\n the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes.\n By default, the sort order is ascending. To reverse the order, set the ScanIndexForward
parameter\n to false.\n
A single Query
operation will read up to the maximum number of items\n set (if using the Limit
parameter) or a maximum of 1 MB of data and then\n apply any filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.
\n FilterExpression
is applied after a Query
finishes, but before\n the results are returned.\n A FilterExpression
cannot contain partition key or sort key attributes.\n You need to specify those attributes in the KeyConditionExpression
.\n
\n A Query
operation can return an empty result set and a LastEvaluatedKey
\n if all the items read for the page of results are filtered out.\n
You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead
parameter to true
and obtain a\n strongly consistent result. Global secondary indexes support eventually consistent reads\n only, so do not specify ConsistentRead
when querying a global\n secondary index.
Determines the level of detail about provisioned throughput consumption that is returned in the response:
\n\n INDEXES
- The response includes the aggregate ConsumedCapacity
for the operation, together with ConsumedCapacity
for each table and secondary index that was accessed.
Note that some operations, such as GetItem
and BatchGetItem
, do not access any indexes at all. In these cases, specifying INDEXES
will only return ConsumedCapacity
information for table(s).
\n TOTAL
- The response includes only the aggregate ConsumedCapacity
for the operation.
\n NONE
- No ConsumedCapacity
details are included in the response.
The Scan
operation returns one or more items and item attributes by accessing every\n item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression
operation.
If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan stops and results are returned to the user as a LastEvaluatedKey
value\n to continue the scan in a subsequent operation. The results also include the number of\n items exceeding the limit. A scan can result in no table data meeting the filter\n criteria.
A single Scan
operation reads up to the maximum number of items set (if\n using the Limit
parameter) or a maximum of 1 MB of data and then apply any\n filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you need to paginate the\n result set. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.
\n Scan
operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan
\n operation by providing the Segment
and TotalSegments
\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.
\n Scan
uses eventually consistent reads when accessing the data in a\n table; therefore, the result set might not include the changes to data in the table\n immediately before the operation began. If you need a consistent copy of the data, as of\n the time that the Scan
begins, you can set the ConsistentRead
\n parameter to true
.
The Scan
operation returns one or more items and item attributes by accessing every\n item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression
operation.
If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan stops and results are returned to the user as a LastEvaluatedKey
value\n to continue the scan in a subsequent operation. The results also include the number of\n items exceeding the limit. A scan can result in no table data meeting the filter\n criteria.
A single Scan
operation reads up to the maximum number of items set (if\n using the Limit
parameter) or a maximum of 1 MB of data and then apply any\n filtering to the results using FilterExpression
. If\n LastEvaluatedKey
is present in the response, you need to paginate the\n result set. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.
\n Scan
operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan
\n operation by providing the Segment
and TotalSegments
\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.
\n Scan
uses eventually consistent reads when accessing the data in a\n table; therefore, the result set might not include the changes to data in the table\n immediately before the operation began. If you need a consistent copy of the data, as of\n the time that the Scan
begins, you can set the ConsistentRead
\n parameter to true
.