The Amazon Resource Name (ARN) of the backup the table was archived\n to, when applicable in the archival reason. If you wish to restore this\n backup to the same table name, you will need to delete the original\n table.
" + "smithy.api#documentation": "The date and time when table archival was initiated by DynamoDB,\n in UNIX epoch time format.
" } }, "ArchivalReason": { @@ -47,10 +47,10 @@ "smithy.api#documentation": "The reason DynamoDB archived the table. Currently, the only\n possible value is:
\n\n\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The\n table was archived due to the table's AWS KMS key being inaccessible\n for more than seven days. An On-Demand backup was created at the archival\n time.
The date and time when table archival was initiated by DynamoDB,\n in UNIX epoch time format.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the backup the table was archived\n to, when applicable in the archival reason. If you wish to restore this\n backup to the same table name, you will need to delete the original\n table.
" } } }, @@ -77,17 +77,17 @@ "com.amazonaws.dynamodb#AttributeDefinition": { "type": "structure", "members": { - "AttributeType": { - "target": "com.amazonaws.dynamodb#ScalarAttributeType", + "AttributeName": { + "target": "com.amazonaws.dynamodb#KeySchemaAttributeName", "traits": { - "smithy.api#documentation": "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
A name for the attribute.
", "smithy.api#required": {} } }, - "AttributeName": { - "target": "com.amazonaws.dynamodb#KeySchemaAttributeName", + "AttributeType": { + "target": "com.amazonaws.dynamodb#ScalarAttributeType", "traits": { - "smithy.api#documentation": "A name for the attribute.
", + "smithy.api#documentation": "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
An attribute of type Boolean. For example:
\n\n \"BOOL\": true\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 across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
" - } - }, "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 Binary. For example:
\n\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\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 across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
" } }, - "BS": { - "target": "com.amazonaws.dynamodb#BinarySetAttributeValue", + "B": { + "target": "com.amazonaws.dynamodb#BinaryAttributeValue", "traits": { - "smithy.api#documentation": "An attribute of type Binary Set. For example:
\n\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\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 Number. For example:
\n\n \"N\": \"123.45\"\n
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
" + "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 across languages and libraries. However, DynamoDB treats them as number type attributes 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 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 Null. For example:
\n\n \"NULL\": true\n
An attribute of type List. For example:
\n\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n
An attribute of type Boolean. For example:
\n\n \"BOOL\": true\n
Specifies how to perform the update. Valid values are PUT (default), DELETE,\n and ADD. The behavior depends on whether the specified primary key already exists\n in the table.
\n If an item with the specified Key is found in the table:\n
\n\n\n PUT - Adds the specified attribute to the item. If the attribute already\n exists, it is replaced by the new value.
\n DELETE - If no value is specified, the attribute and its value are removed\n from the item. The data type of the specified value must match the existing value's data\n type.
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 the\n DELETE action specified [a,c], then the final attribute value would\n be [b]. Specifying an empty set is an error.
\n ADD - If the attribute does not already exist, then the attribute and its\n values are added to the item. 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 also a number, then the\n Value is mathematically added to the existing attribute. If Value is a\n negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item\n that doesn't exist before the update, DynamoDB uses 0 as the initial value.
In addition, if you use ADD to update an existing item, and intend to\n increment or decrement an attribute value which does not yet exist, DynamoDB uses\n 0 as the initial value. For example, suppose that the item you want\n to update does not yet have an attribute named itemcount, but you decide to\n ADD the number 3 to this attribute anyway, even though\n it currently does not exist. DynamoDB will create the itemcount attribute, set\n its initial value to 0, and finally add 3 to it. The\n result will be a new itemcount attribute in the item, with a value of\n 3.
If the existing data type is a set, and if the Value is also a set, then the\n Value is added to the existing set. (This is a set operation, not\n mathematical addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified [3], then\n the final attribute value would be [1,2,3]. An error occurs if an Add\n action is specified for a set attribute and the attribute type specified does not\n match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data\n type is a set of strings, the Value must also be a set of strings. The same\n holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a\n set. Do not use ADD for any other data types.
\n If no item with the specified Key is found:\n
\n\n\n PUT - DynamoDB creates a new item with the specified primary key, and then adds\n the attribute.
\n DELETE - Nothing happens; there is no attribute to delete.
\n ADD - DynamoDB creates an item with the supplied primary key and number (or set\n of numbers) for the attribute value. The only data types allowed are number and number\n set; no other data types can be specified.
Represents the data for an attribute.
\nEach attribute value is described as a name-value pair. The name is the data type, and 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), DELETE,\n and ADD. The behavior depends on whether the specified primary key already exists\n in the table.
\n If an item with the specified Key is found in the table:\n
\n\n\n PUT - Adds the specified attribute to the item. If the attribute already\n exists, it is replaced by the new value.
\n DELETE - If no value is specified, the attribute and its value are removed\n from the item. The data type of the specified value must match the existing value's data\n type.
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 the\n DELETE action specified [a,c], then the final attribute value would\n be [b]. Specifying an empty set is an error.
\n ADD - If the attribute does not already exist, then the attribute and its\n values are added to the item. 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 also a number, then the\n Value is mathematically added to the existing attribute. If Value is a\n negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item\n that doesn't exist before the update, DynamoDB uses 0 as the initial value.
In addition, if you use ADD to update an existing item, and intend to\n increment or decrement an attribute value which does not yet exist, DynamoDB uses\n 0 as the initial value. For example, suppose that the item you want\n to update does not yet have an attribute named itemcount, but you decide to\n ADD the number 3 to this attribute anyway, even though\n it currently does not exist. DynamoDB will create the itemcount attribute, set\n its initial value to 0, and finally add 3 to it. The\n result will be a new itemcount attribute in the item, with a value of\n 3.
If the existing data type is a set, and if the Value is also a set, then the\n Value is added to the existing set. (This is a set operation, not\n mathematical addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified [3], then\n the final attribute value would be [1,2,3]. An error occurs if an Add\n action is specified for a set attribute and the attribute type specified does not\n match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data\n type is a set of strings, the Value must also be a set of strings. The same\n holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a\n set. Do not use ADD for any other data types.
\n If no item with the specified Key is found:\n
\n\n\n PUT - DynamoDB creates a new item with the specified primary key, and then adds\n the attribute.
\n DELETE - Nothing happens; there is no attribute to delete.
\n ADD - DynamoDB creates an item with the supplied primary key and number (or set\n of numbers) for the attribute value. The only data types allowed are number and number\n set; no other data types can be specified.
The minimum capacity units that a global table or global secondary index should be scaled down to.
" } }, + "MaximumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "The maximum capacity units that a global table or global secondary index should be scaled up to.
" + } + }, "AutoScalingDisabled": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { @@ -327,12 +333,6 @@ "traits": { "smithy.api#documentation": "Information about the scaling policies.
" } - }, - "MaximumUnits": { - "target": "com.amazonaws.dynamodb#PositiveLongObject", - "traits": { - "smithy.api#documentation": "The maximum capacity units that a global table or global secondary index should be scaled up to.
" - } } }, "traits": { @@ -348,18 +348,6 @@ "smithy.api#documentation": "The minimum capacity units that a global table or global secondary index should be scaled down to.
" } }, - "ScalingPolicyUpdate": { - "target": "com.amazonaws.dynamodb#AutoScalingPolicyUpdate", - "traits": { - "smithy.api#documentation": "The scaling policy to apply for scaling target global table or global secondary index capacity units.
" - } - }, - "AutoScalingRoleArn": { - "target": "com.amazonaws.dynamodb#AutoScalingRoleArn", - "traits": { - "smithy.api#documentation": "Role ARN used for configuring auto scaling policy.
" - } - }, "MaximumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { @@ -371,6 +359,18 @@ "traits": { "smithy.api#documentation": "Disabled auto scaling for this global table or global secondary index.
" } + }, + "AutoScalingRoleArn": { + "target": "com.amazonaws.dynamodb#AutoScalingRoleArn", + "traits": { + "smithy.api#documentation": "Role ARN used for configuring auto scaling policy.
" + } + }, + "ScalingPolicyUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyUpdate", + "traits": { + "smithy.api#documentation": "The scaling policy to apply for scaling target global table or global secondary index capacity units.
" + } } }, "traits": { @@ -380,10 +380,10 @@ "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription": { "type": "structure", "members": { - "ScaleOutCooldown": { - "target": "com.amazonaws.dynamodb#IntegerObject", + "DisableScaleIn": { + "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.
" + "smithy.api#documentation": "Indicates whether scale in by the target tracking policy is disabled. If the value is true,\n scale in is disabled and the target tracking policy won't remove capacity from the scalable resource.\n Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.\n The default value is false.
" } }, "ScaleInCooldown": { @@ -392,10 +392,10 @@ "smithy.api#documentation": "The amount of time, in seconds, after a scale in activity completes before another scale\n in activity can start. The cooldown period is used to block subsequent scale in requests\n until it has expired. You should scale in conservatively to protect your application's\n availability. However, if another alarm triggers a scale out policy during the cooldown\n period after a scale-in, application auto scaling scales out your scalable target\n immediately.
" } }, - "DisableScaleIn": { - "target": "com.amazonaws.dynamodb#BooleanObject", + "ScaleOutCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { - "smithy.api#documentation": "Indicates whether scale in by the target tracking policy is disabled. If the value is true,\n scale in is disabled and the target tracking policy won't remove capacity from the scalable resource.\n Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.\n The default value is false.
" + "smithy.api#documentation": "The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.
" } }, "TargetValue": { @@ -413,30 +413,30 @@ "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate": { "type": "structure", "members": { + "DisableScaleIn": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "Indicates whether scale in by the target tracking policy is disabled. If the value is true,\n scale in is disabled and the target tracking policy won't remove capacity from the scalable resource.\n Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.\n The default value is false.
" + } + }, "ScaleInCooldown": { "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { "smithy.api#documentation": "The amount of time, in seconds, after a scale in activity completes before another scale\n in activity can start. The cooldown period is used to block subsequent scale in requests\n until it has expired. You should scale in conservatively to protect your application's\n availability. However, if another alarm triggers a scale out policy during the cooldown\n period after a scale-in, application auto scaling scales out your scalable target\n immediately.
" } }, + "ScaleOutCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.
" + } + }, "TargetValue": { "target": "com.amazonaws.dynamodb#Double", "traits": { "smithy.api#documentation": "The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
", "smithy.api#required": {} } - }, - "DisableScaleIn": { - "target": "com.amazonaws.dynamodb#BooleanObject", - "traits": { - "smithy.api#documentation": "Indicates whether scale in by the target tracking policy is disabled. If the value is true,\n scale in is disabled and the target tracking policy won't remove capacity from the scalable resource.\n Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.\n The default value is false.
" - } - }, - "ScaleOutCooldown": { - "target": "com.amazonaws.dynamodb#IntegerObject", - "traits": { - "smithy.api#documentation": "The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.
" - } } }, "traits": { @@ -470,17 +470,17 @@ "smithy.api#documentation": "Contains the details of the backup created for the table.
" } }, - "SourceTableFeatureDetails": { - "target": "com.amazonaws.dynamodb#SourceTableFeatureDetails", - "traits": { - "smithy.api#documentation": "Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
" - } - }, "SourceTableDetails": { "target": "com.amazonaws.dynamodb#SourceTableDetails", "traits": { "smithy.api#documentation": "Contains the details of the table when the backup was created.
" } + }, + "SourceTableFeatureDetails": { + "target": "com.amazonaws.dynamodb#SourceTableFeatureDetails", + "traits": { + "smithy.api#documentation": "Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
" + } } }, "traits": { @@ -490,19 +490,26 @@ "com.amazonaws.dynamodb#BackupDetails": { "type": "structure", "members": { - "BackupExpiryDateTime": { - "target": "com.amazonaws.dynamodb#Date", + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", "traits": { - "smithy.api#documentation": "Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM\n on-demand backup expires automatically 35 days after its creation.
ARN associated with the backup.
", + "smithy.api#required": {} } }, - "BackupType": { - "target": "com.amazonaws.dynamodb#BackupType", + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", "traits": { - "smithy.api#documentation": "BackupType:
\n\n USER - You create and manage these using the on-demand backup feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically\n created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted \n\t\ttable to the state it was in just before the point of deletion.\n\t\t
\n AWS_BACKUP - On-demand backup created by you from AWS Backup service.
Name of the requested backup.
", "smithy.api#required": {} } }, + "BackupSizeBytes": { + "target": "com.amazonaws.dynamodb#BackupSizeBytes", + "traits": { + "smithy.api#documentation": "Size of the backup in bytes.
" + } + }, "BackupStatus": { "target": "com.amazonaws.dynamodb#BackupStatus", "traits": { @@ -510,10 +517,10 @@ "smithy.api#required": {} } }, - "BackupName": { - "target": "com.amazonaws.dynamodb#BackupName", + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupType", "traits": { - "smithy.api#documentation": "Name of the requested backup.
", + "smithy.api#documentation": "BackupType:
\n\n USER - You create and manage these using the on-demand backup feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically\n created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted \n\t\ttable to the state it was in just before the point of deletion.\n\t\t
\n AWS_BACKUP - On-demand backup created by you from AWS Backup service.
ARN associated with the backup.
", - "smithy.api#required": {} - } - }, - "BackupSizeBytes": { - "target": "com.amazonaws.dynamodb#BackupSizeBytes", + "BackupExpiryDateTime": { + "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "Size of the backup in bytes.
" + "smithy.api#documentation": "Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM\n on-demand backup expires automatically 35 days after its creation.
ARN associated with the backup.
" - } - }, - "BackupName": { - "target": "com.amazonaws.dynamodb#BackupName", - "traits": { - "smithy.api#documentation": "Name of the specified backup.
" - } - }, - "BackupExpiryDateTime": { - "target": "com.amazonaws.dynamodb#Date", - "traits": { - "smithy.api#documentation": "Time at which the automatic on-demand backup created by DynamoDB will expire. This\n SYSTEM on-demand backup expires automatically 35 days after its\n creation.
Unique identifier for the table.
" } }, - "BackupType": { - "target": "com.amazonaws.dynamodb#BackupType", + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "BackupType:
\n\n USER - You create and manage these using the on-demand backup feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically\n created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted \n\t\ttable to the state it was in just before the point of deletion.\n\t\t
\n AWS_BACKUP - On-demand backup created by you from AWS Backup service.
ARN associated with the table.
" + } + }, + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "ARN associated with the backup.
" + } + }, + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", + "traits": { + "smithy.api#documentation": "Name of the specified backup.
" } }, "BackupCreationDateTime": { @@ -652,23 +646,29 @@ "smithy.api#documentation": "Time at which the backup was created.
" } }, + "BackupExpiryDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "Time at which the automatic on-demand backup created by DynamoDB will expire. This\n SYSTEM on-demand backup expires automatically 35 days after its\n creation.
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
" } }, + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupType", + "traits": { + "smithy.api#documentation": "BackupType:
\n\n USER - You create and manage these using the on-demand backup feature.
\n SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically\n created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted \n\t\ttable to the state it was in just before the point of deletion.\n\t\t
\n AWS_BACKUP - On-demand backup created by you from AWS Backup service.
Size of the backup in bytes.
" } - }, - "TableArn": { - "target": "com.amazonaws.dynamodb#TableArn", - "traits": { - "smithy.api#documentation": "ARN associated with the table.
" - } } }, "traits": { @@ -727,6 +727,49 @@ } } }, + "com.amazonaws.dynamodb#BatchExecuteStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#BatchExecuteStatementInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#BatchExecuteStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "\nThis operation allows you to perform batch reads and writes on data stored in DynamoDB, using PartiQL.\n
" + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatementInput": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.dynamodb#PartiQLBatchRequest", + "traits": { + "smithy.api#documentation": "\nThe list of PartiQL statements representing the batch to run.\n
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatementOutput": { + "type": "structure", + "members": { + "Responses": { + "target": "com.amazonaws.dynamodb#PartiQLBatchResponse", + "traits": { + "smithy.api#documentation": "\nThe response to each PartiQL statement in the batch.\n
" + } + } + } + }, "com.amazonaws.dynamodb#BatchGetItem": { "type": "operation", "input": { @@ -759,15 +802,15 @@ "com.amazonaws.dynamodb#BatchGetItemInput": { "type": "structure", "members": { - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" - }, "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 items to retrieve from that table. Each table name can be 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 is used; if\n false (the default), an eventually consistent read is used.
\n ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders 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 specific items in the\n table. For each primary key, you must provide all of the key attributes. For\n example, with a simple primary key, you only need to provide the partition key value. For a\n composite key, you must provide both the partition key value and the 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\n Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
\n\n AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.\n\n
A map of table name to a list of items. Each object in Responses consists of a table\n name, along with a map of attribute data consisting of the data type and attribute value.
The read capacity units consumed by the entire BatchGetItem operation.
Each element consists of:
\n\n TableName - The table that consumed the provisioned throughput.
\n CapacityUnits - The total number of capacity units consumed.
A map of tables and their respective keys that were not processed with the current response.\n The UnprocessedKeys value is in the same form as RequestItems, so the value can\n be provided directly to a subsequent 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 specific items in the\n table.
\n ProjectionExpression - One or more attributes to be\n retrieved from the table or index. By default, all attributes are returned. If a\n requested attribute is not found, it does not appear in the result.
\n ConsistentRead - The consistency of a read operation. If set to true,\n then a strongly consistent read is used; otherwise, an eventually consistent read is\n 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 operation.
Each element consists of:
\n\n TableName - The table that consumed the provisioned throughput.
\n CapacityUnits - The total number of capacity units consumed.
\nThe error code associated with the failed PartiQL batch statement.\n
" + } + }, + "Message": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "\nThe error message associated with the PartiQL batch resposne.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nAn error associated with a statement in a PartiQL batch that was run.\n
" + } + }, + "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ConditionalCheckFailed", + "name": "ConditionalCheckFailed" + }, + { + "value": "ItemCollectionSizeLimitExceeded", + "name": "ItemCollectionSizeLimitExceeded" + }, + { + "value": "RequestLimitExceeded", + "name": "RequestLimitExceeded" + }, + { + "value": "ValidationError", + "name": "ValidationError" + }, + { + "value": "ProvisionedThroughputExceeded", + "name": "ProvisionedThroughputExceeded" + }, + { + "value": "TransactionConflict", + "name": "TransactionConflict" + }, + { + "value": "ThrottlingError", + "name": "ThrottlingError" + }, + { + "value": "InternalServerError", + "name": "InternalServerError" + }, + { + "value": "ResourceNotFound", + "name": "ResourceNotFound" + }, + { + "value": "AccessDenied", + "name": "AccessDenied" + }, + { + "value": "DuplicateItem", + "name": "DuplicateItem" + } + ] + } + }, + "com.amazonaws.dynamodb#BatchStatementRequest": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", + "traits": { + "smithy.api#documentation": "\nA valid PartiQL statement.\n
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "\nThe parameters associated with a PartiQL statement in the batch request.\n
" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "\nThe read consistency of the PartiQL batch request. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nA PartiQL batch statement request. \n
" + } + }, + "com.amazonaws.dynamodb#BatchStatementResponse": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.dynamodb#BatchStatementError", + "traits": { + "smithy.api#documentation": "\nThe error associated with a failed PartiQL batch statement.\n
" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "\nThe table name associated with a failed PartiQL batch statement.\n
" + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "\nA DynamoDB item associated with a BatchStatementResponse\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nA PartiQL batch statement response..\n
" + } + }, "com.amazonaws.dynamodb#BatchWriteItem": { "type": "operation", "input": { @@ -859,9 +1026,6 @@ "com.amazonaws.dynamodb#BatchWriteItemInput": { "type": "structure", "members": { - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" - }, "RequestItems": { "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", "traits": { @@ -869,6 +1033,9 @@ "smithy.api#required": {} } }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, "ReturnItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { @@ -883,6 +1050,12 @@ "com.amazonaws.dynamodb#BatchWriteItemOutput": { "type": "structure", "members": { + "UnprocessedItems": { + "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", + "traits": { + "smithy.api#documentation": "A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as RequestItems, so you can provide\n this value directly to a subsequent 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, a list of\n operations to perform (DeleteRequest or PutRequest).
\n DeleteRequest - Perform a DeleteItem operation on the specified item. The\n item to be deleted is identified by a Key subelement:
\n Key - A map of primary key attribute values that uniquely identify the item.\n Each entry in this map consists of an attribute name and an attribute value.
\n PutRequest - Perform a PutItem operation on the specified item. The item to\n be put is identified by an Item subelement:
\n Item - A map of attributes and their values. Each entry in this map consists\n of an attribute name and an attribute value. Attribute values must not be null; string\n and binary type attributes must have lengths greater than zero; and set type\n attributes must not be empty. Requests that contain empty values will be rejected with\n a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
\nIf there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.
The capacity units consumed by the entire BatchWriteItem operation.
Each element consists of:
\n\n TableName - The table that consumed the provisioned throughput.
\n CapacityUnits - The total number of capacity units consumed.
A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as RequestItems, so you can provide\n this value directly to a subsequent 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, a list of\n operations to perform (DeleteRequest or PutRequest).
\n DeleteRequest - Perform a DeleteItem operation on the specified item. The\n item to be deleted is identified by a Key subelement:
\n Key - A map of primary key attribute values that uniquely identify the item.\n Each entry in this map consists of an attribute name and an attribute value.
\n PutRequest - Perform a PutItem operation on the specified item. The item to\n be put is identified by an Item subelement:
\n Item - A map of attributes and their values. Each entry in this map consists\n of an attribute name and an attribute value. Attribute values must not be null; string\n and binary type attributes must have lengths greater than zero; and set type\n attributes must not be empty. Requests that contain empty values will be rejected with\n a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
\nIf there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.
Cancellation reason message description.
" - } - }, "Item": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { @@ -995,6 +1165,12 @@ "traits": { "smithy.api#documentation": "Status code for the result of the cancelled transaction.
" } + }, + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "Cancellation reason message description.
" + } } }, "traits": { @@ -1022,16 +1198,16 @@ "smithy.api#documentation": "The total number of read capacity units consumed on a table or an index.
" } }, - "CapacityUnits": { + "WriteCapacityUnits": { "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", "traits": { - "smithy.api#documentation": "The total number of capacity units consumed on a table or an index.
" + "smithy.api#documentation": "The total number of write capacity units consumed on a table or an index.
" } }, - "WriteCapacityUnits": { + "CapacityUnits": { "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", "traits": { - "smithy.api#documentation": "The total number of write capacity units consumed on a table or an index.
" + "smithy.api#documentation": "The total number of capacity units consumed on a table or an index.
" } } }, @@ -1048,6 +1224,9 @@ } } }, + "com.amazonaws.dynamodb#ClientToken": { + "type": "string" + }, "com.amazonaws.dynamodb#Code": { "type": "string" }, @@ -1100,18 +1279,18 @@ "com.amazonaws.dynamodb#Condition": { "type": "structure", "members": { + "AttributeValueList": { + "target": "com.amazonaws.dynamodb#AttributeValueList", + "traits": { + "smithy.api#documentation": "One or more values to evaluate against the supplied attribute. The number of values in the\n 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 character\n code values. For example, a is greater than A, and a\n 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 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, etc.
\nThe following comparison operators are available:
\n\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN\n
The following are descriptions of each comparison operator.
\n\n EQ : Equal. EQ is supported for all data types, including lists and maps.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different\n type 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\", \"1\"]}.
\n NE : Not equal. NE is supported for all data types, including lists and maps.
\n AttributeValueList can contain only one AttributeValue of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different\n type 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\", \"1\"]}.
\n LE : Less than or equal.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n LT : Less than.
\n AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GE : Greater than or equal.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GT : Greater than.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
\n NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
\n CONTAINS : Checks for a subsequence, or value in a set.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then\n the operator checks for a substring match. If the target attribute of the comparison is\n of type Binary, 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\", \"NS\", or \"BS\"), then the\n operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
\n NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in\n a set.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If the target attribute of the comparison is a String, then\n the operator checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operator checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
\n BEGINS_WITH : Checks for a prefix.
\n AttributeValueList can contain only one AttributeValue of type String or\n Binary (not a Number or a set type). The target attribute of the comparison must be of type String or\n Binary (not a Number or a set type).
\n IN : Checks for matching elements in a list.
\n AttributeValueList can contain one or more AttributeValue\n elements of type String, Number, or Binary. These attributes are compared against an\n existing attribute of an item. If any elements of the input are equal to the item\n attribute, the expression evaluates to true.
\n BETWEEN : Greater than or equal to the first value, and less than or equal\n to the second value.
\n AttributeValueList must contain two AttributeValue elements of the same\n type, either String, Number, or Binary (not a set type). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an AttributeValue element of a different type than\n the one 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\", \"1\"]}\n
For usage examples of AttributeValueList and ComparisonOperator, see\n Legacy Conditional Parameters\n in the Amazon DynamoDB Developer Guide.
One or more values to evaluate against the supplied attribute. The number of values in the\n 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 character\n code values. For example, a is greater than A, and a\n 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 compares binary values.
" - } } }, "traits": { @@ -1128,6 +1307,13 @@ "smithy.api#required": {} } }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "Name of the table for the check item request.
", + "smithy.api#required": {} + } + }, "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { @@ -1135,6 +1321,12 @@ "smithy.api#required": {} } }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression.
" + } + }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { @@ -1146,19 +1338,6 @@ "traits": { "smithy.api#documentation": "Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the ConditionCheck condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.
Name of the table for the check item request.
", - "smithy.api#required": {} - } - }, - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", - "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression.
" - } } }, "traits": { @@ -1217,18 +1396,6 @@ "smithy.api#documentation": "The total number of capacity units consumed by the operation.
" } }, - "LocalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", - "traits": { - "smithy.api#documentation": "The amount of throughput consumed on each local index affected by the operation.
" - } - }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", - "traits": { - "smithy.api#documentation": "The amount of throughput consumed on each global index affected by the operation.
" - } - }, "ReadCapacityUnits": { "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", "traits": { @@ -1246,6 +1413,18 @@ "traits": { "smithy.api#documentation": "The amount of throughput consumed on the table affected by the operation.
" } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "The amount of throughput consumed on each local index affected by the operation.
" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "The amount of throughput consumed on each global index affected by the operation.
" + } } }, "traits": { @@ -1267,23 +1446,23 @@ "com.amazonaws.dynamodb#ContinuousBackupsDescription": { "type": "structure", "members": { - "PointInTimeRecoveryDescription": { - "target": "com.amazonaws.dynamodb#PointInTimeRecoveryDescription", - "traits": { - "smithy.api#documentation": "The description of the point in time recovery settings applied to the table.
" - } - }, "ContinuousBackupsStatus": { "target": "com.amazonaws.dynamodb#ContinuousBackupsStatus", "traits": { "smithy.api#documentation": "\n ContinuousBackupsStatus can be one of the following states: ENABLED,\n DISABLED
Represents the continuous backups and point in time recovery settings on the table.
" - } + }, + "PointInTimeRecoveryDescription": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryDescription", + "traits": { + "smithy.api#documentation": "The description of the point in time recovery settings applied to the table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the continuous backups and point in time recovery settings on the table.
" + } }, "com.amazonaws.dynamodb#ContinuousBackupsStatus": { "type": "string", @@ -1386,7 +1565,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a Contributor Insights summary entry..
" + "smithy.api#documentation": "Represents a Contributor Insights summary entry.
" } }, "com.amazonaws.dynamodb#CreateBackup": { @@ -1457,16 +1636,10 @@ "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction": { "type": "structure", "members": { - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", - "traits": { - "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" - } - }, - "Projection": { - "target": "com.amazonaws.dynamodb#Projection", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.
", + "smithy.api#documentation": "The name of the global secondary index to be created.
", "smithy.api#required": {} } }, @@ -1477,12 +1650,18 @@ "smithy.api#required": {} } }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", "traits": { - "smithy.api#documentation": "The name of the global secondary index to be created.
", + "smithy.api#documentation": "Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.
", "smithy.api#required": {} } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" + } } }, "traits": { @@ -1579,17 +1758,17 @@ "smithy.api#documentation": "The AWS KMS customer master key (CMK) that should be used for AWS KMS encryption\n in the new replica. To specify a CMK, use its key ID, Amazon Resource Name (ARN),\n alias name, or alias ARN. Note that you should only provide this parameter if the\n key is different from the default DynamoDB KMS master key alias/aws/dynamodb.
" } }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "Replica-specific global secondary index settings.
" - } - }, "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { "smithy.api#documentation": "Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.
" } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "Replica-specific global secondary index settings.
" + } } }, "traits": { @@ -1625,23 +1804,17 @@ "com.amazonaws.dynamodb#CreateTableInput": { "type": "structure", "members": { - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "The name of the table to create.
", + "smithy.api#documentation": "An array of attributes that describe the key schema for the table and indexes.
", "smithy.api#required": {} } }, - "SSESpecification": { - "target": "com.amazonaws.dynamodb#SSESpecification", - "traits": { - "smithy.api#documentation": "Represents the settings used to enable server-side encryption.
" - } - }, - "AttributeDefinitions": { - "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "An array of attributes that describe the key schema for the table and indexes.
", + "smithy.api#documentation": "The name of the table to create.
", "smithy.api#required": {} } }, @@ -1652,16 +1825,22 @@ "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. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
\nEach local secondary index in the array includes the following:
\n\n IndexName - The name of the local secondary index. Must be unique only for this table.
\n KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with\n the same partition key as the table.
\n Projection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\n ProjectionType - One\n of the following:
\n KEYS_ONLY - Only the index and primary keys are projected into the\n 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 into the\n index.
\n NonKeyAttributes - A list of one or more non-key\n attribute names that are projected into the secondary index. The total\n count of attributes provided in NonKeyAttributes,\n summed across all of the secondary indexes, must not exceed 100. If you\n project the same attribute into two different indexes, this counts as\n two distinct attributes when determining the total.
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
\n\n IndexName - The name of the global secondary index. Must be unique only for this table.
\n KeySchema - Specifies the key schema for the global secondary index.
\n Projection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\n ProjectionType - One\n of the following:
\n KEYS_ONLY - Only the index and primary keys are projected into the\n 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 into the\n index.
\n NonKeyAttributes - A list of one or more non-key attribute names that are\n projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n ProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units.
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, StreamViewType\n determines what information is written to the table's stream. Valid values for\n StreamViewType are:
\n KEYS_ONLY - Only the key attributes of the modified item are written to the\n stream.
\n NEW_IMAGE - The entire item, as it appears after it was modified, is written\n to the stream.
\n OLD_IMAGE - The entire item, as it appeared before it was modified, is\n written to the stream.
\n NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are\n written to the stream.
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
\n\n PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.\n
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. If you\n 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.
" } }, - "BillingMode": { - "target": "com.amazonaws.dynamodb#BillingMode", + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", "traits": { - "smithy.api#documentation": "Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
\n\n PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.\n
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, StreamViewType\n determines what information is written to the table's stream. Valid values for\n StreamViewType are:
\n KEYS_ONLY - Only the key attributes of the modified item are written to the\n stream.
\n NEW_IMAGE - The entire item, as it appears after it was modified, is written\n to the stream.
\n OLD_IMAGE - The entire item, as it appeared before it was modified, is\n written to the stream.
\n NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are\n written to the stream.
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
\nEach local secondary index in the array includes the following:
\n\n IndexName - The name of the local secondary index. Must be unique only for this table.
\n KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with\n the same partition key as the table.
\n Projection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\n ProjectionType - One\n of the following:
\n KEYS_ONLY - Only the index and primary keys are projected into the\n 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 into the\n index.
\n NonKeyAttributes - A list of one or more non-key\n attribute names that are projected into the secondary index. The total\n count of attributes provided in NonKeyAttributes,\n summed across all of the secondary indexes, must not exceed 100. If you\n project the same attribute into two different indexes, this counts as\n two distinct attributes when determining the total.
Represents the settings used to enable server-side encryption.
" } }, "Tags": { @@ -1713,6 +1892,13 @@ "com.amazonaws.dynamodb#Delete": { "type": "structure", "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "The primary key of the item to be deleted. Each element consists of an\n attribute name and a value for that attribute.
", + "smithy.api#required": {} + } + }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -1726,11 +1912,10 @@ "smithy.api#documentation": "A condition that must be satisfied in order for a conditional delete to succeed.
" } }, - "Key": { - "target": "com.amazonaws.dynamodb#Key", + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "The primary key of the item to be deleted. Each element consists of an\n attribute name and a value for that attribute.
", - "smithy.api#required": {} + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression.
" } }, "ExpressionAttributeValues": { @@ -1739,12 +1924,6 @@ "smithy.api#documentation": "One or more values that can be substituted in an expression.
" } }, - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", - "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression.
" - } - }, "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { @@ -1864,32 +2043,45 @@ "com.amazonaws.dynamodb#DeleteItemInput": { "type": "structure", "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "The name of the table from which to delete the item.
", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "A map of attribute names to AttributeValue objects, representing the primary key of\n the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
", + "smithy.api#required": {} + } + }, "Expected": { "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", "traits": { "smithy.api#documentation": "This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.
A map of attribute names to AttributeValue objects, representing the primary key of\n the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
", - "smithy.api#required": {} + "smithy.api#documentation": "Use ReturnValues if you want to get the item attributes as they appeared before they\n were deleted. For DeleteItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its value is\n NONE, then nothing is returned. (This setting is the default for\n ReturnValues.)
\n ALL_OLD - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations; however,\n DeleteItem does not recognize any values other than NONE or\n ALL_OLD.
One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether 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 follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":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": "Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
A condition that must be satisfied in order for a conditional DeleteItem to\n succeed.
An expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type | 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.
" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "The name of the table from which to delete the item.
", - "smithy.api#required": {} - } - }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, - "ReturnItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", - "traits": { - "smithy.api#documentation": "Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
Use ReturnValues if you want to get the item attributes as they appeared before they\n were deleted. For DeleteItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its value is\n NONE, then nothing is returned. (This setting is the default for\n ReturnValues.)
\n ALL_OLD - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations; however,\n DeleteItem does not recognize any values other than NONE or\n ALL_OLD.
One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether 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 follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":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.
" } } }, @@ -1931,6 +2110,12 @@ "com.amazonaws.dynamodb#DeleteItemOutput": { "type": "structure", "members": { + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "A map of attribute names to AttributeValue objects, representing the item as it\n appeared before the DeleteItem operation. This map appears in the response only if\n ReturnValues was specified as ALL_OLD in the request.
Information about item collections, if any, that were affected by the\n DeleteItem operation.\n ItemCollectionMetrics is only returned if the\n 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\n element consists of:
\n ItemCollectionKey - The partition key value of the item\n collection. This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size,\n in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nA map of attribute names to AttributeValue objects, representing the item as it\n appeared before the DeleteItem operation. This map appears in the response only if\n ReturnValues was specified as ALL_OLD in the request.
The name of the global secondary index to describe, if applicable.
" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "The name of the table to describe.
", "smithy.api#required": {} } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "The name of the global secondary index to describe, if applicable.
" + } } } }, @@ -2202,12 +2381,6 @@ "smithy.api#documentation": "The name of the global secondary index being described.
" } }, - "FailureException": { - "target": "com.amazonaws.dynamodb#FailureException", - "traits": { - "smithy.api#documentation": "Returns information about the last failure that encountered.
\nThe most common exceptions for a FAILED status are:
\nLimitExceededException - \tPer-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for\n other tables/indexes OR disable Contributor Insights rules before retrying.
\nAccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
\nAccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
\nInternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
\nTimestamp of the last time the status was changed.
" } + }, + "FailureException": { + "target": "com.amazonaws.dynamodb#FailureException", + "traits": { + "smithy.api#documentation": "Returns information about the last failure that encountered.
\nThe most common exceptions for a FAILED status are:
\nLimitExceededException - \tPer-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for\n other tables/indexes OR disable Contributor Insights rules before retrying.
\nAccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
\nAccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
\nInternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
\nDescribes an existing table export.
" + } + }, + "com.amazonaws.dynamodb#DescribeExportInput": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the export.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dynamodb#DescribeExportOutput": { + "type": "structure", + "members": { + "ExportDescription": { + "target": "com.amazonaws.dynamodb#ExportDescription", + "traits": { + "smithy.api#documentation": "Represents the properties of the export.
" + } + } + } + }, "com.amazonaws.dynamodb#DescribeGlobalTable": { "type": "operation", "input": { @@ -2340,27 +2565,27 @@ "com.amazonaws.dynamodb#DescribeGlobalTableSettingsOutput": { "type": "structure", "members": { - "ReplicaSettings": { - "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", - "traits": { - "smithy.api#documentation": "The Region-specific settings for the global table.
" - } - }, "GlobalTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "The name of the global table.
" } + }, + "ReplicaSettings": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "The Region-specific settings for the global table.
" + } } } }, - "com.amazonaws.dynamodb#DescribeLimits": { + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination": { "type": "operation", "input": { - "target": "com.amazonaws.dynamodb#DescribeLimitsInput" + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationInput" }, "output": { - "target": "com.amazonaws.dynamodb#DescribeLimitsOutput" + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationOutput" }, "errors": [ { @@ -2368,26 +2593,78 @@ }, { "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "Returns the current provisioned-capacity quotas for your AWS account in a Region, both\n for the Region as a whole and for any one DynamoDB table that you create there.
\nWhen you establish an AWS account, the account has initial quotas on the maximum read\n capacity units and write capacity units that you can provision across all of your\n DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you\n create a table there. For more information, see Service, Account, and Table\n Quotas page in the Amazon DynamoDB Developer\n Guide.
\n\nAlthough you can increase these quotas by filing a case at AWS Support Center, obtaining the increase is not\n instantaneous. The DescribeLimits action lets you write code to compare the\n capacity you are currently using to those quotas imposed by your account so that you\n have enough time to apply for an increase before you hit a quota.
For example, you could use one of the AWS SDKs to do the following:
\n\nCall DescribeLimits for a particular Region to obtain your current\n account quotas on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for all\n your tables in that Region, and one to hold the aggregate write capacity units.\n Zero them both.
\nCall ListTables to obtain a list of all your DynamoDB tables.
For each table name listed by ListTables, do the following:
Call DescribeTable with the table name.
Use the data returned by DescribeTable to add the read capacity units and write capacity\n units provisioned for the table itself to your variables.
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
\nReport the account quotas for that Region returned by DescribeLimits, along with\n the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level quotas.
\nThe per-table quotas apply only when you are creating a new table. They restrict the sum\n 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 throttling\n errors if you call it more than once in a minute.
The DescribeLimits Request element has no content.
Returns information about the status of Kinesis streaming.
" } }, - "com.amazonaws.dynamodb#DescribeLimitsInput": { + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationInput": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Represents the input of a DescribeLimits operation. Has no content.
The name of the table being described.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationOutput": { "type": "structure", "members": { - "TableMaxWriteCapacityUnits": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "The name of the table being described.
" + } + }, + "KinesisDataStreamDestinations": { + "target": "com.amazonaws.dynamodb#KinesisDataStreamDestinations", + "traits": { + "smithy.api#documentation": "The list of replica structures for the table being described.
" + } + } + } + }, + "com.amazonaws.dynamodb#DescribeLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeLimitsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeLimitsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the current provisioned-capacity quotas for your AWS account in a Region, both\n for the Region as a whole and for any one DynamoDB table that you create there.
\nWhen you establish an AWS account, the account has initial quotas on the maximum read\n capacity units and write capacity units that you can provision across all of your\n DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you\n create a table there. For more information, see Service, Account, and Table\n Quotas page in the Amazon DynamoDB Developer\n Guide.
\n\nAlthough you can increase these quotas by filing a case at AWS Support Center, obtaining the increase is not\n instantaneous. The DescribeLimits action lets you write code to compare the\n capacity you are currently using to those quotas imposed by your account so that you\n have enough time to apply for an increase before you hit a quota.
For example, you could use one of the AWS SDKs to do the following:
\n\nCall DescribeLimits for a particular Region to obtain your current\n account quotas on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for all\n your tables in that Region, and one to hold the aggregate write capacity units.\n Zero them both.
\nCall ListTables to obtain a list of all your DynamoDB tables.
For each table name listed by ListTables, do the following:
Call DescribeTable with the table name.
Use the data returned by DescribeTable to add the read capacity units and write capacity\n units provisioned for the table itself to your variables.
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
\nReport the account quotas for that Region returned by DescribeLimits, along with\n the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level quotas.
\nThe per-table quotas apply only when you are creating a new table. They restrict the sum\n 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 throttling\n 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 content.
The maximum write capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the write capacity units\n provisioned for its global secondary indexes (GSIs).
" + "smithy.api#documentation": "The maximum total read capacity units that your account allows you to provision across\n all of your tables in this Region.
" } }, "AccountMaxWriteCapacityUnits": { @@ -2402,10 +2679,10 @@ "smithy.api#documentation": "The maximum read capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the read capacity units\n provisioned for its global secondary indexes (GSIs).
" } }, - "AccountMaxReadCapacityUnits": { + "TableMaxWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "The maximum total read capacity units that your account allows you to provision across\n all of your tables in this Region.
" + "smithy.api#documentation": "The maximum write capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the write capacity units\n provisioned for its global secondary indexes (GSIs).
" } } }, @@ -2554,16 +2831,82 @@ } } }, + "com.amazonaws.dynamodb#DestinationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLING" + }, + { + "value": "ACTIVE" + }, + { + "value": "DISABLING" + }, + { + "value": "DISABLED" + }, + { + "value": "ENABLE_FAILED" + } + ] + } + }, + "com.amazonaws.dynamodb#DisableKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" + }, + "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": { + "smithy.api#documentation": "Stops replication from the DynamoDB table to the Kinesis data stream. This is done\n without deleting either of the resources.
" + } + }, "com.amazonaws.dynamodb#Double": { "type": "double", "traits": { "smithy.api#box": {} } }, + "com.amazonaws.dynamodb#DuplicateItemException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "\nThere was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.\n
", + "smithy.api#error": "client" + } + }, "com.amazonaws.dynamodb#DynamoDB_20120810": { "type": "service", "version": "2012-08-10", "operations": [ + { + "target": "com.amazonaws.dynamodb#BatchExecuteStatement" + }, { "target": "com.amazonaws.dynamodb#BatchGetItem" }, @@ -2600,12 +2943,18 @@ { "target": "com.amazonaws.dynamodb#DescribeEndpoints" }, + { + "target": "com.amazonaws.dynamodb#DescribeExport" + }, { "target": "com.amazonaws.dynamodb#DescribeGlobalTable" }, { "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettings" }, + { + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination" + }, { "target": "com.amazonaws.dynamodb#DescribeLimits" }, @@ -2618,6 +2967,21 @@ { "target": "com.amazonaws.dynamodb#DescribeTimeToLive" }, + { + "target": "com.amazonaws.dynamodb#DisableKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#ExecuteStatement" + }, + { + "target": "com.amazonaws.dynamodb#ExecuteTransaction" + }, + { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTime" + }, { "target": "com.amazonaws.dynamodb#GetItem" }, @@ -2627,6 +2991,9 @@ { "target": "com.amazonaws.dynamodb#ListContributorInsights" }, + { + "target": "com.amazonaws.dynamodb#ListExports" + }, { "target": "com.amazonaws.dynamodb#ListGlobalTables" }, @@ -2710,20 +3077,49 @@ } } }, + "com.amazonaws.dynamodb#EnableKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" + }, + "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": { + "smithy.api#documentation": "Starts table data replication to the specified Kinesis data stream at a timestamp chosen\n during the enable workflow. If this operation doesn't return results immediately, use\n DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is\n ACTIVE.
" + } + }, "com.amazonaws.dynamodb#Endpoint": { "type": "structure", "members": { - "CachePeriodInMinutes": { - "target": "com.amazonaws.dynamodb#Long", + "Address": { + "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "Endpoint cache time to live (TTL) value.
", + "smithy.api#documentation": "IP address of the endpoint.
", "smithy.api#required": {} } }, - "Address": { - "target": "com.amazonaws.dynamodb#String", + "CachePeriodInMinutes": { + "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "IP address of the endpoint.
", + "smithy.api#documentation": "Endpoint cache time to live (TTL) value.
", "smithy.api#required": {} } } @@ -2747,113 +3143,599 @@ "com.amazonaws.dynamodb#ExceptionName": { "type": "string" }, - "com.amazonaws.dynamodb#ExpectedAttributeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.dynamodb#AttributeName" + "com.amazonaws.dynamodb#ExecuteStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExecuteStatementInput" }, - "value": { - "target": "com.amazonaws.dynamodb#ExpectedAttributeValue" + "output": { + "target": "com.amazonaws.dynamodb#ExecuteStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#DuplicateItemException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "smithy.api#documentation": "\nThis operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.\n
" } }, - "com.amazonaws.dynamodb#ExpectedAttributeValue": { + "com.amazonaws.dynamodb#ExecuteStatementInput": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.dynamodb#AttributeValue", + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", "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 the value is the data itself.
\nFor more information, see Data Types in the\n Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "\nThe PartiQL statement representing the operation to run.\n
", + "smithy.api#required": {} } }, - "AttributeValueList": { - "target": "com.amazonaws.dynamodb#AttributeValueList", + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", "traits": { - "smithy.api#documentation": "One or more values to evaluate against the supplied attribute. The number of values in the\n 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 character\n code values. For example, a is greater than A, and a\n 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 compares binary values.
\nFor information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "\nThe parameters for the PartiQL statement, if any.\n
" } }, - "Exists": { - "target": "com.amazonaws.dynamodb#BooleanObject", + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "Causes DynamoDB to evaluate the value before attempting a conditional operation:
\nIf Exists is true, DynamoDB will check to see if that attribute value\n already exists in the table. If it is found, then the operation succeeds. If it is not\n found, the operation fails with a ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the assumption\n is valid and the operation succeeds. If the value is found, despite the assumption that it\n does not exist, the operation fails with a ConditionCheckFailedException.
The default setting for Exists is true. If you supply a Value all\n by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.
DynamoDB returns a ValidationException if:
\n Exists is true but there is no Value to check. (You expect a\n value to exist, but don't specify what that value is.)
\n Exists is false but you also provide a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
\nThe consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.\n
A comparator for evaluating attributes in the AttributeValueList. For example, equals,\n 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 | BEGINS_WITH | IN | BETWEEN\n
The following are descriptions of each comparison operator.
\n\n EQ : Equal. EQ is supported for all data types, including lists and maps.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different\n type 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\", \"1\"]}.
\n NE : Not equal. NE is supported for all data types, including lists and maps.
\n AttributeValueList can contain only one AttributeValue of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different\n type 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\", \"1\"]}.
\n LE : Less than or equal.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n LT : Less than.
\n AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GE : Greater than or equal.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GT : Greater than.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
\n NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
\n CONTAINS : Checks for a subsequence, or value in a set.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then\n the operator checks for a substring match. If the target attribute of the comparison is\n of type Binary, 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\", \"NS\", or \"BS\"), then the\n operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
\n NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in\n a set.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If the target attribute of the comparison is a String, then\n the operator checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operator checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
\n BEGINS_WITH : Checks for a prefix.
\n AttributeValueList can contain only one AttributeValue of type String or\n Binary (not a Number or a set type). The target attribute of the comparison must be of type String or\n Binary (not a Number or a set type).
\n IN : Checks for matching elements in a list.
\n AttributeValueList can contain one or more AttributeValue\n elements of type String, Number, or Binary. These attributes are compared against an\n existing attribute of an item. If any elements of the input are equal to the item\n attribute, the expression evaluates to true.
\n BETWEEN : Greater than or equal to the first value, and less than or equal\n to the second value.
\n AttributeValueList must contain two AttributeValue elements of the same\n type, either String, Number, or Binary (not a set type). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an AttributeValue element of a different type than\n the one 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\", \"1\"]}\n
\nSet this value to get remaining results, if NextToken was returned in the statement response.\n
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 against an\n attribute. Use ComparisonOperator to specify how you want to perform the\n comparison. If the comparison evaluates to true, then the conditional operation\n succeeds.
Use Value to specify a value that DynamoDB will compare against an attribute. If the\n values match, then ExpectedAttributeValue evaluates to true and the conditional\n operation succeeds. Optionally, you can also set Exists to false, indicating that\n you do not expect to find the attribute value in the table. In this case, the\n conditional operation succeeds only if the comparison evaluates to false.
\n Value and Exists are incompatible with AttributeValueList and\n ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will\n return a ValidationException exception.
Description of the failure.
" + "smithy.api#documentation": "\nIf a read operation was used, this property will contain the result of the reade operation; a map of attribute names and their values. For the write operations this value will be empty.\n
" } }, - "ExceptionName": { - "target": "com.amazonaws.dynamodb#ExceptionName", + "NextToken": { + "target": "com.amazonaws.dynamodb#PartiQLNextToken", "traits": { - "smithy.api#documentation": "Exception name.
" + "smithy.api#documentation": "\nIf the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.\n
" } } + } + }, + "com.amazonaws.dynamodb#ExecuteTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExecuteTransactionInput" }, + "output": { + "target": "com.amazonaws.dynamodb#ExecuteTransactionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionCanceledException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionInProgressException" + } + ], "traits": { - "smithy.api#documentation": "Represents a failure a contributor insights operation.
" + "smithy.api#documentation": "\nThis operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.\n
" } }, - "com.amazonaws.dynamodb#FilterConditionMap": { + "com.amazonaws.dynamodb#ExecuteTransactionInput": { + "type": "structure", + "members": { + "TransactStatements": { + "target": "com.amazonaws.dynamodb#ParameterizedStatements", + "traits": { + "smithy.api#documentation": "\nThe list of PartiQL statements representing the transaction to run.\n
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.dynamodb#ClientRequestToken", + "traits": { + "smithy.api#documentation": "\nSet this value to get remaining results, if NextToken was returned in the statement response.\n
\nThe response to a PartiQL transaction.\n
" + } + } + } + }, + "com.amazonaws.dynamodb#ExpectedAttributeMap": { "type": "map", "key": { "target": "com.amazonaws.dynamodb#AttributeName" }, "value": { - "target": "com.amazonaws.dynamodb#Condition" + "target": "com.amazonaws.dynamodb#ExpectedAttributeValue" } }, - "com.amazonaws.dynamodb#Get": { + "com.amazonaws.dynamodb#ExpectedAttributeValue": { "type": "structure", "members": { - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "Value": { + "target": "com.amazonaws.dynamodb#AttributeValue", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in the\n ProjectionExpression parameter.
" + "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 the value is the data itself.
\nFor more information, see Data Types in the\n Amazon DynamoDB Developer Guide.
" } }, - "ProjectionExpression": { - "target": "com.amazonaws.dynamodb#ProjectionExpression", + "Exists": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "Causes DynamoDB to evaluate the value before attempting a conditional operation:
\nIf Exists is true, DynamoDB will check to see if that attribute value\n already exists in the table. If it is found, then the operation succeeds. If it is not\n found, the operation fails with a ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the assumption\n is valid and the operation succeeds. If the value is found, despite the assumption that it\n does not exist, the operation fails with a ConditionCheckFailedException.
The default setting for Exists is true. If you supply a Value all\n by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.
DynamoDB returns a ValidationException if:
\n Exists is true but there is no Value to check. (You expect a\n value to exist, but don't specify what that value is.)
\n Exists is false but you also provide a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
A comparator for evaluating attributes in the AttributeValueList. For example, equals,\n 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 | BEGINS_WITH | IN | BETWEEN\n
The following are descriptions of each comparison operator.
\n\n EQ : Equal. EQ is supported for all data types, including lists and maps.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different\n type 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\", \"1\"]}.
\n NE : Not equal. NE is supported for all data types, including lists and maps.
\n AttributeValueList can contain only one AttributeValue of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different\n type 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\", \"1\"]}.
\n LE : Less than or equal.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n LT : Less than.
\n AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GE : Greater than or equal.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n GT : Greater than.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If an item contains an AttributeValue element of a different\n type 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 compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
\n NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
\n NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
\n CONTAINS : Checks for a subsequence, or value in a set.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then\n the operator checks for a substring match. If the target attribute of the comparison is\n of type Binary, 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\", \"NS\", or \"BS\"), then the\n operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
\n NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in\n a set.
\n AttributeValueList can contain only one AttributeValue element of type String,\n Number, or Binary (not a set type). If the target attribute of the comparison is a String, then\n the operator checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operator checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
\n BEGINS_WITH : Checks for a prefix.
\n AttributeValueList can contain only one AttributeValue of type String or\n Binary (not a Number or a set type). The target attribute of the comparison must be of type String or\n Binary (not a Number or a set type).
\n IN : Checks for matching elements in a list.
\n AttributeValueList can contain one or more AttributeValue\n elements of type String, Number, or Binary. These attributes are compared against an\n existing attribute of an item. If any elements of the input are equal to the item\n attribute, the expression evaluates to true.
\n BETWEEN : Greater than or equal to the first value, and less than or equal\n to the second value.
\n AttributeValueList must contain two AttributeValue elements of the same\n type, either String, Number, or Binary (not a set type). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an AttributeValue element of a different type than\n the one 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\", \"1\"]}\n
One or more values to evaluate against the supplied attribute. The number of values in the\n 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 character\n code values. For example, a is greater than A, and a\n 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 compares binary values.
\nFor information on specifying data types in JSON, see JSON Data Format 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 against an\n attribute. Use ComparisonOperator to specify how you want to perform the\n comparison. If the comparison evaluates to true, then the conditional operation\n succeeds.
Use Value to specify a value that DynamoDB will compare against an attribute. If the\n values match, then ExpectedAttributeValue evaluates to true and the conditional\n operation succeeds. Optionally, you can also set Exists to false, indicating that\n you do not expect to find the attribute value in the table. In this case, the\n conditional operation succeeds only if the comparison evaluates to false.
\n Value and Exists are incompatible with AttributeValueList and\n ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will\n return a ValidationException exception.
There was a conflict when writing to the specified S3 bucket.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportDescription": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the table export.
" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ExportStartTime", + "traits": { + "smithy.api#documentation": "The time at which the export task began.
" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ExportEndTime", + "traits": { + "smithy.api#documentation": "The time at which the export task completed.
" + } + }, + "ExportManifest": { + "target": "com.amazonaws.dynamodb#ExportManifest", + "traits": { + "smithy.api#documentation": "The name of the manifest file for the export task.
" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the table that was exported.
" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "Unique ID of the table that was exported.
" + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "Point in time from which table data was exported.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "The client token that was provided for the export task. A client token makes calls to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.
The name of the Amazon S3 bucket containing the export.
" + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the bucket containing the export.
" + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket prefix used as the file name and path of the exported\n snapshot.
" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "Type of encryption used on the bucket where export data is stored. Valid values\n for S3SseAlgorithm are:
\n AES256 - server-side encryption with Amazon S3 managed keys
\n KMS - server-side encryption with AWS KMS managed keys
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data is\n stored (if applicable).
" + } + }, + "FailureCode": { + "target": "com.amazonaws.dynamodb#FailureCode", + "traits": { + "smithy.api#documentation": "Status code for the result of the failed export.
" + } + }, + "FailureMessage": { + "target": "com.amazonaws.dynamodb#FailureMessage", + "traits": { + "smithy.api#documentation": "Export failure reason description.
" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "The format of the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.
The billable size of the table export.
" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", + "traits": { + "smithy.api#documentation": "The number of items exported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the properties of the exported table.
" + } + }, + "com.amazonaws.dynamodb#ExportEndTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DYNAMODB_JSON", + "name": "DYNAMODB_JSON" + }, + { + "value": "ION", + "name": "ION" + } + ] + } + }, + "com.amazonaws.dynamodb#ExportManifest": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNextToken": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified export was not found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportStartTime": { + "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" + } + ] + } + }, + "com.amazonaws.dynamodb#ExportSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ExportSummary" + } + }, + "com.amazonaws.dynamodb#ExportSummary": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the export.
" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about an export task.
" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ExportConflictException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidExportTimeException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Exports table data to an S3 bucket. The table must have point in time recovery\n enabled, and you can export data from any time within the point in time recovery\n window.
" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTimeInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the table to export.
", + "smithy.api#required": {} + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "Time in the past from which to export table data. The table export will be a snapshot\n of the table's state at this point in time.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "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\n completed. After 8 hours, 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 8\n hours, 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 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.
The name of the Amazon S3 bucket to export the snapshot to.
", + "smithy.api#required": {} + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the bucket the export will be stored in.
" + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket prefix to use as the file name and path of the exported\n snapshot.
" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "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 keys
\n KMS - server-side encryption with AWS KMS managed keys
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will\n be stored (if applicable).
" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "The format for the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.
Contains a description of the table export.
" + } + } + } + }, + "com.amazonaws.dynamodb#ExportTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExpressionAttributeNameMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameVariable" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeName" + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeNameVariable": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExpressionAttributeValueMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueVariable" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeValueVariable": { + "type": "string" + }, + "com.amazonaws.dynamodb#FailureCode": { + "type": "string" + }, + "com.amazonaws.dynamodb#FailureException": { + "type": "structure", + "members": { + "ExceptionName": { + "target": "com.amazonaws.dynamodb#ExceptionName", + "traits": { + "smithy.api#documentation": "Exception name.
" + } + }, + "ExceptionDescription": { + "target": "com.amazonaws.dynamodb#ExceptionDescription", + "traits": { + "smithy.api#documentation": "Description of the failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a failure a contributor insights operation.
" + } + }, + "com.amazonaws.dynamodb#FailureMessage": { + "type": "string" + }, + "com.amazonaws.dynamodb#FilterConditionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#Condition" + } + }, + "com.amazonaws.dynamodb#Get": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "A string that identifies one or more attributes of the specified item\n to retrieve from the table. The attributes in the expression must be\n separated by commas. If no attribute names are specified, then all\n attributes of the specified item are returned. If any of the requested\n attributes are not found, they do not appear in the result.
" + "smithy.api#documentation": "A map of attribute names to AttributeValue objects that\n specifies the primary key of the item to retrieve.
A map of attribute names to AttributeValue objects that\n specifies the primary key of the item to retrieve.
A string that identifies one or more attributes of the specified item\n to retrieve from the table. The attributes in the expression must be\n separated by commas. If no attribute names are specified, then all\n attributes of the specified item are returned. If any of the requested\n attributes are not found, they do not appear in the result.
" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "One or more substitution tokens for attribute names in the\n ProjectionExpression parameter.
" } } }, @@ -2907,12 +3794,6 @@ "com.amazonaws.dynamodb#GetItemInput": { "type": "structure", "members": { - "ConsistentRead": { - "target": "com.amazonaws.dynamodb#ConsistentRead", - "traits": { - "smithy.api#documentation": "Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the 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": "A map of attribute names to AttributeValue objects, representing the primary key of\n the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
", + "smithy.api#required": {} } }, "AttributesToGet": { @@ -2935,18 +3814,26 @@ "smithy.api#documentation": "This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.
A map of attribute names to AttributeValue objects, representing the primary key of\n the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
", - "smithy.api#required": {} + "smithy.api#documentation": "Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the 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 are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" + } } }, "traits": { @@ -2976,19 +3863,6 @@ "com.amazonaws.dynamodb#GlobalSecondaryIndex": { "type": "structure", "members": { - "Projection": { - "target": "com.amazonaws.dynamodb#Projection", - "traits": { - "smithy.api#documentation": "Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.
", - "smithy.api#required": {} - } - }, - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", - "traits": { - "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" - } - }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { @@ -3002,6 +3876,19 @@ "smithy.api#documentation": "The complete key schema for a global secondary index, which consists of one or more 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nRepresents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.
", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" + } } }, "traits": { @@ -3039,16 +3926,16 @@ "com.amazonaws.dynamodb#GlobalSecondaryIndexDescription": { "type": "structure", "members": { - "IndexSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" + "smithy.api#documentation": "The name of the global secondary index.
" } }, - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "The complete key schema for a global secondary index, which consists of one or more 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nRepresents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.
" } }, - "IndexArn": { - "target": "com.amazonaws.dynamodb#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the index.
" - } - }, - "KeySchema": { - "target": "com.amazonaws.dynamodb#KeySchema", - "traits": { - "smithy.api#documentation": "The complete key schema for a global secondary index, which consists of one or more 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key 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 name of the global secondary index.
" - } - }, "Backfilling": { "target": "com.amazonaws.dynamodb#Backfilling", "traits": { "smithy.api#documentation": "Indicates whether the index is currently backfilling. Backfilling is the process of reading items from \n the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key \n cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, \n the backfilling operation is complete and Backfilling is false.
You can delete an index that is being created during the Backfilling phase\n when IndexStatus is set to CREATING and Backfilling is true. You\n can't delete the index that is being created when IndexStatus is set to\n CREATING and Backfilling is false.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#Long", + "traits": { + "smithy.api#documentation": "The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" + } + }, "ItemCount": { "target": "com.amazonaws.dynamodb#Long", "traits": { "smithy.api#documentation": "The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" } + }, + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the index.
" + } } }, "traits": { @@ -3151,17 +4038,17 @@ "smithy.api#documentation": "The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
" } }, - "Delete": { - "target": "com.amazonaws.dynamodb#DeleteGlobalSecondaryIndexAction", - "traits": { - "smithy.api#documentation": "The name of an existing global secondary index to be removed.
" - } - }, "Create": { "target": "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction", "traits": { "smithy.api#documentation": "The parameters required for creating a global secondary index on an existing table:
\n\n IndexName \n
\n KeySchema \n
\n AttributeDefinitions \n
\n Projection \n
\n ProvisionedThroughput \n
The name of an existing global secondary index to be removed.
" + } } }, "traits": { @@ -3218,22 +4105,16 @@ "com.amazonaws.dynamodb#GlobalTableDescription": { "type": "structure", "members": { - "GlobalTableArn": { - "target": "com.amazonaws.dynamodb#GlobalTableArnString", - "traits": { - "smithy.api#documentation": "The unique identifier of the global table.
" - } - }, "ReplicationGroup": { "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", "traits": { "smithy.api#documentation": "The Regions where the global table has replicas.
" } }, - "GlobalTableName": { - "target": "com.amazonaws.dynamodb#TableName", + "GlobalTableArn": { + "target": "com.amazonaws.dynamodb#GlobalTableArnString", "traits": { - "smithy.api#documentation": "The global table name.
" + "smithy.api#documentation": "The unique identifier of the global table.
" } }, "CreationDateTime": { @@ -3247,6 +4128,12 @@ "traits": { "smithy.api#documentation": "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.
The global table name.
" + } } }, "traits": { @@ -3256,12 +4143,6 @@ "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdate": { "type": "structure", "members": { - "ProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.dynamodb#PositiveLongObject", - "traits": { - "smithy.api#documentation": "The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n
The specified ExportTime is outside of the point in time recovery\n window.
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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nThe name of a key attribute.
", "smithy.api#required": {} } }, - "AttributeName": { - "target": "com.amazonaws.dynamodb#KeySchemaAttributeName", + "KeyType": { + "target": "com.amazonaws.dynamodb#KeyType", "traits": { - "smithy.api#documentation": "The name of a key attribute.
", + "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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nOne or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the actual value at runtime.
\nFor more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
" - } - }, "AttributesToGet": { "target": "com.amazonaws.dynamodb#AttributeNameList", "traits": { @@ -3670,12 +4563,92 @@ "traits": { "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by\n commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
\nFor more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
" } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the actual value at runtime.
\nFor more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
" + } } }, "traits": { "smithy.api#documentation": "Represents a set of primary keys and, for each key, the attributes to retrieve from the table.
\nFor each primary key, you must provide all of the key attributes. For example, with a\n simple primary key, you only need to provide the partition key. For a composite\n primary key, you must provide both the partition key 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#LastUpdateDateTime": { "type": "timestamp" }, @@ -3723,28 +4696,22 @@ "com.amazonaws.dynamodb#ListBackupsInput": { "type": "structure", "members": { - "BackupType": { - "target": "com.amazonaws.dynamodb#BackupTypeFilter", - "traits": { - "smithy.api#documentation": "The backups from the table specified by BackupType are listed.
Where BackupType can be:
\n USER - On-demand backup created by you.
\n SYSTEM - On-demand backup automatically created by\n DynamoDB.
\n ALL - All types of on-demand backups (USER and SYSTEM).
Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
The backups from the table specified by TableName are listed.
\n LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last\n evaluated when the current page of results was returned, inclusive of the current page\n of results. This value may be specified as the ExclusiveStartBackupArn of a\n new ListBackups operation in order to fetch the next page of results.
Maximum number of backups to return at once.
" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "TimeRangeLowerBound": { + "target": "com.amazonaws.dynamodb#TimeRangeLowerBound", "traits": { - "smithy.api#documentation": "The backups from the table specified by TableName are listed.
Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
Maximum number of backups to return at once.
" + "smithy.api#documentation": "\n LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last\n evaluated when the current page of results was returned, inclusive of the current page\n of results. This value may be specified as the ExclusiveStartBackupArn of a\n new ListBackups operation in order to fetch the next page of results.
The backups from the table specified by BackupType are listed.
Where BackupType can be:
\n USER - On-demand backup created by you.
\n SYSTEM - On-demand backup automatically created by\n DynamoDB.
\n ALL - All types of on-demand backups (USER and SYSTEM).
\n 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 order to fetch the next page of results.\n
\n If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no\n more results to be retrieved.\n
If LastEvaluatedBackupArn is not empty, this may or may not indicate that\n there is more data to be returned. All results are guaranteed to have been returned if\n and only if no value for LastEvaluatedBackupArn is returned.
List of BackupSummary objects.
\n 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 order to fetch the next page of results.\n
\n If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no\n more results to be retrieved.\n
If LastEvaluatedBackupArn is not empty, this may or may not indicate that\n there is more data to be returned. All results are guaranteed to have been returned if\n and only if no value for LastEvaluatedBackupArn is returned.
A list of ContributorInsightsSummary.
" + } + }, "NextToken": { "target": "com.amazonaws.dynamodb#NextTokenString", "traits": { "smithy.api#documentation": "A token to go to the next page if there is one.
" } + } + } + }, + "com.amazonaws.dynamodb#ListExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListExportsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListExportsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Lists completed exports within the past 90 days.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.dynamodb#ListExportsInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the exported table.
" + } }, - "ContributorInsightsSummaries": { - "target": "com.amazonaws.dynamodb#ContributorInsightsSummaries", + "MaxResults": { + "target": "com.amazonaws.dynamodb#ListExportsMaxLimit", "traits": { - "smithy.api#documentation": "A list of ContributorInsightsSummary.
" + "smithy.api#documentation": "Maximum number of results to return per page.
" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ExportNextToken", + "traits": { + "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.
A list of ExportSummary objects.
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 the global tables in a specific Region.
" + "smithy.api#documentation": "The first global table name that this operation will evaluate.
" } }, "Limit": { @@ -3886,10 +4934,10 @@ "smithy.api#documentation": "The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.
\nIf the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point,\n with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.
The first global table name that this operation will evaluate.
" + "smithy.api#documentation": "Lists the global tables in a specific Region.
" } } } @@ -3940,17 +4988,17 @@ "com.amazonaws.dynamodb#ListTablesInput": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.dynamodb#ListTablesInputLimit", - "traits": { - "smithy.api#documentation": "A maximum number of table names to return. If this parameter is not specified, the limit is 100.
" - } - }, "ExclusiveStartTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "The first table name that this operation will evaluate. Use the value that was returned for\n LastEvaluatedTableName in a previous operation, so that you can obtain the next page\n of results.
A maximum number of table names to return. If this parameter is not specified, the limit is 100.
" + } } }, "traits": { @@ -3970,17 +5018,17 @@ "com.amazonaws.dynamodb#ListTablesOutput": { "type": "structure", "members": { - "LastEvaluatedTableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "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 results, until\n all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that\n there are no more table names to be retrieved.
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
\nIf LastEvaluatedTableName also appears in the output, you can use this value as the\n ExclusiveStartTableName parameter in a subsequent ListTables request and\n 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 results, until\n all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that\n there are no more table names to be retrieved.
If this value is returned, there are additional results to be displayed. To retrieve them,\n call ListTagsOfResource again, with NextToken set to this value.
" - } - }, "Tags": { "target": "com.amazonaws.dynamodb#TagList", "traits": { "smithy.api#documentation": "The tags currently associated with the Amazon DynamoDB resource.
" } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "If this value is returned, there are additional results to be displayed. To retrieve them,\n call ListTagsOfResource again, with NextToken set to this value.
" + } } } }, @@ -4083,16 +5131,10 @@ "smithy.api#documentation": "Represents the name of the local secondary index.
" } }, - "IndexArn": { - "target": "com.amazonaws.dynamodb#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the index.
" - } - }, - "IndexSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" + "smithy.api#documentation": "The complete key schema for the local secondary index, consisting of one or more 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nRepresents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.
" } }, - "KeySchema": { - "target": "com.amazonaws.dynamodb#KeySchema", + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "The complete key schema for the local secondary index, consisting of one or more 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nThe total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" } }, "ItemCount": { @@ -4112,6 +5154,12 @@ "traits": { "smithy.api#documentation": "The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" } + }, + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the index.
" + } } }, "traits": { @@ -4127,18 +5175,18 @@ "com.amazonaws.dynamodb#LocalSecondaryIndexInfo": { "type": "structure", "members": { - "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 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nRepresents the name of the local secondary index.
" } }, + "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 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\n\nA PartiQL statment that uses parameters.\n
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "\nThe parameter values.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nRepresents a PartiQL statment that uses parameters.\n
" + } + }, + "com.amazonaws.dynamodb#ParameterizedStatements": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ParameterizedStatement" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#PartiQLBatchRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BatchStatementRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#PartiQLBatchResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BatchStatementResponse" + } + }, + "com.amazonaws.dynamodb#PartiQLNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + } + } + }, + "com.amazonaws.dynamodb#PartiQLStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, "com.amazonaws.dynamodb#PointInTimeRecoveryDescription": { "type": "structure", "members": { + "PointInTimeRecoveryStatus": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", + "traits": { + "smithy.api#documentation": "The current state of point in time recovery:
\n\n ENABLING - Point in time recovery is being enabled.
\n ENABLED - Point in time recovery is enabled.
\n DISABLED - Point in time recovery is disabled.
\n LatestRestorableDateTime is typically 5 minutes before the current time.\n
The current state of point in time recovery:
\n\n ENABLING - Point in time recovery is being enabled.
\n ENABLED - Point in time recovery is enabled.
\n DISABLED - Point in time recovery is disabled.
The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.
The date and time of the last provisioned throughput increase for this table.
" } }, - "LastIncreaseDateTime": { + "LastDecreaseDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "The date and time of the last provisioned throughput increase for this table.
" + "smithy.api#documentation": "The date and time of the last provisioned throughput decrease for this table.
" } }, "NumberOfDecreasesToday": { @@ -4394,10 +5522,10 @@ "smithy.api#documentation": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
The date and time of the last provisioned throughput decrease for this table.
" + "smithy.api#documentation": "The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.
One or more values that can be substituted in an expression.
" + "smithy.api#documentation": "A map of attribute name to attribute values, representing the primary key\n of the item to be written by PutItem. All of the table's primary key\n attributes must be specified, and their data types must match those of the table's\n key schema. If any attributes are present in the item that are part of an index\n key schema for the table, their types must match the index key schema.
A condition that must be satisfied in order for a conditional update to succeed.
" } }, - "ReturnValuesOnConditionCheckFailure": { - "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", - "traits": { - "smithy.api#documentation": "Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Put condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.
One or more substitution tokens for attribute names in an expression.
" } }, - "Item": { - "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "A map of attribute name to attribute values, representing the primary key\n of the item to be written by PutItem. All of the table's primary key\n attributes must be specified, and their data types must match those of the table's\n key schema. If any attributes are present in the item that are part of an index\n key schema for the table, their types must match the index key schema.
One or more values that can be substituted in an expression.
" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Put condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.
Use ReturnValues if you want to get the item attributes as they appeared before they\n were updated with the PutItem request. For PutItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its value is\n NONE, then nothing is returned. (This setting is the default for\n ReturnValues.)
\n ALL_OLD - If PutItem overwrote an attribute name-value pair, then the\n content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations; however,\n PutItem does not recognize any values other than NONE or\n ALL_OLD.
Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the 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": "This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.
A condition that must be satisfied in order for a conditional PutItem operation to\n succeed.
An expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type | 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": "Use ReturnValues if you want to get the item attributes as they appeared before they\n were updated with the PutItem request. For PutItem, the valid values are:
\n NONE - If ReturnValues is not specified, or if its value is\n NONE, then nothing is returned. (This setting is the default for\n ReturnValues.)
\n ALL_OLD - If PutItem overwrote an attribute name-value pair, then the\n content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations; however,\n PutItem does not recognize any values other than NONE or\n ALL_OLD.
This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.
Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.
A condition that must be satisfied in order for a conditional PutItem operation to\n succeed.
An expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type | 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 are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the 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": { @@ -4597,10 +5725,10 @@ "com.amazonaws.dynamodb#PutItemOutput": { "type": "structure", "members": { - "ItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { - "smithy.api#documentation": "Information about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics\n is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local\n secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics\n element consists of:
\n ItemCollectionKey - The partition key value of the item\n collection. This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size,\n in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nThe attribute values as they appeared before the PutItem operation, but only if\n ReturnValues is specified as ALL_OLD in the request. Each element\n consists of an attribute name and an attribute value.
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 attribute values as they appeared before the PutItem operation, but only if\n ReturnValues is specified as ALL_OLD in the request. Each element\n consists of an attribute name and an attribute value.
Information about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics\n is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local\n secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics\n element consists of:
\n ItemCollectionKey - The partition key value of the item\n collection. This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size,\n in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nThe name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that\n if you use the IndexName parameter, you must also provide TableName.\n
This is a legacy parameter. Use KeyConditionExpression instead. For more information, see\n KeyConditions in the Amazon DynamoDB Developer Guide.
Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
\nIf ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer 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 expression attribute values, which are placeholders for the 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": "The attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n 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\n index is configured to project all attributes, this return value is\n equivalent to 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 AttributesToGet. This return value is equivalent to\n specifying AttributesToGet without specifying any value\n for 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\n attributes that are projected into the index. Global secondary index queries\n cannot fetch attributes from the parent table.
\nIf neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)
If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.
This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use FilterExpression instead. For more information, see\n QueryFilter in the Amazon DynamoDB Developer Guide.
One or more values that can be substituted in an expression.
\nUse the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the\n ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":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 Guide.
" - } - }, - "ProjectionExpression": { - "target": "com.amazonaws.dynamodb#ProjectionExpression", + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
\nIf no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
\nFor more information, see\n Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n 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. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.
Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads\n are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.
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\n sort key value. This allows Query to retrieve one item with a given\n partition key value and sort key value, or several items that have the same partition\n key value but different sort key values.
The partition key equality test is required, and must be specified in the following 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 AND with the condition\n for the sort key. Following is an example, using 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 :sortkeyval.
\n sortKeyName\n <\n :sortkeyval - true if the sort key value is less than :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 :sortkeyval.
\n sortKeyName\n >= \n :sortkeyval - true if the sort key value is greater than\n or equal to :sortkeyval.
\n sortKeyName\n BETWEEN\n :sortkeyval1\n AND\n :sortkeyval2 - true if the sort key value is greater than or equal to\n :sortkeyval1, and less than or equal to :sortkeyval2.
\n begins_with (\n sortKeyName, :sortkeyval\n ) -\n true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name\n begins_with is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of\n the partition key and sort key with placeholder tokens. This option might be necessary if an attribute\n name conflicts with a DynamoDB reserved word. For example, the following\n KeyConditionExpression parameter causes an error because Size is a reserved\n word:
\n Size = :myval\n
To work around this, define a placeholder (such a #S) to represent the attribute\n name Size. KeyConditionExpression then is as follows:
\n #S = :myval\n
For a list of reserved words, see Reserved\n Words in the Amazon DynamoDB Developer Guide.
\n\nFor more information on ExpressionAttributeNames and ExpressionAttributeValues,\n see Using Placeholders for Attribute\n Names and Values in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use KeyConditionExpression instead. For more information, see\n KeyConditions in the Amazon DynamoDB Developer Guide.
The attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n 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\n index is configured to project all attributes, this return value is\n equivalent to 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 AttributesToGet. This return value is equivalent to\n specifying AttributesToGet without specifying any value\n for 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\n attributes that are projected into the index. Global secondary index queries\n cannot fetch attributes from the parent table.
\nIf neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)
If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.
This is a legacy parameter. Use FilterExpression instead. For more information, see\n QueryFilter in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.
The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n 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. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.
Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
\nIf ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in 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 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 attributes can include scalars, sets, or elements of a JSON document. 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 the requested attributes are not found, they will not appear in the result.
\nFor more information, see\n Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
" + } + }, "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Query operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.
For more information, see Filter\n Expressions in the Amazon DynamoDB Developer 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\n sort key value. This allows Query to retrieve one item with a given\n partition key value and sort key value, or several items that have the same partition\n key value but different sort key values.
The partition key equality test is required, and must be specified in the following 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 AND with the condition\n for the sort key. Following is an example, using 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 :sortkeyval.
\n sortKeyName\n <\n :sortkeyval - true if the sort key value is less than :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 :sortkeyval.
\n sortKeyName\n >= \n :sortkeyval - true if the sort key value is greater than\n or equal to :sortkeyval.
\n sortKeyName\n BETWEEN\n :sortkeyval1\n AND\n :sortkeyval2 - true if the sort key value is greater than or equal to\n :sortkeyval1, and less than or equal to :sortkeyval2.
\n begins_with (\n sortKeyName, :sortkeyval\n ) -\n true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name\n begins_with is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of\n the partition key and sort key with placeholder tokens. This option might be necessary if an attribute\n name conflicts with a DynamoDB reserved word. For example, the following\n KeyConditionExpression parameter causes an error because Size is a reserved\n word:
\n Size = :myval\n
To work around this, define a placeholder (such a #S) to represent the attribute\n name Size. KeyConditionExpression then is as follows:
\n #S = :myval\n
For a list of reserved words, see Reserved\n Words in the Amazon DynamoDB Developer Guide.
\n\nFor more information on ExpressionAttributeNames and ExpressionAttributeValues,\n see Using Placeholders for Attribute\n Names and Values in the Amazon DynamoDB Developer Guide.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer 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 expression attribute values, which are placeholders for the 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 dereference an attribute value. For example, suppose that you wanted to check whether the value of the\n ProductStatus attribute was one of the following:
\n\n Available | Backordered | Discontinued\n
You would first need to specify ExpressionAttributeValues as follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":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 Guide.
" + } } }, "traits": { @@ -4781,16 +5909,10 @@ "smithy.api#documentation": "An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
" } }, - "LastEvaluatedKey": { - "target": "com.amazonaws.dynamodb#Key", - "traits": { - "smithy.api#documentation": "The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
\nIf LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when 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 number of items in the response.
\nIf you used a QueryFilter in the request, then Count is the number of items\n returned after the filter was applied, and ScannedCount is the number of\n matching items before the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the\n same.
The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Query operation. For more information, see Count and ScannedCount in the\n Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as\n Count.
The number of items in the response.
\nIf you used a QueryFilter in the request, then Count is the number of items\n returned after the filter was applied, and ScannedCount is the number of\n matching items before the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the\n same.
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
\nIf LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when 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 Region where the replica exists.
", + "smithy.api#required": {} + } + }, "ReplicaGlobalSecondaryIndexUpdates": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdateList", "traits": { @@ -4888,13 +6023,6 @@ }, "ReplicaProvisionedReadCapacityAutoScalingUpdate": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" - }, - "RegionName": { - "target": "com.amazonaws.dynamodb#RegionName", - "traits": { - "smithy.api#documentation": "The Region where the replica exists.
", - "smithy.api#required": {} - } } }, "traits": { @@ -4915,52 +6043,52 @@ "com.amazonaws.dynamodb#ReplicaDescription": { "type": "structure", "members": { - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList", + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", "traits": { - "smithy.api#documentation": "Replica-specific global secondary index settings.
" + "smithy.api#documentation": "The name of the Region.
" } }, - "ProvisionedThroughputOverride": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", "traits": { - "smithy.api#documentation": "Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.
" + "smithy.api#documentation": "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 AWS Region has been disabled.
If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
\n\n INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table is inaccessible.
If the AWS KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
\nThe AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS\n encryption.
" + "smithy.api#documentation": "Detailed information about the replica status.
" } }, - "ReplicaInaccessibleDateTime": { - "target": "com.amazonaws.dynamodb#Date", + "ReplicaStatusPercentProgress": { + "target": "com.amazonaws.dynamodb#ReplicaStatusPercentProgress", "traits": { - "smithy.api#documentation": "The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
Specifies the progress of a Create, Update, or Delete action on the replica\n as a percentage.
" } }, - "RegionName": { - "target": "com.amazonaws.dynamodb#RegionName", + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", "traits": { - "smithy.api#documentation": "The name of the Region.
" + "smithy.api#documentation": "The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS\n encryption.
" } }, - "ReplicaStatusDescription": { - "target": "com.amazonaws.dynamodb#ReplicaStatusDescription", + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { - "smithy.api#documentation": "Detailed information about the replica status.
" + "smithy.api#documentation": "Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.
" } }, - "ReplicaStatus": { - "target": "com.amazonaws.dynamodb#ReplicaStatus", + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "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 AWS Region has been disabled.
If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
\nReplica-specific global secondary index settings.
" } }, - "ReplicaStatusPercentProgress": { - "target": "com.amazonaws.dynamodb#ReplicaStatusPercentProgress", + "ReplicaInaccessibleDateTime": { + "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "Specifies the progress of a Create, Update, or Delete action on the replica\n as a percentage.
" + "smithy.api#documentation": "The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
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.
\n 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 maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
Auto scaling settings for a global secondary index replica's write capacity\n units.
" + "smithy.api#documentation": "Auto scaling settings for a global secondary index replica's read capacity units.
" } }, "ProvisionedWriteCapacityUnits": { @@ -5115,16 +6249,10 @@ "smithy.api#documentation": "The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
\n 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.
Auto scaling settings for a global secondary index replica's read capacity units.
" + "smithy.api#documentation": "Auto scaling settings for a global secondary index replica's write capacity\n units.
" } } }, @@ -5141,10 +6269,11 @@ "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdate": { "type": "structure", "members": { - "ProvisionedReadCapacityAutoScalingSettingsUpdate": { - "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "Auto scaling settings for managing a global secondary index replica's read capacity\n units.
" + "smithy.api#documentation": "The name of the global secondary index. The name must be unique among all other indexes on this table.
", + "smithy.api#required": {} } }, "ProvisionedReadCapacityUnits": { @@ -5153,11 +6282,10 @@ "smithy.api#documentation": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
The name of the global secondary index. The name must be unique among all other indexes on this table.
", - "smithy.api#required": {} + "smithy.api#documentation": "Auto scaling settings for managing a global secondary index replica's read capacity\n units.
" } } }, @@ -5198,18 +6326,6 @@ "com.amazonaws.dynamodb#ReplicaSettingsDescription": { "type": "structure", "members": { - "ReplicaProvisionedReadCapacityUnits": { - "target": "com.amazonaws.dynamodb#NonNegativeLongObject", - "traits": { - "smithy.api#documentation": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.\n
Auto scaling settings for a global table replica's read capacity units.
" - } - }, "RegionName": { "target": "com.amazonaws.dynamodb#RegionName", "traits": { @@ -5217,12 +6333,6 @@ "smithy.api#required": {} } }, - "ReplicaProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.dynamodb#NonNegativeLongObject", - "traits": { - "smithy.api#documentation": "The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.
The read/write capacity mode of the replica.
" } }, - "ReplicaGlobalSecondaryIndexSettings": { - "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescriptionList", + "ReplicaProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", "traits": { - "smithy.api#documentation": "Replica global secondary index settings for the global table.
" + "smithy.api#documentation": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.\n
Auto scaling settings for a global table replica's read capacity units.
" + } + }, + "ReplicaProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.
Auto scaling settings for a global table replica's write capacity units.
" } + }, + "ReplicaGlobalSecondaryIndexSettings": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "Replica global secondary index settings for the global table.
" + } } }, "traits": { @@ -5261,16 +6389,11 @@ "com.amazonaws.dynamodb#ReplicaSettingsUpdate": { "type": "structure", "members": { - "ReplicaGlobalSecondaryIndexSettingsUpdate": { - "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList", - "traits": { - "smithy.api#documentation": "Represents the settings of a global secondary index for a global table that will be modified.
" - } - }, - "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": { - "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", "traits": { - "smithy.api#documentation": "Auto scaling settings for managing a global table replica's read capacity units.
" + "smithy.api#documentation": "The Region of the replica to be added.
", + "smithy.api#required": {} } }, "ReplicaProvisionedReadCapacityUnits": { @@ -5279,11 +6402,16 @@ "smithy.api#documentation": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.\n
The Region of the replica to be added.
", - "smithy.api#required": {} + "smithy.api#documentation": "Auto scaling settings for managing a global table replica's read capacity units.
" + } + }, + "ReplicaGlobalSecondaryIndexSettingsUpdate": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList", + "traits": { + "smithy.api#documentation": "Represents the settings of a global secondary index for a global table that will be modified.
" } } }, @@ -5324,6 +6452,9 @@ }, { "value": "REGION_DISABLED" + }, + { + "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" } ] } @@ -5363,12 +6494,6 @@ "com.amazonaws.dynamodb#ReplicationGroupUpdate": { "type": "structure", "members": { - "Delete": { - "target": "com.amazonaws.dynamodb#DeleteReplicationGroupMemberAction", - "traits": { - "smithy.api#documentation": "The parameters required for deleting a replica for the table.
" - } - }, "Create": { "target": "com.amazonaws.dynamodb#CreateReplicationGroupMemberAction", "traits": { @@ -5380,6 +6505,12 @@ "traits": { "smithy.api#documentation": "The parameters required for updating a replica for the table.
" } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteReplicationGroupMemberAction", + "traits": { + "smithy.api#documentation": "The parameters required for deleting a replica for the table.
" + } } }, "traits": { @@ -5457,17 +6588,16 @@ "com.amazonaws.dynamodb#RestoreSummary": { "type": "structure", "members": { - "SourceTableArn": { - "target": "com.amazonaws.dynamodb#TableArn", + "SourceBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", "traits": { - "smithy.api#documentation": "The ARN of the source table of the backup that is being restored.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the backup from which the table was restored.
" } }, - "RestoreInProgress": { - "target": "com.amazonaws.dynamodb#RestoreInProgress", + "SourceTableArn": { + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "Indicates if a restore is in progress or not.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the source table of the backup that is being restored.
" } }, "RestoreDateTime": { @@ -5477,10 +6607,11 @@ "smithy.api#required": {} } }, - "SourceBackupArn": { - "target": "com.amazonaws.dynamodb#BackupArn", + "RestoreInProgress": { + "target": "com.amazonaws.dynamodb#RestoreInProgress", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the backup from which the table was restored.
" + "smithy.api#documentation": "Indicates if a restore is in progress or not.
", + "smithy.api#required": {} } } }, @@ -5526,24 +6657,6 @@ "com.amazonaws.dynamodb#RestoreTableFromBackupInput": { "type": "structure", "members": { - "GlobalSecondaryIndexOverride": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" - } - }, - "LocalSecondaryIndexOverride": { - "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" - } - }, - "SSESpecificationOverride": { - "target": "com.amazonaws.dynamodb#SSESpecification", - "traits": { - "smithy.api#documentation": "The new server-side encryption settings for the restored table.
" - } - }, "TargetTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -5564,11 +6677,29 @@ "smithy.api#documentation": "The billing mode of the restored table.
" } }, + "GlobalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" + } + }, + "LocalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" + } + }, "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { "smithy.api#documentation": "Provisioned throughput settings for the restored table.
" } + }, + "SSESpecificationOverride": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "The new server-side encryption settings for the restored table.
" + } } } }, @@ -5624,34 +6755,29 @@ "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput": { "type": "structure", "members": { - "LocalSecondaryIndexOverride": { - "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" - } - }, - "SSESpecificationOverride": { - "target": "com.amazonaws.dynamodb#SSESpecification", + "SourceTableArn": { + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "The new server-side encryption settings for the restored table.
" + "smithy.api#documentation": "The DynamoDB table that will be restored. This value is an Amazon\n Resource Name (ARN).
" } }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.dynamodb#BooleanObject", + "SourceTableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.
Name of the source table that is being restored.
" } }, - "ProvisionedThroughputOverride": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "TargetTableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "Provisioned throughput settings for the restored table.
" + "smithy.api#documentation": "The name of the new table to which it must be restored to.
", + "smithy.api#required": {} } }, - "GlobalSecondaryIndexOverride": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "UseLatestRestorableTime": { + "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" + "smithy.api#documentation": "Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.
Time in the past to restore the table to.
" } }, - "SourceTableArn": { - "target": "com.amazonaws.dynamodb#TableArn", + "BillingModeOverride": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "The billing mode of the restored table.
" + } + }, + "GlobalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", "traits": { - "smithy.api#documentation": "The DynamoDB table that will be restored. This value is an Amazon\n Resource Name (ARN).
" + "smithy.api#documentation": "List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" } }, - "BillingModeOverride": { - "target": "com.amazonaws.dynamodb#BillingMode", + "LocalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", "traits": { - "smithy.api#documentation": "The billing mode of the restored table.
" + "smithy.api#documentation": "List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.
" } }, - "TargetTableName": { - "target": "com.amazonaws.dynamodb#TableName", + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "The name of the new table to which it must be restored to.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provisioned throughput settings for the restored table.
" } }, - "SourceTableName": { - "target": "com.amazonaws.dynamodb#TableName", + "SSESpecificationOverride": { + "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { - "smithy.api#documentation": "Name of the source table that is being restored.
" + "smithy.api#documentation": "The new server-side encryption settings for the restored table.
" } } } @@ -5763,21 +6894,40 @@ ] } }, + "com.amazonaws.dynamodb#S3Bucket": { + "type": "string" + }, + "com.amazonaws.dynamodb#S3BucketOwner": { + "type": "string" + }, + "com.amazonaws.dynamodb#S3Prefix": { + "type": "string" + }, + "com.amazonaws.dynamodb#S3SseAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AES256" + }, + { + "value": "KMS" + } + ] + } + }, + "com.amazonaws.dynamodb#S3SseKmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.dynamodb#SSEDescription": { "type": "structure", "members": { - "InaccessibleEncryptionDateTime": { - "target": "com.amazonaws.dynamodb#Date", - "traits": { - "smithy.api#documentation": "Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's\n AWS KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB\n detects that the table's AWS KMS key is accessible again. DynamoDB will initiate the table\n archival process when table's AWS KMS key remains inaccessible for more than seven days\n from this date.
" - } - }, - "KMSMasterKeyArn": { - "target": "com.amazonaws.dynamodb#KMSMasterKeyArn", - "traits": { - "smithy.api#documentation": "The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.
" - } - }, "Status": { "target": "com.amazonaws.dynamodb#SSEStatus", "traits": { @@ -5789,6 +6939,18 @@ "traits": { "smithy.api#documentation": "Server-side encryption type. The only supported value is:
\n\n KMS - Server-side encryption that uses AWS Key Management Service. The\n key is stored in your account and is managed by AWS KMS (AWS KMS charges\n apply).
The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.
" + } + }, + "InaccessibleEncryptionDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's\n AWS KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB\n detects that the table's AWS KMS key is accessible again. DynamoDB will initiate the table\n archival process when table's AWS KMS key remains inaccessible for more than seven days\n from this date.
" + } } }, "traits": { @@ -5804,10 +6966,10 @@ "com.amazonaws.dynamodb#SSESpecification": { "type": "structure", "members": { - "KMSMasterKeyId": { - "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "Enabled": { + "target": "com.amazonaws.dynamodb#SSEEnabled", "traits": { - "smithy.api#documentation": "The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To\n specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note\n that you should only provide this parameter if the key is different from the default\n DynamoDB customer master key alias/aws/dynamodb.
" + "smithy.api#documentation": "Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true),\n server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side\nencryption is set to AWS owned CMK.
Server-side encryption type. The only supported value is:
\n\n KMS - Server-side encryption that uses AWS Key Management Service. The\n key is stored in your account and is managed by AWS KMS (AWS KMS charges\n apply).
Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true),\n server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side\nencryption is set to AWS owned CMK.
The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To\n specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note\n that you should only provide this parameter if the key is different from the default\n DynamoDB customer master key alias/aws/dynamodb.
" } } }, @@ -5910,40 +7072,35 @@ "com.amazonaws.dynamodb#ScanInput": { "type": "structure", "members": { - "ProjectionExpression": { - "target": "com.amazonaws.dynamodb#ProjectionExpression", - "traits": { - "smithy.api#documentation": "A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. 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 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.
" - } - }, - "ConsistentRead": { - "target": "com.amazonaws.dynamodb#ConsistentRead", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "A Boolean value that determines the read consistency model during the scan:
\nIf ConsistentRead is false, then the data returned from\n 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 operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
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 attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n 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\n index is configured to project all attributes, this return value is\n equivalent to 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 AttributesToGet. This return value is equivalent to\n specifying AttributesToGet without specifying any value\n for 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\n attributes that are projected into the index. Global secondary index queries\n cannot fetch attributes from the parent table.
\nIf neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)
If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.
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 follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":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": "This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.
For a parallel Scan request, Segment identifies an individual segment to be\n scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to\n use four application threads to scan a table or an index, then the first thread specifies a Segment value\n of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be\n used as ExclusiveStartKey with the same segment ID in a subsequent Scan\n operation.
The value for Segment must be greater than or equal to 0, and less than the value\n provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n 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. For more information, see Working with Queries in the Amazon DynamoDB Developer\n Guide.
For a parallel Scan request, TotalSegments represents the total number of\n segments into which the Scan operation will be divided. The value of\n TotalSegments corresponds to the number of application workers that will perform the\n parallel scan. For example, if you want to use four application threads to scan a table or an index,\n specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal\n to 1000000. If you specify a TotalSegments value of 1, the Scan operation will\n be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
The attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n 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\n index is configured to project all attributes, this return value is\n equivalent to 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 AttributesToGet. This return value is equivalent to\n specifying AttributesToGet without specifying any value\n for 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\n attributes that are projected into the index. Global secondary index queries\n cannot fetch attributes from the parent table.
\nIf neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)
If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.
This is a legacy parameter. Use FilterExpression instead. For more information, see\n ScanFilter in the Amazon DynamoDB Developer Guide.
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.
This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.
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 primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a\n Scan request that includes ExclusiveStartKey must specify the same segment\n whose previous Scan returned the corresponding value of LastEvaluatedKey.
This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.
For a parallel Scan request, TotalSegments represents the total number of\n segments into which the Scan operation will be divided. The value of\n TotalSegments corresponds to the number of application workers that will perform the\n parallel scan. For example, if you want to use four application threads to scan a table or an index,\n specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal\n to 1000000. If you specify a TotalSegments value of 1, the Scan operation will\n be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the 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": "For a parallel Scan request, Segment identifies an individual segment to be\n scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to\n use four application threads to scan a table or an index, then the first thread specifies a Segment value\n of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be\n used as ExclusiveStartKey with the same segment ID in a subsequent Scan\n operation.
The value for Segment must be greater than or equal to 0, and less than the value\n provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a\n Scan request that includes ExclusiveStartKey must specify the same segment\n whose previous Scan returned the corresponding value of LastEvaluatedKey.
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. 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 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": { @@ -5992,16 +7148,22 @@ "smithy.api#documentation": "A string that contains conditions that DynamoDB applies after the Scan operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.
For more information, see\n Filter Expressions in the Amazon DynamoDB Developer Guide.
" } }, - "Limit": { - "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n 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. For more information, see Working with Queries in the Amazon DynamoDB Developer\n Guide.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for 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 expression attribute values, which are placeholders for the actual value at runtime.
\nFor more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, - "ConditionalOperator": { - "target": "com.amazonaws.dynamodb#ConditionalOperator", + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.
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 follows:
\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":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 from\n 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 operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
" + } + }, "Count": { "target": "com.amazonaws.dynamodb#Integer", "traits": { @@ -6024,22 +7192,16 @@ "smithy.api#documentation": "The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Scan operation. For more information, see Count and ScannedCount in the\n Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as\n Count.
The capacity units consumed by the Scan operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.
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\n has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean\n that there is more data in the result set. The only way to know when you have reached\n the end of the result set is when LastEvaluatedKey is\n empty.
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
" + "smithy.api#documentation": "The capacity units consumed by the Scan operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.
Time when the source table was created.
", - "smithy.api#required": {} + "smithy.api#documentation": "ARN of the table for which backup was created.
" + } + }, + "TableSizeBytes": { + "target": "com.amazonaws.dynamodb#Long", + "traits": { + "smithy.api#documentation": "Size of the table in bytes. Note that this is an approximate value.
" } }, "KeySchema": { @@ -6126,16 +7293,11 @@ "smithy.api#required": {} } }, - "ItemCount": { - "target": "com.amazonaws.dynamodb#ItemCount", - "traits": { - "smithy.api#documentation": "Number of items in the table. Note that this is an approximate value.
" - } - }, - "TableArn": { - "target": "com.amazonaws.dynamodb#TableArn", + "TableCreationDateTime": { + "target": "com.amazonaws.dynamodb#TableCreationDateTime", "traits": { - "smithy.api#documentation": "ARN of the table for which backup was created.
" + "smithy.api#documentation": "Time when the source table was created.
", + "smithy.api#required": {} } }, "ProvisionedThroughput": { @@ -6145,16 +7307,16 @@ "smithy.api#required": {} } }, - "BillingMode": { - "target": "com.amazonaws.dynamodb#BillingMode", + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", "traits": { - "smithy.api#documentation": "Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
\n\n PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
\n PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.\n
Number of items in the table. Note that this is an approximate value.
" } }, - "TableSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "Size of the table in bytes. Note that this is an approximate value.
" + "smithy.api#documentation": "Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
\n\n PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
\n PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.\n
Time to Live settings on the table when the backup was created.
" - } - }, "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexes", "traits": { "smithy.api#documentation": "Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.
" } }, - "SSEDescription": { - "target": "com.amazonaws.dynamodb#SSEDescription", + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexes", "traits": { - "smithy.api#documentation": "The description of the server-side encryption status on the table when the backup was created.
" + "smithy.api#documentation": "Represents the GSI properties for the table when the backup was created. It includes the\n IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at\n the time of backup.
" } }, "StreamDescription": { @@ -6189,10 +7345,16 @@ "smithy.api#documentation": "Stream settings on the table when the backup was created.
" } }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexes", + "TimeToLiveDescription": { + "target": "com.amazonaws.dynamodb#TimeToLiveDescription", "traits": { - "smithy.api#documentation": "Represents the GSI properties for the table when the backup was created. It includes the\n IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at\n the time of backup.
" + "smithy.api#documentation": "Time to Live settings on the table when the backup was created.
" + } + }, + "SSEDescription": { + "target": "com.amazonaws.dynamodb#SSEDescription", + "traits": { + "smithy.api#documentation": "The description of the server-side encryption status on the table when the backup was created.
" } } }, @@ -6285,6 +7447,12 @@ "com.amazonaws.dynamodb#TableAutoScalingDescription": { "type": "structure", "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "The name of the table.
" + } + }, "TableStatus": { "target": "com.amazonaws.dynamodb#TableStatus", "traits": { @@ -6296,12 +7464,6 @@ "traits": { "smithy.api#documentation": "Represents replicas of the global table.
" } - }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "The name of the table.
" - } } }, "traits": { @@ -6314,46 +7476,34 @@ "com.amazonaws.dynamodb#TableDescription": { "type": "structure", "members": { - "BillingModeSummary": { - "target": "com.amazonaws.dynamodb#BillingModeSummary", - "traits": { - "smithy.api#documentation": "Contains the details for the read/write capacity mode.
" - } - }, - "TableArn": { - "target": "com.amazonaws.dynamodb#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the table.
" - } - }, - "SSEDescription": { - "target": "com.amazonaws.dynamodb#SSEDescription", + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "The description of the server-side encryption status on the specified table.
" + "smithy.api#documentation": "An array of AttributeDefinition objects. Each of these objects describes one attribute\n 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.
Contains information about the table archive.
" + "smithy.api#documentation": "The name of the table.
" } }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
\n\n Backfilling - If true, then the index is currently in the backfilling\n phase. Backfilling occurs only when a new global secondary index is added to the\n table. It is the process by which DynamoDB populates the new index with data from the\n table. (This attribute does not appear for indexes that were created during a\n CreateTable operation.)
You can delete an index that is being created during the Backfilling\n phase when IndexStatus is set to CREATING and Backfilling\n is true. You can't delete the index that is being created when\n IndexStatus is set to CREATING and Backfilling is false.\n (This attribute does not appear for indexes that were created during a\n CreateTable operation.)
\n IndexName - The name of the global secondary index.
\n IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n IndexStatus - The current status of the global secondary 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. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n KeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same partition key as the table.
\n Projection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\n ProjectionType - One\n of the following:
\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
\n ALL - All of the table attributes are projected into the\n index.
\n NonKeyAttributes - A list of one or more non-key attribute names that are\n projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n ProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases.
If the table is in the DELETING state, no information about indexes will be\n returned.
The primary key structure for the table. Each KeySchemaElement consists 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nFor more information about primary keys, see Primary Key in the\n Amazon DynamoDB Developer Guide.
" } }, - "GlobalTableVersion": { - "target": "com.amazonaws.dynamodb#String", + "TableStatus": { + "target": "com.amazonaws.dynamodb#TableStatus", "traits": { - "smithy.api#documentation": "Represents the version of global tables in use, if the table is replicated across AWS Regions.
" + "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 AWS KMS\n key used to encrypt the table in inaccessible. Table operations\n may fail due to failure to use the AWS KMS key. DynamoDB will\n initiate the table archival process when a table's AWS KMS key\n remains inaccessible for more than seven days.\n
\n ARCHIVING - The table is being archived. Operations\n are not allowed until archival is complete.\n
\n ARCHIVED - The table has been archived. See the\n ArchivalReason for more information.\n
Unique identifier for the table for which the backup was created.
" + "smithy.api#documentation": "The date and time when the table was created, in UNIX epoch time format.
" } }, "ProvisionedThroughput": { @@ -6362,46 +7512,52 @@ "smithy.api#documentation": "The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
" } }, - "KeySchema": { - "target": "com.amazonaws.dynamodb#KeySchema", + "TableSizeBytes": { + "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "The primary key structure for the table. Each KeySchemaElement consists 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 attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across 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 the same\n partition key physically close together, in sorted order by the sort key value.
\nFor more information about primary keys, see Primary Key in the\n Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" } }, - "Replicas": { - "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", + "ItemCount": { + "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "Represents replicas of the table.
" + "smithy.api#documentation": "The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" } }, - "TableSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "TableArn": { + "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the table.
" } }, - "TableStatus": { - "target": "com.amazonaws.dynamodb#TableStatus", + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", "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 AWS KMS\n key used to encrypt the table in inaccessible. Table operations\n may fail due to failure to use the AWS KMS key. DynamoDB will\n initiate the table archival process when a table's AWS KMS key\n remains inaccessible for more than seven days.\n
\n ARCHIVING - The table is being archived. Operations\n are not allowed until archival is complete.\n
\n ARCHIVED - The table has been archived. See the\n ArchivalReason for more information.\n
Unique identifier for the table for which the backup was created.
" } }, - "StreamSpecification": { - "target": "com.amazonaws.dynamodb#StreamSpecification", + "BillingModeSummary": { + "target": "com.amazonaws.dynamodb#BillingModeSummary", "traits": { - "smithy.api#documentation": "The current DynamoDB Streams configuration for the table.
" + "smithy.api#documentation": "Contains the details for the read/write capacity mode.
" } }, - "RestoreSummary": { - "target": "com.amazonaws.dynamodb#RestoreSummary", + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "Contains details for the restore.
" + "smithy.api#documentation": "Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
\n\n IndexName - The name of the local secondary index.
\n KeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same partition key as the table.
\n Projection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\n ProjectionType - One\n of the following:
\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - Only the specified table attributes are projected\n into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected into the\n index.
\n NonKeyAttributes - A list of one or more non-key attribute names that are\n projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.
\n ItemCount - Represents the number of items in the index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING state, no information about indexes will be\n returned.
An array of AttributeDefinition objects. Each of these objects describes one attribute\n 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 global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
\n\n Backfilling - If true, then the index is currently in the backfilling\n phase. Backfilling occurs only when a new global secondary index is added to the\n table. It is the process by which DynamoDB populates the new index with data from the\n table. (This attribute does not appear for indexes that were created during a\n CreateTable operation.)
You can delete an index that is being created during the Backfilling\n phase when IndexStatus is set to CREATING and Backfilling\n is true. You can't delete the index that is being created when\n IndexStatus is set to CREATING and Backfilling is false.\n (This attribute does not appear for indexes that were created during a\n CreateTable operation.)
\n IndexName - The name of the global secondary index.
\n IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n IndexStatus - The current status of the global secondary 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. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n KeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same partition key as the table.
\n Projection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\n ProjectionType - One\n of the following:
\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
\n ALL - All of the table attributes are projected into the\n index.
\n NonKeyAttributes - A list of one or more non-key attribute names that are\n projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n ProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases.
If the table is in the DELETING state, no information about indexes will be\n returned.
The current DynamoDB Streams configuration for the table.
" } }, "LatestStreamLabel": { @@ -6416,28 +7572,34 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
" } }, - "LocalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", + "GlobalTableVersion": { + "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
\n\n IndexName - The name of the local secondary index.
\n KeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same partition key as the table.
\n Projection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\n ProjectionType - One\n of the following:
\n KEYS_ONLY - Only the index and primary keys are projected into the\n index.
\n INCLUDE - Only the specified table attributes are projected\n into the index. The list of projected attributes is in\n NonKeyAttributes.
\n ALL - All of the table attributes are projected into the\n index.
\n NonKeyAttributes - A list of one or more non-key attribute names that are\n projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.
\n ItemCount - Represents the number of items in the index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING state, no information about indexes will be\n returned.
Represents the version of global tables in use, if the table is replicated across AWS Regions.
" } }, - "CreationDateTime": { - "target": "com.amazonaws.dynamodb#Date", + "Replicas": { + "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", "traits": { - "smithy.api#documentation": "The date and time when the table was created, in UNIX epoch time format.
" + "smithy.api#documentation": "Represents replicas of the table.
" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "RestoreSummary": { + "target": "com.amazonaws.dynamodb#RestoreSummary", "traits": { - "smithy.api#documentation": "The name of the table.
" + "smithy.api#documentation": "Contains details for the restore.
" } }, - "ItemCount": { - "target": "com.amazonaws.dynamodb#Long", + "SSEDescription": { + "target": "com.amazonaws.dynamodb#SSEDescription", "traits": { - "smithy.api#documentation": "The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" + "smithy.api#documentation": "The description of the server-side encryption status on the specified table.
" + } + }, + "ArchivalSummary": { + "target": "com.amazonaws.dynamodb#ArchivalSummary", + "traits": { + "smithy.api#documentation": "Contains information about the table archive.
" } } }, @@ -6591,17 +7753,17 @@ "com.amazonaws.dynamodb#TagResourceInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.dynamodb#TagList", + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", "traits": { - "smithy.api#documentation": "The tags to be assigned to the Amazon DynamoDB resource.
", + "smithy.api#documentation": "Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).
", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.dynamodb#ResourceArnString", + "Tags": { + "target": "com.amazonaws.dynamodb#TagList", "traits": { - "smithy.api#documentation": "Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).
", + "smithy.api#documentation": "The tags to be assigned to the Amazon DynamoDB resource.
", "smithy.api#required": {} } } @@ -6660,17 +7822,17 @@ "com.amazonaws.dynamodb#TimeToLiveSpecification": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", + "Enabled": { + "target": "com.amazonaws.dynamodb#TimeToLiveEnabled", "traits": { - "smithy.api#documentation": "The name of the TTL attribute used to store the expiration time for items in the\n table.
", + "smithy.api#documentation": "Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
", "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.dynamodb#TimeToLiveEnabled", + "AttributeName": { + "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", "traits": { - "smithy.api#documentation": "Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
", + "smithy.api#documentation": "The name of the TTL attribute used to store the expiration time for items in the\n table.
", "smithy.api#required": {} } } @@ -6778,23 +7940,29 @@ "com.amazonaws.dynamodb#TransactGetItemsOutput": { "type": "structure", "members": { - "Responses": { - "target": "com.amazonaws.dynamodb#ItemResponseList", - "traits": { - "smithy.api#documentation": "An ordered array of up to 25 ItemResponse objects, each of which corresponds\n 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\n the requested item.
If a requested item could not be retrieved, the corresponding ItemResponse\n object is Null, or if the requested item has no projected attributes, the corresponding\n ItemResponse object is an empty Map.
If the ReturnConsumedCapacity value was TOTAL,\n this is an array of ConsumedCapacity objects, one for each table\n addressed by TransactGetItem objects in the TransactItems\n parameter. These ConsumedCapacity objects report the read-capacity\n units consumed by the TransactGetItems call in that table.
An ordered array of up to 25 ItemResponse objects, each of which corresponds\n 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\n the requested item.
If a requested item could not be retrieved, the corresponding ItemResponse\n object is Null, or if the requested item has no projected attributes, the corresponding\n ItemResponse object is an empty Map.
A request to perform a check item operation.
" + } + }, "Put": { "target": "com.amazonaws.dynamodb#Put", "traits": { @@ -6807,12 +7975,6 @@ "smithy.api#documentation": "A request to perform a DeleteItem operation.
A request to perform a check item operation.
" - } - }, "Update": { "target": "com.amazonaws.dynamodb#Update", "traits": { @@ -6877,59 +8039,59 @@ "com.amazonaws.dynamodb#TransactWriteItemsInput": { "type": "structure", "members": { - "ReturnItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "TransactItems": { + "target": "com.amazonaws.dynamodb#TransactWriteItemList", "traits": { - "smithy.api#documentation": "Determines whether item collection metrics are returned. If set to\n SIZE, the response includes statistics about item collections (if any), that\n were modified during the operation and are returned in the response.\n If set to NONE (the default), no statistics are returned.\n
An 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 AWS account and Region, and no two of them can operate on\n the same item.
Determines whether item collection metrics are returned. If set to\n SIZE, the response includes statistics about item collections (if any), that\n were modified during the operation and are returned in the response.\n If set to NONE (the default), no statistics are returned.\n
Providing a ClientRequestToken makes the call to TransactWriteItems\n idempotent, meaning that multiple identical calls 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.
An 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 AWS account and Region, and no two of them can operate on\n the same item.
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 capacity units consumed by the entire TransactWriteItems\n operation. The values of the list are ordered according to\n the ordering of the TransactItems request parameter.\n
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.
A list of cancellation reasons.
" } - }, - "Message": { - "target": "com.amazonaws.dynamodb#ErrorMessage" } }, "traits": { @@ -7009,6 +8171,13 @@ "com.amazonaws.dynamodb#Update": { "type": "structure", "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "The primary key of the item to be updated. Each element consists of\n an attribute name and a value for that attribute.
", + "smithy.api#required": {} + } + }, "UpdateExpression": { "target": "com.amazonaws.dynamodb#UpdateExpression", "traits": { @@ -7016,23 +8185,23 @@ "smithy.api#required": {} } }, - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression.
" + "smithy.api#documentation": "Name of the table for the UpdateItem request.
Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Update condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
A condition that must be satisfied in order for a conditional update to\n succeed.
" } }, - "Key": { - "target": "com.amazonaws.dynamodb#Key", + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "The primary key of the item to be updated. Each element consists of\n an attribute name and a value for that attribute.
", - "smithy.api#required": {} + "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression.
" } }, "ExpressionAttributeValues": { @@ -7041,17 +8210,10 @@ "smithy.api#documentation": "One or more values that can be substituted in an expression.
" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "Name of the table for the UpdateItem request.
A condition that must be satisfied in order for a conditional update to\n succeed.
" + "smithy.api#documentation": "Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Update condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
Represents the contributor insights action.
", + "smithy.api#documentation": "The name of the table.
", "smithy.api#required": {} } }, @@ -7151,10 +8313,10 @@ "smithy.api#documentation": "The global secondary index name, if applicable.
" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "ContributorInsightsAction": { + "target": "com.amazonaws.dynamodb#ContributorInsightsAction", "traits": { - "smithy.api#documentation": "The name of the table.
", + "smithy.api#documentation": "Represents the contributor insights action.
", "smithy.api#required": {} } } @@ -7169,17 +8331,17 @@ "smithy.api#documentation": "The name of the table.
" } }, - "ContributorInsightsStatus": { - "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", - "traits": { - "smithy.api#documentation": "The status of contributor insights
" - } - }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { "smithy.api#documentation": "The name of the global secondary index, if applicable.
" } + }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "The status of contributor insights
" + } } } }, @@ -7189,17 +8351,17 @@ "com.amazonaws.dynamodb#UpdateGlobalSecondaryIndexAction": { "type": "structure", "members": { - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
", + "smithy.api#documentation": "The name of the global secondary index to be updated.
", "smithy.api#required": {} } }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "The name of the global secondary index to be updated.
", + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary index.
\nFor current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
", "smithy.api#required": {} } } @@ -7308,22 +8470,11 @@ "com.amazonaws.dynamodb#UpdateGlobalTableSettingsInput": { "type": "structure", "members": { - "GlobalTableProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.dynamodb#PositiveLongObject", - "traits": { - "smithy.api#documentation": "The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n
Represents the settings of a global secondary index for a global table that will be modified.
" - } - }, - "ReplicaSettingsUpdate": { - "target": "com.amazonaws.dynamodb#ReplicaSettingsUpdateList", + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "Represents the settings for a global table in a Region that will be modified.
" + "smithy.api#documentation": "The name of the global table
", + "smithy.api#required": {} } }, "GlobalTableBillingMode": { @@ -7332,17 +8483,28 @@ "smithy.api#documentation": "The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.
\n PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.\n
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n
Auto scaling settings for managing provisioned write capacity for the global\n table.
" } }, - "GlobalTableName": { - "target": "com.amazonaws.dynamodb#TableName", + "GlobalTableGlobalSecondaryIndexSettingsUpdate": { + "target": "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList", "traits": { - "smithy.api#documentation": "The name of the global table
", - "smithy.api#required": {} + "smithy.api#documentation": "Represents the settings of a global secondary index for a global table that will be modified.
" + } + }, + "ReplicaSettingsUpdate": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsUpdateList", + "traits": { + "smithy.api#documentation": "Represents the settings for a global table in a Region that will be modified.
" } } } @@ -7350,17 +8512,17 @@ "com.amazonaws.dynamodb#UpdateGlobalTableSettingsOutput": { "type": "structure", "members": { - "ReplicaSettings": { - "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", - "traits": { - "smithy.api#documentation": "The Region-specific settings for the global table.
" - } - }, "GlobalTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "The name of the global table.
" } + }, + "ReplicaSettings": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "The Region-specific settings for the global table.
" + } } } }, @@ -7405,22 +8567,30 @@ "com.amazonaws.dynamodb#UpdateItemInput": { "type": "structure", "members": { - "ReturnValues": { - "target": "com.amazonaws.dynamodb#ReturnValue", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "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 value is\n NONE, then nothing is returned. (This setting is the default for\n ReturnValues.)
\n ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
\n UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
\n ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
\n UPDATED_NEW - Returns only the updated attributes, as they appear 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": "The name of the table containing the item to update.
", + "smithy.api#required": {} } }, - "UpdateExpression": { - "target": "com.amazonaws.dynamodb#UpdateExpression", + "Key": { + "target": "com.amazonaws.dynamodb#Key", "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 contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
\n list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or 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 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 also a number, then\n Value is mathematically added to the existing attribute. If Value is a\n negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item\n that doesn't exist before the update, DynamoDB uses 0 as the initial\n value.
Similarly, if you use ADD for an existing item to increment\n or decrement an attribute value that doesn't exist before the\n 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 set, then\n Value is added to the existing set. For example, if the attribute value is the set\n [1,2], and the ADD action specified [3], then\n the final attribute value is [1,2,3]. An error occurs if an ADD\n action is specified for a set attribute and the attribute type specified does not\n match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data\n type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition,\n ADD can only be used on top-level attributes, not 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 the\n DELETE action specifies [a,c], then the final attribute value\n 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 attributes.
You can have many actions in a single expression, such as the following: SET a=:value1,\n b=:value2 DELETE :value3, :value4, :value5\n
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
" + "smithy.api#documentation": "The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
\nFor the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
", + "smithy.api#required": {} } }, - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "AttributeUpdates": { + "target": "com.amazonaws.dynamodb#AttributeUpdates", "traits": { - "smithy.api#documentation": "One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly\n 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 expression attribute values, which are placeholders for the 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": "This is a legacy parameter. Use UpdateExpression instead. For more information, see\n AttributeUpdates in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.
A condition that must be satisfied in order for a conditional update to succeed.
\nAn expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type | 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": "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 value is\n NONE, then nothing is returned. (This setting is the default for\n ReturnValues.)
\n ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
\n UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
\n ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
\n UPDATED_NEW - Returns only the updated attributes, as they appear 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.
" } }, - "AttributeUpdates": { - "target": "com.amazonaws.dynamodb#AttributeUpdates", - "traits": { - "smithy.api#documentation": "This is a legacy parameter. Use UpdateExpression instead. For more information, see\n AttributeUpdates in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.
Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
The name of the table containing the item to update.
", - "smithy.api#required": {} + "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 contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
\n list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or 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 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 also a number, then\n Value is mathematically added to the existing attribute. If Value is a\n negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item\n that doesn't exist before the update, DynamoDB uses 0 as the initial\n value.
Similarly, if you use ADD for an existing item to increment\n or decrement an attribute value that doesn't exist before the\n 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 set, then\n Value is added to the existing set. For example, if the attribute value is the set\n [1,2], and the ADD action specified [3], then\n the final attribute value is [1,2,3]. An error occurs if an ADD\n action is specified for a set attribute and the attribute type specified does not\n match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data\n type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition,\n ADD can only be used on top-level attributes, not 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 the\n DELETE action specifies [a,c], then the final attribute value\n 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 attributes.
You can have many actions in a single expression, such as the following: SET a=:value1,\n b=:value2 DELETE :value3, :value4, :value5\n
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
" } }, - "Key": { - "target": "com.amazonaws.dynamodb#Key", + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
\nFor the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
", - "smithy.api#required": {} + "smithy.api#documentation": "A condition that must be satisfied in order for a conditional update to succeed.
\nAn expression can contain any of the following:
\nFunctions: attribute_exists | attribute_not_exists | attribute_type | 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.
" } }, - "ReturnItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
\nTo create a placeholder for repeating occurrences of an attribute name in an expression.
\nTo prevent special characters in an attribute name from being misinterpreted in an expression.
\nUse the # character in an expression to dereference 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 directly\n 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 expression attribute values, which are placeholders for the actual value at runtime.
\nFor more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.
" } }, "ExpressionAttributeValues": { @@ -7490,17 +8652,17 @@ "smithy.api#documentation": "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.
Information about item collections, if any, that were affected by the\n UpdateItem operation.\n ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not\n returned in the response.
Each ItemCollectionMetrics\n element consists of:
\n ItemCollectionKey - The partition key value of the item\n collection. This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size,\n in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nThe capacity units consumed by the UpdateItem operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.
Information about item collections, if any, that were affected by the\n UpdateItem operation.\n ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not\n returned in the response.
Each ItemCollectionMetrics\n element consists of:
\n ItemCollectionKey - The partition key value of the item\n collection. This is the same as the partition key value of the item itself.
\n SizeEstimateRangeGB - An estimate of item collection size,\n in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nReplica-specific global secondary index settings.
" + "smithy.api#documentation": "The AWS KMS customer master key (CMK) of the replica that should be used for AWS KMS encryption.\n To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias\n ARN. Note that you should only provide this parameter if the key is different from\n the default DynamoDB KMS master key alias/aws/dynamodb.
" } }, "ProvisionedThroughputOverride": { @@ -7529,10 +8691,10 @@ "smithy.api#documentation": "Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.
" } }, - "KMSMasterKeyId": { - "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", "traits": { - "smithy.api#documentation": "The AWS KMS customer master key (CMK) of the replica that should be used for AWS KMS encryption.\n To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias\n ARN. Note that you should only provide this parameter if the key is different from\n the default DynamoDB KMS master key alias/aws/dynamodb.
" + "smithy.api#documentation": "Replica-specific global secondary index settings.
" } } }, @@ -7572,6 +8734,12 @@ "com.amazonaws.dynamodb#UpdateTableInput": { "type": "structure", "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
Controls how you are charged for read and write throughput and how you manage capacity. \n When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial\n provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes \n over the past 30 minutes.
\n\n PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.\n
The new provisioned throughput settings for the specified table or index.
" + } + }, "GlobalSecondaryIndexUpdates": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList", "traits": { "smithy.api#documentation": "An array of one or more global secondary indexes for the table. For each index in the 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 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 operation.
For more information, see Managing Global Secondary\n Indexes in the Amazon DynamoDB Developer Guide.
" } }, - "AttributeDefinitions": { - "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", "traits": { - "smithy.api#documentation": "An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
Represents the DynamoDB Streams configuration for the table.
\nYou receive a ResourceInUseException 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.
The new server-side encryption settings for the specified table.
" } }, - "BillingMode": { - "target": "com.amazonaws.dynamodb#BillingMode", - "traits": { - "smithy.api#documentation": "Controls how you are charged for read and write throughput and how you manage capacity. \n When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial\n provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes \n over the past 30 minutes.
\n\n PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
\n PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.\n
A list of replica update actions (create, delete, or update) for the table.
\nThis property only applies to Version 2019.11.21 of global tables.
\nThe new provisioned throughput settings for the specified table or index.
" - } - }, - "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 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.
Represents the auto scaling settings of the global secondary indexes of the replica\n to be updated.
" + } + }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -7679,12 +8847,6 @@ "ProvisionedWriteCapacityAutoScalingUpdate": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" }, - "GlobalSecondaryIndexUpdates": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList", - "traits": { - "smithy.api#documentation": "Represents the auto scaling settings of the global secondary indexes of the replica\n to be updated.
" - } - }, "ReplicaUpdates": { "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList", "traits": { @@ -7736,17 +8898,17 @@ "com.amazonaws.dynamodb#UpdateTimeToLiveInput": { "type": "structure", "members": { - "TimeToLiveSpecification": { - "target": "com.amazonaws.dynamodb#TimeToLiveSpecification", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "Represents the settings used to enable or disable Time to Live for the specified table.
", + "smithy.api#documentation": "The name of the table to be configured.
", "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "TimeToLiveSpecification": { + "target": "com.amazonaws.dynamodb#TimeToLiveSpecification", "traits": { - "smithy.api#documentation": "The name of the table to be configured.
", + "smithy.api#documentation": "Represents the settings used to enable or disable Time to Live for the specified table.
", "smithy.api#required": {} } } @@ -7769,17 +8931,17 @@ "com.amazonaws.dynamodb#WriteRequest": { "type": "structure", "members": { - "DeleteRequest": { - "target": "com.amazonaws.dynamodb#DeleteRequest", - "traits": { - "smithy.api#documentation": "A request to perform a DeleteItem operation.
A request to perform a PutItem operation.
A request to perform a DeleteItem operation.