models.dynamodb-2012-08-10-intermediate.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
{
"metadata" : {
"apiVersion" : "2012-08-10",
"protocol" : "json",
"checksumFormat" : null,
"documentation" : "Amazon DynamoDB This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API.
This guide is intended for use with the following DynamoDB documentation:
-
Amazon DynamoDB Getting Started Guide - provides hands-on exercises that help you learn the basics of working with DynamoDB. If you are new to DynamoDB, we recommend that you begin with the Getting Started Guide.
-
Amazon DynamoDB Developer Guide - contains detailed information about DynamoDB concepts, usage, and best practices.
-
Amazon DynamoDB Streams API Reference - provides descriptions and samples of the DynamoDB Streams API. (For more information, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.)
Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see Using the AWS SDKs with DynamoDB in the Amazon DynamoDB Developer Guide.
If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see Using the DynamoDB API in the Amazon DynamoDB Developer Guide.
The following are short descriptions of each low-level API action, organized by function.
Managing Tables
-
CreateTable - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes.
-
DescribeTable - Returns metadata for a table, such as table size, status, and index information.
-
UpdateTable - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table.
-
ListTables - Returns a list of all tables associated with the current AWS account and endpoint.
-
DeleteTable - Deletes a table and all of its indexes.
For conceptual information about managing tables, see Working with Tables in the Amazon DynamoDB Developer Guide.
Reading Data
-
GetItem - Returns a set of attributes for the item that has a given primary key. By default, GetItem performs an eventually consistent read; however, applications can request a strongly consistent read instead.
-
BatchGetItem - Performs multiple GetItem requests for data items using their primary keys, from one table or multiple tables. The response from BatchGetItem has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used.
-
Query - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. Query supports either eventual or strong consistency. A single response has a size limit of 1 MB.
-
Scan - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. Scan can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, Scan should not be used for any application query use case that requires predictable performance.
For conceptual information about reading data, see Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.
Modifying Data
-
PutItem - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist.
-
UpdateItem - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions.
-
DeleteItem - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions.
-
BatchWriteItem - Performs multiple PutItem and DeleteItem requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire BatchWriteItem operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB.
For conceptual information about modifying data, see Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.
",
"defaultEndpoint" : "https://dynamodb.us-east-1.amazonaws.com",
"defaultEndpointWithoutHttpProtocol" : "dynamodb.us-east-1.amazonaws.com",
"syncInterface" : "AmazonDynamoDB",
"syncClient" : "AmazonDynamoDBClient",
"asyncInterface" : "AmazonDynamoDBAsync",
"asyncClient" : "AmazonDynamoDBAsyncClient",
"packageName" : "com.amazonaws.services.dynamodbv2",
"packagePath" : "com/amazonaws/services/dynamodbv2",
"serviceAbbreviation" : "DynamoDB",
"serviceFullName" : "Amazon DynamoDB",
"hasApiWithStreamInput" : false,
"contentType" : null,
"jsonVersion" : "1.0",
"endpointPrefix" : "dynamodb",
"signingName" : "dynamodb",
"protocolDefaultExceptionUmarshallerImpl" : null,
"jsonProtocol" : true,
"syncClientBuilderClassName" : "AmazonDynamoDBClientBuilder",
"asyncClientBuilderClassName" : "AmazonDynamoDBAsyncClientBuilder",
"serviceName" : "DynamoDB",
"cborProtocol" : false,
"xmlProtocol" : false,
"unmarshallerContextClassName" : "JsonUnmarshallerContext",
"unmarshallerClassSuffix" : "JsonUnmarshaller"
},
"operations" : {
"BatchGetItem" : {
"documentation" : "The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.
If you request more than 100 items BatchGetItem will return a ValidationException with the message \"Too many items requested for the BatchGetItem call\".
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem retrieves items in parallel.
When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.
If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.
",
"operationName" : "BatchGetItem",
"deprecated" : false,
"input" : {
"variableName" : "batchGetItemRequest",
"variableType" : "BatchGetItemRequest",
"variableDeclarationType" : "BatchGetItemRequest",
"documentation" : "Represents the input of a BatchGetItem operation.
",
"simpleType" : "BatchGetItemRequest",
"variableSetterType" : "BatchGetItemRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "BatchGetItemResult",
"documentation" : "Represents the output of a BatchGetItem operation.
"
},
"exceptions" : [ {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "BatchGetItemResult",
"asyncReturnType" : "BatchGetItemResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "batchGetItem"
},
"BatchWriteItem" : {
"documentation" : "The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.
BatchWriteItem cannot update items. To update items, use the UpdateItem API.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
-
One or more tables specified in the BatchWriteItem request does not exist.
-
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
-
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
-
There are more than 25 requests in the batch.
-
Any individual item in a batch exceeds 400 KB.
-
The total request size exceeds 16 MB.
",
"operationName" : "BatchWriteItem",
"deprecated" : false,
"input" : {
"variableName" : "batchWriteItemRequest",
"variableType" : "BatchWriteItemRequest",
"variableDeclarationType" : "BatchWriteItemRequest",
"documentation" : "Represents the input of a BatchWriteItem operation.
",
"simpleType" : "BatchWriteItemRequest",
"variableSetterType" : "BatchWriteItemRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "BatchWriteItemResult",
"documentation" : "Represents the output of a BatchWriteItem operation.
"
},
"exceptions" : [ {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "ItemCollectionSizeLimitExceededException",
"documentation" : "An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "BatchWriteItemResult",
"asyncReturnType" : "BatchWriteItemResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "batchWriteItem"
},
"CreateTable" : {
"documentation" : "The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.
CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable API to check the table status.
",
"operationName" : "CreateTable",
"deprecated" : false,
"input" : {
"variableName" : "createTableRequest",
"variableType" : "CreateTableRequest",
"variableDeclarationType" : "CreateTableRequest",
"documentation" : "Represents the input of a CreateTable operation.
",
"simpleType" : "CreateTableRequest",
"variableSetterType" : "CreateTableRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "CreateTableResult",
"documentation" : "Represents the output of a CreateTable operation.
"
},
"exceptions" : [ {
"exceptionName" : "ResourceInUseException",
"documentation" : "The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "CreateTableResult",
"asyncReturnType" : "CreateTableResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "createTable"
},
"DeleteItem" : {
"documentation" : "Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
",
"operationName" : "DeleteItem",
"deprecated" : false,
"input" : {
"variableName" : "deleteItemRequest",
"variableType" : "DeleteItemRequest",
"variableDeclarationType" : "DeleteItemRequest",
"documentation" : "Represents the input of a DeleteItem operation.
",
"simpleType" : "DeleteItemRequest",
"variableSetterType" : "DeleteItemRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "DeleteItemResult",
"documentation" : "Represents the output of a DeleteItem operation.
"
},
"exceptions" : [ {
"exceptionName" : "ConditionalCheckFailedException",
"documentation" : "A condition specified in the operation could not be evaluated.
"
}, {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "ItemCollectionSizeLimitExceededException",
"documentation" : "An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "DeleteItemResult",
"asyncReturnType" : "DeleteItemResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "deleteItem"
},
"DeleteTable" : {
"documentation" : "The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable API to check the status of the table.
",
"operationName" : "DeleteTable",
"deprecated" : false,
"input" : {
"variableName" : "deleteTableRequest",
"variableType" : "DeleteTableRequest",
"variableDeclarationType" : "DeleteTableRequest",
"documentation" : "Represents the input of a DeleteTable operation.
",
"simpleType" : "DeleteTableRequest",
"variableSetterType" : "DeleteTableRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "DeleteTableResult",
"documentation" : "Represents the output of a DeleteTable operation.
"
},
"exceptions" : [ {
"exceptionName" : "ResourceInUseException",
"documentation" : "The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "DeleteTableResult",
"asyncReturnType" : "DeleteTableResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "deleteTable"
},
"DescribeLimits" : {
"documentation" : "Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.
When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide.
Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.
For example, you could use one of the AWS SDKs to do the following:
Call DescribeLimits for a particular region to obtain your current account limits on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.
Call 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 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.
Report the account limits for that region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level limits.
The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.
DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.
The DescribeLimits Request element has no content.
",
"operationName" : "DescribeLimits",
"deprecated" : false,
"input" : {
"variableName" : "describeLimitsRequest",
"variableType" : "DescribeLimitsRequest",
"variableDeclarationType" : "DescribeLimitsRequest",
"documentation" : "Represents the input of a DescribeLimits operation. Has no content.
",
"simpleType" : "DescribeLimitsRequest",
"variableSetterType" : "DescribeLimitsRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "DescribeLimitsResult",
"documentation" : "Represents the output of a DescribeLimits operation.
"
},
"exceptions" : [ {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "DescribeLimitsResult",
"asyncReturnType" : "DescribeLimitsResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "describeLimits"
},
"DescribeTable" : {
"documentation" : "Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
",
"operationName" : "DescribeTable",
"deprecated" : false,
"input" : {
"variableName" : "describeTableRequest",
"variableType" : "DescribeTableRequest",
"variableDeclarationType" : "DescribeTableRequest",
"documentation" : "Represents the input of a DescribeTable operation.
",
"simpleType" : "DescribeTableRequest",
"variableSetterType" : "DescribeTableRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "DescribeTableResult",
"documentation" : "Represents the output of a DescribeTable operation.
"
},
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "DescribeTableResult",
"asyncReturnType" : "DescribeTableResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "describeTable"
},
"GetItem" : {
"documentation" : "The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data.
GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.
",
"operationName" : "GetItem",
"deprecated" : false,
"input" : {
"variableName" : "getItemRequest",
"variableType" : "GetItemRequest",
"variableDeclarationType" : "GetItemRequest",
"documentation" : "Represents the input of a GetItem operation.
",
"simpleType" : "GetItemRequest",
"variableSetterType" : "GetItemRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "GetItemResult",
"documentation" : "Represents the output of a GetItem operation.
"
},
"exceptions" : [ {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "GetItemResult",
"asyncReturnType" : "GetItemResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "getItem"
},
"ListTables" : {
"documentation" : "Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.
",
"operationName" : "ListTables",
"deprecated" : false,
"input" : {
"variableName" : "listTablesRequest",
"variableType" : "ListTablesRequest",
"variableDeclarationType" : "ListTablesRequest",
"documentation" : "Represents the input of a ListTables operation.
",
"simpleType" : "ListTablesRequest",
"variableSetterType" : "ListTablesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ListTablesResult",
"documentation" : "Represents the output of a ListTables operation.
"
},
"exceptions" : [ {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "ListTablesResult",
"asyncReturnType" : "ListTablesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "listTables"
},
"PutItem" : {
"documentation" : "Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.
In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.
You can request that PutItem return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the ReturnValues description below.
To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.
For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.
",
"operationName" : "PutItem",
"deprecated" : false,
"input" : {
"variableName" : "putItemRequest",
"variableType" : "PutItemRequest",
"variableDeclarationType" : "PutItemRequest",
"documentation" : "Represents the input of a PutItem operation.
",
"simpleType" : "PutItemRequest",
"variableSetterType" : "PutItemRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "PutItemResult",
"documentation" : "Represents the output of a PutItem operation.
"
},
"exceptions" : [ {
"exceptionName" : "ConditionalCheckFailedException",
"documentation" : "A condition specified in the operation could not be evaluated.
"
}, {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "ItemCollectionSizeLimitExceededException",
"documentation" : "An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "PutItemResult",
"asyncReturnType" : "PutItemResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "putItem"
},
"Query" : {
"documentation" : "A Query operation uses the primary key of a table or a secondary index to directly access items from that table or index.
Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. You can use the ScanIndexForward parameter to get results in forward or reverse order, by sort key.
Queries that do not return results consume the minimum number of read capacity units for that type of read operation.
If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the LastEvaluatedKey element to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey value. LastEvaluatedKey is only provided if you have used the Limit parameter, or if the result set exceeds 1 MB (prior to applying a filter).
You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.
",
"operationName" : "Query",
"deprecated" : false,
"input" : {
"variableName" : "queryRequest",
"variableType" : "QueryRequest",
"variableDeclarationType" : "QueryRequest",
"documentation" : "Represents the input of a Query operation.
",
"simpleType" : "QueryRequest",
"variableSetterType" : "QueryRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "QueryResult",
"documentation" : "Represents the output of a Query operation.
"
},
"exceptions" : [ {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "QueryResult",
"asyncReturnType" : "QueryResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "query"
},
"Scan" : {
"documentation" : "The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a ScanFilter operation.
If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.
By default, Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.
By default, Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.
",
"operationName" : "Scan",
"deprecated" : false,
"input" : {
"variableName" : "scanRequest",
"variableType" : "ScanRequest",
"variableDeclarationType" : "ScanRequest",
"documentation" : "Represents the input of a Scan operation.
",
"simpleType" : "ScanRequest",
"variableSetterType" : "ScanRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ScanResult",
"documentation" : "Represents the output of a Scan operation.
"
},
"exceptions" : [ {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "ScanResult",
"asyncReturnType" : "ScanResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "scan"
},
"UpdateItem" : {
"documentation" : "Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).
You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.
",
"operationName" : "UpdateItem",
"deprecated" : false,
"input" : {
"variableName" : "updateItemRequest",
"variableType" : "UpdateItemRequest",
"variableDeclarationType" : "UpdateItemRequest",
"documentation" : "Represents the input of an UpdateItem operation.
",
"simpleType" : "UpdateItemRequest",
"variableSetterType" : "UpdateItemRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "UpdateItemResult",
"documentation" : "Represents the output of an UpdateItem operation.
"
},
"exceptions" : [ {
"exceptionName" : "ConditionalCheckFailedException",
"documentation" : "A condition specified in the operation could not be evaluated.
"
}, {
"exceptionName" : "ProvisionedThroughputExceededException",
"documentation" : "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "ItemCollectionSizeLimitExceededException",
"documentation" : "An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "UpdateItemResult",
"asyncReturnType" : "UpdateItemResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "updateItem"
},
"UpdateTable" : {
"documentation" : "Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
You can only perform one of the following operations at once:
-
Modify the provisioned throughput settings of the table.
-
Enable or disable Streams on the table.
-
Remove a global secondary index from the table.
-
Create a new global secondary index on the table. Once the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
",
"operationName" : "UpdateTable",
"deprecated" : false,
"input" : {
"variableName" : "updateTableRequest",
"variableType" : "UpdateTableRequest",
"variableDeclarationType" : "UpdateTableRequest",
"documentation" : "Represents the input of an UpdateTable operation.
",
"simpleType" : "UpdateTableRequest",
"variableSetterType" : "UpdateTableRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "UpdateTableResult",
"documentation" : "Represents the output of an UpdateTable operation.
"
},
"exceptions" : [ {
"exceptionName" : "ResourceInUseException",
"documentation" : "The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
"
}, {
"exceptionName" : "InternalServerErrorException",
"documentation" : "An error occurred on the server side.
"
} ],
"hasBlobMemberAsPayload" : false,
"syncReturnType" : "UpdateTableResult",
"asyncReturnType" : "UpdateTableResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"authenticated" : true,
"methodName" : "updateTable"
}
},
"shapes" : {
"AttributeAction" : {
"c2jName" : "AttributeAction",
"documentation" : "",
"shapeName" : "AttributeAction",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : null,
"enums" : [ {
"name" : "ADD",
"value" : "ADD"
}, {
"name" : "PUT",
"value" : "PUT"
}, {
"name" : "DELETE",
"value" : "DELETE"
} ],
"variable" : {
"variableName" : "attributeAction",
"variableType" : "AttributeAction",
"variableDeclarationType" : "AttributeAction",
"documentation" : null,
"simpleType" : "AttributeAction",
"variableSetterType" : "AttributeAction"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : null,
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : { }
},
"AttributeValue" : {
"c2jName" : "AttributeValue",
"documentation" : "Represents the data for an attribute. You can set one, and only one, of the elements.
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
",
"shapeName" : "AttributeValue",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "A String data type.
",
"name" : "S",
"c2jName" : "S",
"c2jShape" : "StringAttributeValue",
"variable" : {
"variableName" : "s",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "A String data type.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "s",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "S",
"marshallLocationName" : "S",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A String data type.
\n@param s A String data type.*/",
"getterDocumentation" : "/**A String data type.
\n@return A String data type.*/",
"fluentSetterDocumentation" : "/**A String data type.
\n@param s A String data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A String data type.
\n@param s A String data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A Number data type.
",
"name" : "N",
"c2jName" : "N",
"c2jShape" : "NumberAttributeValue",
"variable" : {
"variableName" : "n",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "A Number data type.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "n",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "N",
"marshallLocationName" : "N",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Number data type.
\n@param n A Number data type.*/",
"getterDocumentation" : "/**A Number data type.
\n@return A Number data type.*/",
"fluentSetterDocumentation" : "/**A Number data type.
\n@param n A Number data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Number data type.
\n@param n A Number data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A Binary data type.
",
"name" : "B",
"c2jName" : "B",
"c2jShape" : "BinaryAttributeValue",
"variable" : {
"variableName" : "b",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "A Binary data type.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"setterModel" : {
"variableName" : "b",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "B",
"marshallLocationName" : "B",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Binary data type.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param b A Binary data type.*/",
"getterDocumentation" : "/**A Binary data type.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return A Binary data type.*/",
"fluentSetterDocumentation" : "/**A Binary data type.
\n@param b A Binary data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Binary data type.
\n@param b A Binary data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A String Set data type.
",
"name" : "SS",
"c2jName" : "SS",
"c2jShape" : "StringSetAttributeValue",
"variable" : {
"variableName" : "sS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A String Set data type.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "sS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SS",
"marshallLocationName" : "SS",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "String",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "StringAttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"map" : false,
"simpleType" : "String",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A String Set data type.
\n@param sS A String Set data type.*/",
"getterDocumentation" : "/**A String Set data type.
\n@return A String Set data type.*/",
"fluentSetterDocumentation" : "/**A String Set data type.
\n@param sS A String Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A String Set data type.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setSS(java.util.Collection)} or {@link #withSS(java.util.Collection)} if you want to override the existing values.
\n@param sS A String Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A Number Set data type.
",
"name" : "NS",
"c2jName" : "NS",
"c2jShape" : "NumberSetAttributeValue",
"variable" : {
"variableName" : "nS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A Number Set data type.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "nS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NS",
"marshallLocationName" : "NS",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "String",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "NumberAttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"map" : false,
"simpleType" : "String",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A Number Set data type.
\n@param nS A Number Set data type.*/",
"getterDocumentation" : "/**A Number Set data type.
\n@return A Number Set data type.*/",
"fluentSetterDocumentation" : "/**A Number Set data type.
\n@param nS A Number Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Number Set data type.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setNS(java.util.Collection)} or {@link #withNS(java.util.Collection)} if you want to override the existing values.
\n@param nS A Number Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A Binary Set data type.
",
"name" : "BS",
"c2jName" : "BS",
"c2jShape" : "BinarySetAttributeValue",
"variable" : {
"variableName" : "bS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A Binary Set data type.
",
"simpleType" : "ByteBuffer>",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "bS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "ByteBuffer>",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "BS",
"marshallLocationName" : "BS",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "java.nio.ByteBuffer",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "BinaryAttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param member */",
"getterDocumentation" : "/**\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"map" : false,
"simpleType" : "ByteBuffer",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A Binary Set data type.
\n@param bS A Binary Set data type.*/",
"getterDocumentation" : "/**A Binary Set data type.
\n@return A Binary Set data type.*/",
"fluentSetterDocumentation" : "/**A Binary Set data type.
\n@param bS A Binary Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Binary Set data type.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setBS(java.util.Collection)} or {@link #withBS(java.util.Collection)} if you want to override the existing values.
\n@param bS A Binary Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A Map of attribute values.
",
"name" : "M",
"c2jName" : "M",
"c2jShape" : "MapAttributeValue",
"variable" : {
"variableName" : "m",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "A Map of attribute values.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "m",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "M",
"marshallLocationName" : "M",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "AttributeValue",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "AttributeValue",
"variable" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"getterModel" : {
"returnType" : "AttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : false,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**A Map of attribute values.
\n@param m A Map of attribute values.*/",
"getterDocumentation" : "/**A Map of attribute values.
\n@return A Map of attribute values.*/",
"fluentSetterDocumentation" : "/**A Map of attribute values.
\n@param m A Map of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Map of attribute values.
\n@param m A Map of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A List of attribute values.
",
"name" : "L",
"c2jName" : "L",
"c2jShape" : "ListAttributeValue",
"variable" : {
"variableName" : "l",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A List of attribute values.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "l",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "L",
"marshallLocationName" : "L",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "AttributeValue",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "AttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"getterModel" : {
"returnType" : "AttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"map" : false,
"simpleType" : "AttributeValue",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A List of attribute values.
\n@param l A List of attribute values.*/",
"getterDocumentation" : "/**A List of attribute values.
\n@return A List of attribute values.*/",
"fluentSetterDocumentation" : "/**A List of attribute values.
\n@param l A List of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A List of attribute values.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setL(java.util.Collection)} or {@link #withL(java.util.Collection)} if you want to override the existing values.
\n@param l A List of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A Null data type.
",
"name" : "NULL",
"c2jName" : "NULL",
"c2jShape" : "NullAttributeValue",
"variable" : {
"variableName" : "nULLValue",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "A Null data type.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"setterModel" : {
"variableName" : "nULLValue",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NULL",
"marshallLocationName" : "NULL",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Null data type.
\n@param nULLValue A Null data type.*/",
"getterDocumentation" : "/**A Null data type.
\n@return A Null data type.*/",
"fluentSetterDocumentation" : "/**A Null data type.
\n@param nULLValue A Null data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Null data type.
\n@param nULLValue A Null data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A Boolean data type.
",
"name" : "BOOL",
"c2jName" : "BOOL",
"c2jShape" : "BooleanAttributeValue",
"variable" : {
"variableName" : "bOOL",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "A Boolean data type.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"setterModel" : {
"variableName" : "bOOL",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "BOOL",
"marshallLocationName" : "BOOL",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Boolean data type.
\n@param bOOL A Boolean data type.*/",
"getterDocumentation" : "/**A Boolean data type.
\n@return A Boolean data type.*/",
"fluentSetterDocumentation" : "/**A Boolean data type.
\n@param bOOL A Boolean data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Boolean data type.
\n@param bOOL A Boolean data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "attributeValue",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : null,
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : null,
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"SS" : {
"documentation" : "A String Set data type.
",
"name" : "SS",
"c2jName" : "SS",
"c2jShape" : "StringSetAttributeValue",
"variable" : {
"variableName" : "sS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A String Set data type.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "sS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SS",
"marshallLocationName" : "SS",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "String",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "StringAttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"map" : false,
"simpleType" : "String",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A String Set data type.
\n@param sS A String Set data type.*/",
"getterDocumentation" : "/**A String Set data type.
\n@return A String Set data type.*/",
"fluentSetterDocumentation" : "/**A String Set data type.
\n@param sS A String Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A String Set data type.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setSS(java.util.Collection)} or {@link #withSS(java.util.Collection)} if you want to override the existing values.
\n@param sS A String Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"BS" : {
"documentation" : "A Binary Set data type.
",
"name" : "BS",
"c2jName" : "BS",
"c2jShape" : "BinarySetAttributeValue",
"variable" : {
"variableName" : "bS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A Binary Set data type.
",
"simpleType" : "ByteBuffer>",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "bS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "ByteBuffer>",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "BS",
"marshallLocationName" : "BS",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "java.nio.ByteBuffer",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "BinaryAttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param member */",
"getterDocumentation" : "/**\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"map" : false,
"simpleType" : "ByteBuffer",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A Binary Set data type.
\n@param bS A Binary Set data type.*/",
"getterDocumentation" : "/**A Binary Set data type.
\n@return A Binary Set data type.*/",
"fluentSetterDocumentation" : "/**A Binary Set data type.
\n@param bS A Binary Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Binary Set data type.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setBS(java.util.Collection)} or {@link #withBS(java.util.Collection)} if you want to override the existing values.
\n@param bS A Binary Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"B" : {
"documentation" : "A Binary data type.
",
"name" : "B",
"c2jName" : "B",
"c2jShape" : "BinaryAttributeValue",
"variable" : {
"variableName" : "b",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "A Binary data type.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"setterModel" : {
"variableName" : "b",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "B",
"marshallLocationName" : "B",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Binary data type.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param b A Binary data type.*/",
"getterDocumentation" : "/**A Binary data type.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return A Binary data type.*/",
"fluentSetterDocumentation" : "/**A Binary data type.
\n@param b A Binary data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Binary data type.
\n@param b A Binary data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"S" : {
"documentation" : "A String data type.
",
"name" : "S",
"c2jName" : "S",
"c2jShape" : "StringAttributeValue",
"variable" : {
"variableName" : "s",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "A String data type.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "s",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "S",
"marshallLocationName" : "S",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A String data type.
\n@param s A String data type.*/",
"getterDocumentation" : "/**A String data type.
\n@return A String data type.*/",
"fluentSetterDocumentation" : "/**A String data type.
\n@param s A String data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A String data type.
\n@param s A String data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"NULL" : {
"documentation" : "A Null data type.
",
"name" : "NULL",
"c2jName" : "NULL",
"c2jShape" : "NullAttributeValue",
"variable" : {
"variableName" : "nULLValue",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "A Null data type.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"setterModel" : {
"variableName" : "nULLValue",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NULL",
"marshallLocationName" : "NULL",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Null data type.
\n@param nULLValue A Null data type.*/",
"getterDocumentation" : "/**A Null data type.
\n@return A Null data type.*/",
"fluentSetterDocumentation" : "/**A Null data type.
\n@param nULLValue A Null data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Null data type.
\n@param nULLValue A Null data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"NS" : {
"documentation" : "A Number Set data type.
",
"name" : "NS",
"c2jName" : "NS",
"c2jShape" : "NumberSetAttributeValue",
"variable" : {
"variableName" : "nS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A Number Set data type.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "nS",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NS",
"marshallLocationName" : "NS",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "String",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "NumberAttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"map" : false,
"simpleType" : "String",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A Number Set data type.
\n@param nS A Number Set data type.*/",
"getterDocumentation" : "/**A Number Set data type.
\n@return A Number Set data type.*/",
"fluentSetterDocumentation" : "/**A Number Set data type.
\n@param nS A Number Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Number Set data type.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setNS(java.util.Collection)} or {@link #withNS(java.util.Collection)} if you want to override the existing values.
\n@param nS A Number Set data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"BOOL" : {
"documentation" : "A Boolean data type.
",
"name" : "BOOL",
"c2jName" : "BOOL",
"c2jShape" : "BooleanAttributeValue",
"variable" : {
"variableName" : "bOOL",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "A Boolean data type.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"setterModel" : {
"variableName" : "bOOL",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "BOOL",
"marshallLocationName" : "BOOL",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Boolean data type.
\n@param bOOL A Boolean data type.*/",
"getterDocumentation" : "/**A Boolean data type.
\n@return A Boolean data type.*/",
"fluentSetterDocumentation" : "/**A Boolean data type.
\n@param bOOL A Boolean data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Boolean data type.
\n@param bOOL A Boolean data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"L" : {
"documentation" : "A List of attribute values.
",
"name" : "L",
"c2jName" : "L",
"c2jShape" : "ListAttributeValue",
"variable" : {
"variableName" : "l",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "A List of attribute values.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "l",
"variableType" : "java.util.List",
"variableDeclarationType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "L",
"marshallLocationName" : "L",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "AttributeValue",
"memberLocationName" : null,
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "AttributeValue",
"variable" : {
"variableName" : "member",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"getterModel" : {
"returnType" : "AttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"map" : false,
"simpleType" : "AttributeValue",
"templateType" : "java.util.List",
"templateImplType" : "java.util.ArrayList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A List of attribute values.
\n@param l A List of attribute values.*/",
"getterDocumentation" : "/**A List of attribute values.
\n@return A List of attribute values.*/",
"fluentSetterDocumentation" : "/**A List of attribute values.
\n@param l A List of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A List of attribute values.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setL(java.util.Collection)} or {@link #withL(java.util.Collection)} if you want to override the existing values.
\n@param l A List of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"M" : {
"documentation" : "A Map of attribute values.
",
"name" : "M",
"c2jName" : "M",
"c2jShape" : "MapAttributeValue",
"variable" : {
"variableName" : "m",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "A Map of attribute values.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "m",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "M",
"marshallLocationName" : "M",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "AttributeValue",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "AttributeValue",
"variable" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"getterModel" : {
"returnType" : "AttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : false,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**A Map of attribute values.
\n@param m A Map of attribute values.*/",
"getterDocumentation" : "/**A Map of attribute values.
\n@return A Map of attribute values.*/",
"fluentSetterDocumentation" : "/**A Map of attribute values.
\n@param m A Map of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Map of attribute values.
\n@param m A Map of attribute values.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"N" : {
"documentation" : "A Number data type.
",
"name" : "N",
"c2jName" : "N",
"c2jShape" : "NumberAttributeValue",
"variable" : {
"variableName" : "n",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "A Number data type.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "n",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "N",
"marshallLocationName" : "N",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A Number data type.
\n@param n A Number data type.*/",
"getterDocumentation" : "/**A Number data type.
\n@return A Number data type.*/",
"fluentSetterDocumentation" : "/**A Number data type.
\n@param n A Number data type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A Number data type.
\n@param n A Number data type.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"UpdateItemRequest" : {
"c2jName" : "UpdateItemInput",
"documentation" : "Represents the input of an UpdateItem operation.
",
"shapeName" : "UpdateItemRequest",
"deprecated" : false,
"required" : [ "TableName", "Key" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The name of the table containing the item to update.
",
"name" : "TableName",
"c2jName" : "TableName",
"c2jShape" : "TableName",
"variable" : {
"variableName" : "tableName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The name of the table containing the item to update.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "tableName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TableName",
"marshallLocationName" : "TableName",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The name of the table containing the item to update.
\n@param tableName The name of the table containing the item to update.*/",
"getterDocumentation" : "/**The name of the table containing the item to update.
\n@return The name of the table containing the item to update.*/",
"fluentSetterDocumentation" : "/**The name of the table containing the item to update.
\n@param tableName The name of the table containing the item to update.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The name of the table containing the item to update.
\n@param tableName The name of the table containing the item to update.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
",
"name" : "Key",
"c2jName" : "Key",
"c2jShape" : "Key",
"variable" : {
"variableName" : "key",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "key",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Key",
"marshallLocationName" : "Key",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "AttributeValue",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "AttributeValue",
"variable" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"getterModel" : {
"returnType" : "AttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : false,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
\n@param key The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. 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.*/",
"getterDocumentation" : "/**
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
\n@return The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. 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.*/",
"fluentSetterDocumentation" : "/**
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
\n@param key The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. 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.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
\n@param key The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. 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.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.
",
"name" : "AttributeUpdates",
"c2jName" : "AttributeUpdates",
"c2jShape" : "AttributeUpdates",
"variable" : {
"variableName" : "attributeUpdates",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributeUpdates",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeUpdates",
"marshallLocationName" : "AttributeUpdates",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "AttributeValueUpdate",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "AttributeValueUpdate",
"variable" : {
"variableName" : "value",
"variableType" : "AttributeValueUpdate",
"variableDeclarationType" : "AttributeValueUpdate",
"documentation" : "",
"simpleType" : "AttributeValueUpdate",
"variableSetterType" : "AttributeValueUpdate"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "AttributeValueUpdate",
"variableDeclarationType" : "AttributeValueUpdate",
"documentation" : "",
"simpleType" : "AttributeValueUpdate",
"variableSetterType" : "AttributeValueUpdate"
},
"getterModel" : {
"returnType" : "AttributeValueUpdate",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : false,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.
\n@param attributeUpdates This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.*/",
"getterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.
\n@return This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.*/",
"fluentSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.
\n@param attributeUpdates This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.
\n@param attributeUpdates This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
-
Value - The new value, if applicable, for this attribute.
-
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
-
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
-
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
-
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
-
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
-
DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.
-
ADD - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you provide 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.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
",
"name" : "Expected",
"c2jName" : "Expected",
"c2jShape" : "ExpectedAttributeMap",
"variable" : {
"variableName" : "expected",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "expected",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Expected",
"marshallLocationName" : "Expected",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "ExpectedAttributeValue",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "ExpectedAttributeValue",
"variable" : {
"variableName" : "value",
"variableType" : "ExpectedAttributeValue",
"variableDeclarationType" : "ExpectedAttributeValue",
"documentation" : "",
"simpleType" : "ExpectedAttributeValue",
"variableSetterType" : "ExpectedAttributeValue"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "ExpectedAttributeValue",
"variableDeclarationType" : "ExpectedAttributeValue",
"documentation" : "",
"simpleType" : "ExpectedAttributeValue",
"variableSetterType" : "ExpectedAttributeValue"
},
"getterModel" : {
"returnType" : "ExpectedAttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : false,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@param expected This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
*/",
"getterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@return This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
*/",
"fluentSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@param expected This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@param expected This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
",
"name" : "ConditionalOperator",
"c2jName" : "ConditionalOperator",
"c2jShape" : "ConditionalOperator",
"variable" : {
"variableName" : "conditionalOperator",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "conditionalOperator",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ConditionalOperator",
"marshallLocationName" : "ConditionalOperator",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : "ConditionalOperator",
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@param conditionalOperator This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@see ConditionalOperator*/",
"getterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@return This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@see ConditionalOperator*/",
"fluentSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@param conditionalOperator This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConditionalOperator*/",
"varargSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@param conditionalOperator This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConditionalOperator*/"
}, {
"documentation" : "Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
",
"name" : "ReturnValues",
"c2jName" : "ReturnValues",
"c2jShape" : "ReturnValue",
"variable" : {
"variableName" : "returnValues",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "returnValues",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ReturnValues",
"marshallLocationName" : "ReturnValues",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : "ReturnValue",
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
\n@param returnValues Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are: -
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent\n@see ReturnValue*/",
"getterDocumentation" : "/**
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
\n@return Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are: -
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent\n@see ReturnValue*/",
"fluentSetterDocumentation" : "/**
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
\n@param returnValues Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are: -
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent\n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnValue*/",
"varargSetterDocumentation" : "/**
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
\n@param returnValues Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are: -
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
-
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
-
UPDATED_OLD - The old versions of only the updated attributes are returned.
-
ALL_NEW - All of the attributes of the new version of the item are returned.
-
UPDATED_NEW - The new versions of only the updated attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent\n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnValue*/"
}, {
"documentation" : "",
"name" : "ReturnConsumedCapacity",
"c2jName" : "ReturnConsumedCapacity",
"c2jShape" : "ReturnConsumedCapacity",
"variable" : {
"variableName" : "returnConsumedCapacity",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "returnConsumedCapacity",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ReturnConsumedCapacity",
"marshallLocationName" : "ReturnConsumedCapacity",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : "ReturnConsumedCapacity",
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param returnConsumedCapacity \n@see ReturnConsumedCapacity*/",
"getterDocumentation" : "/**\n@return \n@see ReturnConsumedCapacity*/",
"fluentSetterDocumentation" : "/**\n@param returnConsumedCapacity \n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnConsumedCapacity*/",
"varargSetterDocumentation" : "/**\n@param returnConsumedCapacity \n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnConsumedCapacity*/"
}, {
"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 the operation are returned in the response. If set to NONE (the default), no statistics are returned.
",
"name" : "ReturnItemCollectionMetrics",
"c2jName" : "ReturnItemCollectionMetrics",
"c2jShape" : "ReturnItemCollectionMetrics",
"variable" : {
"variableName" : "returnItemCollectionMetrics",
"variableType" : "String",
"variableDeclarationType" : "String",
"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 the operation are returned in the response. If set to NONE (the default), no statistics are returned.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "returnItemCollectionMetrics",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ReturnItemCollectionMetrics",
"marshallLocationName" : "ReturnItemCollectionMetrics",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : "ReturnItemCollectionMetrics",
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
\n@param returnItemCollectionMetrics Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.\n@see ReturnItemCollectionMetrics*/",
"getterDocumentation" : "/**Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
\n@return Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.\n@see ReturnItemCollectionMetrics*/",
"fluentSetterDocumentation" : "/**Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
\n@param returnItemCollectionMetrics Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.\n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnItemCollectionMetrics*/",
"varargSetterDocumentation" : "/**Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
\n@param returnItemCollectionMetrics Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.\n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnItemCollectionMetrics*/"
}, {
"documentation" : "An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
",
"name" : "UpdateExpression",
"c2jName" : "UpdateExpression",
"c2jShape" : "UpdateExpression",
"variable" : {
"variableName" : "updateExpression",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "updateExpression",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "UpdateExpression",
"marshallLocationName" : "UpdateExpression",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
\n@param updateExpression An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
*/",
"getterDocumentation" : "/**An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
\n@return An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
*/",
"fluentSetterDocumentation" : "/**An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
\n@param updateExpression An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
\n@param updateExpression An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for UpdateExpression.
-
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
-
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.
-
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.
-
REMOVE - Removes one or more attributes from an item.
-
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
-
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
-
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
-
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, 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, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
",
"name" : "ConditionExpression",
"c2jName" : "ConditionExpression",
"c2jShape" : "ConditionExpression",
"variable" : {
"variableName" : "conditionExpression",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "conditionExpression",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ConditionExpression",
"marshallLocationName" : "ConditionExpression",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
\n@param conditionExpression A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
*/",
"getterDocumentation" : "/**A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
\n@return A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
*/",
"fluentSetterDocumentation" : "/**A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
\n@param conditionExpression A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
\n@param conditionExpression A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following:
-
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"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.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
",
"name" : "ExpressionAttributeNames",
"c2jName" : "ExpressionAttributeNames",
"c2jShape" : "ExpressionAttributeNameMap",
"variable" : {
"variableName" : "expressionAttributeNames",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"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.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "expressionAttributeNames",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ExpressionAttributeNames",
"marshallLocationName" : "ExpressionAttributeNames",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "AttributeName",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
\n@param expressionAttributeNames One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: -
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.*/",
"getterDocumentation" : "/**
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
\n@return One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: -
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.*/",
"fluentSetterDocumentation" : "/**
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
\n@param expressionAttributeNames One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: -
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
\n@param expressionAttributeNames One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: -
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{\"#P\":\"Percentile\"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "
One or more values that can be substituted in an expression.
Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
",
"name" : "ExpressionAttributeValues",
"c2jName" : "ExpressionAttributeValues",
"c2jShape" : "ExpressionAttributeValueMap",
"variable" : {
"variableName" : "expressionAttributeValues",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "One or more values that can be substituted in an expression.
Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "expressionAttributeValues",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ExpressionAttributeValues",
"marshallLocationName" : "ExpressionAttributeValues",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "AttributeValue",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "AttributeValue",
"variable" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "AttributeValue",
"variableDeclarationType" : "AttributeValue",
"documentation" : "",
"simpleType" : "AttributeValue",
"variableSetterType" : "AttributeValue"
},
"getterModel" : {
"returnType" : "AttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : false,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**One or more values that can be substituted in an expression.
Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
\n@param expressionAttributeValues One or more values that can be substituted in an expression. Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.*/",
"getterDocumentation" : "/**
One or more values that can be substituted in an expression.
Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
\n@return One or more values that can be substituted in an expression. Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.*/",
"fluentSetterDocumentation" : "/**
One or more values that can be substituted in an expression.
Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
\n@param expressionAttributeValues One or more values that can be substituted in an expression. Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
One or more values that can be substituted in an expression.
Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
\n@param expressionAttributeValues One or more values that can be substituted in an expression. Use 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:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "updateItemRequest",
"variableType" : "UpdateItemRequest",
"variableDeclarationType" : "UpdateItemRequest",
"documentation" : null,
"simpleType" : "UpdateItemRequest",
"variableSetterType" : "UpdateItemRequest"
},
"marshaller" : {
"action" : "UpdateItem",
"verb" : "POST",
"target" : "DynamoDB_20120810.UpdateItem",
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"TableName" : {
"documentation" : "
The name of the table containing the item to update.
",
"name" : "TableName",
"c2jName" : "TableName",
"c2jShape" : "TableName",
"variable" : {
"variableName" : "tableName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The name of the table containing the item to update.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "tableName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TableName",
"marshallLocationName" : "TableName",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The name of the table containing the item to update.
\n@param tableName The name of the table containing the item to update.*/",
"getterDocumentation" : "/**The name of the table containing the item to update.
\n@return The name of the table containing the item to update.*/",
"fluentSetterDocumentation" : "/**The name of the table containing the item to update.
\n@param tableName The name of the table containing the item to update.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The name of the table containing the item to update.
\n@param tableName The name of the table containing the item to update.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"Expected" : {
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
",
"name" : "Expected",
"c2jName" : "Expected",
"c2jShape" : "ExpectedAttributeMap",
"variable" : {
"variableName" : "expected",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "expected",
"variableType" : "java.util.Map",
"variableDeclarationType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Expected",
"marshallLocationName" : "Expected",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "ExpectedAttributeValue",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "ExpectedAttributeValue",
"variable" : {
"variableName" : "value",
"variableType" : "ExpectedAttributeValue",
"variableDeclarationType" : "ExpectedAttributeValue",
"documentation" : "",
"simpleType" : "ExpectedAttributeValue",
"variableSetterType" : "ExpectedAttributeValue"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "ExpectedAttributeValue",
"variableDeclarationType" : "ExpectedAttributeValue",
"documentation" : "",
"simpleType" : "ExpectedAttributeValue",
"variableSetterType" : "ExpectedAttributeValue"
},
"getterModel" : {
"returnType" : "ExpectedAttributeValue",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"keySimple" : true,
"valueSimple" : false,
"valueList" : false,
"templateType" : "java.util.Map",
"templateImplType" : "java.util.HashMap",
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@param expected This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
*/",
"getterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@return This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
*/",
"fluentSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@param expected This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@param expected This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
-
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
-
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
-
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, 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.
-
NULL : The attribute does not exist. NULL is supported for all datatypes, 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.
-
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
-
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_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.
-
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
-
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
-
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
-
Value - A value for DynamoDB to compare with an attribute.
-
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
-
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
-
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"ConditionalOperator" : {
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
",
"name" : "ConditionalOperator",
"c2jName" : "ConditionalOperator",
"c2jShape" : "ConditionalOperator",
"variable" : {
"variableName" : "conditionalOperator",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : " This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "conditionalOperator",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ConditionalOperator",
"marshallLocationName" : "ConditionalOperator",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : "ConditionalOperator",
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@param conditionalOperator This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@see ConditionalOperator*/",
"getterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@return This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@see ConditionalOperator*/",
"fluentSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@param conditionalOperator This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConditionalOperator*/",
"varargSetterDocumentation" : "/** This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@param conditionalOperator This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
-
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
-
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConditionalOperator*/"
},
"ReturnConsumedCapacity" : {
"documentation" : "",
"name" : "ReturnConsumedCapacity",
"c2jName" : "ReturnConsumedCapacity",
"c2jShape" : "ReturnConsumedCapacity",
"variable" : {
"variableName" : "returnConsumedCapacity",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "returnConsumedCapacity",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "ReturnConsumedCapacity",
"marshallLocationName" : "ReturnConsumedCapacity",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : "ReturnConsumedCapacity",
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param returnConsumedCapacity \n@see ReturnConsumedCapacity*/",
"getterDocumentation" : "/**\n@return \n@see ReturnConsumedCapacity*/",
"fluentSetterDocumentation" : "/**\n@param returnConsumedCapacity \n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnConsumedCapacity*/",
"varargSetterDocumentation" : "/**\n@param returnConsumedCapacity \n@return Returns a reference to this object so that method calls can be chained together.\n@see ReturnConsumedCapacity*/"
},
"ConditionExpression" : {
"documentation" : "A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions: