The reason DynamoDB archived the table. Currently, the only possible value is:
\n\n\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due\n to the table's KMS key being inaccessible for more than seven\n days. An On-Demand backup was created at the archival time.
The reason DynamoDB archived the table. Currently, the only possible value is:
\n\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due\n to the table's KMS key being inaccessible for more than seven\n days. An On-Demand backup was created at the archival time.
The data type for the attribute, where:
\n\n S - the attribute is of type String
\n N - the attribute is of type Number
\n B - the attribute is of type Binary
The data type for the attribute, where:
\n\n S - the attribute is of type String
\n N - the attribute is of type Number
\n B - the attribute is of type Binary
Represents an attribute for describing the key schema for the table and\n indexes.
" + "smithy.api#documentation": "Represents an attribute for describing the schema for the table and\n indexes.
" } }, "com.amazonaws.dynamodb#AttributeDefinitions": { @@ -149,66 +170,66 @@ "S": { "target": "com.amazonaws.dynamodb#StringAttributeValue", "traits": { - "smithy.api#documentation": "An attribute of type String. For example:
\n\n \"S\": \"Hello\"\n
An attribute of type String. For example:
\n\n \"S\": \"Hello\"\n
An attribute of type Number. For example:
\n\n \"N\": \"123.45\"\n
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.
" + "smithy.api#documentation": "An attribute of type Number. For example:
\n\n \"N\": \"123.45\"\n
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.
" } }, "B": { "target": "com.amazonaws.dynamodb#BinaryAttributeValue", "traits": { - "smithy.api#documentation": "An attribute of type Binary. For example:
\n\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n
An attribute of type Binary. For example:
\n\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n
An attribute of type String Set. For example:
\n\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n
An attribute of type String Set. For example:
\n\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n
An attribute of type Number Set. For example:
\n\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.
" + "smithy.api#documentation": "An attribute of type Number Set. For example:
\n\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.
" } }, "BS": { "target": "com.amazonaws.dynamodb#BinarySetAttributeValue", "traits": { - "smithy.api#documentation": "An attribute of type Binary Set. For example:
\n\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n
An attribute of type Binary Set. For example:
\n\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n
An attribute of type Map. For example:
\n\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n
An attribute of type Map. For example:
\n\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n
An attribute of type List. For example:
\n\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\": \"3.14159\"}]\n
An attribute of type List. For example:
\n\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\": \"3.14159\"}]\n
An attribute of type Null. For example:
\n\n \"NULL\": true\n
An attribute of type Null. For example:
\n\n \"NULL\": true\n
An attribute of type Boolean. For example:
\n\n \"BOOL\": true\n
An attribute of type Boolean. For example:
\n\n \"BOOL\": true\n
Represents the data for an attribute.
\nEach attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.
\nFor more information, see Data Types in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the data for an attribute.
\nEach attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.
\nFor more information, see Data Types in the Amazon DynamoDB Developer\n Guide.
" } }, "com.amazonaws.dynamodb#AttributeValueList": { @@ -223,18 +244,18 @@ "Value": { "target": "com.amazonaws.dynamodb#AttributeValue", "traits": { - "smithy.api#documentation": "Represents the data for an attribute.
\nEach attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.
\nFor more information, see Data Types in the Amazon DynamoDB Developer Guide.\n
" + "smithy.api#documentation": "Represents the data for an attribute.
\nEach attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.
\nFor more information, see Data Types in the Amazon DynamoDB Developer Guide.\n
" } }, "Action": { "target": "com.amazonaws.dynamodb#AttributeAction", "traits": { - "smithy.api#documentation": "Specifies how to perform the update. Valid values are PUT (default),\n DELETE, and ADD. The behavior depends on whether the\n specified primary key already exists in the table.
\n If an item with the specified Key is found in\n the table:\n
\n\n\n PUT - Adds the specified attribute to the item. If the attribute\n already exists, it is replaced by the new value.
\n DELETE - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the\n existing value's data type.
If a set of values is specified, then those values are\n subtracted from the old set. For example, if the attribute value was the set\n [a,b,c] and the DELETE action specified\n [a,c], then the final attribute value would be\n [b]. Specifying an empty set is an error.
\n ADD - If the attribute does not already exist, then the attribute\n and its values are added to the item. If the attribute does exist, then the\n behavior of ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is\n also a number, then the Value is mathematically added to\n the existing attribute. If Value is a negative number, then\n it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number\n value for an item that doesn't exist before the update, DynamoDB\n uses 0 as the initial value.
In addition, if you use ADD to update an existing\n item, and intend to increment or decrement an attribute value which\n does not yet exist, DynamoDB uses 0 as the initial\n value. For example, suppose that the item you want to update does\n not yet have an attribute named itemcount, but\n you decide to ADD the number 3 to this\n attribute anyway, even though it currently does not exist. DynamoDB\n will create the itemcount attribute, set its\n initial value to 0, and finally add 3 to\n it. The result will be a new itemcount\n attribute in the item, with a value of 3.
If the existing data type is a set, and if the Value is\n also a set, then the Value is added to the existing set.\n (This is a set operation, not mathematical\n addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified\n [3], then the final attribute value would be\n [1,2,3]. An error occurs if an Add action is specified\n for a set attribute and the attribute type specified does not match the\n existing set type.
Both sets must have the same primitive data type. For example, if the\n existing data type is a set of strings, the Value must also\n be a set of strings. The same holds true for number sets and binary\n sets.
This action is only valid for an existing attribute whose data type is number\n or is a set. Do not use ADD for any other data types.
\n If no item with the specified Key is\n found:\n
\n\n\n PUT - DynamoDB creates a new item with the specified primary key,\n and then adds the attribute.
\n DELETE - Nothing happens; there is no attribute to delete.
\n ADD - DynamoDB creates a new item with the supplied primary key and\n number (or set) for the attribute value. The only data types allowed\n are number, number set, string set or binary set.
Specifies how to perform the update. Valid values are PUT (default),\n DELETE, and ADD. The behavior depends on whether the\n specified primary key already exists in the table.
\n If an item with the specified Key is found in\n the table:\n
\n\n PUT - Adds the specified attribute to the item. If the attribute\n already exists, it is replaced by the new value.
\n DELETE - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the\n existing value's data type.
If a set of values is specified, then those values are\n subtracted from the old set. For example, if the attribute value was the set\n [a,b,c] and the DELETE action specified\n [a,c], then the final attribute value would be\n [b]. Specifying an empty set is an error.
\n ADD - If the attribute does not already exist, then the attribute\n and its values are added to the item. If the attribute does exist, then the\n behavior of ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is\n also a number, then the Value is mathematically added to\n the existing attribute. If Value is a negative number, then\n it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number\n value for an item that doesn't exist before the update, DynamoDB\n uses 0 as the initial value.
In addition, if you use ADD to update an existing\n item, and intend to increment or decrement an attribute value which\n does not yet exist, DynamoDB uses 0 as the initial\n value. For example, suppose that the item you want to update does\n not yet have an attribute named itemcount, but\n you decide to ADD the number 3 to this\n attribute anyway, even though it currently does not exist. DynamoDB\n will create the itemcount attribute, set its\n initial value to 0, and finally add 3 to\n it. The result will be a new itemcount\n attribute in the item, with a value of 3.
If the existing data type is a set, and if the Value is\n also a set, then the Value is added to the existing set.\n (This is a set operation, not mathematical\n addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified\n [3], then the final attribute value would be\n [1,2,3]. An error occurs if an Add action is specified\n for a set attribute and the attribute type specified does not match the\n existing set type.
Both sets must have the same primitive data type. For example, if the\n existing data type is a set of strings, the Value must also\n be a set of strings. The same holds true for number sets and binary\n sets.
This action is only valid for an existing attribute whose data type is number\n or is a set. Do not use ADD for any other data types.
\n If no item with the specified Key is\n found:\n
\n\n PUT - DynamoDB creates a new item with the specified primary key,\n and then adds the attribute.
\n DELETE - Nothing happens; there is no attribute to delete.
\n ADD - DynamoDB creates a new item with the supplied primary key and\n number (or set) for the attribute value. The only data types allowed are number,\n number set, string set or binary set.
For the UpdateItem operation, represents the attributes to be modified,\n the action to perform on each, and the new value for each.
You cannot use UpdateItem to update any primary key attributes.\n Instead, you will need to delete the item, and then use PutItem to\n create a new item with new attributes.
Attribute values cannot be null; string and binary type attributes must have lengths\n greater than zero; and set type attributes must not be empty. Requests with empty values\n will be rejected with a ValidationException exception.
For the UpdateItem operation, represents the attributes to be modified,\n the action to perform on each, and the new value for each.
You cannot use UpdateItem to update any primary key attributes.\n Instead, you will need to delete the item, and then use PutItem to\n create a new item with new attributes.
Attribute values cannot be null; string and binary type attributes must have lengths\n greater than zero; and set type attributes must not be empty. Requests with empty values\n will be rejected with a ValidationException exception.
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).
", "smithy.api#required": {} @@ -435,7 +456,7 @@ } }, "TargetValue": { - "target": "com.amazonaws.dynamodb#Double", + "target": "com.amazonaws.dynamodb#DoubleObject", "traits": { "smithy.api#documentation": "The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).
", "smithy.api#required": {} @@ -447,10 +468,7 @@ } }, "com.amazonaws.dynamodb#Backfilling": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.dynamodb#BackupArn": { "type": "string", @@ -510,7 +528,7 @@ "BackupSizeBytes": { "target": "com.amazonaws.dynamodb#BackupSizeBytes", "traits": { - "smithy.api#documentation": "Size of the backup in bytes. DynamoDB updates this value approximately every six hours. \n Recent changes might not be reflected in this value.
" + "smithy.api#documentation": "Size of the backup in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.
" } }, "BackupStatus": { @@ -523,7 +541,7 @@ "BackupType": { "target": "com.amazonaws.dynamodb#BackupType", "traits": { - "smithy.api#documentation": "BackupType:
\n\n USER - You create and manage these using the on-demand backup\n feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled,\n a SYSTEM backup is automatically created and is retained for 35\n days (at no additional cost). System backups allow you to restore the deleted\n table to the state it was in just before the point of deletion.
\n AWS_BACKUP - On-demand backup created by you from Backup service.
BackupType:
\n\n USER - You create and manage these using the on-demand backup\n feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled,\n a SYSTEM backup is automatically created and is retained for 35\n days (at no additional cost). System backups allow you to restore the deleted\n table to the state it was in just before the point of deletion.
\n AWS_BACKUP - On-demand backup created by you from Backup service.
BackupType:
\n\n USER - You create and manage these using the on-demand backup\n feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled,\n a SYSTEM backup is automatically created and is retained for 35\n days (at no additional cost). System backups allow you to restore the deleted\n table to the state it was in just before the point of deletion.
\n AWS_BACKUP - On-demand backup created by you from Backup service.
BackupType:
\n\n USER - You create and manage these using the on-demand backup\n feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled,\n a SYSTEM backup is automatically created and is retained for 35\n days (at no additional cost). System backups allow you to restore the deleted\n table to the state it was in just before the point of deletion.
\n AWS_BACKUP - On-demand backup created by you from Backup service.
This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality\n condition on all key attributes. This enforces that each SELECT statement in a\n batch returns at most a single item.
The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.
\nA HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.
This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB\n .
The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.
\nA HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.
The response to each PartiQL statement in the batch.
" + "smithy.api#documentation": "The response to each PartiQL statement in the batch. The values of the list are\n ordered according to the ordering of the request statements.
" } }, "ConsumedCapacity": { @@ -783,6 +816,9 @@ "smithy.api#documentation": "The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#BatchGetItem": { @@ -814,7 +850,67 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, or an internal processing\n failure occurs. If a partial result is returned, the operation returns a value for\n UnprocessedKeys. You can use this value to retry the operation starting\n with the next item to get.
If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nBy default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem retrieves items in\n parallel.
When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for UnprocessedKeys. You can use this value\n to retry the operation starting with the next item to get.
If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nBy default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.
When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
", + "smithy.api#examples": [ + { + "title": "To retrieve multiple items from a table", + "documentation": "This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.", + "input": { + "RequestItems": { + "Music": { + "Keys": [ + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ProjectionExpression": "AlbumTitle" + } + } + }, + "output": { + "Responses": { + "Music": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + } + }, + { + "AlbumTitle": { + "S": "Louder Than Ever" + } + } + ] + } + } + } + ] } }, "com.amazonaws.dynamodb#BatchGetItemInput": { @@ -823,7 +919,7 @@ "RequestItems": { "target": "com.amazonaws.dynamodb#BatchGetRequestMap", "traits": { - "smithy.api#documentation": "A map of one or more table names and, for each table, a map that describes one or more\n items to retrieve from that table. Each table name can be used only once per\n BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
\n\n ConsistentRead - If true, a strongly consistent read\n is used; if false (the default), an eventually consistent read is\n used.
\n ExpressionAttributeNames - One or more substitution tokens for\n attribute names in the ProjectionExpression parameter. The\n following are some use cases for using\n ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name\n in an expression.
\nTo prevent special characters in an attribute name from being\n misinterpreted in an expression.
\nUse the # character in an expression to\n dereference an attribute name. For example, consider the following attribute\n name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be\n used directly in an expression. (For the complete list of reserved words, see\n Reserved\n Words in the Amazon DynamoDB Developer Guide).\n To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this\n example:
\n\n #P = :val\n
Tokens that begin with the : character\n are expression attribute values, which are placeholders\n for the actual value at runtime.
\nFor more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n Keys - An array of primary key attribute values that define\n specific items in the table. For each primary key, you must provide\n all of the key attributes. For example, with a simple\n primary key, you only need to provide the partition key value. For a composite\n key, you must provide both the partition key value and the\n sort key value.
\n ProjectionExpression - A string that identifies one or more\n attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the expression must be\n separated by commas.
If no attribute names are specified, then all attributes are returned. If any\n of the requested attributes are not found, they do not appear in the\n result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n AttributesToGet - This is a legacy parameter. Use\n ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.
A map of one or more table names or table ARNs and, for each table, a map that\n describes one or more items to retrieve from that table. Each table name or ARN can be\n used only once per BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
\n\n ConsistentRead - If true, a strongly consistent read\n is used; if false (the default), an eventually consistent read is\n used.
\n ExpressionAttributeNames - One or more substitution tokens for\n attribute names in the ProjectionExpression parameter. The\n following are some use cases for using\n ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name\n in an expression.
\nTo prevent special characters in an attribute name from being\n misinterpreted in an expression.
\nUse the # character in an expression to\n dereference an attribute name. For example, consider the following attribute\n name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be\n used directly in an expression. (For the complete list of reserved words, see\n Reserved\n Words in the Amazon DynamoDB Developer Guide).\n To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this\n example:
\n\n #P = :val\n
Tokens that begin with the : character\n are expression attribute values, which are placeholders\n for the actual value at runtime.
\nFor more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n Keys - An array of primary key attribute values that define\n specific items in the table. For each primary key, you must provide\n all of the key attributes. For example, with a simple\n primary key, you only need to provide the partition key value. For a composite\n key, you must provide both the partition key value and the\n sort key value.
\n ProjectionExpression - A string that identifies one or more\n attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the expression must be\n separated by commas.
If no attribute names are specified, then all attributes are returned. If any\n of the requested attributes are not found, they do not appear in the\n result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.
\n\n AttributesToGet - This is a legacy parameter. Use\n ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.
Represents the input of a BatchGetItem operation.
Represents the input of a BatchGetItem operation.
A map of table name to a list of items. Each object in Responses consists\n of a table name, along with a map of attribute data consisting of the data type and\n attribute value.
A map of table name or table ARN to a list of items. Each object in\n Responses consists of a table name or ARN, along with a map of\n attribute data consisting of the data type and attribute value.
A map of tables and their respective keys that were not processed with the current\n response. The UnprocessedKeys value is in the same form as\n RequestItems, so the value can be provided directly to a subsequent\n BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.
Each element consists of:
\n\n Keys - An array of primary key attribute values that define\n specific items in the table.
\n ProjectionExpression - One or more attributes to be retrieved from\n the table or index. By default, all attributes are returned. If a requested\n attribute is not found, it does not appear in the result.
\n ConsistentRead - The consistency of a read operation. If set to\n true, then a strongly consistent read is used; otherwise, an\n eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty\n UnprocessedKeys map.
A map of tables and their respective keys that were not processed with the current\n response. The UnprocessedKeys value is in the same form as\n RequestItems, so the value can be provided directly to a subsequent\n BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.
Each element consists of:
\n\n Keys - An array of primary key attribute values that define\n specific items in the table.
\n ProjectionExpression - One or more attributes to be retrieved from\n the table or index. By default, all attributes are returned. If a requested\n attribute is not found, it does not appear in the result.
\n ConsistentRead - The consistency of a read operation. If set to\n true, then a strongly consistent read is used; otherwise, an\n eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty\n UnprocessedKeys map.
The read capacity units consumed by the entire BatchGetItem\n operation.
Each element consists of:
\n\n TableName - The table that consumed the provisioned\n throughput.
\n CapacityUnits - The total number of capacity units consumed.
The read capacity units consumed by the entire BatchGetItem\n operation.
Each element consists of:
\n\n TableName - The table that consumed the provisioned\n throughput.
\n CapacityUnits - The total number of capacity units consumed.
Represents the output of a BatchGetItem operation.
Represents the output of a BatchGetItem operation.
The error message associated with the PartiQL batch response.
" } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.
The read consistency of the PartiQL batch request.
" } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "An optional parameter that returns the item attributes for a PartiQL batch request\n operation that failed a condition check.
\nThere is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" + } } }, "traits": { @@ -1041,7 +1171,65 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.
\n BatchWriteItem cannot update items. To update items, use the\n UpdateItem action.
The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nWith BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.
\nIf one or more of the following is true, DynamoDB rejects the entire batch write\n operation:
\nOne or more tables specified in the BatchWriteItem request does\n not exist.
Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.
\nYou try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).
\nThere are more than 25 requests in the batch.
\nAny individual item in a batch exceeds 400 KB.
\nThe total request size exceeds 16 MB.
\nThe BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.
\n BatchWriteItem cannot update items. If you perform a\n BatchWriteItem operation on an existing item, that item's values\n will be overwritten by the operation and it will appear like it was updated. To\n update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.
For tables and indexes with provisioned capacity, if none of the items can be\n processed due to insufficient provisioned throughput on all of the tables in the\n request, then BatchWriteItem returns a\n ProvisionedThroughputExceededException. For all tables and indexes, if\n none of the items can be processed due to other throttling scenarios (such as exceeding\n partition level limits), then BatchWriteItem returns a\n ThrottlingException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nWith BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.
\nIf one or more of the following is true, DynamoDB rejects the entire batch write\n operation:
\nOne or more tables specified in the BatchWriteItem request does\n not exist.
Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.
\nYou try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).
\nThere are more than 25 requests in the batch.
\nAny individual item in a batch exceeds 400 KB.
\nThe total request size exceeds 16 MB.
\nAny individual items with keys exceeding the key length limits. For a\n partition key, the limit is 2048 bytes and for a sort key, the limit is 1024\n bytes.
\nA map of one or more table names and, for each table, a list of operations to be\n performed (DeleteRequest or PutRequest). Each element in the\n map consists of the following:
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value. For each primary key, you must provide\n all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition\n key. For a composite primary key, you must provide values for\n both the partition key and the sort key.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values are rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nA map of one or more table names or table ARNs and, for each table, a list of\n operations to be performed (DeleteRequest or PutRequest). Each\n element in the map consists of the following:
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value. For each primary key, you must provide\n all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition\n key. For a composite primary key, you must provide values for\n both the partition key and the sort key.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values are rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nRepresents the input of a BatchWriteItem operation.
Represents the input of a BatchWriteItem operation.
A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name and, for that table,\n a list of operations to perform (DeleteRequest or\n PutRequest).
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values will be rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nIf there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.
A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchWriteItem operation. For more information, see\n RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name or table ARN\n and, for that table, a list of operations to perform (DeleteRequest or\n PutRequest).
\n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:
\n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value.
\n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:
\n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values will be rejected with a\n ValidationException exception.
If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.
\nIf there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.
A list of tables that were processed by BatchWriteItem and, for each\n table, information about any item collections that were affected by individual\n DeleteItem or PutItem operations.
Each entry consists of the following subelements:
\n\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item.
\n SizeEstimateRangeGB - An estimate of item collection size,\n expressed in GB. This is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on the table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nA list of tables that were processed by BatchWriteItem and, for each\n table, information about any item collections that were affected by individual\n DeleteItem or PutItem operations.
Each entry consists of the following subelements:
\n\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item.
\n SizeEstimateRangeGB - An estimate of item collection size,\n expressed in GB. This is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on the table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nThe capacity units consumed by the entire BatchWriteItem\n operation.
Each element consists of:
\n\n TableName - The table that consumed the provisioned\n throughput.
\n CapacityUnits - The total number of capacity units consumed.
The capacity units consumed by the entire BatchWriteItem\n operation.
Each element consists of:
\n\n TableName - The table that consumed the provisioned\n throughput.
\n CapacityUnits - The total number of capacity units consumed.
Represents the output of a BatchWriteItem operation.
Represents the output of a BatchWriteItem operation.
Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.
\n\n PROVISIONED - Sets the read/write capacity mode to\n PROVISIONED. We recommend using PROVISIONED for\n predictable workloads.
\n PAY_PER_REQUEST - Sets the read/write capacity mode to\n PAY_PER_REQUEST. We recommend using\n PAY_PER_REQUEST for unpredictable workloads.
Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.
\n\n PROVISIONED - Sets the read/write capacity mode to\n PROVISIONED. We recommend using PROVISIONED for\n predictable workloads.
\n PAY_PER_REQUEST - Sets the read/write capacity mode to\n PAY_PER_REQUEST. We recommend using\n PAY_PER_REQUEST for unpredictable workloads.
Contains the details for the read/write capacity mode.
" + "smithy.api#documentation": "Contains the details for the read/write capacity mode. This page talks about\n PROVISIONED and PAY_PER_REQUEST billing modes. For more\n information about these modes, see Read/write capacity mode.
You may need to switch to on-demand mode at least once in order to return a\n BillingModeSummary response.
One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.
" + "smithy.api#enumValue": "EQ" } }, - "ComparisonOperator": { - "target": "com.amazonaws.dynamodb#ComparisonOperator", + "NE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.
\nThe following comparison operators are available:
\n\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n
The following are descriptions of each comparison operator.
\n\n EQ : Equal. EQ is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, Binary, String Set, Number Set, or Binary Set.\n If an item contains an AttributeValue element of a different type\n than the one provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n NE : Not equal. NE is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, Binary, String Set, Number Set, or Binary Set. If an\n item contains an AttributeValue of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n LE : Less than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n LT : Less than.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, or Binary (not a set type). If an item contains an\n AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n GE : Greater than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GT : Greater than.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n NOT_NULL : The attribute exists. NOT_NULL is supported\n for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type.\n If the data type of attribute \"a\" is null, and you evaluate it\n using NOT_NULL, the result is a Boolean true. This\n result is because the attribute \"a\" exists; its data type is\n not relevant to the NOT_NULL comparison operator.
\n NULL : The attribute does not exist. NULL is supported\n for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data\n type. If the data type of attribute \"a\" is null, and you\n evaluate it using NULL, the result is a Boolean\n false. This is because the attribute \"a\"\n exists; its data type is not relevant to the NULL comparison\n operator.
\n CONTAINS : Checks for a subsequence, or value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is of type String, then the operator checks for a\n substring match. If the target attribute of the comparison is of type Binary,\n then the operator looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operator evaluates to\n true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\",\n \"a\" can be a list; however, \"b\" cannot be a set, a\n map, or a list.
\n NOT_CONTAINS : Checks for absence of a subsequence, or absence of a\n value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is a String, then the operator checks for the\n absence of a substring match. If the target attribute of the comparison is\n Binary, then the operator checks for the absence of a subsequence of the target\n that matches the input. If the target attribute of the comparison is a set\n (\"SS\", \"NS\", or \"BS\"), then the\n operator evaluates to true if it does not find an exact\n match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS\n b\", \"a\" can be a list; however, \"b\" cannot\n be a set, a map, or a list.
\n BEGINS_WITH : Checks for a prefix.
\n AttributeValueList can contain only one AttributeValue\n of type String or Binary (not a Number or a set type). The target attribute of\n the comparison must be of type String or Binary (not a Number or a set\n type).
\n IN : Checks for matching elements in a list.
\n AttributeValueList can contain one or more\n AttributeValue elements of type String, Number, or Binary.\n These attributes are compared against an existing attribute of an item. If any\n elements of the input are equal to the item attribute, the expression evaluates\n to true.
\n BETWEEN : Greater than or equal to the first value, and less than\n or equal to the second value.
\n AttributeValueList must contain two AttributeValue\n elements of the same type, either String, Number, or Binary (not a set type). A\n target attribute matches if the target value is greater than, or equal to, the\n first element and less than, or equal to, the second element. If an item\n contains an AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}\n
For usage examples of AttributeValueList and\n ComparisonOperator, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.
Represents the selection criteria for a Query or Scan\n operation:
For a Query operation, Condition is used for\n specifying the KeyConditions to use when querying a table or an\n index. For KeyConditions, only the following comparison operators\n are supported:
\n EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN\n
\n Condition is also used in a QueryFilter, which\n evaluates the query results and returns only the desired values.
For a Scan operation, Condition is used in a\n ScanFilter, which evaluates the scan results and returns only\n the desired values.
The primary key of the item to be checked. Each element consists of an attribute name\n and a value for that attribute.
", - "smithy.api#required": {} + "smithy.api#enumValue": "IN" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "LE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Name of the table for the check item request.
", - "smithy.api#required": {} + "smithy.api#enumValue": "LE" } }, - "ConditionExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", + "LT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A condition that must be satisfied in order for a conditional update to\n succeed.
", - "smithy.api#required": {} + "smithy.api#enumValue": "LT" } }, - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "GE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression.
" + "smithy.api#enumValue": "GE" } }, - "ExpressionAttributeValues": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "GT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "One or more values that can be substituted in an expression.
" + "smithy.api#enumValue": "GT" } }, - "ReturnValuesOnConditionCheckFailure": { - "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "BETWEEN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n ConditionCheck condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.
One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.
" + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.dynamodb#ComparisonOperator", + "traits": { + "smithy.api#documentation": "A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.
\nThe following comparison operators are available:
\n\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n
The following are descriptions of each comparison operator.
\n\n EQ : Equal. EQ is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, Binary, String Set, Number Set, or Binary Set.\n If an item contains an AttributeValue element of a different type\n than the one provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n NE : Not equal. NE is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, Binary, String Set, Number Set, or Binary Set. If an\n item contains an AttributeValue of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n LE : Less than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n LT : Less than.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, or Binary (not a set type). If an item contains an\n AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n GE : Greater than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GT : Greater than.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n NOT_NULL : The attribute exists. NOT_NULL is supported\n for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type.\n If the data type of attribute \"a\" is null, and you evaluate it\n using NOT_NULL, the result is a Boolean true. This\n result is because the attribute \"a\" exists; its data type is\n not relevant to the NOT_NULL comparison operator.
\n NULL : The attribute does not exist. NULL is supported\n for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data\n type. If the data type of attribute \"a\" is null, and you\n evaluate it using NULL, the result is a Boolean\n false. This is because the attribute \"a\"\n exists; its data type is not relevant to the NULL comparison\n operator.
\n CONTAINS : Checks for a subsequence, or value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is of type String, then the operator checks for a\n substring match. If the target attribute of the comparison is of type Binary,\n then the operator looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operator evaluates to\n true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\",\n \"a\" can be a list; however, \"b\" cannot be a set, a\n map, or a list.
\n NOT_CONTAINS : Checks for absence of a subsequence, or absence of a\n value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is a String, then the operator checks for the\n absence of a substring match. If the target attribute of the comparison is\n Binary, then the operator checks for the absence of a subsequence of the target\n that matches the input. If the target attribute of the comparison is a set\n (\"SS\", \"NS\", or \"BS\"), then the\n operator evaluates to true if it does not find an exact\n match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS\n b\", \"a\" can be a list; however, \"b\" cannot\n be a set, a map, or a list.
\n BEGINS_WITH : Checks for a prefix.
\n AttributeValueList can contain only one AttributeValue\n of type String or Binary (not a Number or a set type). The target attribute of\n the comparison must be of type String or Binary (not a Number or a set\n type).
\n IN : Checks for matching elements in a list.
\n AttributeValueList can contain one or more\n AttributeValue elements of type String, Number, or Binary.\n These attributes are compared against an existing attribute of an item. If any\n elements of the input are equal to the item attribute, the expression evaluates\n to true.
\n BETWEEN : Greater than or equal to the first value, and less than\n or equal to the second value.
\n AttributeValueList must contain two AttributeValue\n elements of the same type, either String, Number, or Binary (not a set type). A\n target attribute matches if the target value is greater than, or equal to, the\n first element and less than, or equal to, the second element. If an item\n contains an AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}\n
For usage examples of AttributeValueList and\n ComparisonOperator, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.
Represents the selection criteria for a Query or Scan\n operation:
For a Query operation, Condition is used for\n specifying the KeyConditions to use when querying a table or an\n index. For KeyConditions, only the following comparison operators\n are supported:
\n EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN\n
\n Condition is also used in a QueryFilter, which\n evaluates the query results and returns only the desired values.
For a Scan operation, Condition is used in a\n ScanFilter, which evaluates the scan results and returns only\n the desired values.
The primary key of the item to be checked. Each element consists of an attribute name\n and a value for that attribute.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "A condition that must be satisfied in order for a conditional update to\n succeed. For more information, see Condition expressions in the Amazon DynamoDB Developer\n Guide.
", + "smithy.api#required": {} + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. For more information, see\n Expression attribute names \n in the Amazon DynamoDB Developer Guide.
" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "One or more values that can be substituted in an expression. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.
" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n ConditionCheck condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.
Represents a request to perform a check that an item exists or to check the condition\n of specific attributes of the item.
" @@ -1403,6 +1612,12 @@ "traits": { "smithy.api#documentation": "The conditional request failed.
" } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "Item which caused the ConditionalCheckFailedException.
The name of the table that was affected by the operation.
" + "smithy.api#documentation": "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.
" } }, "CapacityUnits": { @@ -1478,7 +1698,7 @@ } }, "traits": { - "smithy.api#documentation": "The capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes\n involved in the operation. ConsumedCapacity is only returned if the request\n asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes\n involved in the operation. ConsumedCapacity is only returned if the request\n asked for it. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer\n Guide.
Creates a backup for an existing table.
\nEach time you create an on-demand backup, the entire table data is backed up. There\n is no limit to the number of on-demand backups that can be taken.
\nWhen you create an on-demand backup, a time marker of the request is cataloged, and\n the backup is created asynchronously, by applying all changes until the time of the\n request to the last full table snapshot. Backup requests are processed instantaneously\n and become available for restore within minutes.
\nYou can call CreateBackup at a maximum rate of 50 times per\n second.
All backups in DynamoDB work without consuming any provisioned throughput on the\n table.
\nIf you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to\n contain all data committed to the table up to 14:24:00, and data committed after\n 14:26:00 will not be. The backup might contain data modifications made between 14:24:00\n and 14:26:00. On-demand backup does not support causal consistency.
\nAlong with data, the following are also included on the backups:
\nGlobal secondary indexes (GSIs)
\nLocal secondary indexes (LSIs)
\nStreams
\nProvisioned read and write capacity
\nCreates a backup for an existing table.
\nEach time you create an on-demand backup, the entire table data is backed up. There\n is no limit to the number of on-demand backups that can be taken.
\nWhen you create an on-demand backup, a time marker of the request is cataloged, and\n the backup is created asynchronously, by applying all changes until the time of the\n request to the last full table snapshot. Backup requests are processed instantaneously\n and become available for restore within minutes.
\nYou can call CreateBackup at a maximum rate of 50 times per\n second.
All backups in DynamoDB work without consuming any provisioned throughput on the\n table.
\nIf you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to\n contain all data committed to the table up to 14:24:00, and data committed after\n 14:26:00 will not be. The backup might contain data modifications made between 14:24:00\n and 14:26:00. On-demand backup does not support causal consistency.
\nAlong with data, the following are also included on the backups:
\nGlobal secondary indexes (GSIs)
\nLocal secondary indexes (LSIs)
\nStreams
\nProvisioned read and write capacity
\nThe name of the table.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } }, @@ -1682,6 +1911,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#CreateBackupOutput": { @@ -1693,6 +1925,9 @@ "smithy.api#documentation": "Contains the details of the backup created for the table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction": { @@ -1722,7 +1957,13 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "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.
Creates a global table from an existing table. A global table creates a replication\n relationship between two or more DynamoDB tables with the same table name in the\n provided Regions.
\nThis operation only applies to Version\n 2017.11.29 of global tables.
\nIf you want to add a new replica table to a global table, each of the following\n conditions must be true:
\nThe table must have the same primary key as all of the other replicas.
\nThe table must have the same name as all of the other replicas.
\nThe table must have DynamoDB Streams enabled, with the stream containing both\n the new and the old images of the item.
\nNone of the replica tables in the global table can contain any data.
\nIf global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nIf local secondary indexes are specified, then the following conditions must also be\n met:
\nThe local secondary indexes must have the same name.
\nThe local secondary indexes must have the same hash key and sort key (if\n present).
\nWrite capacity settings should be set consistently across your replica tables and\n secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the\n write capacity settings for all of your global tables replicas and indexes.
\nIf you prefer to manage write capacity settings manually, you should provision\n equal replicated write capacity units to your replica tables. You should also\n provision equal replicated write capacity units to matching secondary indexes across\n your global table.
\nCreates a global table from an existing table. A global table creates a replication\n relationship between two or more DynamoDB tables with the same table name in the\n provided Regions.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\nIf you want to add a new replica table to a global table, each of the following\n conditions must be true:
\nThe table must have the same primary key as all of the other replicas.
\nThe table must have the same name as all of the other replicas.
\nThe table must have DynamoDB Streams enabled, with the stream containing both\n the new and the old images of the item.
\nNone of the replica tables in the global table can contain any data.
\nIf global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nIf local secondary indexes are specified, then the following conditions must also be\n met:
\nThe local secondary indexes must have the same name.
\nThe local secondary indexes must have the same hash key and sort key (if\n present).
\nWrite capacity settings should be set consistently across your replica tables and\n secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the\n write capacity settings for all of your global tables replicas and indexes.
\nIf you prefer to manage write capacity settings manually, you should provision\n equal replicated write capacity units to your replica tables. You should also\n provision equal replicated write capacity units to matching secondary indexes across\n your global table.
\nContains the details of the global table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#CreateReplicaAction": { @@ -1829,6 +2076,12 @@ "smithy.api#documentation": "Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "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.\n
Replica-specific table class. If not specified, uses the source table's\n table class.
" + "smithy.api#documentation": "Replica-specific table class. If not specified, uses the source table's table\n class.
" } } }, @@ -1872,7 +2125,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can\n have two tables with same name if you create the tables in different Regions.
\n CreateTable is an asynchronous operation. Upon receiving a\n CreateTable request, DynamoDB immediately returns a response with a\n TableStatus of CREATING. After the table is created,\n DynamoDB sets the TableStatus to ACTIVE. You can perform read\n and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the\n CreateTable operation. If you want to create multiple tables with\n secondary indexes on them, you must create the tables sequentially. Only one table with\n secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable action to check the table status.
The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can\n have two tables with same name if you create the tables in different Regions.
\n CreateTable is an asynchronous operation. Upon receiving a\n CreateTable request, DynamoDB immediately returns a response with a\n TableStatus of CREATING. After the table is created,\n DynamoDB sets the TableStatus to ACTIVE. You can perform read\n and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the\n CreateTable operation. If you want to create multiple tables with\n secondary indexes on them, you must create the tables sequentially. Only one table with\n secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable action to check the table status.
The name of the table to create.
", + "smithy.api#documentation": "The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } }, "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "Specifies the attributes that make up the primary key for a table or an index. The\n attributes in KeySchema must also be defined in the\n AttributeDefinitions array. For more information, see Data\n Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
\n AttributeName - The name of this key attribute.
\n KeyType - The role that the key attribute will assume:
\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from the DynamoDB usage\n of an internal hash function to evenly distribute data items across partitions,\n based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nFor a simple primary key (partition key), you must provide exactly one element with a\n KeyType of HASH.
For a composite primary key (partition key and sort key), you must provide exactly two\n elements, in this order: The first element must have a KeyType of\n HASH, and the second element must have a KeyType of\n RANGE.
For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
", + "smithy.api#documentation": "Specifies the attributes that make up the primary key for a table or an index. The\n attributes in KeySchema must also be defined in the\n AttributeDefinitions array. For more information, see Data\n Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
\n AttributeName - The name of this key attribute.
\n KeyType - The role that the key attribute will assume:
\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from the DynamoDB usage\n of an internal hash function to evenly distribute data items across partitions,\n based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nFor a simple primary key (partition key), you must provide exactly one element with a\n KeyType of HASH.
For a composite primary key (partition key and sort key), you must provide exactly two\n elements, in this order: The first element must have a KeyType of\n HASH, and the second element must have a KeyType of\n RANGE.
For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
", "smithy.api#required": {} } }, "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", "traits": { - "smithy.api#documentation": "One or more local secondary indexes (the maximum is 5) to be created on the table.\n Each index is scoped to a given partition key value. There is a 10 GB size limit per\n partition key value; otherwise, the size of a local secondary index is\n unconstrained.
\nEach local secondary index in the array includes the following:
\n\n IndexName - The name of the local secondary index. Must be unique\n only for this table.
\n KeySchema - Specifies the key schema for the local secondary index.\n The key schema must begin with the same partition key as the table.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
One or more local secondary indexes (the maximum is 5) to be created on the table.\n Each index is scoped to a given partition key value. There is a 10 GB size limit per\n partition key value; otherwise, the size of a local secondary index is\n unconstrained.
\nEach local secondary index in the array includes the following:
\n\n IndexName - The name of the local secondary index. Must be unique\n only for this table.
\n KeySchema - Specifies the key schema for the local secondary index.\n The key schema must begin with the same partition key as the table.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
One or more global secondary indexes (the maximum is 20) to be created on the table.\n Each global secondary index in the array includes the following:
\n\n IndexName - The name of the global secondary index. Must be unique\n only for this table.
\n KeySchema - Specifies the key schema for the global secondary\n index.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
\n ProvisionedThroughput - The provisioned throughput settings for the\n global secondary index, consisting of read and write capacity units.
One or more global secondary indexes (the maximum is 20) to be created on the table.\n Each global secondary index in the array includes the following:
\n\n IndexName - The name of the global secondary index. Must be unique\n only for this table.
\n KeySchema - Specifies the key schema for the global secondary\n index.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
\n ProvisionedThroughput - The provisioned throughput settings for the\n global secondary index, consisting of read and write capacity units.
Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.
\n\n PROVISIONED - We recommend using PROVISIONED for\n predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST\n for unpredictable workloads. PAY_PER_REQUEST sets the billing mode\n to On-Demand Mode.
Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.
\n\n PROVISIONED - We recommend using PROVISIONED for\n predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST\n for unpredictable workloads. PAY_PER_REQUEST sets the billing mode\n to On-demand capacity mode.
Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.
If you set BillingMode as PROVISIONED, you must specify this property.\n If you set BillingMode as PAY_PER_REQUEST, you cannot specify this\n property.
For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.
If you set BillingMode as PROVISIONED, you must specify this property.\n If you set BillingMode as PAY_PER_REQUEST, you cannot specify this\n property.
For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" } }, "StreamSpecification": { "target": "com.amazonaws.dynamodb#StreamSpecification", "traits": { - "smithy.api#documentation": "The settings for DynamoDB Streams on the table. These settings consist of:
\n\n StreamEnabled - Indicates whether DynamoDB Streams is to be enabled\n (true) or disabled (false).
\n StreamViewType - When an item in the table is modified,\n StreamViewType determines what information is written to the\n table's stream. Valid values for StreamViewType are:
\n KEYS_ONLY - Only the key attributes of the modified item\n are written to the stream.
\n NEW_IMAGE - The entire item, as it appears after it was\n modified, is written to the stream.
\n OLD_IMAGE - The entire item, as it appeared before it was\n modified, is written to the stream.
\n NEW_AND_OLD_IMAGES - Both the new and the old item images\n of the item are written to the stream.
The settings for DynamoDB Streams on the table. These settings consist of:
\n\n StreamEnabled - Indicates whether DynamoDB Streams is to be enabled\n (true) or disabled (false).
\n StreamViewType - When an item in the table is modified,\n StreamViewType determines what information is written to the\n table's stream. Valid values for StreamViewType are:
\n KEYS_ONLY - Only the key attributes of the modified item\n are written to the stream.
\n NEW_IMAGE - The entire item, as it appears after it was\n modified, is written to the stream.
\n OLD_IMAGE - The entire item, as it appeared before it was\n modified, is written to the stream.
\n NEW_AND_OLD_IMAGES - Both the new and the old item images\n of the item are written to the stream.
The table class of the new table. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.
Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.
" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "An Amazon Web Services resource-based policy document in JSON format that will be\n attached to the table.
\nWhen you attach a resource-based policy while creating a table, the policy application\n is strongly consistent.
\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this\n limit. For a full list of all considerations that apply for resource-based policies, see\n Resource-based\n policy considerations.
\nYou need to specify the CreateTable and\n PutResourcePolicy\n IAM actions for authorizing a user to create a table with a\n resource-based policy.
Sets the maximum number of read and write units for the specified table in on-demand\n capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the input of a CreateTable operation.
Represents the input of a CreateTable operation.
Represents the output of a CreateTable operation.
Represents the output of a CreateTable operation.
\n The delimiter used for separating items in the CSV file being imported.\n
" + "smithy.api#documentation": "The delimiter used for separating items in the CSV file being imported.
" } }, "HeaderList": { "target": "com.amazonaws.dynamodb#CsvHeaderList", "traits": { - "smithy.api#documentation": "List of the headers used to specify a common header for all source CSV files being\n imported. If this field is specified then the first line of each CSV file is treated as\n data instead of the header. If this field is not specified the the first line of each\n CSV file is treated as the header. \n
" + "smithy.api#documentation": "List of the headers used to specify a common header for all source CSV files being\n imported. If this field is specified then the first line of each CSV file is treated as\n data instead of the header. If this field is not specified the the first line of each\n CSV file is treated as the header.
" } } }, "traits": { - "smithy.api#documentation": "\n Processing options for the CSV file being imported.\n
" + "smithy.api#documentation": "Processing options for the CSV file being imported.
" } }, "com.amazonaws.dynamodb#Date": { @@ -2032,9 +2305,9 @@ } }, "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "Name of the table in which the item to be deleted resides.
", + "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, @@ -2096,7 +2369,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Deletes an existing backup of a table.
\nYou can call DeleteBackup at a maximum rate of 10 times per\n second.
Deletes an existing backup of a table.
\nYou can call DeleteBackup at a maximum rate of 10 times per\n second.
Contains the description of the backup created for the table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DeleteGlobalSecondaryIndexAction": { @@ -2175,23 +2454,46 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute\n value.
\nIn addition to deleting an item, you can also return the item's attribute values in\n the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation;\n running it multiple times on the same item or attribute does not\n result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met.\n If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not\n deleted.
" + "smithy.api#documentation": "Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute\n value.
\nIn addition to deleting an item, you can also return the item's attribute values in\n the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation;\n running it multiple times on the same item or attribute does not\n result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met.\n If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not\n deleted.
", + "smithy.api#examples": [ + { + "title": "To delete an item", + "documentation": "This example deletes an item from the Music table.", + "input": { + "TableName": "Music", + "Key": { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + } + } + ] } }, "com.amazonaws.dynamodb#DeleteItemInput": { "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table from which to delete the item.
", + "smithy.api#documentation": "The name of the table from which to delete the item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "A map of attribute names to AttributeValue objects, representing the\n primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.
", + "smithy.api#documentation": "A map of attribute names to AttributeValue objects, representing the\n primary key of the item to delete.
For the primary key, you must provide all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.
", "smithy.api#required": {} } }, @@ -2210,7 +2512,7 @@ "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "Use ReturnValues if you want to get the item attributes as they appeared\n before they were deleted. For DeleteItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small \n network and processing overhead of receiving a larger response. No read capacity units are \n consumed.
\nThe ReturnValues parameter is used by several DynamoDB operations;\n however, DeleteItem does not recognize any values other than\n NONE or ALL_OLD.
Use ReturnValues if you want to get the item attributes as they appeared\n before they were deleted. For DeleteItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
\nThe ReturnValues parameter is used by several DynamoDB operations;\n however, DeleteItem does not recognize any values other than\n NONE or ALL_OLD.
A condition that must be satisfied in order for a conditional DeleteItem\n to succeed.
An expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type |\n contains | begins_with | size\n
These function names are case-sensitive.
\nComparison operators: = | <> |\n < | > | <= | >= |\n BETWEEN | IN \n
Logical operators: AND | OR | NOT\n
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A condition that must be satisfied in order for a conditional DeleteItem\n to succeed.
An expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type |\n contains | begins_with | size\n
These function names are case-sensitive.
\nComparison operators: = | <> |\n < | > | <= | >= |\n BETWEEN | IN \n
Logical operators: AND | OR | NOT\n
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "An optional parameter that returns the item attributes for a DeleteItem\n operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteItem operation.
Represents the input of a DeleteItem operation.
The capacity units consumed by the DeleteItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned Mode in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the DeleteItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned capacity mode in the Amazon DynamoDB Developer\n Guide.
Information about item collections, if any, that were affected by the\n DeleteItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.
Each ItemCollectionMetrics element consists of:
\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size, in\n gigabytes. This value is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on that table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nInformation about item collections, if any, that were affected by the\n DeleteItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.
Each ItemCollectionMetrics element consists of:
\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size, in\n gigabytes. This value is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on that table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nRepresents the output of a DeleteItem operation.
Represents the output of a DeleteItem operation.
Represents a request to perform a DeleteItem operation on an item.
Deletes the resource-based policy attached to the resource, which can be a table or\n stream.
\n\n DeleteResourcePolicy is an idempotent operation; running it multiple\n times on the same resource doesn't result in an error response,\n unless you specify an ExpectedRevisionId, which will then return a\n PolicyNotFoundException.
To make sure that you don't inadvertently lock yourself out of your own resources,\n the root principal in your Amazon Web Services account can perform\n DeleteResourcePolicy requests, even if your resource-based policy\n explicitly denies the root principal's access.
\n DeleteResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after running the\n DeleteResourcePolicy request, DynamoDB might still return\n the deleted policy. This is because the policy for your resource might not have been\n deleted yet. Wait for a few seconds, and then try the GetResourcePolicy\n request again.
The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be\n removed. The resources you can specify include tables and streams. If you remove the\n policy of a table, it will also remove the permissions for the table's indexes defined\n in that policy document. This is because index permissions are defined in the table's\n policy.
", + "smithy.api#required": {} + } + }, + "ExpectedRevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A string value that you can use to conditionally delete your policy. When you provide\n an expected revision ID, if the revision ID of the existing policy on the resource\n doesn't match or if there's no policy attached to the resource, the request will fail\n and return a PolicyNotFoundException.
A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
\nThis value will be empty if you make a request against a resource without a\n policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.dynamodb#DeleteTable": { "type": "operation", "input": { @@ -2345,22 +2725,45 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.
DynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
\nIf you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.
For global tables, this operation only applies to\n global tables using Version 2019.11.21 (Current version).
\nDynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete. For the full\n list of table states, see TableStatus.
When you delete a table, any indexes on that table are also deleted.
\nIf you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
The name of the table to delete.
", + "smithy.api#documentation": "The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteTable operation.
Represents the input of a DeleteTable operation.
Represents the output of a DeleteTable operation.
Represents the output of a DeleteTable operation.
Describes an existing backup of a table.
\nYou can call DescribeBackup at a maximum rate of 10 times per\n second.
Describes an existing backup of a table.
\nYou can call DescribeBackup at a maximum rate of 10 times per\n second.
Contains the description of the backup created for the table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeContinuousBackups": { @@ -2449,19 +2862,22 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Checks the status of continuous backups and point in time recovery on the specified\n table. Continuous backups are ENABLED on all tables at table creation. If\n point in time recovery is enabled, PointInTimeRecoveryStatus will be set to\n ENABLED.
After continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.
\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time during the last 35 days.
You can call DescribeContinuousBackups at a maximum rate of 10 times per\n second.
Checks the status of continuous backups and point in time recovery on the specified\n table. Continuous backups are ENABLED on all tables at table creation. If\n point in time recovery is enabled, PointInTimeRecoveryStatus will be set to\n ENABLED.
After continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.
\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time during the last 35 days.
You can call DescribeContinuousBackups at a maximum rate of 10 times per\n second.
Name of the table for which the customer wants to check the continuous backups and\n point in time recovery settings.
", + "smithy.api#documentation": "Name of the table for which the customer wants to check the continuous backups and\n point in time recovery settings.
\nYou can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#DescribeContinuousBackupsOutput": { @@ -2473,6 +2889,9 @@ "smithy.api#documentation": "Represents the continuous backups and point in time recovery settings on the\n table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeContributorInsights": { @@ -2492,16 +2911,16 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about contributor insights, for a given table or global secondary\n index.
" + "smithy.api#documentation": "Returns information about contributor insights for a given table or global secondary\n index.
" } }, "com.amazonaws.dynamodb#DescribeContributorInsightsInput": { "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table to describe.
", + "smithy.api#documentation": "The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } }, @@ -2511,6 +2930,9 @@ "smithy.api#documentation": "The name of the global secondary index to describe, if applicable.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#DescribeContributorInsightsOutput": { @@ -2549,9 +2971,12 @@ "FailureException": { "target": "com.amazonaws.dynamodb#FailureException", "traits": { - "smithy.api#documentation": "Returns information about the last failure that was encountered.
\nThe most common exceptions for a FAILED status are:
\nLimitExceededException - Per-account Amazon CloudWatch Contributor Insights\n rule limit reached. Please disable Contributor Insights for other tables/indexes\n OR disable Contributor Insights rules before retrying.
\nAccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be\n modified due to insufficient permissions.
\nAccessDeniedException - Failed to create service-linked role for Contributor\n Insights due to insufficient permissions.
\nInternalServerError - Failed to create Amazon CloudWatch Contributor Insights\n rules. Please retry request.
\nReturns information about the last failure that was encountered.
\nThe most common exceptions for a FAILED status are:
\nLimitExceededException - Per-account Amazon CloudWatch Contributor Insights\n rule limit reached. Please disable Contributor Insights for other tables/indexes\n OR disable Contributor Insights rules before retrying.
\nAccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be\n modified due to insufficient permissions.
\nAccessDeniedException - Failed to create service-linked role for Contributor\n Insights due to insufficient permissions.
\nInternalServerError - Failed to create Amazon CloudWatch Contributor Insights\n rules. Please retry request.
\nReturns the regional endpoint information.
" + "smithy.api#documentation": "Returns the regional endpoint information. For more information on policy permissions,\n please see Internetwork traffic privacy.
" } }, "com.amazonaws.dynamodb#DescribeEndpointsRequest": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#input": {} + } }, "com.amazonaws.dynamodb#DescribeEndpointsResponse": { "type": "structure", @@ -2580,6 +3008,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeExport": { @@ -2615,6 +3046,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#DescribeExportOutput": { @@ -2626,6 +3060,9 @@ "smithy.api#documentation": "Represents the properties of the export.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeGlobalTable": { @@ -2651,7 +3088,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Returns information about the specified global table.
\nThis operation only applies to Version\n 2017.11.29 of global tables. If you are using global tables Version\n 2019.11.21 you can use DescribeTable instead.
\nReturns information about the specified global table.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\nContains the details of the global table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeGlobalTableSettings": { @@ -2700,7 +3143,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Describes Region-specific settings for a global table.
\nThis operation only applies to Version\n 2017.11.29 of global tables.
\nDescribes Region-specific settings for a global table.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\nThe Region-specific settings for the global table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeImport": { @@ -2746,7 +3195,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Represents the properties of the import.\n
" + "smithy.api#documentation": "Represents the properties of the import.
" } }, "com.amazonaws.dynamodb#DescribeImportInput": { @@ -2755,10 +3204,13 @@ "ImportArn": { "target": "com.amazonaws.dynamodb#ImportArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) associated with the table you're importing to.\n
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the table you're importing to.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#DescribeImportOutput": { @@ -2767,10 +3219,13 @@ "ImportTableDescription": { "target": "com.amazonaws.dynamodb#ImportTableDescription", "traits": { - "smithy.api#documentation": "\n Represents the properties of the table created for the import, and parameters of \n the import. The import parameters include import status, how many items were processed, \n and how many errors were encountered.\n
", + "smithy.api#documentation": "Represents the properties of the table created for the import, and parameters of the\n import. The import parameters include import status, how many items were processed, and\n how many errors were encountered.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination": { @@ -2803,12 +3258,15 @@ "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table being described.
", + "smithy.api#documentation": "The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationOutput": { @@ -2826,6 +3284,9 @@ "smithy.api#documentation": "The list of replica structures for the table being described.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeLimits": { @@ -2848,14 +3309,27 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Returns the current provisioned-capacity quotas for your Amazon Web Services account in\n a Region, both for the Region as a whole and for any one DynamoDB table that you create\n there.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum read capacity units and write capacity units that you can provision across\n all of your DynamoDB tables in a given Region. Also, there are per-table\n quotas that apply when you create a table there. For more information, see Service,\n Account, and Table Quotas page in the Amazon DynamoDB\n Developer Guide.
\n\nAlthough you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the\n increase is not instantaneous. The DescribeLimits action lets you write\n code to compare the capacity you are currently using to those quotas imposed by your\n account so that you have enough time to apply for an increase before you hit a\n quota.
For example, you could use one of the Amazon Web Services SDKs to do the\n following:
\n\nCall DescribeLimits for a particular Region to obtain your\n current account quotas on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for\n all your tables in that Region, and one to hold the aggregate write capacity\n units. Zero them both.
\nCall ListTables to obtain a list of all your DynamoDB\n tables.
For each table name listed by ListTables, do the\n following:
Call DescribeTable with the table name.
Use the data returned by DescribeTable to add the read\n capacity units and write capacity units provisioned for the table itself\n to your variables.
If the table has one or more global secondary indexes (GSIs), loop\n over these GSIs and add their provisioned capacity values to your\n variables as well.
\nReport the account quotas for that Region returned by\n DescribeLimits, along with the total current provisioned\n capacity levels you have calculated.
This will let you see whether you are getting close to your account-level\n quotas.
\nThe per-table quotas apply only when you are creating a new table. They restrict the\n sum of the provisioned capacity of the new table itself and all its global secondary\n indexes.
\nFor existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly, but the only quota that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account quotas.
\n\n DescribeLimits should only be called periodically. You can expect\n throttling errors if you call it more than once in a minute.
The DescribeLimits Request element has no content.
Returns the current provisioned-capacity quotas for your Amazon Web Services account in\n a Region, both for the Region as a whole and for any one DynamoDB table that you create\n there.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum read capacity units and write capacity units that you can provision across\n all of your DynamoDB tables in a given Region. Also, there are per-table\n quotas that apply when you create a table there. For more information, see Service,\n Account, and Table Quotas page in the Amazon DynamoDB\n Developer Guide.
\nAlthough you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the\n increase is not instantaneous. The DescribeLimits action lets you write\n code to compare the capacity you are currently using to those quotas imposed by your\n account so that you have enough time to apply for an increase before you hit a\n quota.
For example, you could use one of the Amazon Web Services SDKs to do the\n following:
\nCall DescribeLimits for a particular Region to obtain your\n current account quotas on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for\n all your tables in that Region, and one to hold the aggregate write capacity\n units. Zero them both.
\nCall ListTables to obtain a list of all your DynamoDB\n tables.
For each table name listed by ListTables, do the\n following:
Call DescribeTable with the table name.
Use the data returned by DescribeTable to add the read\n capacity units and write capacity units provisioned for the table itself\n to your variables.
If the table has one or more global secondary indexes (GSIs), loop\n over these GSIs and add their provisioned capacity values to your\n variables as well.
\nReport the account quotas for that Region returned by\n DescribeLimits, along with the total current provisioned\n capacity levels you have calculated.
This will let you see whether you are getting close to your account-level\n quotas.
\nThe per-table quotas apply only when you are creating a new table. They restrict the\n sum of the provisioned capacity of the new table itself and all its global secondary\n indexes.
\nFor existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly, but the only quota that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account quotas.
\n\n DescribeLimits should only be called periodically. You can expect\n throttling errors if you call it more than once in a minute.
The DescribeLimits Request element has no content.
Represents the input of a DescribeLimits operation. Has no\n content.
Represents the input of a DescribeLimits operation. Has no\n content.
Represents the output of a DescribeLimits operation.
Represents the output of a DescribeLimits operation.
Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.
\nIf you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.
Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nIf you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.
The name of the table to describe.
", + "smithy.api#documentation": "The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeTable operation.
Represents the input of a DescribeTable operation.
Represents the output of a DescribeTable operation.
Represents the output of a DescribeTable operation.
Describes auto scaling settings across replicas of the global table at once.
\nThis operation only applies to Version\n 2019.11.21 of global tables.
\nDescribes auto scaling settings across replicas of the global table at once.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nThe name of the table.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingOutput": { @@ -3020,6 +3500,9 @@ "smithy.api#documentation": "Represents the auto scaling properties of the table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DescribeTimeToLive": { @@ -3052,12 +3535,15 @@ "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table to be described.
", + "smithy.api#documentation": "The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#DescribeTimeToLiveOutput": { @@ -3069,42 +3555,59 @@ "smithy.api#documentation": "" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#DestinationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLING", - "name": "ENABLING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DISABLING", - "name": "DISABLING" - }, - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "ENABLE_FAILED", - "name": "ENABLE_FAILED" + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" } - ] + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.dynamodb#DisableKinesisStreamingDestination": { "type": "operation", "input": { - "target": "com.amazonaws.dynamodb#DisableKinesisStreamingDestinationInput" + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" }, "output": { - "target": "com.amazonaws.dynamodb#DisableKinesisStreamingDestinationOutput" + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" }, "errors": [ { @@ -3127,14 +3630,11 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Stops replication from the DynamoDB table to the Kinesis data stream. This is done\n without deleting either of the resources.
" + "smithy.api#documentation": "Stops replication from the DynamoDB table to the Kinesis data stream. This\n is done without deleting either of the resources.
" } }, - "com.amazonaws.dynamodb#Double": { - "type": "double", - "traits": { - "smithy.api#box": {} - } + "com.amazonaws.dynamodb#DoubleObject": { + "type": "double" }, "com.amazonaws.dynamodb#DuplicateItemException": { "type": "structure", @@ -3150,28 +3650,6 @@ }, "com.amazonaws.dynamodb#DynamoDB_20120810": { "type": "service", - "traits": { - "aws.api#clientEndpointDiscovery": { - "operation": "com.amazonaws.dynamodb#DescribeEndpoints", - "error": "com.amazonaws.dynamodb#InvalidEndpointException" - }, - "aws.api#service": { - "sdkId": "DynamoDB", - "arnNamespace": "dynamodb", - "cloudFormationName": "DynamoDB", - "cloudTrailEventSource": "dynamodb.amazonaws.com", - "endpointPrefix": "dynamodb" - }, - "aws.auth#sigv4": { - "name": "dynamodb" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Amazon DynamoDB is a fully managed NoSQL database service that provides fast\n and predictable performance with seamless scalability. DynamoDB lets you\n offload the administrative burdens of operating and scaling a distributed database, so\n that you don't have to worry about hardware provisioning, setup and configuration,\n replication, software patching, or cluster scaling.
\n\nWith DynamoDB, you can create database tables that can store and retrieve\n any amount of data, and serve any level of request traffic. You can scale up or scale\n down your tables' throughput capacity without downtime or performance degradation, and\n use the Amazon Web Services Management Console to monitor resource utilization and performance\n metrics.
\n\nDynamoDB automatically spreads the data and traffic for your tables over\n a sufficient number of servers to handle your throughput and storage requirements, while\n maintaining consistent and fast performance. All of your data is stored on solid state\n disks (SSDs) and automatically replicated across multiple Availability Zones in an\n Amazon Web Services Region, providing built-in high availability and data\n durability.
", - "smithy.api#title": "Amazon DynamoDB", - "smithy.api#xmlNamespace": { - "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" - } - }, "version": "2012-08-10", "operations": [ { @@ -3198,6 +3676,9 @@ { "target": "com.amazonaws.dynamodb#DeleteItem" }, + { + "target": "com.amazonaws.dynamodb#DeleteResourcePolicy" + }, { "target": "com.amazonaws.dynamodb#DeleteTable" }, @@ -3258,6 +3739,9 @@ { "target": "com.amazonaws.dynamodb#GetItem" }, + { + "target": "com.amazonaws.dynamodb#GetResourcePolicy" + }, { "target": "com.amazonaws.dynamodb#ImportTable" }, @@ -3285,6 +3769,9 @@ { "target": "com.amazonaws.dynamodb#PutItem" }, + { + "target": "com.amazonaws.dynamodb#PutResourcePolicy" + }, { "target": "com.amazonaws.dynamodb#Query" }, @@ -3324,6 +3811,9 @@ { "target": "com.amazonaws.dynamodb#UpdateItem" }, + { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestination" + }, { "target": "com.amazonaws.dynamodb#UpdateTable" }, @@ -3333,15 +3823,1133 @@ { "target": "com.amazonaws.dynamodb#UpdateTimeToLive" } - ] + ], + "traits": { + "aws.api#clientEndpointDiscovery": { + "operation": "com.amazonaws.dynamodb#DescribeEndpoints", + "error": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + "aws.api#service": { + "sdkId": "DynamoDB", + "arnNamespace": "dynamodb", + "cloudFormationName": "DynamoDB", + "cloudTrailEventSource": "dynamodb.amazonaws.com", + "endpointPrefix": "dynamodb" + }, + "aws.auth#sigv4": { + "name": "dynamodb" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon DynamoDB is a fully managed NoSQL database service that provides fast\n and predictable performance with seamless scalability. DynamoDB lets you\n offload the administrative burdens of operating and scaling a distributed database, so\n that you don't have to worry about hardware provisioning, setup and configuration,\n replication, software patching, or cluster scaling.
\nWith DynamoDB, you can create database tables that can store and retrieve\n any amount of data, and serve any level of request traffic. You can scale up or scale\n down your tables' throughput capacity without downtime or performance degradation, and\n use the Amazon Web Services Management Console to monitor resource utilization and performance\n metrics.
\nDynamoDB automatically spreads the data and traffic for your tables over\n a sufficient number of servers to handle your throughput and storage requirements, while\n maintaining consistent and fast performance. All of your data is stored on solid state\n disks (SSDs) and automatically replicated across multiple Availability Zones in an\n Amazon Web Services Region, providing built-in high availability and data\n durability.
", + "smithy.api#suppress": [ + "RuleSetAwsBuiltIn.AWS::Auth::AccountId" + ], + "smithy.api#title": "Amazon DynamoDB", + "smithy.api#xmlNamespace": { + "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://dynamodb.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "local" + ] + } + ], + "endpoint": { + "url": "http://localhost:8000", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region local with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "Region": "local", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration": { + "type": "structure", + "members": { + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.
Enables setting the configuration for Kinesis Streaming.
" + } }, "com.amazonaws.dynamodb#EnableKinesisStreamingDestination": { "type": "operation", "input": { - "target": "com.amazonaws.dynamodb#EnableKinesisStreamingDestinationInput" + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" }, "output": { - "target": "com.amazonaws.dynamodb#EnableKinesisStreamingDestinationOutput" + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" }, "errors": [ { @@ -3380,6 +4988,7 @@ "CachePeriodInMinutes": { "target": "com.amazonaws.dynamodb#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Endpoint cache time to live (TTL) value.
", "smithy.api#required": {} } @@ -3398,6 +5007,7 @@ "com.amazonaws.dynamodb#ErrorCount": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -3447,7 +5057,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.
\nFor PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.
A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set.
This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.
\nFor PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.
A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. If NextToken is present, you need to paginate the result set\n and include NextToken.
The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, along\n with a key in LastEvaluatedKey to apply in a subsequent operation so you\n can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation.
An optional parameter that returns the item attributes for an\n ExecuteStatement operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#ExecuteStatementOutput": { @@ -3513,6 +5132,9 @@ "smithy.api#documentation": "The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request. If LastEvaluatedKey is empty, then the \"last page\" of results has\n been processed and there is no more data to be retrieved. If\n LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.
This operation allows you to perform transactional reads or writes on data stored in\n DynamoDB, using PartiQL.
\nThe entire transaction must consist of either read statements or write statements,\n you cannot mix both in one transaction. The EXISTS function is an exception and can\n be used to check the condition of specific attributes of the item in a similar\n manner to ConditionCheck in the TransactWriteItems API.
This operation allows you to perform transactional reads or writes on data stored in\n DynamoDB, using PartiQL.
\nThe entire transaction must consist of either read statements or write statements,\n you cannot mix both in one transaction. The EXISTS function is an exception and can\n be used to check the condition of specific attributes of the item in a similar\n manner to ConditionCheck in the TransactWriteItems API.
Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#ExecuteTransactionOutput": { @@ -3590,6 +5215,9 @@ "smithy.api#documentation": "The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#ExpectedAttributeMap": { @@ -3607,30 +5235,30 @@ "Value": { "target": "com.amazonaws.dynamodb#AttributeValue", "traits": { - "smithy.api#documentation": "Represents the data for the expected attribute.
\nEach attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.
\nFor more information, see Data Types in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the data for the expected attribute.
\nEach attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.
\nFor more information, see Data Types in the Amazon DynamoDB Developer\n Guide.
" } }, "Exists": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "Causes DynamoDB to evaluate the value before attempting a conditional\n operation:
\nIf Exists is true, DynamoDB will check to\n see if that attribute value already exists in the table. If it is found, then\n the operation succeeds. If it is not found, the operation fails with a\n ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that\n the attribute value does not exist in the table. If in fact the value does not\n exist, then the assumption is valid and the operation succeeds. If the value is\n found, despite the assumption that it does not exist, the operation fails with a\n ConditionCheckFailedException.
The default setting for Exists is true. If you supply a\n Value all by itself, DynamoDB assumes the attribute exists:\n You don't have to set Exists to true, because it is\n implied.
DynamoDB returns a ValidationException if:
\n Exists is true but there is no Value to\n check. (You expect a value to exist, but don't specify what that value\n is.)
\n Exists is false but you also provide a\n Value. (You cannot expect an attribute to have a value, while\n also expecting it not to exist.)
Causes DynamoDB to evaluate the value before attempting a conditional\n operation:
\nIf Exists is true, DynamoDB will check to\n see if that attribute value already exists in the table. If it is found, then\n the operation succeeds. If it is not found, the operation fails with a\n ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that\n the attribute value does not exist in the table. If in fact the value does not\n exist, then the assumption is valid and the operation succeeds. If the value is\n found, despite the assumption that it does not exist, the operation fails with a\n ConditionCheckFailedException.
The default setting for Exists is true. If you supply a\n Value all by itself, DynamoDB assumes the attribute exists:\n You don't have to set Exists to true, because it is\n implied.
DynamoDB returns a ValidationException if:
\n Exists is true but there is no Value to\n check. (You expect a value to exist, but don't specify what that value\n is.)
\n Exists is false but you also provide a\n Value. (You cannot expect an attribute to have a value, while\n also expecting it not to exist.)
A comparator for evaluating attributes in the AttributeValueList. For\n example, equals, greater than, less than, etc.
The following comparison operators are available:
\n\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n
The following are descriptions of each comparison operator.
\n\n EQ : Equal. EQ is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, Binary, String Set, Number Set, or Binary Set.\n If an item contains an AttributeValue element of a different type\n than the one provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n NE : Not equal. NE is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, Binary, String Set, Number Set, or Binary Set. If an\n item contains an AttributeValue of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n LE : Less than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n LT : Less than.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, or Binary (not a set type). If an item contains an\n AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n GE : Greater than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GT : Greater than.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n NOT_NULL : The attribute exists. NOT_NULL is supported\n for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type.\n If the data type of attribute \"a\" is null, and you evaluate it\n using NOT_NULL, the result is a Boolean true. This\n result is because the attribute \"a\" exists; its data type is\n not relevant to the NOT_NULL comparison operator.
\n NULL : The attribute does not exist. NULL is supported\n for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data\n type. If the data type of attribute \"a\" is null, and you\n evaluate it using NULL, the result is a Boolean\n false. This is because the attribute \"a\"\n exists; its data type is not relevant to the NULL comparison\n operator.
\n CONTAINS : Checks for a subsequence, or value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is of type String, then the operator checks for a\n substring match. If the target attribute of the comparison is of type Binary,\n then the operator looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operator evaluates to\n true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\",\n \"a\" can be a list; however, \"b\" cannot be a set, a\n map, or a list.
\n NOT_CONTAINS : Checks for absence of a subsequence, or absence of a\n value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is a String, then the operator checks for the\n absence of a substring match. If the target attribute of the comparison is\n Binary, then the operator checks for the absence of a subsequence of the target\n that matches the input. If the target attribute of the comparison is a set\n (\"SS\", \"NS\", or \"BS\"), then the\n operator evaluates to true if it does not find an exact\n match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS\n b\", \"a\" can be a list; however, \"b\" cannot\n be a set, a map, or a list.
\n BEGINS_WITH : Checks for a prefix.
\n AttributeValueList can contain only one AttributeValue\n of type String or Binary (not a Number or a set type). The target attribute of\n the comparison must be of type String or Binary (not a Number or a set\n type).
\n IN : Checks for matching elements in a list.
\n AttributeValueList can contain one or more\n AttributeValue elements of type String, Number, or Binary.\n These attributes are compared against an existing attribute of an item. If any\n elements of the input are equal to the item attribute, the expression evaluates\n to true.
\n BETWEEN : Greater than or equal to the first value, and less than\n or equal to the second value.
\n AttributeValueList must contain two AttributeValue\n elements of the same type, either String, Number, or Binary (not a set type). A\n target attribute matches if the target value is greater than, or equal to, the\n first element and less than, or equal to, the second element. If an item\n contains an AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}\n
A comparator for evaluating attributes in the AttributeValueList. For\n example, equals, greater than, less than, etc.
The following comparison operators are available:
\n\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n
The following are descriptions of each comparison operator.
\n\n EQ : Equal. EQ is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, Binary, String Set, Number Set, or Binary Set.\n If an item contains an AttributeValue element of a different type\n than the one provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n NE : Not equal. NE is supported for all data types,\n including lists and maps.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, Binary, String Set, Number Set, or Binary Set. If an\n item contains an AttributeValue of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n LE : Less than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n LT : Less than.
\n AttributeValueList can contain only one AttributeValue\n of type String, Number, or Binary (not a set type). If an item contains an\n AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}.
\n GE : Greater than or equal.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GT : Greater than.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If an item contains\n an AttributeValue element of a different type than the one provided\n in the request, the value does not match. For example, {\"S\":\"6\"}\n does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not\n compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n NOT_NULL : The attribute exists. NOT_NULL is supported\n for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type.\n If the data type of attribute \"a\" is null, and you evaluate it\n using NOT_NULL, the result is a Boolean true. This\n result is because the attribute \"a\" exists; its data type is\n not relevant to the NOT_NULL comparison operator.
\n NULL : The attribute does not exist. NULL is supported\n for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data\n type. If the data type of attribute \"a\" is null, and you\n evaluate it using NULL, the result is a Boolean\n false. This is because the attribute \"a\"\n exists; its data type is not relevant to the NULL comparison\n operator.
\n CONTAINS : Checks for a subsequence, or value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is of type String, then the operator checks for a\n substring match. If the target attribute of the comparison is of type Binary,\n then the operator looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operator evaluates to\n true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\",\n \"a\" can be a list; however, \"b\" cannot be a set, a\n map, or a list.
\n NOT_CONTAINS : Checks for absence of a subsequence, or absence of a\n value in a set.
\n AttributeValueList can contain only one AttributeValue\n element of type String, Number, or Binary (not a set type). If the target\n attribute of the comparison is a String, then the operator checks for the\n absence of a substring match. If the target attribute of the comparison is\n Binary, then the operator checks for the absence of a subsequence of the target\n that matches the input. If the target attribute of the comparison is a set\n (\"SS\", \"NS\", or \"BS\"), then the\n operator evaluates to true if it does not find an exact\n match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS\n b\", \"a\" can be a list; however, \"b\" cannot\n be a set, a map, or a list.
\n BEGINS_WITH : Checks for a prefix.
\n AttributeValueList can contain only one AttributeValue\n of type String or Binary (not a Number or a set type). The target attribute of\n the comparison must be of type String or Binary (not a Number or a set\n type).
\n IN : Checks for matching elements in a list.
\n AttributeValueList can contain one or more\n AttributeValue elements of type String, Number, or Binary.\n These attributes are compared against an existing attribute of an item. If any\n elements of the input are equal to the item attribute, the expression evaluates\n to true.
\n BETWEEN : Greater than or equal to the first value, and less than\n or equal to the second value.
\n AttributeValueList must contain two AttributeValue\n elements of the same type, either String, Number, or Binary (not a set type). A\n target attribute matches if the target value is greater than, or equal to, the\n first element and less than, or equal to, the second element. If an item\n contains an AttributeValue element of a different type than the one\n provided in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\",\n \"1\"]}\n
One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.
\nFor information on specifying data types in JSON, see JSON Data Format\n in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.
\nFor information on specifying data types in JSON, see JSON Data Format\n in the Amazon DynamoDB Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "Represents a condition to be compared with an attribute value. This condition can be\n used with DeleteItem, PutItem, or UpdateItem\n operations; if the comparison evaluates to true, the operation succeeds; if not, the\n operation fails. You can use ExpectedAttributeValue in one of two different\n ways:
Use AttributeValueList to specify one or more values to compare\n against an attribute. Use ComparisonOperator to specify how you\n want to perform the comparison. If the comparison evaluates to true, then the\n conditional operation succeeds.
Use Value to specify a value that DynamoDB will compare against\n an attribute. If the values match, then ExpectedAttributeValue\n evaluates to true and the conditional operation succeeds. Optionally, you can\n also set Exists to false, indicating that you do\n not expect to find the attribute value in the table. In this\n case, the conditional operation succeeds only if the comparison evaluates to\n false.
\n Value and Exists are incompatible with\n AttributeValueList and ComparisonOperator. Note that if\n you use both sets of parameters at once, DynamoDB will return a\n ValidationException exception.
Represents a condition to be compared with an attribute value. This condition can be\n used with DeleteItem, PutItem, or UpdateItem\n operations; if the comparison evaluates to true, the operation succeeds; if not, the\n operation fails. You can use ExpectedAttributeValue in one of two different\n ways:
Use AttributeValueList to specify one or more values to compare\n against an attribute. Use ComparisonOperator to specify how you\n want to perform the comparison. If the comparison evaluates to true, then the\n conditional operation succeeds.
Use Value to specify a value that DynamoDB will compare against\n an attribute. If the values match, then ExpectedAttributeValue\n evaluates to true and the conditional operation succeeds. Optionally, you can\n also set Exists to false, indicating that you do\n not expect to find the attribute value in the table. In this\n case, the conditional operation succeeds only if the comparison evaluates to\n false.
\n Value and Exists are incompatible with\n AttributeValueList and ComparisonOperator. Note that if\n you use both sets of parameters at once, DynamoDB will return a\n ValidationException exception.
Type of encryption used on the bucket where export data is stored. Valid values for\n S3SseAlgorithm are:
\n AES256 - server-side encryption with Amazon S3 managed\n keys
\n KMS - server-side encryption with KMS managed\n keys
Type of encryption used on the bucket where export data is stored. Valid values for\n S3SseAlgorithm are:
\n AES256 - server-side encryption with Amazon S3 managed\n keys
\n KMS - server-side encryption with KMS managed\n keys
The number of items exported.
" } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
Optional object containing the parameters specific to an incremental export.
" + } } }, "traits": { @@ -3780,20 +5420,25 @@ "type": "timestamp" }, "com.amazonaws.dynamodb#ExportFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DYNAMODB_JSON", - "name": "DYNAMODB_JSON" - }, - { - "value": "ION", - "name": "ION" + "type": "enum", + "members": { + "DYNAMODB_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB_JSON" } - ] + }, + "ION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ION" + } + } } }, + "com.amazonaws.dynamodb#ExportFromTime": { + "type": "timestamp" + }, "com.amazonaws.dynamodb#ExportManifest": { "type": "string" }, @@ -3816,22 +5461,26 @@ "type": "timestamp" }, "com.amazonaws.dynamodb#ExportStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" } - ] + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.dynamodb#ExportSummaries": { @@ -3854,6 +5503,12 @@ "traits": { "smithy.api#documentation": "Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.
" } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.
\nIf you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n ImportConflictException.
Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.
\nIf you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n ImportConflictException.
The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.
\nS3BucketOwner is a required parameter when exporting to a S3 bucket in another\n account.
\nType of encryption used on the bucket where export data will be stored. Valid values\n for S3SseAlgorithm are:
\n AES256 - server-side encryption with Amazon S3 managed\n keys
\n KMS - server-side encryption with KMS managed\n keys
Type of encryption used on the bucket where export data will be stored. Valid values\n for S3SseAlgorithm are:
\n AES256 - server-side encryption with Amazon S3 managed\n keys
\n KMS - server-side encryption with KMS managed\n keys
The format for the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.
Choice of whether to execute as a full export or incremental export. Valid values are\n FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If\n INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be\n used.
" + } + }, + "IncrementalExportSpecification": { + "target": "com.amazonaws.dynamodb#IncrementalExportSpecification", + "traits": { + "smithy.api#documentation": "Optional object containing the parameters specific to an incremental export.
" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#ExportTableToPointInTimeOutput": { @@ -3963,11 +5633,51 @@ "smithy.api#documentation": "Contains a description of the table export.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#ExportTime": { "type": "timestamp" }, + "com.amazonaws.dynamodb#ExportToTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportType": { + "type": "enum", + "members": { + "FULL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_EXPORT" + } + }, + "INCREMENTAL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_EXPORT" + } + } + } + }, + "com.amazonaws.dynamodb#ExportViewType": { + "type": "enum", + "members": { + "NEW_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_IMAGE" + } + }, + "NEW_AND_OLD_IMAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_AND_OLD_IMAGES" + } + } + } + }, "com.amazonaws.dynamodb#ExpressionAttributeNameMap": { "type": "map", "key": { @@ -4038,9 +5748,9 @@ } }, "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table from which to retrieve the specified item.
", + "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, @@ -4090,23 +5800,53 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The GetItem operation returns a set of attributes for the item with the\n given primary key. If there is no matching item, GetItem does not return\n any data and there will be no Item element in the response.
\n GetItem provides an eventually consistent read by default. If your\n application requires a strongly consistent read, set ConsistentRead to\n true. Although a strongly consistent read might take more time than an\n eventually consistent read, it always returns the last updated value.
The GetItem operation returns a set of attributes for the item with the\n given primary key. If there is no matching item, GetItem does not return\n any data and there will be no Item element in the response.
\n GetItem provides an eventually consistent read by default. If your\n application requires a strongly consistent read, set ConsistentRead to\n true. Although a strongly consistent read might take more time than an\n eventually consistent read, it always returns the last updated value.
The name of the table containing the requested item.
", + "smithy.api#documentation": "The name of the table containing the requested item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "A map of attribute names to AttributeValue objects, representing the\n primary key of the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.
", + "smithy.api#documentation": "A map of attribute names to AttributeValue objects, representing the\n primary key of the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.
", "smithy.api#required": {} } }, @@ -4128,18 +5868,19 @@ "ProjectionExpression": { "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.
\nIf no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.
\nFor more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.
\nIf no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.
\nFor more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a GetItem operation.
Represents the input of a GetItem operation.
A map of attribute names to AttributeValue objects, as specified by\n ProjectionExpression.
A map of attribute names to AttributeValue objects, as specified by\n ProjectionExpression.
The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.
Represents the output of a GetItem operation.
Returns the resource-based policy document attached to the resource, which can be a\n table or stream, in JSON format.
\n\n GetResourcePolicy follows an \n eventually consistent\n model. The following list\n describes the outcomes when you issue the GetResourcePolicy request\n immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return a\n PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a\n DeleteResourcePolicy request, DynamoDB might return\n the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a\n CreateTable request, which includes a resource-based policy,\n DynamoDB might return a ResourceNotFoundException or\n a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually\n consistent query, the metadata for your policy or table might not be\n available at that moment. Wait for a few seconds, and then retry the\n GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the\n PutResourcePolicy request, the policy will be applied in the\n authorization of requests to the resource. Because this process is eventually\n consistent, it will take some time to apply the policy to all requests to a resource.\n Policies that you attach while creating a table using the CreateTable\n request will always be applied to all requests for that table.
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The\n resources you can specify include tables and streams.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#GetResourcePolicyOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The resource-based policy document attached to the resource, which can be a table or\n stream, in JSON format.
" } }, - "ConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "RevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", "traits": { - "smithy.api#documentation": "The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer\n Guide.
A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a GetItem operation.
The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nThe complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nRepresents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "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.
The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.
\nThe complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.
\nThe current state of the global secondary index:
\n\n CREATING - The index is being created.
\n UPDATING - The index is being updated.
\n DELETING - The index is being deleted.
\n ACTIVE - The index is ready for use.
The current state of the global secondary index:
\n\n CREATING - The index is being created.
\n UPDATING - The index is being updated.
\n DELETING - The index is being deleted.
\n ACTIVE - The index is ready for use.
Indicates whether the index is currently backfilling. Backfilling\n is the process of reading items from the table and determining whether they can be added\n to the index. (Not all items will qualify: For example, a partition key cannot have any\n duplicate values.) If an item can be added to the index, DynamoDB will do so. After all\n items have been processed, the backfilling operation is complete and\n Backfilling is false.
You can delete an index that is being created during the Backfilling\n phase when IndexStatus is set to CREATING and Backfilling is\n true. You can't delete the index that is being created when IndexStatus is\n set to CREATING and Backfilling is false.
For indexes that were created during a CreateTable operation, the\n Backfilling attribute does not appear in the\n DescribeTable output.
Indicates whether the index is currently backfilling. Backfilling\n is the process of reading items from the table and determining whether they can be added\n to the index. (Not all items will qualify: For example, a partition key cannot have any\n duplicate values.) If an item can be added to the index, DynamoDB will do so. After all\n items have been processed, the backfilling operation is complete and\n Backfilling is false.
You can delete an index that is being created during the Backfilling\n phase when IndexStatus is set to CREATING and Backfilling is\n true. You can't delete the index that is being created when IndexStatus is\n set to CREATING and Backfilling is false.
For indexes that were created during a CreateTable operation, the\n Backfilling attribute does not appear in the\n DescribeTable output.
Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" } }, "IndexSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "target": "com.amazonaws.dynamodb#LongObject", "traits": { "smithy.api#documentation": "The total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.
" } }, "ItemCount": { - "target": "com.amazonaws.dynamodb#Long", + "target": "com.amazonaws.dynamodb#LongObject", "traits": { "smithy.api#documentation": "The number of items in the specified index. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.
" } @@ -4281,6 +6093,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the index.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "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.
The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.
\nThe complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.
\nRepresents the provisioned throughput settings for the specified global secondary\n index.
" } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" } }, "traits": { @@ -4343,7 +6164,7 @@ "Create": { "target": "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction", "traits": { - "smithy.api#documentation": "The parameters required for creating a global secondary index on an existing\n table:
\n\n IndexName \n
\n KeySchema \n
\n AttributeDefinitions \n
\n Projection \n
\n ProvisionedThroughput \n
The parameters required for creating a global secondary index on an existing\n table:
\n\n IndexName \n
\n KeySchema \n
\n AttributeDefinitions \n
\n Projection \n
\n ProvisionedThroughput \n
Represents one of the following:
\nA new global secondary index to be added to an existing table.
\nNew provisioned throughput parameters for an existing global secondary\n index.
\nAn existing global secondary index to be removed from an existing\n table.
\nRepresents one of the following:
\nA new global secondary index to be added to an existing table.
\nNew provisioned throughput parameters for an existing global secondary\n index.
\nAn existing global secondary index to be removed from an existing\n table.
\nThe current state of the global table:
\n\n CREATING - The global table is being created.
\n UPDATING - The global table is being updated.
\n DELETING - The global table is being deleted.
\n ACTIVE - The global table is ready for use.
The current state of the global table:
\n\n CREATING - The global table is being created.
\n UPDATING - The global table is being updated.
\n DELETING - The global table is being deleted.
\n ACTIVE - The global table is ready for use.
\n The Amazon Resource Number (ARN) corresponding to the import request.\n
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) corresponding to the import request.
" } }, "ImportStatus": { "target": "com.amazonaws.dynamodb#ImportStatus", "traits": { - "smithy.api#documentation": "\n The status of the import operation.\n
" + "smithy.api#documentation": "The status of the import operation.
" } }, "TableArn": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Number (ARN) of the table being imported into.\n
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the table being imported into.
" } }, "S3BucketSource": { "target": "com.amazonaws.dynamodb#S3BucketSource", "traits": { - "smithy.api#documentation": "\n The path and S3 bucket of the source file that is being imported. This includes the S3Bucket (required), \n S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is owned by the requester).\n
" + "smithy.api#documentation": "The path and S3 bucket of the source file that is being imported. This includes the\n S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is\n owned by the requester).
" } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this import task.\n
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this\n import task.
" } }, "InputFormat": { "target": "com.amazonaws.dynamodb#InputFormat", "traits": { - "smithy.api#documentation": "\n The format of the source data. Valid values are CSV,\n DYNAMODB_JSON or ION.
The format of the source data. Valid values are CSV,\n DYNAMODB_JSON or ION.
\n The time at which this import task began.\n
" + "smithy.api#documentation": "The time at which this import task began.
" } }, "EndTime": { "target": "com.amazonaws.dynamodb#ImportEndTime", "traits": { - "smithy.api#documentation": "\n The time at which this import task ended. (Does this include the successful complete creation of \n the table it was imported to?)\n
" + "smithy.api#documentation": "The time at which this import task ended. (Does this include the successful complete\n creation of the table it was imported to?)
" } } }, "traits": { - "smithy.api#documentation": "\n Summary information about the source file for the import.\n
" + "smithy.api#documentation": "Summary information about the source file for the import.\n
" } }, "com.amazonaws.dynamodb#ImportSummaryList": { @@ -4692,7 +6527,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Imports table data from an S3 bucket. \n \n
" + "smithy.api#documentation": "Imports table data from an S3 bucket.
" } }, "com.amazonaws.dynamodb#ImportTableDescription": { @@ -4701,120 +6536,123 @@ "ImportArn": { "target": "com.amazonaws.dynamodb#ImportArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Number (ARN) corresponding to the import request.\n
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) corresponding to the import request.\n
" } }, "ImportStatus": { "target": "com.amazonaws.dynamodb#ImportStatus", "traits": { - "smithy.api#documentation": "\n The status of the import.\n
" + "smithy.api#documentation": "The status of the import.
" } }, "TableArn": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Number (ARN) of the table being imported into.\n
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the table being imported into.\n
" } }, "TableId": { "target": "com.amazonaws.dynamodb#TableId", "traits": { - "smithy.api#documentation": "\n The table id corresponding to the table created by import table process.\n \n
" + "smithy.api#documentation": "The table id corresponding to the table created by import table process.\n
" } }, "ClientToken": { "target": "com.amazonaws.dynamodb#ClientToken", "traits": { - "smithy.api#documentation": "\n The client token that was provided for the import task. Reusing the client token \n on retry makes a call to ImportTable idempotent.\n
The client token that was provided for the import task. Reusing the client token on\n retry makes a call to ImportTable idempotent.
\n Values for the S3 bucket the source file is imported from. Includes bucket name (required), \n key prefix (optional) and bucket account owner ID (optional).\n
" + "smithy.api#documentation": "Values for the S3 bucket the source file is imported from. Includes bucket name\n (required), key prefix (optional) and bucket account owner ID (optional).
" } }, "ErrorCount": { "target": "com.amazonaws.dynamodb#ErrorCount", "traits": { - "smithy.api#documentation": "\n The number of errors occurred on importing the source file into the target table.\n
" + "smithy.api#default": 0, + "smithy.api#documentation": "The number of errors occurred on importing the source file into the target table.\n
" } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.\n
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the\n target table.
" } }, "InputFormat": { "target": "com.amazonaws.dynamodb#InputFormat", "traits": { - "smithy.api#documentation": "\n The format of the source data going into the target table.\n
" + "smithy.api#documentation": "The format of the source data going into the target table.\n
" } }, "InputFormatOptions": { "target": "com.amazonaws.dynamodb#InputFormatOptions", "traits": { - "smithy.api#documentation": "The format options for the data that was imported into the target table. There is one value, CsvOption.\n
" + "smithy.api#documentation": "The format options for the data that was imported into the target table. There is one\n value, CsvOption.
" } }, "InputCompressionType": { "target": "com.amazonaws.dynamodb#InputCompressionType", "traits": { - "smithy.api#documentation": "\n The compression options for the data that has been imported into the target table. The values are \n NONE, GZIP, or ZSTD.\n
" + "smithy.api#documentation": "The compression options for the data that has been imported into the target table.\n The values are NONE, GZIP, or ZSTD.
" } }, "TableCreationParameters": { "target": "com.amazonaws.dynamodb#TableCreationParameters", "traits": { - "smithy.api#documentation": "\n The parameters for the new table that is being imported into.\n
" + "smithy.api#documentation": "The parameters for the new table that is being imported into.
" } }, "StartTime": { "target": "com.amazonaws.dynamodb#ImportStartTime", "traits": { - "smithy.api#documentation": "\n The time when this import task started.\n
" + "smithy.api#documentation": "The time when this import task started.
" } }, "EndTime": { "target": "com.amazonaws.dynamodb#ImportEndTime", "traits": { - "smithy.api#documentation": "\n The time at which the creation of the table associated with this import task completed.\n
" + "smithy.api#documentation": "The time at which the creation of the table associated with this import task\n completed.
" } }, "ProcessedSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "target": "com.amazonaws.dynamodb#LongObject", "traits": { - "smithy.api#documentation": "\n The total size of data processed from the source file, in Bytes.\n
" + "smithy.api#documentation": "The total size of data processed from the source file, in Bytes.
" } }, "ProcessedItemCount": { "target": "com.amazonaws.dynamodb#ProcessedItemCount", "traits": { - "smithy.api#documentation": "\n The total number of items processed from the source file.\n
" + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of items processed from the source file.
" } }, "ImportedItemCount": { "target": "com.amazonaws.dynamodb#ImportedItemCount", "traits": { - "smithy.api#documentation": "\n The number of items successfully imported into the new table.\n
" + "smithy.api#default": 0, + "smithy.api#documentation": "The number of items successfully imported into the new table.
" } }, "FailureCode": { "target": "com.amazonaws.dynamodb#FailureCode", "traits": { - "smithy.api#documentation": "\n The error code corresponding to the failure that the import job ran into during execution.\n
" + "smithy.api#documentation": "The error code corresponding to the failure that the import job ran into during\n execution.
" } }, "FailureMessage": { "target": "com.amazonaws.dynamodb#FailureMessage", "traits": { - "smithy.api#documentation": "\n The error message corresponding to the failure that the import job ran into during execution.\n
" + "smithy.api#documentation": "The error message corresponding to the failure that the import job ran into during\n execution.
" } } }, "traits": { - "smithy.api#documentation": "\n Represents the properties of the table being imported into.\n
" + "smithy.api#documentation": "Represents the properties of the table being imported into.\n
" } }, "com.amazonaws.dynamodb#ImportTableInput": { @@ -4823,43 +6661,46 @@ "ClientToken": { "target": "com.amazonaws.dynamodb#ClientToken", "traits": { - "smithy.api#documentation": "Providing a ClientToken makes the call to\n ImportTableInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.
\nIf you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.
Providing a ClientToken makes the call to ImportTableInput\n idempotent, meaning that multiple identical calls have the same effect as one single\n call.
A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.
\nIf you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.
\n The S3 bucket that provides the source for the import.\n
", + "smithy.api#documentation": "The S3 bucket that provides the source for the import.
", "smithy.api#required": {} } }, "InputFormat": { "target": "com.amazonaws.dynamodb#InputFormat", "traits": { - "smithy.api#documentation": " The format of the source data. Valid values for ImportFormat are\n CSV, DYNAMODB_JSON or ION.\n
The format of the source data. Valid values for ImportFormat are\n CSV, DYNAMODB_JSON or ION.
\n Additional properties that specify how the input is formatted,\n
" + "smithy.api#documentation": "Additional properties that specify how the input is formatted,
" } }, "InputCompressionType": { "target": "com.amazonaws.dynamodb#InputCompressionType", "traits": { - "smithy.api#documentation": "\n Type of compression to be used on the input coming from the imported table.\n
" + "smithy.api#documentation": "Type of compression to be used on the input coming from the imported table.
" } }, "TableCreationParameters": { "target": "com.amazonaws.dynamodb#TableCreationParameters", "traits": { - "smithy.api#documentation": "Parameters for the table to import the data into.\n
", + "smithy.api#documentation": "Parameters for the table to import the data into.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#ImportTableOutput": { @@ -4868,20 +6709,50 @@ "ImportTableDescription": { "target": "com.amazonaws.dynamodb#ImportTableDescription", "traits": { - "smithy.api#documentation": "\n Represents the properties of the table created for the import, and parameters of \n the import. The import parameters include import status, how many items were processed, \n and how many errors were encountered.\n
", + "smithy.api#documentation": "Represents the properties of the table created for the import, and parameters of the\n import. The import parameters include import status, how many items were processed, and\n how many errors were encountered.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#ImportedItemCount": { "type": "long", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, + "com.amazonaws.dynamodb#IncrementalExportSpecification": { + "type": "structure", + "members": { + "ExportFromTime": { + "target": "com.amazonaws.dynamodb#ExportFromTime", + "traits": { + "smithy.api#documentation": "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.
" + } + }, + "ExportToTime": { + "target": "com.amazonaws.dynamodb#ExportToTime", + "traits": { + "smithy.api#documentation": "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.
" + } + }, + "ExportViewType": { + "target": "com.amazonaws.dynamodb#ExportViewType", + "traits": { + "smithy.api#documentation": "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.
Optional object containing the parameters specific to an incremental export.
" + } + }, "com.amazonaws.dynamodb#IndexName": { "type": "string", "traits": { @@ -4905,64 +6776,78 @@ } }, "com.amazonaws.dynamodb#IndexStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" } - ] + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } } }, "com.amazonaws.dynamodb#InputCompressionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GZIP", - "name": "GZIP" - }, - { - "value": "ZSTD", - "name": "ZSTD" - }, - { - "value": "NONE", - "name": "NONE" + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" } - ] + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } } }, "com.amazonaws.dynamodb#InputFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DYNAMODB_JSON", - "name": "DYNAMODB_JSON" - }, - { - "value": "ION", - "name": "ION" - }, - { - "value": "CSV", - "name": "CSV" + "type": "enum", + "members": { + "DYNAMODB_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB_JSON" } - ] + }, + "ION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ION" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } } }, "com.amazonaws.dynamodb#InputFormatOptions": { @@ -4971,23 +6856,23 @@ "Csv": { "target": "com.amazonaws.dynamodb#CsvOptions", "traits": { - "smithy.api#documentation": "\n The options for imported source files in CSV format. The values are Delimiter and HeaderList.\n
" + "smithy.api#documentation": "The options for imported source files in CSV format. The values are Delimiter and\n HeaderList.
" } } }, "traits": { - "smithy.api#documentation": "\n The format options for the data that was imported into the target table. There is one value, CsvOption.
" + "smithy.api#documentation": "The format options for the data that was imported into the target table. There is one\n value, CsvOption.
" } }, "com.amazonaws.dynamodb#Integer": { - "type": "integer" - }, - "com.amazonaws.dynamodb#IntegerObject": { "type": "integer", "traits": { - "smithy.api#box": {} + "smithy.api#default": 0 } }, + "com.amazonaws.dynamodb#IntegerObject": { + "type": "integer" + }, "com.amazonaws.dynamodb#InternalServerError": { "type": "structure", "members": { @@ -5060,7 +6945,7 @@ "SizeEstimateRangeGB": { "target": "com.amazonaws.dynamodb#ItemCollectionSizeEstimateRange", "traits": { - "smithy.api#documentation": "An estimate of item collection size, in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the\n size of all the items in the table, plus the size of all attributes projected into all\n of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision\n or accuracy of the estimate.
" + "smithy.api#documentation": "An estimate of item collection size, in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the\n size of all the items in the table, plus the size of all attributes projected into all\n of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision\n or accuracy of the estimate.
" } } }, @@ -5077,17 +6962,14 @@ "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable": { "type": "map", "key": { - "target": "com.amazonaws.dynamodb#TableName" + "target": "com.amazonaws.dynamodb#TableArn" }, "value": { "target": "com.amazonaws.dynamodb#ItemCollectionMetricsMultiple" } }, "com.amazonaws.dynamodb#ItemCollectionSizeEstimateBound": { - "type": "double", - "traits": { - "smithy.api#box": {} - } + "type": "double" }, "com.amazonaws.dynamodb#ItemCollectionSizeEstimateRange": { "type": "list", @@ -5113,7 +6995,6 @@ "com.amazonaws.dynamodb#ItemCount": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -5147,7 +7028,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 25 + "max": 100 } } }, @@ -5224,28 +7105,30 @@ "KeyType": { "target": "com.amazonaws.dynamodb#KeyType", "traits": { - "smithy.api#documentation": "The role that this key attribute will assume:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.
\nThe role that this key attribute will assume:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.
\nRepresents a single element of a key schema. A key schema\n specifies the attributes that make up the primary key of a table, or the key attributes\n of an index.
\nA KeySchemaElement represents exactly one attribute of the primary key.\n For example, a simple primary key would be represented by one\n KeySchemaElement (for the partition key). A composite primary key would\n require one KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested\n attribute). The data type must be one of String, Number, or Binary. The attribute cannot\n be nested within a List or a Map.
Represents a single element of a key schema. A key schema\n specifies the attributes that make up the primary key of a table, or the key attributes\n of an index.
\nA KeySchemaElement represents exactly one attribute of the primary key.\n For example, a simple primary key would be represented by one\n KeySchemaElement (for the partition key). A composite primary key would\n require one KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested\n attribute). The data type must be one of String, Number, or Binary. The attribute cannot\n be nested within a List or a Map.
The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.
A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the ProjectionExpression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.
" - } - }, - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", - "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a set of primary keys and, for each key, the attributes to retrieve from\n the table.
\nFor each primary key, you must provide all of the key attributes.\n For example, with a simple primary key, you only need to provide the partition key. For\n a composite primary key, you must provide both the partition key\n and the sort key.
" - } - }, - "com.amazonaws.dynamodb#KinesisDataStreamDestination": { - "type": "structure", - "members": { - "StreamArn": { - "target": "com.amazonaws.dynamodb#StreamArn", - "traits": { - "smithy.api#documentation": "The ARN for a specific Kinesis data stream.
" - } - }, - "DestinationStatus": { - "target": "com.amazonaws.dynamodb#DestinationStatus", - "traits": { - "smithy.api#documentation": "The current status of replication.
" - } - }, - "DestinationStatusDescription": { - "target": "com.amazonaws.dynamodb#String", - "traits": { - "smithy.api#documentation": "The human-readable string that corresponds to the replica status.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a Kinesis data stream destination.
" - } - }, - "com.amazonaws.dynamodb#KinesisDataStreamDestinations": { - "type": "list", - "member": { - "target": "com.amazonaws.dynamodb#KinesisDataStreamDestination" - } - }, - "com.amazonaws.dynamodb#KinesisStreamingDestinationInput": { - "type": "structure", - "members": { - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "The name of the DynamoDB table.
", - "smithy.api#required": {} - } - }, - "StreamArn": { - "target": "com.amazonaws.dynamodb#StreamArn", - "traits": { - "smithy.api#documentation": "The ARN for a Kinesis data stream.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput": { - "type": "structure", - "members": { - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "The name of the table being modified.
" - } - }, - "StreamArn": { - "target": "com.amazonaws.dynamodb#StreamArn", - "traits": { - "smithy.api#documentation": "The ARN for the specific Kinesis data stream.
" - } - }, - "DestinationStatus": { - "target": "com.amazonaws.dynamodb#DestinationStatus", - "traits": { - "smithy.api#documentation": "The current status of the replication.
" - } - } - } - }, - "com.amazonaws.dynamodb#EnableKinesisStreamingDestinationInput": { - "type": "structure", - "members": { - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "The name of the DynamoDB table.
", - "smithy.api#required": {} + "smithy.api#documentation": "The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.
The ARN for a Kinesis data stream.
", - "smithy.api#required": {} + "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the ProjectionExpression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } } + }, + "traits": { + "smithy.api#documentation": "Represents a set of primary keys and, for each key, the attributes to retrieve from\n the table.
\nFor each primary key, you must provide all of the key attributes.\n For example, with a simple primary key, you only need to provide the partition key. For\n a composite primary key, you must provide both the partition key\n and the sort key.
" } }, - "com.amazonaws.dynamodb#EnableKinesisStreamingDestinationOutput": { + "com.amazonaws.dynamodb#KinesisDataStreamDestination": { "type": "structure", "members": { - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "The name of the table being modified.
" - } - }, "StreamArn": { "target": "com.amazonaws.dynamodb#StreamArn", "traits": { - "smithy.api#documentation": "The ARN for the specific Kinesis data stream.
" + "smithy.api#documentation": "The ARN for a specific Kinesis data stream.
" } }, "DestinationStatus": { "target": "com.amazonaws.dynamodb#DestinationStatus", "traits": { - "smithy.api#documentation": "The current status of the replication.
" + "smithy.api#documentation": "The current status of replication.
" + } + }, + "DestinationStatusDescription": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "The human-readable string that corresponds to the replica status.
" + } + }, + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "The precision of the Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.
Describes a Kinesis data stream destination.
" + } + }, + "com.amazonaws.dynamodb#KinesisDataStreamDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#KinesisDataStreamDestination" } }, - "com.amazonaws.dynamodb#DisableKinesisStreamingDestinationInput": { + "com.amazonaws.dynamodb#KinesisStreamingDestinationInput": { "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the DynamoDB table.
", + "smithy.api#documentation": "The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, @@ -5419,10 +7224,16 @@ "smithy.api#documentation": "The ARN for a Kinesis data stream.
", "smithy.api#required": {} } + }, + "EnableKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "The source for the Kinesis streaming information that is being enabled.
" + } } } }, - "com.amazonaws.dynamodb#DisableKinesisStreamingDestinationOutput": { + "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput": { "type": "structure", "members": { "TableName": { @@ -5442,6 +7253,12 @@ "traits": { "smithy.api#documentation": "The current status of the replication.
" } + }, + "EnableKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "The destination for the Kinesis streaming information that is being enabled.
" + } } } }, @@ -5459,7 +7276,7 @@ } }, "traits": { - "smithy.api#documentation": "There is no limit to the number of daily on-demand backups that can be taken.
\nUp to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.
The only exception is when you are creating a table with one or more secondary\n indexes. You can have up to 250 such requests running at a time; however, if the table or\n index specifications are complex, DynamoDB might temporarily reduce the number\n of concurrent operations.
\nThere is a soft account quota of 2,500 tables.
", + "smithy.api#documentation": "There is no limit to the number of daily on-demand backups that can be taken.
\nFor most purposes, up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.
When you are creating a table with one or more secondary\n indexes, you can have up to 250 such requests running at a time. However, if the table or\n index specifications are complex, then DynamoDB might temporarily reduce the number\n of concurrent operations.
\nWhen importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
\nThere is a soft account quota of 2,500 tables.
\nGetRecords was called with a value of more than 1000 for the limit request parameter.
\nMore than 2 processes are reading from the same streams shard at the same time. Exceeding\n this limit may result in request throttling.
", "smithy.api#error": "client" } }, @@ -5489,16 +7306,16 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "List backups associated with an Amazon Web Services account. To list backups for a\n given table, specify TableName. ListBackups returns a\n paginated list of results with at most 1 MB worth of items in a page. You can also\n specify a maximum number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.
\nYou can call ListBackups a maximum of five times per second.
List DynamoDB backups that are associated with an Amazon Web Services account and\n weren't made with Amazon Web Services Backup. To list these backups for a given table,\n specify TableName. ListBackups returns a paginated list of\n results with at most 1 MB worth of items in a page. You can also specify a maximum\n number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.
\nYou can call ListBackups a maximum of five times per second.
If you want to retrieve the complete list of backups made with Amazon Web Services\n Backup, use the Amazon Web Services Backup\n list API.\n
" } }, "com.amazonaws.dynamodb#ListBackupsInput": { "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The backups from the table specified by TableName are listed.
Lists the backups from the table specified in TableName. You can also\n provide the Amazon Resource Name (ARN) of the table in this parameter.
The backups from the table specified by BackupType are listed.
Where BackupType can be:
\n USER - On-demand backup created by you. (The default setting if no other backup types are specified.)
\n SYSTEM - On-demand backup automatically created by DynamoDB.
\n ALL - All types of on-demand backups (USER and SYSTEM).
The backups from the table specified by BackupType are listed.
Where BackupType can be:
\n USER - On-demand backup created by you. (The default setting if no\n other backup types are specified.)
\n SYSTEM - On-demand backup automatically created by DynamoDB.
\n ALL - All types of on-demand backups (USER and SYSTEM).
The ARN of the backup last evaluated when the current page of results was returned,\n inclusive of the current page of results. This value may be specified as the\n ExclusiveStartBackupArn of a new ListBackups operation in\n order to fetch the next page of results.
If LastEvaluatedBackupArn is empty, then the last page of results has\n been processed and there are no more results to be retrieved.
If LastEvaluatedBackupArn is not empty, this may or may not indicate\n that there is more data to be returned. All results are guaranteed to have been returned\n if and only if no value for LastEvaluatedBackupArn is returned.
The ARN of the backup last evaluated when the current page of results was returned,\n inclusive of the current page of results. This value may be specified as the\n ExclusiveStartBackupArn of a new ListBackups operation in\n order to fetch the next page of results.
If LastEvaluatedBackupArn is empty, then the last page of results has\n been processed and there are no more results to be retrieved.
If LastEvaluatedBackupArn is not empty, this may or may not indicate\n that there is more data to be returned. All results are guaranteed to have been returned\n if and only if no value for LastEvaluatedBackupArn is returned.
The name of the table.
" + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
" } }, "NextToken": { @@ -5593,14 +7416,19 @@ "MaxResults": { "target": "com.amazonaws.dynamodb#ListContributorInsightsLimit", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Maximum number of results to return per page.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#ListContributorInsightsLimit": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "max": 100 } @@ -5621,6 +7449,9 @@ "smithy.api#documentation": "A token to go to the next page if there is one.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#ListExports": { @@ -5669,12 +7500,14 @@ "smithy.api#documentation": "An optional string that, if supplied, must be copied from the output of a previous\n call to ListExports. When provided in this manner, the API fetches the next\n page of results.
If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListExports again, with NextToken set to this\n value.
Lists all global tables that have a replica in the specified Region.
\nThis operation only applies to Version\n 2017.11.29 of global tables.
\nLists all global tables that have a replica in the specified Region.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\nThe maximum number of table names to return, if the parameter is not specified\n DynamoDB defaults to 100.
\nIf the number of global tables DynamoDB finds reaches this limit, it stops the\n operation and returns the table names collected up to that point, with a table name in\n the LastEvaluatedGlobalTableName to apply in a subsequent operation to the\n ExclusiveStartGlobalTableName parameter.
The maximum number of table names to return, if the parameter is not specified\n DynamoDB defaults to 100.
\nIf the number of global tables DynamoDB finds reaches this limit, it stops the\n operation and returns the table names collected up to that point, with a table name in\n the LastEvaluatedGlobalTableName to apply in a subsequent operation to the\n ExclusiveStartGlobalTableName parameter.
Lists the global tables in a specific Region.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#ListGlobalTablesOutput": { @@ -5759,6 +7598,9 @@ "smithy.api#documentation": "Last evaluated global table name.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#ListImports": { @@ -5775,7 +7617,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Lists completed imports within the past 90 days.\n
", + "smithy.api#documentation": "Lists completed imports within the past 90 days.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5789,27 +7631,29 @@ "TableArn": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) associated with the table that was imported to.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the table that was imported to.\n
" } }, "PageSize": { "target": "com.amazonaws.dynamodb#ListImportsMaxLimit", "traits": { - "smithy.api#documentation": "\n The number of ImportSummary objects returned in a single page.\n
The number of ImportSummary objects returned in a single page.
\n An optional string that, if supplied, must be copied from the output of a previous\n call to ListImports. When provided in this manner, the API fetches the next\n page of results.\n
An optional string that, if supplied, must be copied from the output of a previous\n call to ListImports. When provided in this manner, the API fetches the next\n page of results.
\n A list of ImportSummary objects.\n
A list of ImportSummary objects.
\n If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListImports again, with NextToken set to this\n value.\n
If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListImports again, with NextToken set to this\n value.
Returns an array of table names associated with the current account and endpoint. The\n output from ListTables is paginated, with each page returning a maximum of\n 100 table names.
Represents the input of a ListTables operation.
Represents the input of a ListTables operation.
The names of the tables associated with the current account at the current endpoint.\n The maximum size of this array is 100.
\nIf LastEvaluatedTableName also appears in the output, you can use this\n value as the ExclusiveStartTableName parameter in a subsequent\n ListTables request and obtain the next page of results.
The names of the tables associated with the current account at the current endpoint.\n The maximum size of this array is 100.
\nIf LastEvaluatedTableName also appears in the output, you can use this\n value as the ExclusiveStartTableName parameter in a subsequent\n ListTables request and obtain the next page of results.
The name of the last table in the current page of results. Use this value as the\n ExclusiveStartTableName in a new request to obtain the next page of\n results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response,\n this means that there are no more table names to be retrieved.
The name of the last table in the current page of results. Use this value as the\n ExclusiveStartTableName in a new request to obtain the next page of\n results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response,\n this means that there are no more table names to be retrieved.
Represents the output of a ListTables operation.
Represents the output of a ListTables operation.
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10\n times per second, per account.
\nFor an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10\n times per second, per account.
\nFor an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.
" } }, "com.amazonaws.dynamodb#ListTagsOfResourceInput": { @@ -5954,6 +7816,9 @@ "smithy.api#documentation": "An optional string that, if supplied, must be copied from the output of a previous\n call to ListTagOfResource. When provided in this manner, this API fetches the next page\n of results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#ListTagsOfResourceOutput": { @@ -5971,6 +7836,9 @@ "smithy.api#documentation": "If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListTagsOfResource again, with NextToken set to this value.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#LocalSecondaryIndex": { @@ -5986,7 +7854,7 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "The complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nThe complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nThe complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nThe complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nThe total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.
" } }, "ItemCount": { - "target": "com.amazonaws.dynamodb#Long", + "target": "com.amazonaws.dynamodb#LongObject", "traits": { "smithy.api#documentation": "The number of items in the specified index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.
" } @@ -6064,7 +7932,7 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "The complete key schema for a local secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nThe complete key schema for a local secondary index, which consists of one or more\n pairs of attribute names and key types:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.
\nMaximum number of read request units for the specified table.
\nTo 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.
Maximum number of write request units for the specified table.
\nTo 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.
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.
Maximum number of read request units for the specified replica table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "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.
" + } + }, "com.amazonaws.dynamodb#ParameterizedStatement": { "type": "structure", "members": { "Statement": { "target": "com.amazonaws.dynamodb#PartiQLStatement", "traits": { - "smithy.api#documentation": "A PartiQL statment that uses parameters.
", + "smithy.api#documentation": "A PartiQL statement that uses parameters.
", "smithy.api#required": {} } }, @@ -6165,10 +8069,16 @@ "traits": { "smithy.api#documentation": "The parameter values.
" } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "An optional parameter that returns the item attributes for a PartiQL\n ParameterizedStatement operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" + } } }, "traits": { - "smithy.api#documentation": "Represents a PartiQL statment that uses parameters.
" + "smithy.api#documentation": "Represents a PartiQL statement that uses parameters.
" } }, "com.amazonaws.dynamodb#ParameterizedStatements": { @@ -6179,7 +8089,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 25 + "max": 100 } } }, @@ -6225,7 +8135,7 @@ "PointInTimeRecoveryStatus": { "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", "traits": { - "smithy.api#documentation": "The current state of point in time recovery:
\n\n ENABLED - Point in time recovery is enabled.
\n DISABLED - Point in time recovery is disabled.
The current state of point in time recovery:
\n\n ENABLED - Point in time recovery is enabled.
\n DISABLED - Point in time recovery is disabled.
The operation tried to access a nonexistent resource-based policy.
\nIf you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.
The set of attributes that are projected into the index:
\n\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - In addition to the attributes described in\n KEYS_ONLY, the secondary index will include other non-key\n attributes that you specify.
\n ALL - All of the table attributes are projected into the\n index.
The set of attributes that are projected into the index:
\n\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - In addition to the attributes described in\n KEYS_ONLY, the secondary index will include other non-key\n attributes that you specify.
\n ALL - All of the table attributes are projected into the\n index.
When using the DynamoDB console, ALL is selected by default.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed\n across all of the local secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed\n across all of the local secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total.
The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" } }, "com.amazonaws.dynamodb#ProvisionedThroughputDescription": { @@ -6466,9 +8402,9 @@ } }, "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "Name of the table in which to write the item.
", + "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, @@ -6539,23 +8475,50 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.
When you add an item, the primary key attributes are the only required attributes.\n Attribute values cannot be null.
\nEmpty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.
\nInvalid Requests with empty values will be rejected with a\n ValidationException exception.
To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.
For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.
Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.
When you add an item, the primary key attributes are the only required attributes.
\nEmpty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.
\nInvalid Requests with empty values will be rejected with a\n ValidationException exception.
To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.
For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.
The name of the table to contain the item.
", + "smithy.api#documentation": "The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, "Item": { "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", "traits": { - "smithy.api#documentation": "A map of attribute name/value pairs, one for each attribute. Only the primary key\n attributes are required; you can optionally provide other attribute name-value pairs for\n the item.
\nYou must provide all of the attributes for the primary key. For example, with a simple\n primary key, you only need to provide a value for the partition key. For a composite\n primary key, you must provide both values for both the partition key and the sort\n key.
\nIf you specify any attributes that are part of an index key, then the data types for\n those attributes must match those of the schema in the table's attribute\n definition.
\nEmpty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index.
\n\nFor more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.
\nEach element in the Item map is an AttributeValue\n object.
A map of attribute name/value pairs, one for each attribute. Only the primary key\n attributes are required; you can optionally provide other attribute name-value pairs for\n the item.
\nYou must provide all of the attributes for the primary key. For example, with a simple\n primary key, you only need to provide a value for the partition key. For a composite\n primary key, you must provide both values for both the partition key and the sort\n key.
\nIf you specify any attributes that are part of an index key, then the data types for\n those attributes must match those of the schema in the table's attribute\n definition.
\nEmpty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index.
\nFor more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.
\nEach element in the Item map is an AttributeValue\n object.
Use ReturnValues if you want to get the item attributes as they appeared\n before they were updated with the PutItem request. For\n PutItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - If PutItem overwrote an attribute name-value\n pair, then the content of the old item is returned.
The values returned are strongly consistent.
\nThere is no additional cost associated with requesting a return value aside from the small \n network and processing overhead of receiving a larger response. No read capacity units are \n consumed.
\nThe ReturnValues parameter is used by several DynamoDB operations;\n however, PutItem does not recognize any values other than\n NONE or ALL_OLD.
Use ReturnValues if you want to get the item attributes as they appeared\n before they were updated with the PutItem request. For\n PutItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - If PutItem overwrote an attribute name-value\n pair, then the content of the old item is returned.
The values returned are strongly consistent.
\nThere is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
\nThe ReturnValues parameter is used by several DynamoDB operations;\n however, PutItem does not recognize any values other than\n NONE or ALL_OLD.
A condition that must be satisfied in order for a conditional PutItem\n operation to succeed.
An expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type |\n contains | begins_with | size\n
These function names are case-sensitive.
\nComparison operators: = | <> |\n < | > | <= | >= |\n BETWEEN | IN \n
Logical operators: AND | OR | NOT\n
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A condition that must be satisfied in order for a conditional PutItem\n operation to succeed.
An expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type |\n contains | begins_with | size\n
These function names are case-sensitive.
\nComparison operators: = | <> |\n < | > | <= | >= |\n BETWEEN | IN \n
Logical operators: AND | OR | NOT\n
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "An optional parameter that returns the item attributes for a PutItem\n operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a PutItem operation.
Represents the input of a PutItem operation.
The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.
Information about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics is only returned\n if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not returned in the\n response.
Each ItemCollectionMetrics element consists of:
\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size, in\n gigabytes. This value is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on that table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nInformation about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics is only returned\n if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not returned in the\n response.
Each ItemCollectionMetrics element consists of:
\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size, in\n gigabytes. This value is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on that table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nRepresents the output of a PutItem operation.
Represents the output of a PutItem operation.
Represents a request to perform a PutItem operation on an item.
Attaches a resource-based policy document to the resource, which can be a table or\n stream. When you attach a resource-based policy using this API, the policy application\n is \n eventually consistent\n .
\n\n PutResourcePolicy is an idempotent operation; running it multiple times\n on the same resource using the same policy document will return the same revision ID. If\n you specify an ExpectedRevisionId that doesn't match the current policy's\n RevisionId, the PolicyNotFoundException will be\n returned.
\n PutResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return your\n previous policy, if there was one, or return the\n PolicyNotFoundException. This is because\n GetResourcePolicy uses an eventually consistent query, and the\n metadata for your policy or table might not be available at that moment. Wait for a\n few seconds, and then try the GetResourcePolicy request again.
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached.\n The resources you can specify include tables and streams.
\nYou can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.
An Amazon Web Services resource-based policy document in JSON format.
\nThe maximum size supported for a resource-based policy document is 20 KB.\n DynamoDB counts whitespaces when calculating the size of a policy\n against this limit.
\nWithin a resource-based policy, if the action for a DynamoDB\n service-linked role (SLR) to replicate data for a global table is denied, adding\n or deleting a replica will fail with an error.
\nFor a full list of all considerations that apply while attaching a resource-based\n policy, see Resource-based\n policy considerations.
", + "smithy.api#required": {} + } + }, + "ExpectedRevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A string value that you can use to conditionally update your policy. You can provide\n the revision ID of your existing policy to make mutating requests against that\n policy.
\nWhen you provide an expected revision ID, if the revision ID of the existing\n policy on the resource doesn't match or if there's no policy attached to the\n resource, your request will be rejected with a\n PolicyNotFoundException.
To conditionally attach a policy when no policy exists for the resource, specify\n NO_POLICY for the revision ID.
Set this parameter to true to confirm that you want to remove your\n permissions to change the policy of this resource in the future.
A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.dynamodb#Query": { "type": "operation", "input": { @@ -6688,36 +8744,66 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "You must provide the name of the partition key attribute and a single value for that\n attribute. Query returns all items with that partition key value.\n Optionally, you can provide a sort key attribute and use a comparison operator to refine\n the search results.
Use the KeyConditionExpression parameter to provide a specific value for\n the partition key. The Query operation will return all of the items from\n the table or index with that partition key value. You can optionally narrow the scope of\n the Query operation by specifying a sort key value and a comparison\n operator in KeyConditionExpression. To further refine the\n Query results, you can optionally provide a\n FilterExpression. A FilterExpression determines which\n items within the results should be returned to you. All of the other results are\n discarded.
A Query operation always returns a result set. If no matching items are\n found, the result set will be empty. Queries that do not return results consume the\n minimum number of read capacity units for that type of read operation.
DynamoDB calculates the number of read capacity units consumed based on item\n size, not on the amount of data that is returned to an application. The number of\n capacity units consumed will be the same whether you request all of the attributes\n (the default behavior) or just some of them (using a projection expression). The\n number will also be the same whether or not you use a FilterExpression.\n
\n Query results are always sorted by the sort key value. If the data type of\n the sort key is Number, the results are returned in numeric order; otherwise, the\n results are returned in order of UTF-8 bytes. By default, the sort order is ascending.\n To reverse the order, set the ScanIndexForward parameter to false.
A single Query operation will read up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then apply\n 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. A FilterExpression cannot contain partition key\n or sort key attributes. You need to specify those attributes in the\n KeyConditionExpression.
A Query operation can return an empty result set and a\n LastEvaluatedKey if all the items read for the page of results are\n filtered out.
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 strongly\n consistent result. Global secondary indexes support eventually consistent reads only, so\n do not specify ConsistentRead when querying a global secondary\n index.
You must provide the name of the partition key attribute and a single value for that\n attribute. Query returns all items with that partition key value.\n Optionally, you can provide a sort key attribute and use a comparison operator to refine\n the search results.
Use the KeyConditionExpression parameter to provide a specific value for\n the partition key. The Query operation will return all of the items from\n the table or index with that partition key value. You can optionally narrow the scope of\n the Query operation by specifying a sort key value and a comparison\n operator in KeyConditionExpression. To further refine the\n Query results, you can optionally provide a\n FilterExpression. A FilterExpression determines which\n items within the results should be returned to you. All of the other results are\n discarded.
A Query operation always returns a result set. If no matching items are\n found, the result set will be empty. Queries that do not return results consume the\n minimum number of read capacity units for that type of read operation.
DynamoDB calculates the number of read capacity units consumed based on item\n size, not on the amount of data that is returned to an application. The number of\n capacity units consumed will be the same whether you request all of the attributes\n (the default behavior) or just some of them (using a projection expression). The\n number will also be the same whether or not you use a FilterExpression.\n
\n Query results are always sorted by the sort key value. If the data type of\n the sort key is Number, the results are returned in numeric order; otherwise, the\n results are returned in order of UTF-8 bytes. By default, the sort order is ascending.\n To reverse the order, set the ScanIndexForward parameter to false.
A single Query operation will read up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then apply\n 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. A FilterExpression cannot contain partition key\n or sort key attributes. You need to specify those attributes in the\n KeyConditionExpression.
A Query operation can return an empty result set and a\n LastEvaluatedKey if all the items read for the page of results are\n filtered out.
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 strongly\n consistent result. Global secondary indexes support eventually consistent reads only, so\n do not specify ConsistentRead when querying a global secondary\n index.
The name of the table containing the requested items.
", + "smithy.api#documentation": "The name of the table containing the requested items. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "The name of an index to query. This index can be any local secondary index or global\n secondary index on the table. Note that if you use the IndexName parameter,\n you must also provide TableName.\n
The name of an index to query. This index can be any local secondary index or global\n secondary index on the table. Note that if you use the IndexName parameter,\n you must also provide TableName.\n
The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read\n capacity units as getting the items, and is subject to the same item size\n calculations.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.
Strongly consistent reads are not supported on global secondary indexes. If you query\n a global secondary index with ConsistentRead set to true, you\n will receive a ValidationException.
Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.
Strongly consistent reads are not supported on global secondary indexes. If you query\n a global secondary index with ConsistentRead set to true, you\n will receive a ValidationException.
Specifies the order for index traversal: If true (default), the traversal\n is performed in ascending order; if false, the traversal is performed in\n descending order.
Items with the same partition key value are stored in sorted order by sort key. If the\n sort key data type is Number, the results are stored in numeric order. For type String,\n the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each\n byte of the binary data as unsigned.
\nIf ScanIndexForward is true, DynamoDB returns the results in\n the order in which they are stored (by sort key value). This is the default behavior. If\n ScanIndexForward is false, DynamoDB reads the results in\n reverse order by sort key value, and then returns the results to the client.
Specifies the order for index traversal: If true (default), the traversal\n is performed in ascending order; if false, the traversal is performed in\n descending order.
Items with the same partition key value are stored in sorted order by sort key. If the\n sort key data type is Number, the results are stored in numeric order. For type String,\n the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each\n byte of the binary data as unsigned.
\nIf ScanIndexForward is true, DynamoDB returns the results in\n the order in which they are stored (by sort key value). This is the default behavior. If\n ScanIndexForward is false, DynamoDB reads the results in\n reverse order by sort key value, and then returns the results to the client.
The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number, or Binary. No\n set data types are allowed.
The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number, or Binary. No\n set data types are allowed.
A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.
\nIf no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.
\nIf no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "KeyConditionExpression": { "target": "com.amazonaws.dynamodb#KeyExpression", "traits": { - "smithy.api#documentation": "The condition that specifies the key values for items to be retrieved by the\n Query action.
The condition must perform an equality test on a single partition key value.
\nThe condition can optionally perform one of several comparison tests on a single sort\n key value. This allows Query to retrieve one item with a given partition\n key value and sort key value, or several items that have the same partition key value\n but different sort key values.
The partition key equality test is required, and must be specified in the following\n format:
\n\n\n partitionKeyName\n =\n :partitionkeyval\n
If you also want to provide a condition for the sort key, it must be combined using\n AND with the condition for the sort key. Following is an example, using\n the = comparison operator for the sort key:
\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n
Valid comparisons for the sort key condition are as follows:
\n\n sortKeyName\n =\n :sortkeyval - true if the sort key value is equal to\n :sortkeyval.
\n sortKeyName\n <\n :sortkeyval - true if the sort key value is less than\n :sortkeyval.
\n sortKeyName\n <=\n :sortkeyval - true if the sort key value is less than or equal to\n :sortkeyval.
\n sortKeyName\n >\n :sortkeyval - true if the sort key value is greater than\n :sortkeyval.
\n sortKeyName\n >= \n :sortkeyval - true if the sort key value is greater than or equal\n to :sortkeyval.
\n sortKeyName\n BETWEEN\n :sortkeyval1\n AND\n :sortkeyval2 - true if the sort key value is greater than or equal\n to :sortkeyval1, and less than or equal to\n :sortkeyval2.
\n begins_with (\n sortKeyName, :sortkeyval\n ) - true if the sort key value begins with a particular operand.\n (You cannot use this function with a sort key that is of type Number.) Note that\n the function name begins_with is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at\n runtime.
You can optionally use the ExpressionAttributeNames parameter to replace\n the names of the partition key and sort key with placeholder tokens. This option might\n be necessary if an attribute name conflicts with a DynamoDB reserved word. For example,\n the following KeyConditionExpression parameter causes an error because\n Size is a reserved word:
\n Size = :myval\n
To work around this, define a placeholder (such a #S) to represent the\n attribute name Size. KeyConditionExpression then is as\n follows:
\n #S = :myval\n
For a list of reserved words, see Reserved Words\n in the Amazon DynamoDB Developer Guide.
\n\nFor more information on ExpressionAttributeNames and\n ExpressionAttributeValues, see Using\n Placeholders for Attribute Names and Values in the Amazon DynamoDB\n Developer Guide.
The condition that specifies the key values for items to be retrieved by the\n Query action.
The condition must perform an equality test on a single partition key value.
\nThe condition can optionally perform one of several comparison tests on a single sort\n key value. This allows Query to retrieve one item with a given partition\n key value and sort key value, or several items that have the same partition key value\n but different sort key values.
The partition key equality test is required, and must be specified in the following\n format:
\n\n partitionKeyName\n =\n :partitionkeyval\n
If you also want to provide a condition for the sort key, it must be combined using\n AND with the condition for the sort key. Following is an example, using\n the = comparison operator for the sort key:
\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n
Valid comparisons for the sort key condition are as follows:
\n\n sortKeyName\n =\n :sortkeyval - true if the sort key value is equal to\n :sortkeyval.
\n sortKeyName\n <\n :sortkeyval - true if the sort key value is less than\n :sortkeyval.
\n sortKeyName\n <=\n :sortkeyval - true if the sort key value is less than or equal to\n :sortkeyval.
\n sortKeyName\n >\n :sortkeyval - true if the sort key value is greater than\n :sortkeyval.
\n sortKeyName\n >= \n :sortkeyval - true if the sort key value is greater than or equal\n to :sortkeyval.
\n sortKeyName\n BETWEEN\n :sortkeyval1\n AND\n :sortkeyval2 - true if the sort key value is greater than or equal\n to :sortkeyval1, and less than or equal to\n :sortkeyval2.
\n begins_with (\n sortKeyName, :sortkeyval\n ) - true if the sort key value begins with a particular operand.\n (You cannot use this function with a sort key that is of type Number.) Note that\n the function name begins_with is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at\n runtime.
You can optionally use the ExpressionAttributeNames parameter to replace\n the names of the partition key and sort key with placeholder tokens. This option might\n be necessary if an attribute name conflicts with a DynamoDB reserved word. For example,\n the following KeyConditionExpression parameter causes an error because\n Size is a reserved word:
\n Size = :myval\n
To work around this, define a placeholder (such a #S) to represent the\n attribute name Size. KeyConditionExpression then is as\n follows:
\n #S = :myval\n
For a list of reserved words, see Reserved Words\n in the Amazon DynamoDB Developer Guide.
\nFor more information on ExpressionAttributeNames and\n ExpressionAttributeValues, see Using\n Placeholders for Attribute Names and Values in the Amazon DynamoDB\n Developer Guide.
One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a Query operation.
Represents the input of a Query operation.
The number of items in the response.
\nIf you used a QueryFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count and\n ScannedCount are the same.
The number of items in the response.
\nIf you used a QueryFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count and\n ScannedCount are the same.
The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.
If you did not use a filter in the request, then ScannedCount is the same\n as Count.
The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.
If you did not use a filter in the request, then ScannedCount is the same\n as Count.
The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.
\nIf LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.
The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.
\nIf LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.
The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.
Represents the output of a Query operation.
Represents the output of a Query operation.
The current state of the replica:
\n\n CREATING - The replica is being created.
\n UPDATING - The replica is being updated.
\n DELETING - The replica is being deleted.
\n ACTIVE - The replica is ready for use.
The current state of the replica:
\n\n CREATING - The replica is being created.
\n UPDATING - The replica is being updated.
\n DELETING - The replica is being deleted.
\n ACTIVE - The replica is ready for use.
The current state of the replica:
\n\n CREATING - The replica is being created.
\n UPDATING - The replica is being updated.
\n DELETING - The replica is being deleted.
\n ACTIVE - The replica is ready for use.
\n REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
If the Amazon Web Services Region remains inaccessible for more than 20\n hours, DynamoDB will remove this replica from the replication\n group. The replica will not be deleted and replication will stop from and to\n this region.
\n\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key\n used to encrypt the table is inaccessible.
If the KMS key remains inaccessible for more than 20 hours,\n DynamoDB will remove this replica from the replication group.\n The replica will not be deleted and replication will stop from and to this\n region.
\nThe current state of the replica:
\n\n CREATING - The replica is being created.
\n UPDATING - The replica is being updated.
\n DELETING - The replica is being deleted.
\n ACTIVE - The replica is ready for use.
\n REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
If the Amazon Web Services Region remains inaccessible for more than 20\n hours, DynamoDB will remove this replica from the replication\n group. The replica will not be deleted and replication will stop from and to\n this region.
\n\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key\n used to encrypt the table is inaccessible.
If the KMS key remains inaccessible for more than 20 hours,\n DynamoDB will remove this replica from the replication group.\n The replica will not be deleted and replication will stop from and to this\n region.
\nThe KMS key of the replica that will be used for\n KMS encryption.
" + "smithy.api#documentation": "The KMS key of the replica that will be used for KMS\n encryption.
" } }, "ProvisionedThroughputOverride": { @@ -6985,6 +9075,12 @@ "smithy.api#documentation": "Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput settings for the specified replica table.
" + } + }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList", "traits": { @@ -7024,7 +9120,13 @@ "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { - "smithy.api#documentation": "Replica table GSI-specific provisioned throughput. If not specified, uses the source\n table GSI's read capacity settings.
" + "smithy.api#documentation": "Replica table GSI-specific provisioned throughput. If not specified, uses the source\n table GSI's read capacity settings.
" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
" } } }, @@ -7044,7 +9146,7 @@ "IndexStatus": { "target": "com.amazonaws.dynamodb#IndexStatus", "traits": { - "smithy.api#documentation": "The current state of the replica global secondary index:
\n\n CREATING - The index is being created.
\n UPDATING - The index is being updated.
\n DELETING - The index is being deleted.
\n ACTIVE - The index is ready for use.
The current state of the replica global secondary index:
\n\n CREATING - The index is being created.
\n UPDATING - The table/index configuration is being updated. The\n table/index remains available for data operations when\n UPDATING\n
\n DELETING - The index is being deleted.
\n ACTIVE - The index is ready for use.
If not described, uses the source table GSI's read capacity settings.
" } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
" + } } }, "traits": { @@ -7137,7 +9245,7 @@ "IndexStatus": { "target": "com.amazonaws.dynamodb#IndexStatus", "traits": { - "smithy.api#documentation": "The current status of the global secondary index:
\n\n CREATING - The global secondary index is being created.
\n UPDATING - The global secondary index is being updated.
\n DELETING - The global secondary index is being deleted.
\n ACTIVE - The global secondary index is ready for use.
The current status of the global secondary index:
\n\n CREATING - The global secondary index is being created.
\n UPDATING - The global secondary index is being updated.
\n DELETING - The global secondary index is being deleted.
\n ACTIVE - The global secondary index is ready for use.
The current state of the Region:
\n\n CREATING - The Region is being created.
\n UPDATING - The Region is being updated.
\n DELETING - The Region is being deleted.
\n ACTIVE - The Region is ready for use.
The current state of the Region:
\n\n CREATING - The Region is being created.
\n UPDATING - The Region is being updated.
\n DELETING - The Region is being deleted.
\n ACTIVE - The Region is ready for use.
Replica-specific table class. If not specified, uses the source table's\n table class.
" + "smithy.api#documentation": "Replica-specific table class. If not specified, uses the source table's table\n class.
" } } }, @@ -7350,38 +9458,50 @@ } }, "com.amazonaws.dynamodb#ReplicaStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATION_FAILED", - "name": "CREATION_FAILED" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "REGION_DISABLED", - "name": "REGION_DISABLED" - }, - { - "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS", - "name": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" } - ] + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "REGION_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGION_DISABLED" + } + }, + "INACCESSIBLE_ENCRYPTION_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + } + } } }, "com.amazonaws.dynamodb#ReplicaStatusDescription": { @@ -7407,7 +9527,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents one of the following:
\nA new replica to be added to an existing global table.
\nNew parameters for an existing replica.
\nAn existing replica to be removed from an existing global table.
\nRepresents one of the following:
\nA new replica to be added to an existing global table.
\nNew parameters for an existing replica.
\nAn existing replica to be removed from an existing global table.
\nRepresents one of the following:
\nA new replica to be added to an existing regional table or global table. This\n request invokes the CreateTableReplica action in the destination\n Region.
New parameters for an existing replica. This request invokes the\n UpdateTable action in the destination Region.
An existing replica to be deleted. The request invokes the\n DeleteTableReplica action in the destination Region, deleting\n the replica and all if its items in the destination Region.
When you manually remove a table or global table replica, you do not \n automatically remove any associated scalable targets, scaling policies, or \n CloudWatch alarms.
\nRepresents one of the following:
\nA new replica to be added to an existing regional table or global table. This\n request invokes the CreateTableReplica action in the destination\n Region.
New parameters for an existing replica. This request invokes the\n UpdateTable action in the destination Region.
An existing replica to be deleted. The request invokes the\n DeleteTableReplica action in the destination Region, deleting\n the replica and all if its items in the destination Region.
When you manually remove a table or global table replica, you do not automatically\n remove any associated scalable targets, scaling policies, or CloudWatch\n alarms.
\nCreates a new table from an existing backup. Any number of users can execute up to 4\n concurrent restores (any type of restore) in a given account.
\nYou can call RestoreTableFromBackup at a maximum rate of 10 times per\n second.
You must manually set up the following on the restored table:
\nAuto scaling policies
\nIAM policies
\nAmazon CloudWatch metrics and alarms
\nTags
\nStream settings
\nTime to Live (TTL) settings
\nCreates a new table from an existing backup. Any number of users can execute up to 50\n concurrent restores (any type of restore) in a given account.
\nYou can call RestoreTableFromBackup at a maximum rate of 10 times per\n second.
You must manually set up the following on the restored table:
\nAuto scaling policies
\nIAM policies
\nAmazon CloudWatch metrics and alarms
\nTags
\nStream settings
\nTime to Live (TTL) settings
\nProvisioned throughput settings for the restored table.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "SSESpecificationOverride": { "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { "smithy.api#documentation": "The new server-side encryption settings for the restored table.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#RestoreTableFromBackupOutput": { @@ -7640,6 +9766,9 @@ "smithy.api#documentation": "The description of the table created from an existing backup.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#RestoreTableToPointInTime": { @@ -7680,7 +9809,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days. Any number of\n users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.
\nAlong with data, the following are also included on the new restored table using\n point in time recovery:
\nGlobal secondary indexes (GSIs)
\nLocal secondary indexes (LSIs)
\nProvisioned read and write capacity
\nEncryption settings
\nAll these settings come from the current settings of the source table at\n the time of restore.
\nYou must manually set up the following on the restored table:
\nAuto scaling policies
\nIAM policies
\nAmazon CloudWatch metrics and alarms
\nTags
\nStream settings
\nTime to Live (TTL) settings
\nPoint in time recovery settings
\nRestores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days. Any number of\n users can execute up to 50 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.
\nAlong with data, the following are also included on the new restored table using point\n in time recovery:
\nGlobal secondary indexes (GSIs)
\nLocal secondary indexes (LSIs)
\nProvisioned read and write capacity
\nEncryption settings
\nAll these settings come from the current settings of the source table at\n the time of restore.
\nYou must manually set up the following on the restored table:
\nAuto scaling policies
\nIAM policies
\nAmazon CloudWatch metrics and alarms
\nTags
\nStream settings
\nTime to Live (TTL) settings
\nPoint in time recovery settings
\nProvisioned throughput settings for the restored table.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "SSESpecificationOverride": { "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { "smithy.api#documentation": "The new server-side encryption settings for the restored table.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#RestoreTableToPointInTimeOutput": { @@ -7758,83 +9893,104 @@ "smithy.api#documentation": "Represents the properties of a table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#ReturnConsumedCapacity": { - "type": "string", - "traits": { - "smithy.api#documentation": "Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response:
\n\n INDEXES - The response includes the aggregate\n ConsumedCapacity for the operation, together with\n ConsumedCapacity for each table and secondary index that was\n accessed.
Note that some operations, such as GetItem and\n BatchGetItem, do not access any indexes at all. In these cases,\n specifying INDEXES will only return ConsumedCapacity\n information for table(s).
\n TOTAL - The response includes only the aggregate\n ConsumedCapacity for the operation.
\n NONE - No ConsumedCapacity details are included in the\n response.
Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response:
\n\n INDEXES - The response includes the aggregate\n ConsumedCapacity for the operation, together with\n ConsumedCapacity for each table and secondary index that was\n accessed.
Note that some operations, such as GetItem and\n BatchGetItem, do not access any indexes at all. In these cases,\n specifying INDEXES will only return ConsumedCapacity\n information for table(s).
\n TOTAL - The response includes only the aggregate\n ConsumedCapacity for the operation.
\n NONE - No ConsumedCapacity details are included in the\n response.
\n The account number of the S3 bucket that is being imported from. \n If the bucket is owned by the requester this is optional. \n
" + "smithy.api#documentation": "The account number of the S3 bucket that is being imported from. If the bucket is\n owned by the requester this is optional.
" } }, "S3Bucket": { "target": "com.amazonaws.dynamodb#S3Bucket", "traits": { - "smithy.api#documentation": "\n The S3 bucket that is being imported from.\n
", + "smithy.api#documentation": "The S3 bucket that is being imported from.
", "smithy.api#required": {} } }, "S3KeyPrefix": { "target": "com.amazonaws.dynamodb#S3Prefix", "traits": { - "smithy.api#documentation": "\n The key prefix shared by all S3 Objects that are being imported.\n
" + "smithy.api#documentation": "The key prefix shared by all S3 Objects that are being imported.
" } } }, "traits": { - "smithy.api#documentation": "\n The S3 bucket that is being imported from.\n
" + "smithy.api#documentation": "The S3 bucket that is being imported from.
" } }, "com.amazonaws.dynamodb#S3Prefix": { @@ -7890,18 +10046,20 @@ } }, "com.amazonaws.dynamodb#S3SseAlgorithm": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AES256", - "name": "AES256" - }, - { - "value": "KMS", - "name": "KMS" + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" } - ] + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" + } + } } }, "com.amazonaws.dynamodb#S3SseKmsKeyId": { @@ -7919,19 +10077,19 @@ "Status": { "target": "com.amazonaws.dynamodb#SSEStatus", "traits": { - "smithy.api#documentation": "Represents the current state of server-side encryption. The only supported values\n are:
\n\n ENABLED - Server-side encryption is enabled.
\n UPDATING - Server-side encryption is being updated.
Represents the current state of server-side encryption. The only supported values\n are:
\n\n ENABLED - Server-side encryption is enabled.
\n UPDATING - Server-side encryption is being updated.
Server-side encryption type. The only supported value is:
\n\n KMS - Server-side encryption that uses Key Management Service. The\n key is stored in your account and is managed by KMS (KMS charges apply).
Server-side encryption type. The only supported value is:
\n\n KMS - Server-side encryption that uses Key Management Service. The\n key is stored in your account and is managed by KMS (KMS charges apply).
The KMS key ARN used for the KMS\n encryption.
" + "smithy.api#documentation": "The KMS key ARN used for the KMS encryption.
" } }, "InaccessibleEncryptionDateTime": { @@ -7946,10 +10104,7 @@ } }, "com.amazonaws.dynamodb#SSEEnabled": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.dynamodb#SSESpecification": { "type": "structure", @@ -7963,7 +10118,7 @@ "SSEType": { "target": "com.amazonaws.dynamodb#SSEType", "traits": { - "smithy.api#documentation": "Server-side encryption type. The only supported value is:
\n\n KMS - Server-side encryption that uses Key Management Service. The\n key is stored in your account and is managed by KMS (KMS charges apply).
Server-side encryption type. The only supported value is:
\n\n KMS - Server-side encryption that uses Key Management Service. The\n key is stored in your account and is managed by KMS (KMS charges apply).
The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.
If the total number of scanned items exceeds the maximum dataset size limit of 1 MB,\n the scan stops and results are returned to the user as a LastEvaluatedKey\n value to continue the scan in a subsequent operation. The results also include the\n number of items exceeding the limit. A scan can result in no table data meeting the\n filter 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 table;\n therefore, the result set might not include the changes to data in the table immediately\n before the operation began. If you need a consistent copy of the data, as of the time\n that the Scan begins, you can set the ConsistentRead parameter\n to true.
The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.
If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan completes and results are returned to the user. The LastEvaluatedKey\n value is also returned and the requestor can use the LastEvaluatedKey to\n continue the scan in a subsequent operation. Each scan response also includes number of\n items that were scanned (ScannedCount) as part of the request. If using a\n FilterExpression, a scan result can result in no items meeting the\n criteria and the Count will result in zero. If you did not use a\n FilterExpression in the scan request, then Count is the\n same as ScannedCount.
\n Count and ScannedCount only return the count of items\n specific to a single scan request and, unless the table is less than 1MB, do not\n represent the total number of items in the table.
A single Scan operation first reads up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then\n applies any filtering to the results if a FilterExpression is provided. If\n LastEvaluatedKey is present in the response, pagination is required to\n complete the full table scan. 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.
By default, a Scan uses eventually consistent reads when accessing the\n items in a table. Therefore, the results from an eventually consistent Scan\n may not include the latest item changes at the time the scan iterates through each item\n in the table. If you require a strongly consistent read of each item as the scan\n iterates through the items in the table, you can set the ConsistentRead\n parameter to true. Strong consistency only relates to the consistency of the read at the\n item level.
DynamoDB does not provide snapshot isolation for a scan operation when the\n ConsistentRead parameter is set to true. Thus, a DynamoDB scan\n operation does not guarantee that all reads in a scan see a consistent snapshot of\n the table when the scan operation was requested.
The name of the table containing the requested items; or, if you provide\n IndexName, the name of the table to which that index belongs.
The name of the table containing the requested items or if you provide\n IndexName, the name of the table to which that index belongs.
You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, @@ -8108,7 +10322,7 @@ "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.
\n\n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.
\n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.
\n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read\n capacity units as getting the items, and is subject to the same item size\n calculations.
\n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.
If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.
\nIf you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.
\nIf neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)
If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.
The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No\n set data types are allowed.
In a parallel scan, a Scan request that includes\n ExclusiveStartKey must specify the same segment whose previous\n Scan returned the corresponding value of\n LastEvaluatedKey.
The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No\n set data types are allowed.
In a parallel scan, a Scan request that includes\n ExclusiveStartKey must specify the same segment whose previous\n Scan returned the corresponding value of\n LastEvaluatedKey.
For a parallel Scan request, TotalSegments represents the\n total number of segments into which the Scan operation will be divided. The\n value of TotalSegments corresponds to the number of application workers\n that will perform the parallel scan. For example, if you want to use four application\n threads to scan a table or an index, specify a TotalSegments value of\n 4.
The value for TotalSegments must be greater than or equal to 1, and less\n than or equal to 1000000. If you specify a TotalSegments value of 1, the\n Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify\n Segment.
For a parallel Scan request, TotalSegments represents the\n total number of segments into which the Scan operation will be divided. The\n value of TotalSegments corresponds to the number of application workers\n that will perform the parallel scan. For example, if you want to use four application\n threads to scan a table or an index, specify a TotalSegments value of\n 4.
The value for TotalSegments must be greater than or equal to 1, and less\n than or equal to 1000000. If you specify a TotalSegments value of 1, the\n Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify\n Segment.
For a parallel Scan request, Segment identifies an\n individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want\n to use four application threads to scan a table or an index, then the first thread\n specifies a Segment value of 0, the second thread specifies 1, and so\n on.
The value of LastEvaluatedKey returned from a parallel Scan\n request must be used as ExclusiveStartKey with the same segment ID in a\n subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than\n the value provided for TotalSegments.
If you provide Segment, you must also provide\n TotalSegments.
For a parallel Scan request, Segment identifies an\n individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want\n to use four application threads to scan a table or an index, then the first thread\n specifies a Segment value of 0, the second thread specifies 1, and so\n on.
The value of LastEvaluatedKey returned from a parallel Scan\n request must be used as ExclusiveStartKey with the same segment ID in a\n subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than\n the value provided for TotalSegments.
If you provide Segment, you must also provide\n TotalSegments.
A string that identifies one or more attributes to retrieve from the specified table\n or index. These attributes can include scalars, sets, or elements of a JSON document.\n The attributes in the expression must be separated by commas.
\nIf no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.
\nFor more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the specified table\n or index. These attributes can include scalars, sets, or elements of a JSON document.\n The attributes in the expression must be separated by commas.
\nIf no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.
\nFor more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.
For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" } }, "ConsistentRead": { "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "A Boolean value that determines the read consistency model during the scan:
\nIf ConsistentRead is false, then the data returned\n from Scan might not contain the results from other recently\n completed write operations (PutItem, UpdateItem, or\n DeleteItem).
If ConsistentRead is true, then all of the write\n operations that completed before the Scan began are guaranteed to\n be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary\n indexes. If you scan a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.
A Boolean value that determines the read consistency model during the scan:
\nIf ConsistentRead is false, then the data returned\n from Scan might not contain the results from other recently\n completed write operations (PutItem, UpdateItem, or\n DeleteItem).
If ConsistentRead is true, then all of the write\n operations that completed before the Scan began are guaranteed to\n be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary\n indexes. If you scan a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.
Represents the input of a Scan operation.
Represents the input of a Scan operation.
The number of items in the response.
\nIf you set ScanFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as\n ScannedCount.
The number of items in the response.
\nIf you set ScanFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as\n ScannedCount.
The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Scan operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.
If you did not use a filter in the request, then ScannedCount is the same\n as Count.
The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Scan operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.
If you did not use a filter in the request, then ScannedCount is the same\n as Count.
The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.
\nIf LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.
The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.
\nIf LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.
The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.
Represents the output of a Scan operation.
Represents the output of a Scan operation.
Size of the table in bytes. Note that this is an approximate value.
" } @@ -8319,6 +10541,9 @@ "smithy.api#required": {} } }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "ItemCount": { "target": "com.amazonaws.dynamodb#ItemCount", "traits": { @@ -8328,7 +10553,7 @@ "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.
\n\n PROVISIONED - Sets the read/write capacity mode to\n PROVISIONED. We recommend using PROVISIONED for\n predictable workloads.
\n PAY_PER_REQUEST - Sets the read/write capacity mode to\n PAY_PER_REQUEST. We recommend using\n PAY_PER_REQUEST for unpredictable workloads.
Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.
\n\n PROVISIONED - Sets the read/write capacity mode to\n PROVISIONED. We recommend using PROVISIONED for\n predictable workloads.
\n PAY_PER_REQUEST - Sets the read/write capacity mode to\n PAY_PER_REQUEST. We recommend using\n PAY_PER_REQUEST for unpredictable workloads.
When an item in the table is modified, StreamViewType determines what\n information is written to the stream for this table. Valid values for\n StreamViewType are:
\n KEYS_ONLY - Only the key attributes of the modified item are\n written to the stream.
\n NEW_IMAGE - The entire item, as it appears after it was modified,\n is written to the stream.
\n OLD_IMAGE - The entire item, as it appeared before it was modified,\n is written to the stream.
\n NEW_AND_OLD_IMAGES - Both the new and the old item images of the\n item are written to the stream.
When an item in the table is modified, StreamViewType determines what\n information is written to the stream for this table. Valid values for\n StreamViewType are:
\n KEYS_ONLY - Only the key attributes of the modified item are\n written to the stream.
\n NEW_IMAGE - The entire item, as it appears after it was modified,\n is written to the stream.
\n OLD_IMAGE - The entire item, as it appeared before it was modified,\n is written to the stream.
\n NEW_AND_OLD_IMAGES - Both the new and the old item images of the\n item are written to the stream.
The current state of the table:
\n\n CREATING - The table is being created.
\n UPDATING - The table is being updated.
\n DELETING - The table is being deleted.
\n ACTIVE - The table is ready for use.
The current state of the table:
\n\n CREATING - The table is being created.
\n UPDATING - The table is being updated.
\n DELETING - The table is being deleted.
\n ACTIVE - The table is ready for use.
\n The name of the table created as part of the import operation. \n
", + "smithy.api#documentation": "The name of the table created as part of the import operation.
", "smithy.api#required": {} } }, "AttributeDefinitions": { "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "\n The attributes of the table created as part of the import operation.\n
", + "smithy.api#documentation": "The attributes of the table created as part of the import operation.
", "smithy.api#required": {} } }, "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "\n The primary key and option sort key of the table created as part of the import operation.\n
", + "smithy.api#documentation": "The primary key and option sort key of the table created as part of the import\n operation.
", "smithy.api#required": {} } }, "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "\n The billing mode for provisioning the table created as part of the import operation.\n
" + "smithy.api#documentation": "The billing mode for provisioning the table created as part of the import operation.\n
" } }, "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput" }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, "SSESpecification": { "target": "com.amazonaws.dynamodb#SSESpecification" }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", "traits": { - "smithy.api#documentation": "\n The Global Secondary Indexes (GSI) of the table to be created as part of the import operation.\n
" + "smithy.api#documentation": "The Global Secondary Indexes (GSI) of the table to be created as part of the import\n operation.
" } } }, "traits": { - "smithy.api#documentation": "The parameters for the table created as part of the import operation.\n
" + "smithy.api#documentation": "The parameters for the table created as part of the import operation.
" } }, "com.amazonaws.dynamodb#TableDescription": { @@ -8577,7 +10816,7 @@ "AttributeDefinitions": { "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "An array of AttributeDefinition objects. Each of these objects describes\n one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
\n AttributeName - The name of the attribute.
\n AttributeType - The data type for the attribute.
An array of AttributeDefinition objects. Each of these objects describes\n one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
\n AttributeName - The name of the attribute.
\n AttributeType - The data type for the attribute.
The primary key structure for the table. Each KeySchemaElement consists\n of:
\n AttributeName - The name of the attribute.
\n KeyType - The role of the attribute:
\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's\n usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range\n attribute. The term \"range attribute\" derives from the way\n DynamoDB stores items with the same partition key physically close together,\n in sorted order by the sort key value.
\nFor more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "The primary key structure for the table. Each KeySchemaElement consists\n of:
\n AttributeName - The name of the attribute.
\n KeyType - The role of the attribute:
\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's\n usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.
\nThe sort key of an item is also known as its range\n attribute. The term \"range attribute\" derives from the way\n DynamoDB stores items with the same partition key physically close together,\n in sorted order by the sort key value.
\nFor more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.
" } }, "TableStatus": { "target": "com.amazonaws.dynamodb#TableStatus", "traits": { - "smithy.api#documentation": "The current state of the table:
\n\n CREATING - The table is being created.
\n UPDATING - The table is being updated.
\n DELETING - The table is being deleted.
\n ACTIVE - The table is ready for use.
\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key\n used to encrypt the table in inaccessible. Table operations may fail due to\n failure to use the KMS key. DynamoDB will initiate the\n table archival process when a table's KMS key remains\n inaccessible for more than seven days.
\n ARCHIVING - The table is being archived. Operations are not allowed\n until archival is complete.
\n ARCHIVED - The table has been archived. See the ArchivalReason for\n more information.
The current state of the table:
\n\n CREATING - The table is being created.
\n UPDATING - The table/index configuration is being updated. The\n table/index remains available for data operations when\n UPDATING.
\n DELETING - The table is being deleted.
\n ACTIVE - The table is ready for use.
\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key\n used to encrypt the table in inaccessible. Table operations may fail due to\n failure to use the KMS key. DynamoDB will initiate the\n table archival process when a table's KMS key remains\n inaccessible for more than seven days.
\n ARCHIVING - The table is being archived. Operations are not allowed\n until archival is complete.
\n ARCHIVED - The table has been archived. See the ArchivalReason for\n more information.
The total size of the specified table, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.
" } }, "ItemCount": { - "target": "com.amazonaws.dynamodb#Long", + "target": "com.amazonaws.dynamodb#LongObject", "traits": { "smithy.api#documentation": "The number of items in the specified table. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.
" } @@ -8643,13 +10882,13 @@ "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n collection cannot exceed 10 GB. Each element is composed of:
\n\n IndexName - The name of the local secondary index.
\n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
\n IndexSizeBytes - Represents the total size of the index, in bytes.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.
\n ItemCount - Represents the number of items in the index. DynamoDB\n updates this value approximately every six hours. Recent changes might not be\n reflected in this value.
If the table is in the DELETING state, no information about indexes will\n be returned.
Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n collection cannot exceed 10 GB. Each element is composed of:
\n\n IndexName - The name of the local secondary index.
\n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
\n IndexSizeBytes - Represents the total size of the index, in bytes.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.
\n ItemCount - Represents the number of items in the index. DynamoDB\n updates this value approximately every six hours. Recent changes might not be\n reflected in this value.
If the table is in the DELETING state, no information about indexes will\n be returned.
The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:
\n\n Backfilling - If true, then the index is currently in the\n backfilling phase. Backfilling occurs only when a new global secondary index is\n added to the table. It is the process by which DynamoDB populates the new index\n with data from the table. (This attribute does not appear for indexes that were\n created during a CreateTable operation.)
You can delete an index that is being created during the\n Backfilling phase when IndexStatus is set to\n CREATING and Backfilling is true. You can't delete the index that\n is being created when IndexStatus is set to CREATING and\n Backfilling is false. (This attribute does not appear for\n indexes that were created during a CreateTable operation.)
\n IndexName - The name of the global secondary index.
\n IndexSizeBytes - The total size of the global secondary index, in\n bytes. DynamoDB updates this value approximately every six hours. Recent changes\n might not be reflected in this value.
\n IndexStatus - The current status of the global secondary\n index:
\n CREATING - The index is being created.
\n UPDATING - The index is being updated.
\n DELETING - The index is being deleted.
\n ACTIVE - The index is ready for use.
\n ItemCount - The number of items in the global secondary index.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.
\n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - In addition to the attributes described\n in KEYS_ONLY, the secondary index will include\n other non-key attributes that you specify.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
\n ProvisionedThroughput - The provisioned throughput settings for the\n global secondary index, consisting of read and write capacity units, along with\n data about increases and decreases.
If the table is in the DELETING state, no information about indexes will\n be returned.
The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:
\n\n Backfilling - If true, then the index is currently in the\n backfilling phase. Backfilling occurs only when a new global secondary index is\n added to the table. It is the process by which DynamoDB populates the new index\n with data from the table. (This attribute does not appear for indexes that were\n created during a CreateTable operation.)
You can delete an index that is being created during the\n Backfilling phase when IndexStatus is set to\n CREATING and Backfilling is true. You can't delete the index that\n is being created when IndexStatus is set to CREATING and\n Backfilling is false. (This attribute does not appear for\n indexes that were created during a CreateTable operation.)
\n IndexName - The name of the global secondary index.
\n IndexSizeBytes - The total size of the global secondary index, in\n bytes. DynamoDB updates this value approximately every six hours. Recent changes\n might not be reflected in this value.
\n IndexStatus - The current status of the global secondary\n index:
\n CREATING - The index is being created.
\n UPDATING - The index is being updated.
\n DELETING - The index is being deleted.
\n ACTIVE - The index is ready for use.
\n ItemCount - The number of items in the global secondary index.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.
\n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.
\n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:
\n ProjectionType - One of the following:
\n KEYS_ONLY - Only the index and primary keys are\n projected into the index.
\n INCLUDE - In addition to the attributes described\n in KEYS_ONLY, the secondary index will include\n other non-key attributes that you specify.
\n ALL - All of the table attributes are projected\n into the index.
\n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.
\n ProvisionedThroughput - The provisioned throughput settings for the\n global secondary index, consisting of read and write capacity units, along with\n data about increases and decreases.
If the table is in the DELETING state, no information about indexes will\n be returned.
A timestamp, in ISO 8601 format, for this stream.
\n\nNote that LatestStreamLabel is not a unique identifier for the stream,\n because it is possible that a stream from another table might have the same timestamp.\n However, the combination of the following three elements is guaranteed to be\n unique:
Amazon Web Services customer ID
\nTable name
\n\n StreamLabel\n
A timestamp, in ISO 8601 format, for this stream.
\nNote that LatestStreamLabel is not a unique identifier for the stream,\n because it is possible that a stream from another table might have the same timestamp.\n However, the combination of the following three elements is guaranteed to be\n unique:
Amazon Web Services customer ID
\nTable name
\n\n StreamLabel\n
Contains details of the table class.
" } + }, + "DeletionProtectionEnabled": { + "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "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.
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single\n DynamoDB table.
\nAmazon Web Services-assigned tag names and values are automatically assigned the\n aws: prefix, which the user cannot assign. Amazon Web Services-assigned\n tag names do not count towards the tag limit of 50. User-assigned tag names have the\n prefix user: in the Cost Allocation Report. You cannot backdate the\n application of a tag.
For an overview on tagging DynamoDB resources, see Tagging\n for DynamoDB in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single\n DynamoDB table.
\nAmazon Web Services-assigned tag names and values are automatically assigned the\n aws: prefix, which the user cannot assign. Amazon Web Services-assigned\n tag names do not count towards the tag limit of 50. User-assigned tag names have the\n prefix user: in the Cost Allocation Report. You cannot backdate the\n application of a tag.
For an overview on tagging DynamoDB resources, see Tagging\n for DynamoDB in the Amazon DynamoDB Developer\n Guide.
" } }, "com.amazonaws.dynamodb#TagKeyList": { @@ -8864,7 +11127,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.
\nFor an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.
\nFor an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.
" } }, "com.amazonaws.dynamodb#TagResourceInput": { @@ -8884,6 +11147,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#TagValueString": { @@ -8931,10 +11197,7 @@ } }, "com.amazonaws.dynamodb#TimeToLiveEnabled": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.dynamodb#TimeToLiveSpecification": { "type": "structure", @@ -8959,26 +11222,32 @@ } }, "com.amazonaws.dynamodb#TimeToLiveStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLING", - "name": "ENABLING" - }, - { - "value": "DISABLING", - "name": "DISABLING" - }, - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" } - ] + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } } }, "com.amazonaws.dynamodb#TransactGetItem": { @@ -9004,7 +11273,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 25 + "max": 100 } } }, @@ -9040,7 +11309,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "\n TransactGetItems is a synchronous operation that atomically retrieves\n multiple items from one or more tables (but not from indexes) in a single account and\n Region. A TransactGetItems call can contain up to 25\n TransactGetItem objects, each of which contains a Get\n structure that specifies an item to retrieve from a table in the account and Region. A\n call to TransactGetItems cannot retrieve items from tables in more than one\n Amazon Web Services account or Region. The aggregate size of the items in the\n transaction cannot exceed 4 MB.
DynamoDB rejects the entire TransactGetItems request if any of\n the following is true:
A conflicting operation is in the process of updating an item to be\n read.
\nThere is insufficient provisioned capacity for the transaction to be\n completed.
\nThere is a user error, such as an invalid data format.
\nThe aggregate size of the items in the transaction cannot exceed 4 MB.
\n\n TransactGetItems is a synchronous operation that atomically retrieves\n multiple items from one or more tables (but not from indexes) in a single account and\n Region. A TransactGetItems call can contain up to 100\n TransactGetItem objects, each of which contains a Get\n structure that specifies an item to retrieve from a table in the account and Region. A\n call to TransactGetItems cannot retrieve items from tables in more than one\n Amazon Web Services account or Region. The aggregate size of the items in the\n transaction cannot exceed 4 MB.
DynamoDB rejects the entire TransactGetItems request if any of\n the following is true:
A conflicting operation is in the process of updating an item to be\n read.
\nThere is insufficient provisioned capacity for the transaction to be\n completed.
\nThere is a user error, such as an invalid data format.
\nThe aggregate size of the items in the transaction exceeded 4 MB.
\nAn ordered array of up to 25 TransactGetItem objects, each of which\n contains a Get structure.
An ordered array of up to 100 TransactGetItem objects, each of which\n contains a Get structure.
A value of TOTAL causes consumed capacity information to be returned, and\n a value of NONE prevents that information from being returned. No other\n value is valid.
An ordered array of up to 25 ItemResponse objects, each of which\n corresponds to the TransactGetItem object in the same position in the\n TransactItems array. Each ItemResponse object\n contains a Map of the name-value pairs that are the projected attributes of the\n requested item.
If a requested item could not be retrieved, the corresponding\n ItemResponse object is Null, or if the requested item has no projected\n attributes, the corresponding ItemResponse object is an empty Map.
An ordered array of up to 100 ItemResponse objects, each of which\n corresponds to the TransactGetItem object in the same position in the\n TransactItems array. Each ItemResponse object\n contains a Map of the name-value pairs that are the projected attributes of the\n requested item.
If a requested item could not be retrieved, the corresponding\n ItemResponse object is Null, or if the requested item has no projected\n attributes, the corresponding ItemResponse object is an empty Map.
\n TransactWriteItems is a synchronous write operation that groups up to 25\n action requests. These actions can target items in different tables, but not in\n different Amazon Web Services accounts or Regions, and no two actions can target the same\n item. For example, you cannot both ConditionCheck and Update\n the same item. The aggregate size of the items in the transaction cannot exceed 4\n MB.
The actions are completed atomically so that either all of them succeed, or all of\n them fail. They are defined by the following objects:
\n\n\n Put — Initiates a PutItem\n operation to write a new item. This structure specifies the primary key of the\n item to be written, the name of the table to write it in, an optional condition\n expression that must be satisfied for the write to succeed, a list of the item's\n attributes, and a field indicating whether to retrieve the item's attributes if\n the condition is not met.
\n Update — Initiates an UpdateItem\n operation to update an existing item. This structure specifies the primary key\n of the item to be updated, the name of the table where it resides, an optional\n condition expression that must be satisfied for the update to succeed, an\n expression that defines one or more attributes to be updated, and a field\n indicating whether to retrieve the item's attributes if the condition is not\n met.
\n Delete — Initiates a DeleteItem\n operation to delete an existing item. This structure specifies the primary key\n of the item to be deleted, the name of the table where it resides, an optional\n condition expression that must be satisfied for the deletion to succeed, and a\n field indicating whether to retrieve the item's attributes if the condition is\n not met.
\n ConditionCheck — Applies a condition to an item\n that is not being modified by the transaction. This structure specifies the\n primary key of the item to be checked, the name of the table where it resides, a\n condition expression that must be satisfied for the transaction to succeed, and\n a field indicating whether to retrieve the item's attributes if the condition is\n not met.
DynamoDB rejects the entire TransactWriteItems request if any of the\n following is true:
A condition in one of the condition expressions is not met.
\nAn ongoing operation is in the process of updating the same item.
\nThere is insufficient provisioned capacity for the transaction to be\n completed.
\nAn item size becomes too large (bigger than 400 KB), a local secondary index\n (LSI) becomes too large, or a similar validation error occurs because of changes\n made by the transaction.
\nThe aggregate size of the items in the transaction exceeds 4 MB.
\nThere is a user error, such as an invalid data format.
\n\n TransactWriteItems is a synchronous write operation that groups up to 100\n action requests. These actions can target items in different tables, but not in\n different Amazon Web Services accounts or Regions, and no two actions can target the same\n item. For example, you cannot both ConditionCheck and Update\n the same item. The aggregate size of the items in the transaction cannot exceed 4\n MB.
The actions are completed atomically so that either all of them succeed, or all of\n them fail. They are defined by the following objects:
\n\n Put  —  Initiates a PutItem\n operation to write a new item. This structure specifies the primary key of the\n item to be written, the name of the table to write it in, an optional condition\n expression that must be satisfied for the write to succeed, a list of the item's\n attributes, and a field indicating whether to retrieve the item's attributes if\n the condition is not met.
\n Update  —  Initiates an UpdateItem\n operation to update an existing item. This structure specifies the primary key\n of the item to be updated, the name of the table where it resides, an optional\n condition expression that must be satisfied for the update to succeed, an\n expression that defines one or more attributes to be updated, and a field\n indicating whether to retrieve the item's attributes if the condition is not\n met.
\n Delete  —  Initiates a DeleteItem\n operation to delete an existing item. This structure specifies the primary key\n of the item to be deleted, the name of the table where it resides, an optional\n condition expression that must be satisfied for the deletion to succeed, and a\n field indicating whether to retrieve the item's attributes if the condition is\n not met.
\n ConditionCheck  —  Applies a condition to an item\n that is not being modified by the transaction. This structure specifies the\n primary key of the item to be checked, the name of the table where it resides, a\n condition expression that must be satisfied for the transaction to succeed, and\n a field indicating whether to retrieve the item's attributes if the condition is\n not met.
DynamoDB rejects the entire TransactWriteItems request if any of the\n following is true:
A condition in one of the condition expressions is not met.
\nAn ongoing operation is in the process of updating the same item.
\nThere is insufficient provisioned capacity for the transaction to be\n completed.
\nAn item size becomes too large (bigger than 400 KB), a local secondary index\n (LSI) becomes too large, or a similar validation error occurs because of changes\n made by the transaction.
\nThe aggregate size of the items in the transaction exceeds 4 MB.
\nThere is a user error, such as an invalid data format.
\nAn ordered array of up to 25 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same Amazon Web Services account and Region, and no two of them\n can operate on the same item.
An ordered array of up to 100 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same Amazon Web Services account and Region, and no two of them\n can operate on the same item.
Providing a ClientRequestToken makes the call to\n TransactWriteItems idempotent, meaning that multiple identical calls\n have the same effect as one single call.
Although multiple identical calls using the same client request token produce the same\n result on the server (no side effects), the responses to the calls might not be the\n same. If the ReturnConsumedCapacity> parameter is set, then the initial\n TransactWriteItems call returns the amount of write capacity units\n consumed in making the changes. Subsequent TransactWriteItems calls with\n the same client token return the number of read capacity units consumed in reading the\n item.
A client request token is valid for 10 minutes after the first request that uses it is\n completed. After 10 minutes, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 10\n minutes, or the result might not be idempotent.
\nIf you submit a request with the same client token but a change in other parameters\n within the 10-minute idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.
Providing a ClientRequestToken makes the call to\n TransactWriteItems idempotent, meaning that multiple identical calls\n have the same effect as one single call.
Although multiple identical calls using the same client request token produce the same\n result on the server (no side effects), the responses to the calls might not be the\n same. If the ReturnConsumedCapacity parameter is set, then the initial\n TransactWriteItems call returns the amount of write capacity units\n consumed in making the changes. Subsequent TransactWriteItems calls with\n the same client token return the number of read capacity units consumed in reading the\n item.
A client request token is valid for 10 minutes after the first request that uses it is\n completed. After 10 minutes, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 10\n minutes, or the result might not be idempotent.
\nIf you submit a request with the same client token but a change in other parameters\n within the 10-minute idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.
A list of tables that were processed by TransactWriteItems and, for each\n table, information about any item collections that were affected by individual\n UpdateItem, PutItem, or DeleteItem\n operations.
The entire transaction request was canceled.
\nDynamoDB cancels a TransactWriteItems request under the following\n circumstances:
A condition in one of the condition expressions is not met.
\nA table in the TransactWriteItems request is in a different\n account or region.
More than one action in the TransactWriteItems operation\n targets the same item.
There is insufficient provisioned capacity for the transaction to be\n completed.
\nAn item size becomes too large (larger than 400 KB), or a local secondary\n index (LSI) becomes too large, or a similar validation error occurs because of\n changes made by the transaction.
\nThere is a user error, such as an invalid data format.
\nDynamoDB cancels a TransactGetItems request under the\n following circumstances:
There is an ongoing TransactGetItems operation that conflicts\n with a concurrent PutItem, UpdateItem,\n DeleteItem or TransactWriteItems request. In this\n case the TransactGetItems operation fails with a\n TransactionCanceledException.
A table in the TransactGetItems request is in a different\n account or region.
There is insufficient provisioned capacity for the transaction to be\n completed.
\nThere is a user error, such as an invalid data format.
\nIf using Java, DynamoDB lists the cancellation reasons on the\n CancellationReasons property. This property is not set for other\n languages. Transaction cancellation reasons are ordered in the order of requested\n items, if an item has no error it will have None code and\n Null message.
Cancellation reason codes and possible error messages:
\nNo Errors:
\nCode: None\n
Message: null\n
Conditional Check Failed:
\nCode: ConditionalCheckFailed\n
Message: The conditional request failed.
\nItem Collection Size Limit Exceeded:
\nCode: ItemCollectionSizeLimitExceeded\n
Message: Collection size exceeded.
\nTransaction Conflict:
\nCode: TransactionConflict\n
Message: Transaction is ongoing for the item.
\nProvisioned Throughput Exceeded:
\nCode: ProvisionedThroughputExceeded\n
Messages:
\nThe level of configured provisioned throughput for the\n table was exceeded. Consider increasing your provisioning level\n with the UpdateTable API.
\nThis Message is received when provisioned throughput is\n exceeded is on a provisioned DynamoDB\n table.
\nThe level of configured provisioned throughput for one or\n more global secondary indexes of the table was exceeded.\n Consider increasing your provisioning level for the\n under-provisioned global secondary indexes with the UpdateTable\n API.
\nThis message is returned when provisioned throughput is\n exceeded is on a provisioned GSI.
\nThrottling Error:
\nCode: ThrottlingError\n
Messages:
\nThroughput exceeds the current capacity of your table or\n index. DynamoDB is automatically scaling your table or\n index so please try again shortly. If exceptions persist, check\n if you have a hot key:\n https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
\nThis message is returned when writes get throttled on an\n On-Demand table as DynamoDB is automatically\n scaling the table.
\nThroughput exceeds the current capacity for one or more\n global secondary indexes. DynamoDB is automatically\n scaling your index so please try again shortly.
\nThis message is returned when when writes get throttled on\n an On-Demand GSI as DynamoDB is automatically\n scaling the GSI.
\nValidation Error:
\nCode: ValidationError\n
Messages:
\nOne or more parameter values were invalid.
\nThe update expression attempted to update the secondary\n index key beyond allowed size limits.
\nThe update expression attempted to update the secondary\n index key to unsupported type.
\nAn operand in the update expression has an incorrect data\n type.
\nItem size to update has exceeded the maximum allowed\n size.
\nNumber overflow. Attempting to store a number with\n magnitude larger than supported range.
\nType mismatch for attribute to update.
\nNesting Levels have exceeded supported limits.
\nThe document path provided in the update expression is\n invalid for update.
\nThe provided expression refers to an attribute that does\n not exist in the item.
\nThe entire transaction request was canceled.
\nDynamoDB cancels a TransactWriteItems request under the following\n circumstances:
A condition in one of the condition expressions is not met.
\nA table in the TransactWriteItems request is in a different\n account or region.
More than one action in the TransactWriteItems operation\n targets the same item.
There is insufficient provisioned capacity for the transaction to be\n completed.
\nAn item size becomes too large (larger than 400 KB), or a local secondary\n index (LSI) becomes too large, or a similar validation error occurs because of\n changes made by the transaction.
\nThere is a user error, such as an invalid data format.
\n\n There is an ongoing TransactWriteItems operation that conflicts with a concurrent \n TransactWriteItems request. In this case the TransactWriteItems operation \n fails with a TransactionCanceledException.\n
DynamoDB cancels a TransactGetItems request under the\n following circumstances:
There is an ongoing TransactGetItems operation that conflicts\n with a concurrent PutItem, UpdateItem,\n DeleteItem or TransactWriteItems request. In this\n case the TransactGetItems operation fails with a\n TransactionCanceledException.
A table in the TransactGetItems request is in a different\n account or region.
There is insufficient provisioned capacity for the transaction to be\n completed.
\nThere is a user error, such as an invalid data format.
\nIf using Java, DynamoDB lists the cancellation reasons on the\n CancellationReasons property. This property is not set for other\n languages. Transaction cancellation reasons are ordered in the order of requested\n items, if an item has no error it will have None code and\n Null message.
Cancellation reason codes and possible error messages:
\nNo Errors:
\nCode: None\n
Message: null\n
Conditional Check Failed:
\nCode: ConditionalCheckFailed\n
Message: The conditional request failed.
\nItem Collection Size Limit Exceeded:
\nCode: ItemCollectionSizeLimitExceeded\n
Message: Collection size exceeded.
\nTransaction Conflict:
\nCode: TransactionConflict\n
Message: Transaction is ongoing for the item.
\nProvisioned Throughput Exceeded:
\nCode: ProvisionedThroughputExceeded\n
Messages:
\nThe level of configured provisioned throughput for the\n table was exceeded. Consider increasing your provisioning level\n with the UpdateTable API.
\nThis Message is received when provisioned throughput is\n exceeded is on a provisioned DynamoDB\n table.
\nThe level of configured provisioned throughput for one or\n more global secondary indexes of the table was exceeded.\n Consider increasing your provisioning level for the\n under-provisioned global secondary indexes with the UpdateTable\n API.
\nThis message is returned when provisioned throughput is\n exceeded is on a provisioned GSI.
\nThrottling Error:
\nCode: ThrottlingError\n
Messages:
\nThroughput exceeds the current capacity of your table or\n index. DynamoDB is automatically scaling your table or\n index so please try again shortly. If exceptions persist, check\n if you have a hot key:\n https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
\nThis message is returned when writes get throttled on an\n On-Demand table as DynamoDB is automatically\n scaling the table.
\nThroughput exceeds the current capacity for one or more\n global secondary indexes. DynamoDB is automatically\n scaling your index so please try again shortly.
\nThis message is returned when writes get throttled on\n an On-Demand GSI as DynamoDB is automatically\n scaling the GSI.
\nValidation Error:
\nCode: ValidationError\n
Messages:
\nOne or more parameter values were invalid.
\nThe update expression attempted to update the secondary\n index key beyond allowed size limits.
\nThe update expression attempted to update the secondary\n index key to unsupported type.
\nAn operand in the update expression has an incorrect data\n type.
\nItem size to update has exceeded the maximum allowed\n size.
\nNumber overflow. Attempting to store a number with\n magnitude larger than supported range.
\nType mismatch for attribute to update.
\nNesting Levels have exceeded supported limits.
\nThe document path provided in the update expression is\n invalid for update.
\nThe provided expression refers to an attribute that does\n not exist in the item.
\nThe transaction with the given request token is already in progress.
", + "smithy.api#documentation": "The transaction with the given request token is already in progress.
\n\n Recommended Settings \n
\n\n This is a general recommendation for handling the TransactionInProgressException. These settings help \n ensure that the client retries will trigger completion of the ongoing TransactWriteItems request.\n
\n Set clientExecutionTimeout to a value that allows at least one retry to be processed after 5 \n seconds have elapsed since the first attempt for the TransactWriteItems operation.\n
\n Set socketTimeout to a value a little lower than the requestTimeout setting.\n
\n requestTimeout should be set based on the time taken for the individual retries of a single \n HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of \n retries and TransactionInProgressException errors.\n
\n Use exponential backoff when retrying and tune backoff if needed.\n
\n\n Assuming default retry policy, \n example timeout settings based on the guidelines above are as follows: \n
\nExample timeline:
\n0-1000 first attempt
\n1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
\n1500-2500 second attempt
\n2500-3500 second sleep/delay (500 * 2, exponential backoff)
\n3500-4500 third attempt
\n4500-6500 third sleep/delay (500 * 2^2)
\n6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
\nRemoves the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.
" } }, "com.amazonaws.dynamodb#UntagResourceInput": { @@ -9299,6 +11580,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#Update": { @@ -9319,9 +11603,9 @@ } }, "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "Name of the table for the UpdateItem request.
Name of the table for the UpdateItem request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Update condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE,\n ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Update condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.
\n UpdateContinuousBackups enables or disables point in time recovery for\n the specified table. A successful UpdateContinuousBackups call returns the\n current ContinuousBackupsDescription. Continuous backups are\n ENABLED on all tables at table creation. If point in time recovery is\n enabled, PointInTimeRecoveryStatus will be set to ENABLED.
Once continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.
\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time during the last 35 days.
\n UpdateContinuousBackups enables or disables point in time recovery for\n the specified table. A successful UpdateContinuousBackups call returns the\n current ContinuousBackupsDescription. Continuous backups are\n ENABLED on all tables at table creation. If point in time recovery is\n enabled, PointInTimeRecoveryStatus will be set to ENABLED.
Once continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.
\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time during the last 35 days.
The name of the table.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } }, @@ -9400,6 +11684,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#UpdateContinuousBackupsOutput": { @@ -9411,6 +11698,9 @@ "smithy.api#documentation": "Represents the continuous backups and point in time recovery settings on the\n table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#UpdateContributorInsights": { @@ -9437,9 +11727,9 @@ "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table.
", + "smithy.api#documentation": "The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.
", "smithy.api#required": {} } }, @@ -9456,6 +11746,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#UpdateContributorInsightsOutput": { @@ -9479,6 +11772,9 @@ "smithy.api#documentation": "The status of contributor insights
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#UpdateExpression": { @@ -9497,8 +11793,13 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
", - "smithy.api#required": {} + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "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.
Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.
\nAlthough you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nThe global secondary indexes must have the same provisioned and maximum write\n capacity units.
\nAdds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version). If you are using global tables Version\n 2019.11.21 you can use UpdateTable instead.
\n Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be\n met:
\nThe global secondary indexes must have the same name.
\nThe global secondary indexes must have the same hash key and sort key (if\n present).
\nThe global secondary indexes must have the same provisioned and maximum write\n capacity units.
\nContains the details of the global table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#UpdateGlobalTableSettings": { @@ -9606,7 +11913,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Updates settings for a global table.
" + "smithy.api#documentation": "Updates settings for a global table.
\nThis documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
\nTo determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
\nThe billing mode of the global table. If GlobalTableBillingMode is not\n specified, the global table defaults to PROVISIONED capacity billing\n mode.
\n PROVISIONED - We recommend using PROVISIONED for\n predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST\n for unpredictable workloads. PAY_PER_REQUEST sets the billing mode\n to On-Demand Mode.
The billing mode of the global table. If GlobalTableBillingMode is not\n specified, the global table defaults to PROVISIONED capacity billing\n mode.
\n PROVISIONED - We recommend using PROVISIONED for\n predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST\n for unpredictable workloads. PAY_PER_REQUEST sets the billing mode\n to On-demand capacity mode.
Represents the settings for a global table in a Region that will be modified.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#UpdateGlobalTableSettingsOutput": { @@ -9666,6 +11976,9 @@ "smithy.api#documentation": "The Region-specific settings for the global table.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#UpdateItem": { @@ -9706,23 +12019,70 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Edits an existing item's attributes, or adds a new item to the table if it does not\n already exist. You can put, delete, or add attribute values. You can also perform a\n conditional update on an existing item (insert a new attribute name-value pair if it\n doesn't exist, or replace an existing name-value pair if it has certain expected\n attribute values).
\nYou can also return the item's attribute values in the same UpdateItem\n operation using the ReturnValues parameter.
Edits an existing item's attributes, or adds a new item to the table if it does not\n already exist. You can put, delete, or add attribute values. You can also perform a\n conditional update on an existing item (insert a new attribute name-value pair if it\n doesn't exist, or replace an existing name-value pair if it has certain expected\n attribute values).
\nYou can also return the item's attribute values in the same UpdateItem\n operation using the ReturnValues parameter.
The name of the table containing the item to update.
", + "smithy.api#documentation": "The name of the table containing the item to update. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.
", "smithy.api#required": {} } }, "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.
\nFor the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.
", + "smithy.api#documentation": "The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.
\nFor the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.
", "smithy.api#required": {} } }, @@ -9747,7 +12107,7 @@ "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "Use ReturnValues if you want to get the item attributes as they appear\n before or after they are updated. For UpdateItem, the valid values\n are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - Returns all of the attributes of the item, as they\n appeared before the UpdateItem operation.
\n UPDATED_OLD - Returns only the updated attributes, as they appeared\n before the UpdateItem operation.
\n ALL_NEW - Returns all of the attributes of the item, as they appear\n after the UpdateItem operation.
\n UPDATED_NEW - Returns only the updated attributes, as they appear\n after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
\nThe values returned are strongly consistent.
" + "smithy.api#documentation": "Use ReturnValues if you want to get the item attributes as they appear\n before or after they are successfully updated. For UpdateItem, the valid\n values are:
\n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)
\n ALL_OLD - Returns all of the attributes of the item, as they\n appeared before the UpdateItem operation.
\n UPDATED_OLD - Returns only the updated attributes, as they appeared\n before the UpdateItem operation.
\n ALL_NEW - Returns all of the attributes of the item, as they appear\n after the UpdateItem operation.
\n UPDATED_NEW - Returns only the updated attributes, as they appear\n after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
\nThe values returned are strongly consistent.
" } }, "ReturnConsumedCapacity": { @@ -9762,30 +12122,37 @@ "UpdateExpression": { "target": "com.amazonaws.dynamodb#UpdateExpression", "traits": { - "smithy.api#documentation": "An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.
\nThe following action values are available for UpdateExpression.
\n SET - Adds one or more attributes and values to an item. If any of\n these attributes already exist, they are replaced by the new values. You can\n also use SET to add or subtract from an attribute that is of type\n Number. For example: SET myNum = myNum + :val\n
\n SET supports the following functions:
\n if_not_exists (path, operand) - if the item does not\n contain an attribute at the specified path, then\n if_not_exists evaluates to operand; otherwise, it\n evaluates to path. You can use this function to avoid overwriting an\n attribute that may already be present in the item.
\n list_append (operand, operand) - evaluates to a list with a\n new element added to it. You can append the new element to the start or\n the end of the list by reversing the order of the operands.
These function names are case-sensitive.
\n\n REMOVE - Removes one or more attributes from an item.
\n ADD - Adds the specified value to the item, if the attribute does\n not already exist. If the attribute does exist, then the behavior of\n ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is\n also a number, then Value is mathematically added to the\n existing attribute. If Value is a negative number, then it\n is subtracted from the existing attribute.
If you use ADD to increment or decrement a number\n value for an item that doesn't exist before the update, DynamoDB\n uses 0 as the initial value.
Similarly, if you use ADD for an existing item to\n increment or decrement an attribute value that doesn't exist before\n the update, DynamoDB uses 0 as the initial value. For\n example, suppose that the item you want to update doesn't have an\n attribute named itemcount, but you decide to\n ADD the number 3 to this attribute\n anyway. DynamoDB will create the itemcount attribute,\n set its initial value to 0, and finally add\n 3 to it. The result will be a new\n itemcount attribute in the item, with a value of\n 3.
If the existing data type is a set and if Value is also a\n set, then Value is added to the existing set. For example,\n if the attribute value is the set [1,2], and the\n ADD action specified [3], then the final\n attribute value is [1,2,3]. An error occurs if an\n ADD action is specified for a set attribute and the\n attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the\n existing data type is a set of strings, the Value must also\n be a set of strings.
The ADD action only supports Number and set data types. In\n addition, ADD can only be used on top-level attributes, not\n nested attributes.
\n DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old\n set. For example, if the attribute value was the set [a,b,c] and\n the DELETE action specifies [a,c], then the final\n attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition,\n DELETE can only be used on top-level attributes, not nested\n attributes.
You can have many actions in a single expression, such as the following: SET\n a=:value1, b=:value2 DELETE :value3, :value4, :value5\n
For more information on update expressions, see Modifying\n Items and Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.
\nThe following action values are available for UpdateExpression.
\n SET - Adds one or more attributes and values to an item. If any of\n these attributes already exist, they are replaced by the new values. You can\n also use SET to add or subtract from an attribute that is of type\n Number. For example: SET myNum = myNum + :val\n
\n SET supports the following functions:
\n if_not_exists (path, operand) - if the item does not\n contain an attribute at the specified path, then\n if_not_exists evaluates to operand; otherwise, it\n evaluates to path. You can use this function to avoid overwriting an\n attribute that may already be present in the item.
\n list_append (operand, operand) - evaluates to a list with a\n new element added to it. You can append the new element to the start or\n the end of the list by reversing the order of the operands.
These function names are case-sensitive.
\n\n REMOVE - Removes one or more attributes from an item.
\n ADD - Adds the specified value to the item, if the attribute does\n not already exist. If the attribute does exist, then the behavior of\n ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is\n also a number, then Value is mathematically added to the\n existing attribute. If Value is a negative number, then it\n is subtracted from the existing attribute.
If you use ADD to increment or decrement a number\n value for an item that doesn't exist before the update, DynamoDB\n uses 0 as the initial value.
Similarly, if you use ADD for an existing item to\n increment or decrement an attribute value that doesn't exist before\n the update, DynamoDB uses 0 as the initial value. For\n example, suppose that the item you want to update doesn't have an\n attribute named itemcount, but you decide to\n ADD the number 3 to this attribute\n anyway. DynamoDB will create the itemcount attribute,\n set its initial value to 0, and finally add\n 3 to it. The result will be a new\n itemcount attribute in the item, with a value of\n 3.
If the existing data type is a set and if Value is also a\n set, then Value is added to the existing set. For example,\n if the attribute value is the set [1,2], and the\n ADD action specified [3], then the final\n attribute value is [1,2,3]. An error occurs if an\n ADD action is specified for a set attribute and the\n attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the\n existing data type is a set of strings, the Value must also\n be a set of strings.
The ADD action only supports Number and set data types. In\n addition, ADD can only be used on top-level attributes, not\n nested attributes.
\n DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old\n set. For example, if the attribute value was the set [a,b,c] and\n the DELETE action specifies [a,c], then the final\n attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition,\n DELETE can only be used on top-level attributes, not nested\n attributes.
You can have many actions in a single expression, such as the following: SET\n a=:value1, b=:value2 DELETE :value3, :value4, :value5\n
For more information on update expressions, see Modifying\n Items and Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "A condition that must be satisfied in order for a conditional update to\n succeed.
\nAn expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type |\n contains | begins_with | size\n
These function names are case-sensitive.
\nComparison operators: = | <> |\n < | > | <= | >= |\n BETWEEN | IN \n
Logical operators: AND | OR | NOT\n
For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "A condition that must be satisfied in order for a conditional update to\n succeed.
\nAn expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type |\n contains | begins_with | size\n
These function names are case-sensitive.
\nComparison operators: = | <> |\n < | > | <= | >= |\n BETWEEN | IN \n
Logical operators: AND | OR | NOT\n
For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide.) To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved\n word.
\nTo create a placeholder for repeating occurrences of an attribute name in an\n expression.
\nTo prevent special characters in an attribute name from being misinterpreted\n in an expression.
\nUse the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:
\n\n Percentile\n
The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide.) To work around this, you could specify the following for\n ExpressionAttributeNames:
\n {\"#P\":\"Percentile\"}\n
You could then use this substitution in an expression, as in this example:
\n\n #P = :val\n
Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.
\nFor more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:
\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as\n follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n
You could then use these values in an expression, such as this:
\n\n ProductStatus IN (:avail, :back, :disc)\n
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.
" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "An optional parameter that returns the item attributes for an UpdateItem\n operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of an UpdateItem operation.
Represents the input of an UpdateItem operation.
A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.
The Attributes map is only present if ReturnValues was\n specified as something other than NONE in the request. Each element\n represents one attribute.
A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.
The Attributes map is only present if the update was successful and\n ReturnValues was specified as something other than NONE in\n the request. Each element represents one attribute.
The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.
The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.
Information about item collections, if any, that were affected by the\n UpdateItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.
Each ItemCollectionMetrics element consists of:
\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size, in\n gigabytes. This value is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on that table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nInformation about item collections, if any, that were affected by the\n UpdateItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.
Each ItemCollectionMetrics element consists of:
\n ItemCollectionKey - The partition key value of the item collection.\n This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size, in\n gigabytes. This value is a two-element array containing a lower bound and an\n upper bound for the estimate. The estimate includes the size of all the items in\n the table, plus the size of all attributes projected into all of the local\n secondary indexes on that table. Use this estimate to measure whether a local\n secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the\n precision or accuracy of the estimate.
\nRepresents the output of an UpdateItem operation.
Enables updating the precision of Kinesis data stream timestamp.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Enables updating the configuration for Kinesis Streaming.
" + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "The command to update the Kinesis stream destination.
" + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "The table name for the Kinesis streaming destination input. You can also provide the\n ARN of the table in this parameter.
", + "smithy.api#required": {} + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Kinesis stream input.
", + "smithy.api#required": {} + } + }, + "UpdateKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "The command to update the Kinesis stream configuration.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "The table name for the Kinesis streaming destination output.
" + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "The ARN for the Kinesis stream input.
" + } + }, + "DestinationStatus": { + "target": "com.amazonaws.dynamodb#DestinationStatus", + "traits": { + "smithy.api#documentation": "The status of the attempt to update the Kinesis streaming destination output.
" + } + }, + "UpdateKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "The command to update the Kinesis streaming destination configuration.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of an UpdateItem operation.
The KMS key of the replica that should be used\n for KMS encryption. To specify a key, use its key ID, Amazon Resource\n Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter\n if the key is different from the default DynamoDB KMS key\n alias/aws/dynamodb.
The KMS key of the replica that should be used for KMS\n encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or\n alias ARN. Note that you should only provide this parameter if the key is different from\n the default DynamoDB KMS key alias/aws/dynamodb.
Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.
" } }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "Overrides the maximum on-demand throughput for the replica table.
" + } + }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", "traits": { @@ -9845,7 +12325,7 @@ "TableClassOverride": { "target": "com.amazonaws.dynamodb#TableClass", "traits": { - "smithy.api#documentation": "Replica-specific table class. If not specified, uses the source table's\n table class.
" + "smithy.api#documentation": "Replica-specific table class. If not specified, uses the source table's table\n class.
" } } }, @@ -9882,7 +12362,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.
\nYou can only perform one of the following operations at once:
\nModify the provisioned throughput settings of the table.
\nRemove a global secondary index from the table.
\nCreate a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.
\n UpdateTable is an asynchronous operation; while it is executing, the table\n status changes from ACTIVE to UPDATING. While it is\n UPDATING, you cannot issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nYou can only perform one of the following operations at once:
\nModify the provisioned throughput settings of the table.
\nRemove a global secondary index from the table.
\nCreate a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.
\n UpdateTable is an asynchronous operation; while it's executing, the table\n status changes from ACTIVE to UPDATING. While it's\n UPDATING, you can't issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.
The name of the table to be updated.
", + "smithy.api#documentation": "The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.
", "smithy.api#required": {} } }, "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "Controls how you are charged for read and write throughput and how you manage\n capacity. When switching from pay-per-request to provisioned capacity, initial\n provisioned capacity values must be set. The initial provisioned capacity values are\n estimated based on the consumed read and write capacity of your table and global\n secondary indexes over the past 30 minutes.
\n\n PROVISIONED - We recommend using PROVISIONED for\n predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST\n for unpredictable workloads. PAY_PER_REQUEST sets the billing mode\n to On-Demand Mode.
Controls how you are charged for read and write throughput and how you manage\n capacity. When switching from pay-per-request to provisioned capacity, initial\n provisioned capacity values must be set. The initial provisioned capacity values are\n estimated based on the consumed read and write capacity of your table and global\n secondary indexes over the past 30 minutes.
\n\n PROVISIONED - We recommend using PROVISIONED for\n predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST\n for unpredictable workloads. PAY_PER_REQUEST sets the billing mode\n to On-demand capacity mode.
An array of one or more global secondary indexes for the table. For each index in the\n array, you can request one action:
\n\n Create - add a new global secondary index to the table.
\n Update - modify the provisioned throughput settings of an existing\n global secondary index.
\n Delete - remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable\n operation.
For more information, see Managing Global\n Secondary Indexes in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "An array of one or more global secondary indexes for the table. For each index in the\n array, you can request one action:
\n\n Create - add a new global secondary index to the table.
\n Update - modify the provisioned throughput settings of an existing\n global secondary index.
\n Delete - remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable\n operation.
For more information, see Managing Global\n Secondary Indexes in the Amazon DynamoDB Developer\n Guide.
" } }, "StreamSpecification": { "target": "com.amazonaws.dynamodb#StreamSpecification", "traits": { - "smithy.api#documentation": "Represents the DynamoDB Streams configuration for the table.
\nYou receive a ResourceInUseException if you try to enable a stream on\n a table that already has a stream, or if you try to disable a stream on a table that\n doesn't have a stream.
Represents the DynamoDB Streams configuration for the table.
\nYou receive a ValidationException if you try to enable a stream on a\n table that already has a stream, or if you try to disable a stream on a table that\n doesn't have a stream.
A list of replica update actions (create, delete, or update) for the table.
\nThis property only applies to Version\n 2019.11.21 of global tables.
\nA list of replica update actions (create, delete, or update) for the table.
\nFor global tables, this property only applies to global tables using Version\n 2019.11.21 (Current version).
\nThe table class of the table to be updated. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.
Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.
" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "Updates the maximum number of read and write units for the specified table in\n on-demand capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the input of an UpdateTable operation.
Represents the input of an UpdateTable operation.
Represents the output of an UpdateTable operation.
Represents the output of an UpdateTable operation.
Updates auto scaling settings on your global tables at once.
\nThis operation only applies to Version\n 2019.11.21 of global tables.
\nUpdates auto scaling settings on your global tables at once.
\nFor global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).
\nThe name of the global table to be updated.
", + "smithy.api#documentation": "The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, @@ -10013,6 +12507,9 @@ "smithy.api#documentation": "Represents the auto scaling settings of replicas of the table that will be\n modified.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingOutput": { @@ -10024,6 +12521,9 @@ "smithy.api#documentation": "Returns information about the auto scaling settings of a table with replicas.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dynamodb#UpdateTimeToLive": { @@ -10055,16 +12555,16 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The UpdateTimeToLive method enables or disables Time to Live (TTL) for\n the specified table. A successful UpdateTimeToLive call returns the current\n TimeToLiveSpecification. It can take up to one hour for the change to\n fully process. Any additional UpdateTimeToLive calls for the same table\n during this one hour duration result in a ValidationException.
TTL compares the current time in epoch time format to the time stored in the TTL\n attribute of an item. If the epoch time value stored in the attribute is less than the\n current time, the item is marked as expired and subsequently deleted.
\nThe epoch time format is the number of seconds elapsed since 12:00:00 AM January\n 1, 1970 UTC.
\nDynamoDB deletes expired items on a best-effort basis to ensure availability of\n throughput for other data operations.
\nDynamoDB typically deletes expired items within two days of expiration. The exact\n duration within which an item gets deleted after expiration is specific to the\n nature of the workload. Items that have expired and not been deleted will still show\n up in reads, queries, and scans.
\nAs items are deleted, they are removed from any local secondary index and global\n secondary index immediately in the same eventually consistent way as a standard delete\n operation.
\nFor more information, see Time To Live in the\n Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "The UpdateTimeToLive method enables or disables Time to Live (TTL) for\n the specified table. A successful UpdateTimeToLive call returns the current\n TimeToLiveSpecification. It can take up to one hour for the change to\n fully process. Any additional UpdateTimeToLive calls for the same table\n during this one hour duration result in a ValidationException.
TTL compares the current time in epoch time format to the time stored in the TTL\n attribute of an item. If the epoch time value stored in the attribute is less than the\n current time, the item is marked as expired and subsequently deleted.
\nThe epoch time format is the number of seconds elapsed since 12:00:00 AM January\n 1, 1970 UTC.
\nDynamoDB deletes expired items on a best-effort basis to ensure availability of\n throughput for other data operations.
\nDynamoDB typically deletes expired items within two days of expiration. The exact\n duration within which an item gets deleted after expiration is specific to the\n nature of the workload. Items that have expired and not been deleted will still show\n up in reads, queries, and scans.
\nAs items are deleted, they are removed from any local secondary index and global\n secondary index immediately in the same eventually consistent way as a standard delete\n operation.
\nFor more information, see Time To Live in the\n Amazon DynamoDB Developer Guide.
" } }, "com.amazonaws.dynamodb#UpdateTimeToLiveInput": { "type": "structure", "members": { "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The name of the table to be configured.
", + "smithy.api#documentation": "The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.
", "smithy.api#required": {} } }, @@ -10077,7 +12577,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of an UpdateTimeToLive operation.
Represents the input of an UpdateTimeToLive operation.
Represents the output of an UpdateTimeToLive operation.