aws-sdk-core 2.0.0.rc14 → 2.0.0.rc15
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +32 -3
- data/apis/AutoScaling.api.json +1943 -0
- data/apis/{autoscaling-2011-01-01.paginators.json → AutoScaling.paginators.json} +0 -0
- data/apis/CloudFormation.api.json +785 -0
- data/apis/{cloudformation-2010-05-15.paginators.json → CloudFormation.paginators.json} +0 -0
- data/apis/CloudFront.api.json +2581 -0
- data/apis/{cloudfront-2014-05-31.paginators.json → CloudFront.paginators.json} +0 -0
- data/apis/{cloudfront-2014-01-31.waiters.json → CloudFront.waiters.json} +0 -0
- data/apis/CloudSearch.api.json +1955 -0
- data/apis/{cloudsearch-2013-01-01.paginators.json → CloudSearch.paginators.json} +0 -0
- data/apis/CloudSearchDomain.api.json +349 -0
- data/apis/CloudTrail.api.json +559 -0
- data/apis/{cloudtrail-2013-11-01.paginators.json → CloudTrail.paginators.json} +0 -0
- data/apis/CloudWatch.api.json +917 -0
- data/apis/{monitoring-2010-08-01.paginators.json → CloudWatch.paginators.json} +0 -0
- data/apis/CloudWatchLogs.api.json +816 -0
- data/apis/{logs-2014-03-28.paginators.json → CloudWatchLogs.paginators.json} +0 -0
- data/apis/CognitoIdentity.api.json +631 -0
- data/apis/CognitoSync.api.json +721 -0
- data/apis/DataPipeline.api.json +940 -0
- data/apis/{datapipeline-2012-10-29.paginators.json → DataPipeline.paginators.json} +0 -0
- data/apis/DirectConnect.api.json +833 -0
- data/apis/{directconnect-2012-10-25.paginators.json → DirectConnect.paginators.json} +0 -0
- data/apis/DynamoDB.api.json +1210 -0
- data/apis/{dynamodb-2011-12-05.paginators.json → DynamoDB.paginators.json} +0 -0
- data/apis/{dynamodb-2012-08-10.waiters.json → DynamoDB.waiters.json} +0 -0
- data/apis/EC2.api.json +9914 -0
- data/apis/{ec2-2014-06-15.paginators.json → EC2.paginators.json} +0 -0
- data/apis/{ec2-2014-06-15.resources.json → EC2.resources.json} +0 -0
- data/apis/{ec2-2014-06-15.waiters.json → EC2.waiters.json} +0 -0
- data/apis/EMR.api.json +1339 -0
- data/apis/{elasticmapreduce-2009-03-31.paginators.json → EMR.paginators.json} +0 -0
- data/apis/ElastiCache.api.json +3410 -0
- data/apis/{elasticache-2014-03-24.paginators.json → ElastiCache.paginators.json} +0 -0
- data/apis/ElasticBeanstalk.api.json +1540 -0
- data/apis/{elasticbeanstalk-2010-12-01.paginators.json → ElasticBeanstalk.paginators.json} +0 -0
- data/apis/ElasticLoadBalancing.api.json +2131 -0
- data/apis/{elasticloadbalancing-2012-06-01.paginators.json → ElasticLoadBalancing.paginators.json} +0 -0
- data/apis/ElasticTranscoder.api.json +1647 -0
- data/apis/{elastictranscoder-2012-09-25.paginators.json → ElasticTranscoder.paginators.json} +0 -0
- data/apis/Glacier.api.json +1456 -0
- data/apis/{glacier-2012-06-01.paginators.json → Glacier.paginators.json} +0 -0
- data/apis/{glacier-2012-06-01.resources.json → Glacier.resources.json} +0 -0
- data/apis/{glacier-2012-06-01.waiters.json → Glacier.waiters.json} +0 -0
- data/apis/IAM.api.json +4033 -0
- data/apis/{iam-2010-05-08.paginators.json → IAM.paginators.json} +0 -0
- data/apis/{iam-2010-05-08.resources.json → IAM.resources.json} +0 -0
- data/apis/ImportExport.api.json +515 -0
- data/apis/{importexport-2010-06-01.paginators.json → ImportExport.paginators.json} +0 -0
- data/apis/Kinesis.api.json +548 -0
- data/apis/{kinesis-2013-12-02.paginators.json → Kinesis.paginators.json} +0 -0
- data/apis/OpsWorks.api.json +2524 -0
- data/apis/{opsworks-2013-02-18.paginators.json → OpsWorks.paginators.json} +0 -0
- data/apis/RDS.api.json +4473 -0
- data/apis/{rds-2013-02-12.paginators.json → RDS.paginators.json} +0 -0
- data/apis/{rds-2013-09-09.waiters.json → RDS.waiters.json} +0 -0
- data/apis/Redshift.api.json +4482 -0
- data/apis/{redshift-2012-12-01.paginators.json → Redshift.paginators.json} +0 -0
- data/apis/{redshift-2012-12-01.waiters.json → Redshift.waiters.json} +0 -0
- data/apis/Route53.api.json +1935 -0
- data/apis/{route53-2013-04-01.paginators.json → Route53.paginators.json} +0 -0
- data/apis/Route53Domains.api.json +1129 -0
- data/apis/{s3-2006-03-01.api.json → S3.api.json} +336 -942
- data/apis/{s3-2006-03-01.paginators.json → S3.paginators.json} +1 -1
- data/apis/{s3-2006-03-01.resources.json → S3.resources.json} +0 -0
- data/apis/{s3-2006-03-01.waiters.json → S3.waiters.json} +0 -0
- data/apis/SES.api.json +644 -0
- data/apis/{email-2010-12-01.paginators.json → SES.paginators.json} +0 -0
- data/apis/{email-2010-12-01.waiters.json → SES.waiters.json} +0 -0
- data/apis/SNS.api.json +1760 -0
- data/apis/{sns-2010-03-31.paginators.json → SNS.paginators.json} +0 -0
- data/apis/{sns-2010-03-31.resources.json → SNS.resources.json} +0 -0
- data/apis/SQS.api.json +1113 -0
- data/apis/{sqs-2012-11-05.paginators.json → SQS.paginators.json} +0 -0
- data/apis/{sqs-2012-11-05.resources.json → SQS.resources.json} +0 -0
- data/apis/STS.api.json +594 -0
- data/apis/SWF.api.json +2656 -0
- data/apis/{swf-2012-01-25.paginators.json → SWF.paginators.json} +0 -0
- data/apis/SimpleDB.api.json +954 -0
- data/apis/{sdb-2009-04-15.paginators.json → SimpleDB.paginators.json} +0 -0
- data/apis/StorageGateway.api.json +2311 -0
- data/apis/{storagegateway-2013-06-30.paginators.json → StorageGateway.paginators.json} +0 -0
- data/apis/Support.api.json +869 -0
- data/apis/{support-2013-04-15.paginators.json → Support.paginators.json} +0 -0
- data/lib/aws.rb +96 -53
- data/lib/aws/api/documenter.rb +238 -0
- data/lib/aws/api/{documentor.rb → operation_documenter.rb} +9 -5
- data/lib/aws/api/{doc_example.rb → operation_example.rb} +8 -7
- data/lib/aws/api/service_customizations.rb +3 -1
- data/lib/aws/client.rb +38 -0
- data/lib/aws/credential_provider_chain.rb +1 -0
- data/lib/aws/dynamodb/attribute_value.rb +87 -0
- data/lib/aws/empty_structure.rb +4 -3
- data/lib/aws/endpoint_provider.rb +1 -0
- data/lib/aws/errors.rb +2 -0
- data/lib/aws/instance_profile_credentials.rb +1 -1
- data/lib/aws/plugins/csd_conditional_signing.rb +32 -0
- data/lib/aws/plugins/dynamodb_simple_attributes.rb +179 -0
- data/lib/aws/plugins/global_configuration.rb +13 -3
- data/lib/aws/plugins/protocols/json_rpc.rb +9 -7
- data/lib/aws/plugins/regional_endpoint.rb +1 -1
- data/lib/aws/plugins/request_signer.rb +13 -6
- data/lib/aws/plugins/response_paging.rb +1 -2
- data/lib/aws/plugins/s3_url_encoded_keys.rb +92 -0
- data/lib/aws/plugins/user_agent.rb +1 -2
- data/lib/aws/signers/v4.rb +1 -1
- data/lib/aws/structure.rb +49 -2
- data/lib/aws/version.rb +1 -1
- data/lib/aws/xml/builder.rb +1 -0
- data/lib/seahorse.rb +2 -1
- data/lib/seahorse/client/handler_list.rb +10 -3
- data/lib/seahorse/client/http/request.rb +0 -8
- data/lib/seahorse/client/xml/builder.rb +0 -1
- data/lib/seahorse/model/shape_map.rb +1 -0
- data/lib/seahorse/model/shapes.rb +5 -0
- metadata +93 -107
- data/apis/autoscaling-2011-01-01.api.json +0 -3063
- data/apis/cloudformation-2010-05-15.api.json +0 -1306
- data/apis/cloudfront-2014-01-31.api.json +0 -3478
- data/apis/cloudfront-2014-01-31.paginators.json +0 -32
- data/apis/cloudfront-2014-05-31.api.json +0 -3540
- data/apis/cloudfront-2014-05-31.waiters.json +0 -29
- data/apis/cloudsearch-2011-02-01.api.json +0 -2093
- data/apis/cloudsearch-2011-02-01.paginators.json +0 -13
- data/apis/cloudsearch-2013-01-01.api.json +0 -2655
- data/apis/cloudsearchdomain-2013-01-01.api.json +0 -508
- data/apis/cloudtrail-2013-11-01.api.json +0 -773
- data/apis/cognito-identity-2014-06-30.api.json +0 -884
- data/apis/cognito-sync-2014-06-30.api.json +0 -1029
- data/apis/datapipeline-2012-10-29.api.json +0 -1432
- data/apis/directconnect-2012-10-25.api.json +0 -1174
- data/apis/dynamodb-2011-12-05.api.json +0 -1208
- data/apis/dynamodb-2011-12-05.waiters.json +0 -27
- data/apis/dynamodb-2012-08-10.api.json +0 -1857
- data/apis/dynamodb-2012-08-10.paginators.json +0 -26
- data/apis/ec2-2014-06-15.api.json +0 -11670
- data/apis/elasticache-2014-03-24.api.json +0 -4789
- data/apis/elasticache-2014-07-15.api.json +0 -4826
- data/apis/elasticache-2014-07-15.paginators.json +0 -76
- data/apis/elasticbeanstalk-2010-12-01.api.json +0 -2442
- data/apis/elasticloadbalancing-2012-06-01.api.json +0 -2605
- data/apis/elasticmapreduce-2009-03-31.api.json +0 -2282
- data/apis/elastictranscoder-2012-09-25.api.json +0 -2478
- data/apis/email-2010-12-01.api.json +0 -954
- data/apis/glacier-2012-06-01.api.json +0 -2012
- data/apis/iam-2010-05-08.api.json +0 -5322
- data/apis/importexport-2010-06-01.api.json +0 -687
- data/apis/kinesis-2013-12-02.api.json +0 -769
- data/apis/logs-2014-03-28.api.json +0 -942
- data/apis/manifest.json +0 -259
- data/apis/monitoring-2010-08-01.api.json +0 -1338
- data/apis/opsworks-2013-02-18.api.json +0 -4348
- data/apis/rds-2013-01-10.api.json +0 -6074
- data/apis/rds-2013-01-10.paginators.json +0 -97
- data/apis/rds-2013-02-12.api.json +0 -6392
- data/apis/rds-2013-09-09.api.json +0 -6564
- data/apis/rds-2013-09-09.paginators.json +0 -110
- data/apis/redshift-2012-12-01.api.json +0 -6318
- data/apis/route53-2013-04-01.api.json +0 -2493
- data/apis/route53domains-2014-05-15.api.json +0 -1622
- data/apis/sdb-2009-04-15.api.json +0 -1178
- data/apis/sns-2010-03-31.api.json +0 -2275
- data/apis/sqs-2012-11-05.api.json +0 -1438
- data/apis/storagegateway-2013-06-30.api.json +0 -3153
- data/apis/sts-2011-06-15.api.json +0 -786
- data/apis/support-2013-04-15.api.json +0 -1379
- data/apis/swf-2012-01-25.api.json +0 -4463
- data/lib/aws/api/manifest.rb +0 -29
- data/lib/aws/api/manifest_builder.rb +0 -57
- data/lib/aws/api/minifier.rb +0 -42
- data/lib/aws/response_handler.rb +0 -38
- data/lib/aws/service_builder.rb +0 -56
@@ -1,27 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"waiters": {
|
3
|
-
"__default__": {
|
4
|
-
"interval": 20,
|
5
|
-
"max_attempts": 25
|
6
|
-
},
|
7
|
-
"__TableState": {
|
8
|
-
"operation": "DescribeTable"
|
9
|
-
},
|
10
|
-
"TableExists": {
|
11
|
-
"extends": "__TableState",
|
12
|
-
"description": "Wait until a table exists and can be accessed",
|
13
|
-
"ignore_errors": [
|
14
|
-
"ResourceNotFoundException"
|
15
|
-
],
|
16
|
-
"success_type": "output",
|
17
|
-
"success_path": "Table.TableStatus",
|
18
|
-
"success_value": "ACTIVE"
|
19
|
-
},
|
20
|
-
"TableNotExists": {
|
21
|
-
"extends": "__TableState",
|
22
|
-
"description": "Wait until a table is deleted",
|
23
|
-
"success_type": "error",
|
24
|
-
"success_value": "ResourceNotFoundException"
|
25
|
-
}
|
26
|
-
}
|
27
|
-
}
|
@@ -1,1857 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"metadata":{
|
3
|
-
"apiVersion":"2012-08-10",
|
4
|
-
"endpointPrefix":"dynamodb",
|
5
|
-
"jsonVersion":"1.0",
|
6
|
-
"serviceAbbreviation":"DynamoDB",
|
7
|
-
"serviceFullName":"Amazon DynamoDB",
|
8
|
-
"signatureVersion":"v4",
|
9
|
-
"targetPrefix":"DynamoDB_20120810",
|
10
|
-
"protocol":"json"
|
11
|
-
},
|
12
|
-
"documentation":"<fullname>Amazon DynamoDB</fullname> <b>Overview</b> <p>This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the low-level DynamoDB API. For information about DynamoDB application development, go to the <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/\">Amazon DynamoDB Developer Guide</a>.</p> <p>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, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html\">Using the AWS SDKs with DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p>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, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API.html\">Using the DynamoDB API</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p>The following are short descriptions of each low-level API action, organized by function.</p> <p> <b>Managing Tables</b> </p> <p> <ul> <li> <p><i>CreateTable</i> - Creates a table with user-specified provisioned throughput settings. You must designate one attribute as the hash primary key for the table; you can optionally designate a second attribute as the range primary key. DynamoDB creates indexes on these key attributes for fast data access. Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes.</p> </li> <li> <p><i>DescribeTable</i> - Returns metadata for a table, such as table size, status, and index information.</p> </li> <li> <p><i>UpdateTable</i> - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table.</p> </li> <li> <p><i>ListTables</i> - Returns a list of all tables associated with the current AWS account and endpoint.</p> </li> <li> <p><i>DeleteTable</i> - Deletes a table and all of its indexes.</p> </li> </ul> </p> <p>For conceptual information about managing tables, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html\">Working with Tables</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p> <b>Reading Data</b> </p> <p> <ul> <li> <p><i>GetItem</i> - Returns a set of attributes for the item that has a given primary key. By default, <i>GetItem</i> performs an eventually consistent read; however, applications can specify a strongly consistent read instead.</p> </li> <li> <p><i>BatchGetItem</i> - Performs multiple <i>GetItem</i> requests for data items using their primary keys, from one table or multiple tables. The response from <i>BatchGetItem</i> has a size limit of 1 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used.</p> </li> <li> <p><i>Query</i> - Returns one or more items from a table or a secondary index. You must provide a specific hash key value. You can narrow the scope of the query using comparison operators against a range key value, or on the index key. <i>Query</i> supports either eventual or strong consistency. A single response has a size limit of 1 MB.</p> </li> <li> <p><i>Scan</i> - 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. <i>Scan</i> 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, <i>Scan</i> should not be used for any application query use case that requires predictable performance.</p> </li> </ul> </p> <p>For conceptual information about reading data, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html\">Working with Items</a> and <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p> <b>Modifying Data</b> </p> <p> <ul> <li> <p><i>PutItem</i> - 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.</p> </li> <li> <p><i>UpdateItem</i> - 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.</p> </li> <li> <p><i>DeleteItem</i> - 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.</p> </li> <li> <p><i>BatchWriteItem</i> - Performs multiple <i>PutItem</i> and <i>DeleteItem</i> requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire <i>BatchWriteItem</i> operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 1 MB. </p> </li> </ul> </p> <p>For conceptual information about modifying data, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html\">Working with Items</a> and <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
|
13
|
-
"operations":{
|
14
|
-
"BatchGetItem":{
|
15
|
-
"name":"BatchGetItem",
|
16
|
-
"http":{
|
17
|
-
"method":"POST",
|
18
|
-
"requestUri":"/"
|
19
|
-
},
|
20
|
-
"input":{
|
21
|
-
"shape":"BatchGetItemInput",
|
22
|
-
"documentation":"<p>Represents the input of a <i>BatchGetItem</i> operation.</p>"
|
23
|
-
},
|
24
|
-
"output":{
|
25
|
-
"shape":"BatchGetItemOutput",
|
26
|
-
"documentation":"<p>Represents the output of a <i>BatchGetItem</i> operation.</p>"
|
27
|
-
},
|
28
|
-
"errors":[
|
29
|
-
{
|
30
|
-
"shape":"ProvisionedThroughputExceededException",
|
31
|
-
"exception":true,
|
32
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
33
|
-
},
|
34
|
-
{
|
35
|
-
"shape":"ResourceNotFoundException",
|
36
|
-
"exception":true,
|
37
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
38
|
-
},
|
39
|
-
{
|
40
|
-
"shape":"InternalServerError",
|
41
|
-
"exception":true,
|
42
|
-
"fault":true,
|
43
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
44
|
-
}
|
45
|
-
],
|
46
|
-
"documentation":"<p>The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.</p> <p>A single operation can retrieve up to 1 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> 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 <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get.</p> <p>For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items (1 MB) and an appropriate <i>UnprocessedKeys</i> 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 dataset.</p> <p>If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will throw a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>.</p> <important><p>If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. 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.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations\">Batch Operations and Error Handling</a> in the Amazon DynamoDB Developer Guide.</p></important> <p>By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables.</p> <p>In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel.</p> <p>When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter.</p> <p>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 <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations\">Capacity Units Calculations</a> in the Amazon DynamoDB Developer Guide.</p>"
|
47
|
-
},
|
48
|
-
"BatchWriteItem":{
|
49
|
-
"name":"BatchWriteItem",
|
50
|
-
"http":{
|
51
|
-
"method":"POST",
|
52
|
-
"requestUri":"/"
|
53
|
-
},
|
54
|
-
"input":{
|
55
|
-
"shape":"BatchWriteItemInput",
|
56
|
-
"documentation":"<p>Represents the input of a <i>BatchWriteItem</i> operation.</p>"
|
57
|
-
},
|
58
|
-
"output":{
|
59
|
-
"shape":"BatchWriteItemOutput",
|
60
|
-
"documentation":"<p>Represents the output of a <i>BatchWriteItem</i> operation.</p>"
|
61
|
-
},
|
62
|
-
"errors":[
|
63
|
-
{
|
64
|
-
"shape":"ProvisionedThroughputExceededException",
|
65
|
-
"exception":true,
|
66
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
67
|
-
},
|
68
|
-
{
|
69
|
-
"shape":"ResourceNotFoundException",
|
70
|
-
"exception":true,
|
71
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
72
|
-
},
|
73
|
-
{
|
74
|
-
"shape":"ItemCollectionSizeLimitExceededException",
|
75
|
-
"exception":true,
|
76
|
-
"documentation":"<p>An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.</p>"
|
77
|
-
},
|
78
|
-
{
|
79
|
-
"shape":"InternalServerError",
|
80
|
-
"exception":true,
|
81
|
-
"fault":true,
|
82
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
83
|
-
}
|
84
|
-
],
|
85
|
-
"documentation":"<p>The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 1 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 64 KB.</p> <p>The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> 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 <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed.</p> <p>Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will throw a <i>ProvisionedThroughputExceededException</i>.</p> <important><p>If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. 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.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations\">Batch Operations and Error Handling</a> in the Amazon DynamoDB Developer Guide.</p></important> <p>With <i>BatchWriteItem</i>, 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, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response.</p> <p>If you use a programming language that supports concurrency, such as Java, 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, such as PHP, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> 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.</p> <p>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.</p> <p>If one or more of the following is true, DynamoDB rejects the entire batch write operation:</p> <ul> <li> <p>One or more tables specified in the <i>BatchWriteItem</i> request does not exist.</p> </li> <li> <p>Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.</p> </li> <li> <p>You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </p> </li> <li> <p>The total request size exceeds 1 MB.</p> </li> <li> <p>Any individual item in a batch exceeds 64 KB.</p> </li> </ul>"
|
86
|
-
},
|
87
|
-
"CreateTable":{
|
88
|
-
"name":"CreateTable",
|
89
|
-
"http":{
|
90
|
-
"method":"POST",
|
91
|
-
"requestUri":"/"
|
92
|
-
},
|
93
|
-
"input":{
|
94
|
-
"shape":"CreateTableInput",
|
95
|
-
"documentation":"<p>Represents the input of a <i>CreateTable</i> operation.</p>"
|
96
|
-
},
|
97
|
-
"output":{
|
98
|
-
"shape":"CreateTableOutput",
|
99
|
-
"documentation":"<p>Represents the output of a <i>CreateTable</i> operation.</p>"
|
100
|
-
},
|
101
|
-
"errors":[
|
102
|
-
{
|
103
|
-
"shape":"ResourceInUseException",
|
104
|
-
"exception":true,
|
105
|
-
"documentation":"<p>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 <code>CREATING</code> state.</p>"
|
106
|
-
},
|
107
|
-
{
|
108
|
-
"shape":"LimitExceededException",
|
109
|
-
"exception":true,
|
110
|
-
"documentation":"<p>The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10.</p> <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>"
|
111
|
-
},
|
112
|
-
{
|
113
|
-
"shape":"InternalServerError",
|
114
|
-
"exception":true,
|
115
|
-
"fault":true,
|
116
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
117
|
-
}
|
118
|
-
],
|
119
|
-
"documentation":"<p>The <i>CreateTable</i> 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.</p> <p><i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </p> <p>If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time.</p> <p>You can use the <i>DescribeTable</i> API to check the table status.</p>"
|
120
|
-
},
|
121
|
-
"DeleteItem":{
|
122
|
-
"name":"DeleteItem",
|
123
|
-
"http":{
|
124
|
-
"method":"POST",
|
125
|
-
"requestUri":"/"
|
126
|
-
},
|
127
|
-
"input":{
|
128
|
-
"shape":"DeleteItemInput",
|
129
|
-
"documentation":"<p>Represents the input of a <i>DeleteItem</i> operation.</p>"
|
130
|
-
},
|
131
|
-
"output":{
|
132
|
-
"shape":"DeleteItemOutput",
|
133
|
-
"documentation":"<p>Represents the output of a <i>DeleteItem</i> operation.</p>"
|
134
|
-
},
|
135
|
-
"errors":[
|
136
|
-
{
|
137
|
-
"shape":"ConditionalCheckFailedException",
|
138
|
-
"exception":true,
|
139
|
-
"documentation":"<p>A condition specified in the operation could not be evaluated.</p>"
|
140
|
-
},
|
141
|
-
{
|
142
|
-
"shape":"ProvisionedThroughputExceededException",
|
143
|
-
"exception":true,
|
144
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
145
|
-
},
|
146
|
-
{
|
147
|
-
"shape":"ResourceNotFoundException",
|
148
|
-
"exception":true,
|
149
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
150
|
-
},
|
151
|
-
{
|
152
|
-
"shape":"ItemCollectionSizeLimitExceededException",
|
153
|
-
"exception":true,
|
154
|
-
"documentation":"<p>An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.</p>"
|
155
|
-
},
|
156
|
-
{
|
157
|
-
"shape":"InternalServerError",
|
158
|
-
"exception":true,
|
159
|
-
"fault":true,
|
160
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
161
|
-
}
|
162
|
-
],
|
163
|
-
"documentation":"<p>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.</p> <p>In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter.</p> <p>Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response.</p> <p>Conditional deletes are useful for only deleting items if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </p>"
|
164
|
-
},
|
165
|
-
"DeleteTable":{
|
166
|
-
"name":"DeleteTable",
|
167
|
-
"http":{
|
168
|
-
"method":"POST",
|
169
|
-
"requestUri":"/"
|
170
|
-
},
|
171
|
-
"input":{
|
172
|
-
"shape":"DeleteTableInput",
|
173
|
-
"documentation":"<p>Represents the input of a <i>DeleteTable</i> operation.</p>"
|
174
|
-
},
|
175
|
-
"output":{
|
176
|
-
"shape":"DeleteTableOutput",
|
177
|
-
"documentation":"<p>Represents the output of a <i>DeleteTable</i> operation.</p>"
|
178
|
-
},
|
179
|
-
"errors":[
|
180
|
-
{
|
181
|
-
"shape":"ResourceInUseException",
|
182
|
-
"exception":true,
|
183
|
-
"documentation":"<p>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 <code>CREATING</code> state.</p>"
|
184
|
-
},
|
185
|
-
{
|
186
|
-
"shape":"ResourceNotFoundException",
|
187
|
-
"exception":true,
|
188
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
189
|
-
},
|
190
|
-
{
|
191
|
-
"shape":"LimitExceededException",
|
192
|
-
"exception":true,
|
193
|
-
"documentation":"<p>The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10.</p> <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>"
|
194
|
-
},
|
195
|
-
{
|
196
|
-
"shape":"InternalServerError",
|
197
|
-
"exception":true,
|
198
|
-
"fault":true,
|
199
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
200
|
-
}
|
201
|
-
],
|
202
|
-
"documentation":"<p>The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. </p> <p>When you delete a table, any indexes on that table are also deleted.</p> <p>Use the <i>DescribeTable</i> API to check the status of the table. </p>"
|
203
|
-
},
|
204
|
-
"DescribeTable":{
|
205
|
-
"name":"DescribeTable",
|
206
|
-
"http":{
|
207
|
-
"method":"POST",
|
208
|
-
"requestUri":"/"
|
209
|
-
},
|
210
|
-
"input":{
|
211
|
-
"shape":"DescribeTableInput",
|
212
|
-
"documentation":"<p>Represents the input of a <i>DescribeTable</i> operation.</p>"
|
213
|
-
},
|
214
|
-
"output":{
|
215
|
-
"shape":"DescribeTableOutput",
|
216
|
-
"documentation":"<p>Represents the output of a <i>DescribeTable</i> operation.</p>"
|
217
|
-
},
|
218
|
-
"errors":[
|
219
|
-
{
|
220
|
-
"shape":"ResourceNotFoundException",
|
221
|
-
"exception":true,
|
222
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
223
|
-
},
|
224
|
-
{
|
225
|
-
"shape":"InternalServerError",
|
226
|
-
"exception":true,
|
227
|
-
"fault":true,
|
228
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
229
|
-
}
|
230
|
-
],
|
231
|
-
"documentation":"<p>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.</p>"
|
232
|
-
},
|
233
|
-
"GetItem":{
|
234
|
-
"name":"GetItem",
|
235
|
-
"http":{
|
236
|
-
"method":"POST",
|
237
|
-
"requestUri":"/"
|
238
|
-
},
|
239
|
-
"input":{
|
240
|
-
"shape":"GetItemInput",
|
241
|
-
"documentation":"<p>Represents the input of a <i>GetItem</i> operation.</p>"
|
242
|
-
},
|
243
|
-
"output":{
|
244
|
-
"shape":"GetItemOutput",
|
245
|
-
"documentation":"<p>Represents the output of a <i>GetItem</i> operation.</p>"
|
246
|
-
},
|
247
|
-
"errors":[
|
248
|
-
{
|
249
|
-
"shape":"ProvisionedThroughputExceededException",
|
250
|
-
"exception":true,
|
251
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
252
|
-
},
|
253
|
-
{
|
254
|
-
"shape":"ResourceNotFoundException",
|
255
|
-
"exception":true,
|
256
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
257
|
-
},
|
258
|
-
{
|
259
|
-
"shape":"InternalServerError",
|
260
|
-
"exception":true,
|
261
|
-
"fault":true,
|
262
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
263
|
-
}
|
264
|
-
],
|
265
|
-
"documentation":"<p>The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data.</p> <p><i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.</p>"
|
266
|
-
},
|
267
|
-
"ListTables":{
|
268
|
-
"name":"ListTables",
|
269
|
-
"http":{
|
270
|
-
"method":"POST",
|
271
|
-
"requestUri":"/"
|
272
|
-
},
|
273
|
-
"input":{
|
274
|
-
"shape":"ListTablesInput",
|
275
|
-
"documentation":"<p>Represents the input of a <i>ListTables</i> operation.</p>"
|
276
|
-
},
|
277
|
-
"output":{
|
278
|
-
"shape":"ListTablesOutput",
|
279
|
-
"documentation":"<p>Represents the output of a <i>ListTables</i> operation.</p>"
|
280
|
-
},
|
281
|
-
"errors":[
|
282
|
-
{
|
283
|
-
"shape":"InternalServerError",
|
284
|
-
"exception":true,
|
285
|
-
"fault":true,
|
286
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
287
|
-
}
|
288
|
-
],
|
289
|
-
"documentation":"<p>Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names.</p>"
|
290
|
-
},
|
291
|
-
"PutItem":{
|
292
|
-
"name":"PutItem",
|
293
|
-
"http":{
|
294
|
-
"method":"POST",
|
295
|
-
"requestUri":"/"
|
296
|
-
},
|
297
|
-
"input":{
|
298
|
-
"shape":"PutItemInput",
|
299
|
-
"documentation":"<p>Represents the input of a <i>PutItem</i> operation.</p>"
|
300
|
-
},
|
301
|
-
"output":{
|
302
|
-
"shape":"PutItemOutput",
|
303
|
-
"documentation":"<p>Represents the output of a <i>PutItem</i> operation.</p>"
|
304
|
-
},
|
305
|
-
"errors":[
|
306
|
-
{
|
307
|
-
"shape":"ConditionalCheckFailedException",
|
308
|
-
"exception":true,
|
309
|
-
"documentation":"<p>A condition specified in the operation could not be evaluated.</p>"
|
310
|
-
},
|
311
|
-
{
|
312
|
-
"shape":"ProvisionedThroughputExceededException",
|
313
|
-
"exception":true,
|
314
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
315
|
-
},
|
316
|
-
{
|
317
|
-
"shape":"ResourceNotFoundException",
|
318
|
-
"exception":true,
|
319
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
320
|
-
},
|
321
|
-
{
|
322
|
-
"shape":"ItemCollectionSizeLimitExceededException",
|
323
|
-
"exception":true,
|
324
|
-
"documentation":"<p>An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.</p>"
|
325
|
-
},
|
326
|
-
{
|
327
|
-
"shape":"InternalServerError",
|
328
|
-
"exception":true,
|
329
|
-
"fault":true,
|
330
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
331
|
-
}
|
332
|
-
],
|
333
|
-
"documentation":"<p>Creates a new item, or replaces an old item with a new item. If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. </p> <p>In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter.</p> <p>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 <i>ValidationException</i>.</p> <p>You can request that <i>PutItem</i> return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the <i>ReturnValues</i> description.</p> <p>For more information about using this API, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html\">Working with Items</a> in the Amazon DynamoDB Developer Guide.</p>"
|
334
|
-
},
|
335
|
-
"Query":{
|
336
|
-
"name":"Query",
|
337
|
-
"http":{
|
338
|
-
"method":"POST",
|
339
|
-
"requestUri":"/"
|
340
|
-
},
|
341
|
-
"input":{
|
342
|
-
"shape":"QueryInput",
|
343
|
-
"documentation":"<p>Represents the input of a <i>Query</i> operation.</p>"
|
344
|
-
},
|
345
|
-
"output":{
|
346
|
-
"shape":"QueryOutput",
|
347
|
-
"documentation":"<p>Represents the output of a <i>Query</i> operation.</p>"
|
348
|
-
},
|
349
|
-
"errors":[
|
350
|
-
{
|
351
|
-
"shape":"ProvisionedThroughputExceededException",
|
352
|
-
"exception":true,
|
353
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
354
|
-
},
|
355
|
-
{
|
356
|
-
"shape":"ResourceNotFoundException",
|
357
|
-
"exception":true,
|
358
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
359
|
-
},
|
360
|
-
{
|
361
|
-
"shape":"InternalServerError",
|
362
|
-
"exception":true,
|
363
|
-
"fault":true,
|
364
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
365
|
-
}
|
366
|
-
],
|
367
|
-
"documentation":"<p>A <i>Query</i> operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by range key or by index key. </p> <p>Queries that do not return results consume the minimum read capacity units according to the type of read.</p> <p>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 a <i>LastEvaluatedKey</i> to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns an empty result set <i>and</i> a <i>LastEvaluatedKey</i>. The <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used <i>Limit</i>. </p> <p>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 <i>ConsistentRead</i> to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <i>ConsistentRead</i> when querying a global secondary index.</p>"
|
368
|
-
},
|
369
|
-
"Scan":{
|
370
|
-
"name":"Scan",
|
371
|
-
"http":{
|
372
|
-
"method":"POST",
|
373
|
-
"requestUri":"/"
|
374
|
-
},
|
375
|
-
"input":{
|
376
|
-
"shape":"ScanInput",
|
377
|
-
"documentation":"<p>Represents the input of a <i>Scan</i> operation.</p>"
|
378
|
-
},
|
379
|
-
"output":{
|
380
|
-
"shape":"ScanOutput",
|
381
|
-
"documentation":"<p>Represents the output of a <i>Scan</i> operation.</p>"
|
382
|
-
},
|
383
|
-
"errors":[
|
384
|
-
{
|
385
|
-
"shape":"ProvisionedThroughputExceededException",
|
386
|
-
"exception":true,
|
387
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
388
|
-
},
|
389
|
-
{
|
390
|
-
"shape":"ResourceNotFoundException",
|
391
|
-
"exception":true,
|
392
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
393
|
-
},
|
394
|
-
{
|
395
|
-
"shape":"InternalServerError",
|
396
|
-
"exception":true,
|
397
|
-
"fault":true,
|
398
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
399
|
-
}
|
400
|
-
],
|
401
|
-
"documentation":"<p>The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in the table. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i>.</p> <p>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 with a <i>LastEvaluatedKey</i> 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. </p> <p>The result set is eventually consistent. </p> <p>By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel <i>Scan</i> by specifying the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan\">Parallel Scan</a> in the Amazon DynamoDB Developer Guide.</p>"
|
402
|
-
},
|
403
|
-
"UpdateItem":{
|
404
|
-
"name":"UpdateItem",
|
405
|
-
"http":{
|
406
|
-
"method":"POST",
|
407
|
-
"requestUri":"/"
|
408
|
-
},
|
409
|
-
"input":{
|
410
|
-
"shape":"UpdateItemInput",
|
411
|
-
"documentation":"<p>Represents the input of an <i>UpdateItem</i> operation.</p>"
|
412
|
-
},
|
413
|
-
"output":{
|
414
|
-
"shape":"UpdateItemOutput",
|
415
|
-
"documentation":"<p>Represents the output of an <i>UpdateItem</i> operation.</p>"
|
416
|
-
},
|
417
|
-
"errors":[
|
418
|
-
{
|
419
|
-
"shape":"ConditionalCheckFailedException",
|
420
|
-
"exception":true,
|
421
|
-
"documentation":"<p>A condition specified in the operation could not be evaluated.</p>"
|
422
|
-
},
|
423
|
-
{
|
424
|
-
"shape":"ProvisionedThroughputExceededException",
|
425
|
-
"exception":true,
|
426
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
427
|
-
},
|
428
|
-
{
|
429
|
-
"shape":"ResourceNotFoundException",
|
430
|
-
"exception":true,
|
431
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
432
|
-
},
|
433
|
-
{
|
434
|
-
"shape":"ItemCollectionSizeLimitExceededException",
|
435
|
-
"exception":true,
|
436
|
-
"documentation":"<p>An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.</p>"
|
437
|
-
},
|
438
|
-
{
|
439
|
-
"shape":"InternalServerError",
|
440
|
-
"exception":true,
|
441
|
-
"fault":true,
|
442
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
443
|
-
}
|
444
|
-
],
|
445
|
-
"documentation":"<p> Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (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).</p> <p>In addition to updating an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter.</p>"
|
446
|
-
},
|
447
|
-
"UpdateTable":{
|
448
|
-
"name":"UpdateTable",
|
449
|
-
"http":{
|
450
|
-
"method":"POST",
|
451
|
-
"requestUri":"/"
|
452
|
-
},
|
453
|
-
"input":{
|
454
|
-
"shape":"UpdateTableInput",
|
455
|
-
"documentation":"<p>Represents the input of an <i>UpdateTable</i> operation.</p>"
|
456
|
-
},
|
457
|
-
"output":{
|
458
|
-
"shape":"UpdateTableOutput",
|
459
|
-
"documentation":"<p>Represents the output of an <i>UpdateTable</i> operation.</p>"
|
460
|
-
},
|
461
|
-
"errors":[
|
462
|
-
{
|
463
|
-
"shape":"ResourceInUseException",
|
464
|
-
"exception":true,
|
465
|
-
"documentation":"<p>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 <code>CREATING</code> state.</p>"
|
466
|
-
},
|
467
|
-
{
|
468
|
-
"shape":"ResourceNotFoundException",
|
469
|
-
"exception":true,
|
470
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
471
|
-
},
|
472
|
-
{
|
473
|
-
"shape":"LimitExceededException",
|
474
|
-
"exception":true,
|
475
|
-
"documentation":"<p>The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10.</p> <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>"
|
476
|
-
},
|
477
|
-
{
|
478
|
-
"shape":"InternalServerError",
|
479
|
-
"exception":true,
|
480
|
-
"fault":true,
|
481
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
482
|
-
}
|
483
|
-
],
|
484
|
-
"documentation":"<p>Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.</p> <p>The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Limits</a> section in the Amazon DynamoDB Developer Guide.</p> <p>The table must be in the <code>ACTIVE</code> state for this operation to succeed. <i>UpdateTable</i> is an asynchronous operation; while executing the operation, the table is in the <code>UPDATING</code> state. While the table is in the <code>UPDATING</code> state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the <code>ACTIVE</code> state after the <i>UpdateTable</i> operation. </p> <p>You cannot add, modify or delete indexes using <i>UpdateTable</i>. Indexes can only be defined at table creation time.</p>"
|
485
|
-
}
|
486
|
-
},
|
487
|
-
"shapes":{
|
488
|
-
"AttributeAction":{
|
489
|
-
"type":"string",
|
490
|
-
"enum":[
|
491
|
-
"ADD",
|
492
|
-
"PUT",
|
493
|
-
"DELETE"
|
494
|
-
]
|
495
|
-
},
|
496
|
-
"AttributeDefinition":{
|
497
|
-
"type":"structure",
|
498
|
-
"required":[
|
499
|
-
"AttributeName",
|
500
|
-
"AttributeType"
|
501
|
-
],
|
502
|
-
"members":{
|
503
|
-
"AttributeName":{
|
504
|
-
"shape":"KeySchemaAttributeName",
|
505
|
-
"documentation":"<p>A name for the attribute.</p>"
|
506
|
-
},
|
507
|
-
"AttributeType":{
|
508
|
-
"shape":"ScalarAttributeType",
|
509
|
-
"documentation":"<p>The data type for the attribute.</p>"
|
510
|
-
}
|
511
|
-
},
|
512
|
-
"documentation":"<p>Represents an attribute for describing the key schema for the table and indexes.</p>"
|
513
|
-
},
|
514
|
-
"AttributeDefinitions":{
|
515
|
-
"type":"list",
|
516
|
-
"member":{"shape":"AttributeDefinition"}
|
517
|
-
},
|
518
|
-
"AttributeMap":{
|
519
|
-
"type":"map",
|
520
|
-
"key":{"shape":"AttributeName"},
|
521
|
-
"value":{"shape":"AttributeValue"}
|
522
|
-
},
|
523
|
-
"AttributeName":{
|
524
|
-
"type":"string",
|
525
|
-
"max":65535
|
526
|
-
},
|
527
|
-
"AttributeNameList":{
|
528
|
-
"type":"list",
|
529
|
-
"member":{"shape":"AttributeName"},
|
530
|
-
"min":1
|
531
|
-
},
|
532
|
-
"AttributeUpdates":{
|
533
|
-
"type":"map",
|
534
|
-
"key":{"shape":"AttributeName"},
|
535
|
-
"value":{"shape":"AttributeValueUpdate"}
|
536
|
-
},
|
537
|
-
"AttributeValue":{
|
538
|
-
"type":"structure",
|
539
|
-
"members":{
|
540
|
-
"S":{
|
541
|
-
"shape":"StringAttributeValue",
|
542
|
-
"documentation":"<p>A String data type</p>"
|
543
|
-
},
|
544
|
-
"N":{
|
545
|
-
"shape":"NumberAttributeValue",
|
546
|
-
"documentation":"<p>A Number data type</p>"
|
547
|
-
},
|
548
|
-
"B":{
|
549
|
-
"shape":"BinaryAttributeValue",
|
550
|
-
"documentation":"<p>A Binary data type</p>"
|
551
|
-
},
|
552
|
-
"SS":{
|
553
|
-
"shape":"StringSetAttributeValue",
|
554
|
-
"documentation":"<p>A String set data type</p>"
|
555
|
-
},
|
556
|
-
"NS":{
|
557
|
-
"shape":"NumberSetAttributeValue",
|
558
|
-
"documentation":"<p> Number set data type</p>"
|
559
|
-
},
|
560
|
-
"BS":{
|
561
|
-
"shape":"BinarySetAttributeValue",
|
562
|
-
"documentation":"<p>A Binary set data type</p>"
|
563
|
-
}
|
564
|
-
},
|
565
|
-
"documentation":"<p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>"
|
566
|
-
},
|
567
|
-
"AttributeValueList":{
|
568
|
-
"type":"list",
|
569
|
-
"member":{"shape":"AttributeValue"}
|
570
|
-
},
|
571
|
-
"AttributeValueUpdate":{
|
572
|
-
"type":"structure",
|
573
|
-
"members":{
|
574
|
-
"Value":{"shape":"AttributeValue"},
|
575
|
-
"Action":{
|
576
|
-
"shape":"AttributeAction",
|
577
|
-
"documentation":"<p>Specifies how to perform the update. Valid values are <code>PUT</code>, <code>DELETE</code>, and <code>ADD</code>. The behavior depends on whether the specified primary key already exists in the table.</p> <p> <b>If an item with the specified <i>Key</i> is found in the table:</b> </p> <ul> <li> <p><code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </p> </li> <li> <p><code>DELETE</code> - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.</p> <p>If a <i>set</i> of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <i>DELETE</i> action specified <code>[a,c]</code>, then the final attribute value would be <code>[b]</code>. Specifying an empty set is an error.</p> </li> <li> <p><code>ADD</code> - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute:</p> <ul> <li> <p>If the existing attribute is a number, and if <i>Value</i> is also a number, then the <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute.</p> </li> <li> <p>If the existing data type is a set, and if the <i>Value</i> is also a set, then the <i>Value</i> is added to the existing set. (This is a <i>set</i> operation, not mathematical addition.) For example, if the attribute value was the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value would be <code>[1,2,3]</code>. 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. </p> <p>Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the <i>Value</i> must also be a set of strings. The same holds true for number sets and binary sets.</p> </li> </ul> <p>This action is only valid for an existing attribute whose data type is number or is a set. Do not use <code>ADD</code> for any other data types.</p> </li> </ul> <p> <b>If no item with the specified <i>Key</i> is found:</b> </p> <ul> <li> <p><code>PUT</code> - DynamoDB creates a new item with the specified primary key, and then adds the attribute. </p> </li> <li> <p><code>DELETE</code> - Nothing happens; there is no attribute to delete.</p> </li> <li> <p><code>ADD</code> - DynamoDB creates 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; no other data types can be specified.</p> </li> </ul>"
|
578
|
-
}
|
579
|
-
},
|
580
|
-
"documentation":"<p>For the <i>UpdateItem</i> operation, represents the attributes to be modified, the action to perform on each, and the new value for each.</p> <p>Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i>.</p>"
|
581
|
-
},
|
582
|
-
"BatchGetItemInput":{
|
583
|
-
"type":"structure",
|
584
|
-
"required":["RequestItems"],
|
585
|
-
"members":{
|
586
|
-
"RequestItems":{
|
587
|
-
"shape":"BatchGetRequestMap",
|
588
|
-
"documentation":"<p>A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.</p> <p>Each element in the map consists of the following:</p> <ul> <li> <p><i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p> </li> <li> <p><i>AttributesToGet</i> - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.</p> <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</p> </li> <li> <p><i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used.</p> </li> </ul>"
|
589
|
-
},
|
590
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}
|
591
|
-
},
|
592
|
-
"documentation":"<p>Represents the input of a <i>BatchGetItem</i> operation.</p>"
|
593
|
-
},
|
594
|
-
"BatchGetItemOutput":{
|
595
|
-
"type":"structure",
|
596
|
-
"members":{
|
597
|
-
"Responses":{
|
598
|
-
"shape":"BatchGetResponseMap",
|
599
|
-
"documentation":"<p>A map of table name to a list of items. Each object in <i>Responses</i> consists of a table name, along with a map of attribute data consisting of the data type and attribute value.</p>"
|
600
|
-
},
|
601
|
-
"UnprocessedKeys":{
|
602
|
-
"shape":"BatchGetRequestMap",
|
603
|
-
"documentation":"<p>A map of tables and their respective keys that were not processed with the current response. The <i>UnprocessedKeys</i> value is in the same form as <i>RequestItems</i>, so the value can be provided directly to a subsequent <i>BatchGetItem</i> operation. For more information, see <i>RequestItems</i> in the Request Parameters section.</p> <p>Each element consists of:</p> <ul> <li> <p><i>Keys</i> - An array of primary key attribute values that define specific items in the table.</p> </li> <li> <p><i>AttributesToGet</i> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.</p> </li> <li> <p><i>ConsistentRead</i> - The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used.</p> </li> </ul> <p>If there are no unprocessed keys remaining, the response contains an empty <i>UnprocessedKeys</i> map.</p>"
|
604
|
-
},
|
605
|
-
"ConsumedCapacity":{
|
606
|
-
"shape":"ConsumedCapacityMultiple",
|
607
|
-
"documentation":"<p>The write capacity units consumed by the operation.</p> <p>Each element consists of:</p> <ul> <li> <p><i>TableName</i> - The table that consumed the provisioned throughput.</p> </li> <li> <p><i>CapacityUnits</i> - The total number of capacity units consumed.</p> </li> </ul>"
|
608
|
-
}
|
609
|
-
},
|
610
|
-
"documentation":"<p>Represents the output of a <i>BatchGetItem</i> operation.</p>"
|
611
|
-
},
|
612
|
-
"BatchGetRequestMap":{
|
613
|
-
"type":"map",
|
614
|
-
"key":{"shape":"TableName"},
|
615
|
-
"value":{"shape":"KeysAndAttributes"},
|
616
|
-
"min":1,
|
617
|
-
"max":100
|
618
|
-
},
|
619
|
-
"BatchGetResponseMap":{
|
620
|
-
"type":"map",
|
621
|
-
"key":{"shape":"TableName"},
|
622
|
-
"value":{"shape":"ItemList"}
|
623
|
-
},
|
624
|
-
"BatchWriteItemInput":{
|
625
|
-
"type":"structure",
|
626
|
-
"required":["RequestItems"],
|
627
|
-
"members":{
|
628
|
-
"RequestItems":{
|
629
|
-
"shape":"BatchWriteItemRequestMap",
|
630
|
-
"documentation":"<p>A map of one or more table names and, for each table, a list of operations to be performed (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the following:</p> <ul> <li> <p><i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The item to be deleted is identified by a <i>Key</i> subelement:</p> <ul> <li> <p><i>Key</i> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p> </li> </ul> </li> <li> <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to be put is identified by an <i>Item</i> subelement:</p> <ul> <li> <p><i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i>.</p> <p>If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</p> </li> </ul> </li> </ul>"
|
631
|
-
},
|
632
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"},
|
633
|
-
"ReturnItemCollectionMetrics":{
|
634
|
-
"shape":"ReturnItemCollectionMetrics",
|
635
|
-
"documentation":"<p>If set to <code>SIZE</code>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>"
|
636
|
-
}
|
637
|
-
},
|
638
|
-
"documentation":"<p>Represents the input of a <i>BatchWriteItem</i> operation.</p>"
|
639
|
-
},
|
640
|
-
"BatchWriteItemOutput":{
|
641
|
-
"type":"structure",
|
642
|
-
"members":{
|
643
|
-
"UnprocessedItems":{
|
644
|
-
"shape":"BatchWriteItemRequestMap",
|
645
|
-
"documentation":"<p>A map of tables and requests against those tables that were not processed. The <i>UnprocessedItems</i> value is in the same form as <i>RequestItems</i>, so you can provide this value directly to a subsequent <i>BatchGetItem</i> operation. For more information, see <i>RequestItems</i> in the Request Parameters section.</p> <p>Each <i>UnprocessedItems</i> entry consists of a table name and, for that table, a list of operations to perform (<i>DeleteRequest</i> or <i>PutRequest</i>).</p> <ul> <li> <p><i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The item to be deleted is identified by a <i>Key</i> subelement:</p> <ul> <li> <p><i>Key</i> - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.</p> </li> </ul> </li> <li> <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to be put is identified by an <i>Item</i> subelement:</p> <ul> <li> <p><i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i>.</p> <p>If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</p> </li> </ul> </li> </ul> <p>If there are no unprocessed items remaining, the response contains an empty <i>UnprocessedItems</i> map.</p>"
|
646
|
-
},
|
647
|
-
"ItemCollectionMetrics":{
|
648
|
-
"shape":"ItemCollectionMetricsPerTable",
|
649
|
-
"documentation":"<p>A list of tables that were processed by <i>BatchWriteItem</i> and, for each table, information about any item collections that were affected by individual <i>DeleteItem</i> or <i>PutItem</i> operations.</p> <p>Each entry consists of the following subelements:</p> <ul> <li> <p><i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as the hash key of the item.</p> </li> <li> <p><i>SizeEstimateRange</i> - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.</p> <p>The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.</p> </li> </ul>"
|
650
|
-
},
|
651
|
-
"ConsumedCapacity":{
|
652
|
-
"shape":"ConsumedCapacityMultiple",
|
653
|
-
"documentation":"<p>The capacity units consumed by the operation.</p> <p>Each element consists of:</p> <ul> <li> <p><i>TableName</i> - The table that consumed the provisioned throughput.</p> </li> <li> <p><i>CapacityUnits</i> - The total number of capacity units consumed.</p> </li> </ul>"
|
654
|
-
}
|
655
|
-
},
|
656
|
-
"documentation":"<p>Represents the output of a <i>BatchWriteItem</i> operation.</p>"
|
657
|
-
},
|
658
|
-
"BatchWriteItemRequestMap":{
|
659
|
-
"type":"map",
|
660
|
-
"key":{"shape":"TableName"},
|
661
|
-
"value":{"shape":"WriteRequests"},
|
662
|
-
"min":1,
|
663
|
-
"max":25
|
664
|
-
},
|
665
|
-
"BinaryAttributeValue":{"type":"blob"},
|
666
|
-
"BinarySetAttributeValue":{
|
667
|
-
"type":"list",
|
668
|
-
"member":{"shape":"BinaryAttributeValue"}
|
669
|
-
},
|
670
|
-
"BooleanObject":{"type":"boolean"},
|
671
|
-
"Capacity":{
|
672
|
-
"type":"structure",
|
673
|
-
"members":{
|
674
|
-
"CapacityUnits":{
|
675
|
-
"shape":"ConsumedCapacityUnits",
|
676
|
-
"documentation":"<p>The total number of capacity units consumed on a table or an index.</p>"
|
677
|
-
}
|
678
|
-
},
|
679
|
-
"documentation":"<p>Represents the amount of provisioned throughput capacity consumed on a table or an index. </p>"
|
680
|
-
},
|
681
|
-
"ComparisonOperator":{
|
682
|
-
"type":"string",
|
683
|
-
"enum":[
|
684
|
-
"EQ",
|
685
|
-
"NE",
|
686
|
-
"IN",
|
687
|
-
"LE",
|
688
|
-
"LT",
|
689
|
-
"GE",
|
690
|
-
"GT",
|
691
|
-
"BETWEEN",
|
692
|
-
"NOT_NULL",
|
693
|
-
"NULL",
|
694
|
-
"CONTAINS",
|
695
|
-
"NOT_CONTAINS",
|
696
|
-
"BEGINS_WITH"
|
697
|
-
]
|
698
|
-
},
|
699
|
-
"Condition":{
|
700
|
-
"type":"structure",
|
701
|
-
"required":["ComparisonOperator"],
|
702
|
-
"members":{
|
703
|
-
"AttributeValueList":{
|
704
|
-
"shape":"AttributeValueList",
|
705
|
-
"documentation":"<p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p>"
|
706
|
-
},
|
707
|
-
"ComparisonOperator":{
|
708
|
-
"shape":"ComparisonOperator",
|
709
|
-
"documentation":"<p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p> <p>The following comparison operators are available:</p> <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p> <p>The following are descriptions of each comparison operator.</p> <ul> <li> <p><code>EQ</code> : Equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NE</code> : Not equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LE</code> : Less than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LT</code> : Less than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GE</code> : Greater than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GT</code> : Greater than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NOT_NULL</code> : The attribute exists. </p> </li> <li> <p><code>NULL</code> : The attribute does not exist. </p> </li> <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).</p> </li> <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).</p></li> <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).</p> <p/> </li> <li> <p><code>IN</code> : checks for exact matches.</p> <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.</p> </li> <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </p> <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). 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 <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p> </li> </ul> <p>For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#ConditionalExpressions\">Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>"
|
710
|
-
}
|
711
|
-
},
|
712
|
-
"documentation":"<p>Represents the selection criteria for a <i>Query</i> or <i>Scan</i> operation:</p> <ul> <li> <p>For a <i>Query</i> operation, <i>Condition</i> is used for specifying the <i>KeyConditions</i> to use when querying a table or an index. For <i>KeyConditions</i>, only the following comparison operators are supported:</p> <p> <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code> </p> <p><i>Condition</i> is also used in a <i>QueryFilter</i>, which evaluates the query results and returns only the desired values.</p> </li> <li> <p>For a <i>Scan</i> operation, <i>Condition</i> is used in a <i>ScanFilter</i>, which evaluates the scan results and returns only the desired values.</p> </li> </ul>"
|
713
|
-
},
|
714
|
-
"ConditionalCheckFailedException":{
|
715
|
-
"type":"structure",
|
716
|
-
"members":{
|
717
|
-
"message":{
|
718
|
-
"shape":"ErrorMessage",
|
719
|
-
"documentation":"<p>The conditional request failed.</p>"
|
720
|
-
}
|
721
|
-
},
|
722
|
-
"exception":true,
|
723
|
-
"documentation":"<p>A condition specified in the operation could not be evaluated.</p>"
|
724
|
-
},
|
725
|
-
"ConditionalOperator":{
|
726
|
-
"type":"string",
|
727
|
-
"enum":[
|
728
|
-
"AND",
|
729
|
-
"OR"
|
730
|
-
]
|
731
|
-
},
|
732
|
-
"ConsistentRead":{"type":"boolean"},
|
733
|
-
"ConsumedCapacity":{
|
734
|
-
"type":"structure",
|
735
|
-
"members":{
|
736
|
-
"TableName":{
|
737
|
-
"shape":"TableName",
|
738
|
-
"documentation":"<p>The name of the table that was affected by the operation.</p>"
|
739
|
-
},
|
740
|
-
"CapacityUnits":{
|
741
|
-
"shape":"ConsumedCapacityUnits",
|
742
|
-
"documentation":"<p>The total number of capacity units consumed by the operation.</p>"
|
743
|
-
},
|
744
|
-
"Table":{
|
745
|
-
"shape":"Capacity",
|
746
|
-
"documentation":"<p>The amount of throughput consumed on the table affected by the operation.</p>"
|
747
|
-
},
|
748
|
-
"LocalSecondaryIndexes":{
|
749
|
-
"shape":"SecondaryIndexesCapacityMap",
|
750
|
-
"documentation":"<p>The amount of throughput consumed on each local index affected by the operation.</p>"
|
751
|
-
},
|
752
|
-
"GlobalSecondaryIndexes":{
|
753
|
-
"shape":"SecondaryIndexesCapacityMap",
|
754
|
-
"documentation":"<p>The amount of throughput consumed on each global index affected by the operation.</p>"
|
755
|
-
}
|
756
|
-
},
|
757
|
-
"documentation":"<p>Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide.</p>"
|
758
|
-
},
|
759
|
-
"ConsumedCapacityMultiple":{
|
760
|
-
"type":"list",
|
761
|
-
"member":{"shape":"ConsumedCapacity"}
|
762
|
-
},
|
763
|
-
"ConsumedCapacityUnits":{"type":"double"},
|
764
|
-
"CreateTableInput":{
|
765
|
-
"type":"structure",
|
766
|
-
"required":[
|
767
|
-
"AttributeDefinitions",
|
768
|
-
"TableName",
|
769
|
-
"KeySchema",
|
770
|
-
"ProvisionedThroughput"
|
771
|
-
],
|
772
|
-
"members":{
|
773
|
-
"AttributeDefinitions":{
|
774
|
-
"shape":"AttributeDefinitions",
|
775
|
-
"documentation":"<p>An array of attributes that describe the key schema for the table and indexes.</p>"
|
776
|
-
},
|
777
|
-
"TableName":{
|
778
|
-
"shape":"TableName",
|
779
|
-
"documentation":"<p>The name of the table to create.</p>"
|
780
|
-
},
|
781
|
-
"KeySchema":{
|
782
|
-
"shape":"KeySchema",
|
783
|
-
"documentation":"<p>Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html\">Data Model</a> in the Amazon DynamoDB Developer Guide.</p> <p>Each <i>KeySchemaElement</i> in the array is composed of:</p> <ul> <li> <p><i>AttributeName</i> - The name of this key attribute.</p> </li> <li> <p><i>KeyType</i> - Determines whether the key attribute is <code>HASH</code> or <code>RANGE</code>.</p> </li> </ul> <p>For a primary key that consists of a hash attribute, you must specify exactly one element with a <i>KeyType</i> of <code>HASH</code>.</p> <p>For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key\">Specifying the Primary Key</a> in the Amazon DynamoDB Developer Guide.</p>"
|
784
|
-
},
|
785
|
-
"LocalSecondaryIndexes":{
|
786
|
-
"shape":"LocalSecondaryIndexList",
|
787
|
-
"documentation":"<p>One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 GB size limit per hash key; otherwise, the size of a local secondary index is unconstrained.</p> <p>Each local secondary index in the array includes the following:</p> <ul> <li> <p><i>IndexName</i> - The name of the local secondary index. Must be unique only for this table.</p> <p></p> </li> <li> <p><i>KeySchema</i> - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table.</p> </li> <li> <p><i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p><i>ProjectionType</i> - One of the following:</p> <ul> <li> <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>.</p> </li> <li> <p><code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> </ul>"
|
788
|
-
},
|
789
|
-
"GlobalSecondaryIndexes":{
|
790
|
-
"shape":"GlobalSecondaryIndexList",
|
791
|
-
"documentation":"<p>One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:</p> <ul> <li> <p><i>IndexName</i> - The name of the global secondary index. Must be unique only for this table.</p> <p></p> </li> <li> <p><i>KeySchema</i> - Specifies the key schema for the global secondary index.</p> </li> <li> <p><i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p><i>ProjectionType</i> - One of the following:</p> <ul> <li> <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>.</p> </li> <li> <p><code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> <li> <p><i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.</p> </li> </ul>"
|
792
|
-
},
|
793
|
-
"ProvisionedThroughput":{"shape":"ProvisionedThroughput"}
|
794
|
-
},
|
795
|
-
"documentation":"<p>Represents the input of a <i>CreateTable</i> operation.</p>"
|
796
|
-
},
|
797
|
-
"CreateTableOutput":{
|
798
|
-
"type":"structure",
|
799
|
-
"members":{
|
800
|
-
"TableDescription":{"shape":"TableDescription"}
|
801
|
-
},
|
802
|
-
"documentation":"<p>Represents the output of a <i>CreateTable</i> operation.</p>"
|
803
|
-
},
|
804
|
-
"Date":{"type":"timestamp"},
|
805
|
-
"DeleteItemInput":{
|
806
|
-
"type":"structure",
|
807
|
-
"required":[
|
808
|
-
"TableName",
|
809
|
-
"Key"
|
810
|
-
],
|
811
|
-
"members":{
|
812
|
-
"TableName":{
|
813
|
-
"shape":"TableName",
|
814
|
-
"documentation":"<p>The name of the table from which to delete the item.</p>"
|
815
|
-
},
|
816
|
-
"Key":{
|
817
|
-
"shape":"Key",
|
818
|
-
"documentation":"<p>A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete.</p> <p>For the primary key, you must provide <i>all</i> of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>"
|
819
|
-
},
|
820
|
-
"Expected":{
|
821
|
-
"shape":"ExpectedAttributeMap",
|
822
|
-
"documentation":"<p>A map of attribute/condition pairs. This is the conditional block for the <i>DeleteItem</i> operation.</p> <p>Each element of <i>Expected</i> 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 <i>Expected</i> element, the result of the evaluation is either true or false.</p> <p>If you specify more than one element in the <i>Expected</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> 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.)</p> <p>If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails.</p> <p>Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with an <i>AttributeValueList</i> and a <i>ComparisonOperator</i>:</p> <ul> <li> <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\" >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p> </li> <li> <p><i>ComparisonOperator</i> - A comparator for evaluating attributes in the <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads.</p> <p>The following comparison operators are available:</p> <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p> <p>The following are descriptions of each comparison operator.</p> <ul> <li> <p><code>EQ</code> : Equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NE</code> : Not equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LE</code> : Less than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LT</code> : Less than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GE</code> : Greater than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GT</code> : Greater than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NOT_NULL</code> : The attribute exists. </p> </li> <li> <p><code>NULL</code> : The attribute does not exist. </p> </li> <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).</p> </li> <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).</p></li> <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).</p> <p/> </li> <li> <p><code>IN</code> : checks for exact matches.</p> <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.</p> </li> <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </p> <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). 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 <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p> </li> </ul> </li> </ul> <p>For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#ConditionalExpressions\" >Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>"
|
823
|
-
},
|
824
|
-
"ConditionalOperator":{
|
825
|
-
"shape":"ConditionalOperator",
|
826
|
-
"documentation":"<p>A logical operator to apply to the conditions in the <i>Expected</i> map:</p> <ul> <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> <li><p><code>OR</code> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> </ul> <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p> <p>The operation will succeed only if the entire map evaluates to true.</p>"
|
827
|
-
},
|
828
|
-
"ReturnValues":{
|
829
|
-
"shape":"ReturnValue",
|
830
|
-
"documentation":"<p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were deleted. For <i>DeleteItem</i>, the valid values are:</p> <ul> <li> <p><code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This is the default for <i>ReturnValues</i>.)</p> </li> <li> <p><code>ALL_OLD</code> - The content of the old item is returned.</p> </li> </ul>"
|
831
|
-
},
|
832
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"},
|
833
|
-
"ReturnItemCollectionMetrics":{
|
834
|
-
"shape":"ReturnItemCollectionMetrics",
|
835
|
-
"documentation":"<p>If set to <code>SIZE</code>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>"
|
836
|
-
}
|
837
|
-
},
|
838
|
-
"documentation":"<p>Represents the input of a <i>DeleteItem</i> operation.</p>"
|
839
|
-
},
|
840
|
-
"DeleteItemOutput":{
|
841
|
-
"type":"structure",
|
842
|
-
"members":{
|
843
|
-
"Attributes":{
|
844
|
-
"shape":"AttributeMap",
|
845
|
-
"documentation":"<p>A map of attribute names to <i>AttributeValue</i> objects, representing the item as it appeared before the <i>DeleteItem</i> operation. This map appears in the response only if <i>ReturnValues</i> was specified as <code>ALL_OLD</code> in the request.</p>"
|
846
|
-
},
|
847
|
-
"ConsumedCapacity":{"shape":"ConsumedCapacity"},
|
848
|
-
"ItemCollectionMetrics":{
|
849
|
-
"shape":"ItemCollectionMetrics",
|
850
|
-
"documentation":"<p>Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the table does not have any local secondary indexes, this information is not returned in the response.</p> <p>Each <i>ItemCollectionMetrics</i> element consists of:</p> <ul> <li><p><i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as the hash key of the item.</p></li> <li><p><i>SizeEstimateRange</i> - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.</p> <p>The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.</p> </li> </ul>"
|
851
|
-
}
|
852
|
-
},
|
853
|
-
"documentation":"<p>Represents the output of a <i>DeleteItem</i> operation.</p>"
|
854
|
-
},
|
855
|
-
"DeleteRequest":{
|
856
|
-
"type":"structure",
|
857
|
-
"required":["Key"],
|
858
|
-
"members":{
|
859
|
-
"Key":{
|
860
|
-
"shape":"Key",
|
861
|
-
"documentation":"<p>A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.</p>"
|
862
|
-
}
|
863
|
-
},
|
864
|
-
"documentation":"<p>Represents a request to perform a <i>DeleteItem</i> operation on an item.</p>"
|
865
|
-
},
|
866
|
-
"DeleteTableInput":{
|
867
|
-
"type":"structure",
|
868
|
-
"required":["TableName"],
|
869
|
-
"members":{
|
870
|
-
"TableName":{
|
871
|
-
"shape":"TableName",
|
872
|
-
"documentation":"<p> The name of the table to delete.</p>"
|
873
|
-
}
|
874
|
-
},
|
875
|
-
"documentation":"<p>Represents the input of a <i>DeleteTable</i> operation.</p>"
|
876
|
-
},
|
877
|
-
"DeleteTableOutput":{
|
878
|
-
"type":"structure",
|
879
|
-
"members":{
|
880
|
-
"TableDescription":{"shape":"TableDescription"}
|
881
|
-
},
|
882
|
-
"documentation":"<p>Represents the output of a <i>DeleteTable</i> operation.</p>"
|
883
|
-
},
|
884
|
-
"DescribeTableInput":{
|
885
|
-
"type":"structure",
|
886
|
-
"required":["TableName"],
|
887
|
-
"members":{
|
888
|
-
"TableName":{
|
889
|
-
"shape":"TableName",
|
890
|
-
"documentation":"<p> The name of the table to describe.</p>"
|
891
|
-
}
|
892
|
-
},
|
893
|
-
"documentation":"<p>Represents the input of a <i>DescribeTable</i> operation.</p>"
|
894
|
-
},
|
895
|
-
"DescribeTableOutput":{
|
896
|
-
"type":"structure",
|
897
|
-
"members":{
|
898
|
-
"Table":{"shape":"TableDescription"}
|
899
|
-
},
|
900
|
-
"documentation":"<p>Represents the output of a <i>DescribeTable</i> operation.</p>"
|
901
|
-
},
|
902
|
-
"ErrorMessage":{"type":"string"},
|
903
|
-
"ExpectedAttributeMap":{
|
904
|
-
"type":"map",
|
905
|
-
"key":{"shape":"AttributeName"},
|
906
|
-
"value":{"shape":"ExpectedAttributeValue"}
|
907
|
-
},
|
908
|
-
"ExpectedAttributeValue":{
|
909
|
-
"type":"structure",
|
910
|
-
"members":{
|
911
|
-
"Value":{"shape":"AttributeValue"},
|
912
|
-
"Exists":{
|
913
|
-
"shape":"BooleanObject",
|
914
|
-
"documentation":"<p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p> <ul> <li> <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a <i>ConditionalCheckFailedException</i>.</p> </li> <li> <p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does <i>not</i> exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>.</p> </li> </ul> <p>The default setting for <i>Exists</i> is <code>true</code>. If you supply a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <code>true</code>, because it is implied.</p> <p>DynamoDB returns a <i>ValidationException</i> if:</p> <ul> <li> <p><i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect a value to exist, but don't specify what that value is.)</p> </li> <li> <p><i>Exists</i> is <code>false</code> but you also specify a <i>Value</i>. (You cannot expect an attribute to have a value, while also expecting it not to exist.)</p> </li> </ul>"
|
915
|
-
},
|
916
|
-
"ComparisonOperator":{
|
917
|
-
"shape":"ComparisonOperator",
|
918
|
-
"documentation":"<p>A comparator for evaluating attributes in the <i>AttributeValueList</i>. For example, equals, greater than, less than, etc.</p> <p>The following comparison operators are available:</p> <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p> <p>The following are descriptions of each comparison operator.</p> <ul> <li> <p><code>EQ</code> : Equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NE</code> : Not equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LE</code> : Less than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LT</code> : Less than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GE</code> : Greater than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GT</code> : Greater than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NOT_NULL</code> : The attribute exists. </p> </li> <li> <p><code>NULL</code> : The attribute does not exist. </p> </li> <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).</p> </li> <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).</p></li> <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).</p> <p/> </li> <li> <p><code>IN</code> : checks for exact matches.</p> <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.</p> </li> <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </p> <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). 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 <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p> </li> </ul>"
|
919
|
-
},
|
920
|
-
"AttributeValueList":{
|
921
|
-
"shape":"AttributeValueList",
|
922
|
-
"documentation":"<p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p> <p>For information on specifying data types in JSON, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html\">JSON Data Format</a> in the Amazon DynamoDB Developer Guide.</p>"
|
923
|
-
}
|
924
|
-
},
|
925
|
-
"documentation":"<p>Represents a condition to be compared with an attribute value. This condition can be used with <i>DeleteItem</i>, <i>PutItem</i> or <i>UpdateItem</i> operations; if the comparison evaluates to true, the operation succeeds; if not the operation fails. You can use <i>ExpectedAttributeValue</i> in one of two different ways:</p> <ul> <li> <p>Use <i>AttributeValueList</i> to specify one or more values to compare against an attribute. Use <i>ComparisonOperator</i> to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.</p> </li> <li> <p>Use <i>Value</i> to specify a value that DynamoDB will compare against an attribute. If the values match, then <i>ExpectedAttributeValue</i> evaluates to true and the conditional operation succeeds. Optionally, you can also set <i>Exists</i> to false, indicating that you <i>do not</i> expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.</p> </li> </ul> <p><i>Value</i> and <i>Exists</i> are incompatible with <i>AttributeValueList</i> and <i>ComparisonOperator</i>. If you attempt to use both sets of parameters at once, DynamoDB will throw a <i>ValidationException</i>.</p> <important> <p>The <i>Value</i> and <i>Exists</i> parameters are deprecated. Even though DynamoDB will continue to support these parameters, we recommend that you use <i>AttributeValueList</i> and <i>ComparisonOperator</i> instead. <i>AttributeValueList</i> and <i>ComparisonOperator</i> let you construct a much wider range of conditions than is possible with <i>Value</i> and <i>Exists</i>.</p> </important>"
|
926
|
-
},
|
927
|
-
"FilterConditionMap":{
|
928
|
-
"type":"map",
|
929
|
-
"key":{"shape":"AttributeName"},
|
930
|
-
"value":{"shape":"Condition"}
|
931
|
-
},
|
932
|
-
"GetItemInput":{
|
933
|
-
"type":"structure",
|
934
|
-
"required":[
|
935
|
-
"TableName",
|
936
|
-
"Key"
|
937
|
-
],
|
938
|
-
"members":{
|
939
|
-
"TableName":{
|
940
|
-
"shape":"TableName",
|
941
|
-
"documentation":"<p>The name of the table containing the requested item.</p>"
|
942
|
-
},
|
943
|
-
"Key":{
|
944
|
-
"shape":"Key",
|
945
|
-
"documentation":"<p>A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve.</p> <p>For the primary key, you must provide <i>all</i> of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>"
|
946
|
-
},
|
947
|
-
"AttributesToGet":{
|
948
|
-
"shape":"AttributeNameList",
|
949
|
-
"documentation":"<p>The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p> <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</p>"
|
950
|
-
},
|
951
|
-
"ConsistentRead":{
|
952
|
-
"shape":"ConsistentRead",
|
953
|
-
"documentation":"<p>If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.</p>"
|
954
|
-
},
|
955
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}
|
956
|
-
},
|
957
|
-
"documentation":"<p>Represents the input of a <i>GetItem</i> operation.</p>"
|
958
|
-
},
|
959
|
-
"GetItemOutput":{
|
960
|
-
"type":"structure",
|
961
|
-
"members":{
|
962
|
-
"Item":{
|
963
|
-
"shape":"AttributeMap",
|
964
|
-
"documentation":"<p>A map of attribute names to <i>AttributeValue</i> objects, as specified by <i>AttributesToGet</i>.</p>"
|
965
|
-
},
|
966
|
-
"ConsumedCapacity":{"shape":"ConsumedCapacity"}
|
967
|
-
},
|
968
|
-
"documentation":"<p>Represents the output of a <i>GetItem</i> operation.</p>"
|
969
|
-
},
|
970
|
-
"GlobalSecondaryIndex":{
|
971
|
-
"type":"structure",
|
972
|
-
"required":[
|
973
|
-
"IndexName",
|
974
|
-
"KeySchema",
|
975
|
-
"Projection",
|
976
|
-
"ProvisionedThroughput"
|
977
|
-
],
|
978
|
-
"members":{
|
979
|
-
"IndexName":{
|
980
|
-
"shape":"IndexName",
|
981
|
-
"documentation":"<p>The name of the global secondary index. The name must be unique among all other indexes on this table.</p>"
|
982
|
-
},
|
983
|
-
"KeySchema":{
|
984
|
-
"shape":"KeySchema",
|
985
|
-
"documentation":"<p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types (<code>HASH</code> or <code>RANGE</code>).</p>"
|
986
|
-
},
|
987
|
-
"Projection":{"shape":"Projection"},
|
988
|
-
"ProvisionedThroughput":{"shape":"ProvisionedThroughput"}
|
989
|
-
},
|
990
|
-
"documentation":"<p>Represents a global secondary index.</p>"
|
991
|
-
},
|
992
|
-
"GlobalSecondaryIndexDescription":{
|
993
|
-
"type":"structure",
|
994
|
-
"members":{
|
995
|
-
"IndexName":{
|
996
|
-
"shape":"IndexName",
|
997
|
-
"documentation":"<p>The name of the global secondary index.</p>"
|
998
|
-
},
|
999
|
-
"KeySchema":{
|
1000
|
-
"shape":"KeySchema",
|
1001
|
-
"documentation":"<p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (<code>HASH</code> or <code>RANGE</code>).</p>"
|
1002
|
-
},
|
1003
|
-
"Projection":{"shape":"Projection"},
|
1004
|
-
"IndexStatus":{
|
1005
|
-
"shape":"IndexStatus",
|
1006
|
-
"documentation":"<p>The current state of the global secondary index:</p> <ul> <li> <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or <i>UpdateTable</i> operation.</p> </li> <li> <p><i>UPDATING</i> - The index is being updated, as the result of a <i>CreateTable</i> or <i>UpdateTable</i> operation.</p> </li> <li> <p><i>DELETING</i> - The index is being deleted, as the result of a <i>DeleteTable</i> operation.</p> </li> <li> <p><i>ACTIVE</i> - The index is ready for use.</p> </li> </ul>"
|
1007
|
-
},
|
1008
|
-
"ProvisionedThroughput":{"shape":"ProvisionedThroughputDescription"},
|
1009
|
-
"IndexSizeBytes":{
|
1010
|
-
"shape":"Long",
|
1011
|
-
"documentation":"<p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p>"
|
1012
|
-
},
|
1013
|
-
"ItemCount":{
|
1014
|
-
"shape":"Long",
|
1015
|
-
"documentation":"<p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p>"
|
1016
|
-
}
|
1017
|
-
},
|
1018
|
-
"documentation":"<p>Represents the properties of a global secondary index.</p>"
|
1019
|
-
},
|
1020
|
-
"GlobalSecondaryIndexDescriptionList":{
|
1021
|
-
"type":"list",
|
1022
|
-
"member":{"shape":"GlobalSecondaryIndexDescription"}
|
1023
|
-
},
|
1024
|
-
"GlobalSecondaryIndexList":{
|
1025
|
-
"type":"list",
|
1026
|
-
"member":{"shape":"GlobalSecondaryIndex"}
|
1027
|
-
},
|
1028
|
-
"GlobalSecondaryIndexUpdate":{
|
1029
|
-
"type":"structure",
|
1030
|
-
"members":{
|
1031
|
-
"Update":{
|
1032
|
-
"shape":"UpdateGlobalSecondaryIndexAction",
|
1033
|
-
"documentation":"<p>The name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index.</p>"
|
1034
|
-
}
|
1035
|
-
},
|
1036
|
-
"documentation":"<p>Represents the new provisioned throughput settings to apply to a global secondary index.</p>"
|
1037
|
-
},
|
1038
|
-
"GlobalSecondaryIndexUpdateList":{
|
1039
|
-
"type":"list",
|
1040
|
-
"member":{"shape":"GlobalSecondaryIndexUpdate"}
|
1041
|
-
},
|
1042
|
-
"IndexName":{
|
1043
|
-
"type":"string",
|
1044
|
-
"min":3,
|
1045
|
-
"max":255,
|
1046
|
-
"pattern":"[a-zA-Z0-9_.-]+"
|
1047
|
-
},
|
1048
|
-
"IndexStatus":{
|
1049
|
-
"type":"string",
|
1050
|
-
"enum":[
|
1051
|
-
"CREATING",
|
1052
|
-
"UPDATING",
|
1053
|
-
"DELETING",
|
1054
|
-
"ACTIVE"
|
1055
|
-
]
|
1056
|
-
},
|
1057
|
-
"Integer":{"type":"integer"},
|
1058
|
-
"InternalServerError":{
|
1059
|
-
"type":"structure",
|
1060
|
-
"members":{
|
1061
|
-
"message":{
|
1062
|
-
"shape":"ErrorMessage",
|
1063
|
-
"documentation":"<p>The server encountered an internal error trying to fulfill the request.</p>"
|
1064
|
-
}
|
1065
|
-
},
|
1066
|
-
"exception":true,
|
1067
|
-
"fault":true,
|
1068
|
-
"documentation":"<p>An error occurred on the server side.</p>"
|
1069
|
-
},
|
1070
|
-
"ItemCollectionKeyAttributeMap":{
|
1071
|
-
"type":"map",
|
1072
|
-
"key":{"shape":"AttributeName"},
|
1073
|
-
"value":{"shape":"AttributeValue"}
|
1074
|
-
},
|
1075
|
-
"ItemCollectionMetrics":{
|
1076
|
-
"type":"structure",
|
1077
|
-
"members":{
|
1078
|
-
"ItemCollectionKey":{
|
1079
|
-
"shape":"ItemCollectionKeyAttributeMap",
|
1080
|
-
"documentation":"<p>The hash key value of the item collection. This is the same as the hash key of the item.</p>"
|
1081
|
-
},
|
1082
|
-
"SizeEstimateRangeGB":{
|
1083
|
-
"shape":"ItemCollectionSizeEstimateRange",
|
1084
|
-
"documentation":"<p>An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.</p> <p>The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.</p>"
|
1085
|
-
}
|
1086
|
-
},
|
1087
|
-
"documentation":"<p>Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the table does not have any local secondary indexes, this information is not returned in the response.</p>"
|
1088
|
-
},
|
1089
|
-
"ItemCollectionMetricsMultiple":{
|
1090
|
-
"type":"list",
|
1091
|
-
"member":{"shape":"ItemCollectionMetrics"}
|
1092
|
-
},
|
1093
|
-
"ItemCollectionMetricsPerTable":{
|
1094
|
-
"type":"map",
|
1095
|
-
"key":{"shape":"TableName"},
|
1096
|
-
"value":{"shape":"ItemCollectionMetricsMultiple"}
|
1097
|
-
},
|
1098
|
-
"ItemCollectionSizeEstimateBound":{"type":"double"},
|
1099
|
-
"ItemCollectionSizeEstimateRange":{
|
1100
|
-
"type":"list",
|
1101
|
-
"member":{"shape":"ItemCollectionSizeEstimateBound"}
|
1102
|
-
},
|
1103
|
-
"ItemCollectionSizeLimitExceededException":{
|
1104
|
-
"type":"structure",
|
1105
|
-
"members":{
|
1106
|
-
"message":{
|
1107
|
-
"shape":"ErrorMessage",
|
1108
|
-
"documentation":"<p>The total size of an item collection has exceeded the maximum limit of 10 gigabytes.</p>"
|
1109
|
-
}
|
1110
|
-
},
|
1111
|
-
"exception":true,
|
1112
|
-
"documentation":"<p>An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.</p>"
|
1113
|
-
},
|
1114
|
-
"ItemList":{
|
1115
|
-
"type":"list",
|
1116
|
-
"member":{"shape":"AttributeMap"}
|
1117
|
-
},
|
1118
|
-
"Key":{
|
1119
|
-
"type":"map",
|
1120
|
-
"key":{"shape":"AttributeName"},
|
1121
|
-
"value":{"shape":"AttributeValue"}
|
1122
|
-
},
|
1123
|
-
"KeyConditions":{
|
1124
|
-
"type":"map",
|
1125
|
-
"key":{"shape":"AttributeName"},
|
1126
|
-
"value":{"shape":"Condition"}
|
1127
|
-
},
|
1128
|
-
"KeyList":{
|
1129
|
-
"type":"list",
|
1130
|
-
"member":{"shape":"Key"},
|
1131
|
-
"min":1,
|
1132
|
-
"max":100
|
1133
|
-
},
|
1134
|
-
"KeySchema":{
|
1135
|
-
"type":"list",
|
1136
|
-
"member":{"shape":"KeySchemaElement"},
|
1137
|
-
"min":1,
|
1138
|
-
"max":2
|
1139
|
-
},
|
1140
|
-
"KeySchemaAttributeName":{
|
1141
|
-
"type":"string",
|
1142
|
-
"min":1,
|
1143
|
-
"max":255
|
1144
|
-
},
|
1145
|
-
"KeySchemaElement":{
|
1146
|
-
"type":"structure",
|
1147
|
-
"required":[
|
1148
|
-
"AttributeName",
|
1149
|
-
"KeyType"
|
1150
|
-
],
|
1151
|
-
"members":{
|
1152
|
-
"AttributeName":{
|
1153
|
-
"shape":"KeySchemaAttributeName",
|
1154
|
-
"documentation":"<p>The name of a key attribute.</p>"
|
1155
|
-
},
|
1156
|
-
"KeyType":{
|
1157
|
-
"shape":"KeyType",
|
1158
|
-
"documentation":"<p>The attribute data, consisting of the data type and the attribute value itself.</p>"
|
1159
|
-
}
|
1160
|
-
},
|
1161
|
-
"documentation":"<p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.</p> <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another <i>KeySchemaElement</i> for the range attribute.</p>"
|
1162
|
-
},
|
1163
|
-
"KeyType":{
|
1164
|
-
"type":"string",
|
1165
|
-
"enum":[
|
1166
|
-
"HASH",
|
1167
|
-
"RANGE"
|
1168
|
-
]
|
1169
|
-
},
|
1170
|
-
"KeysAndAttributes":{
|
1171
|
-
"type":"structure",
|
1172
|
-
"required":["Keys"],
|
1173
|
-
"members":{
|
1174
|
-
"Keys":{
|
1175
|
-
"shape":"KeyList",
|
1176
|
-
"documentation":"<p>The primary key attribute values that define the items and the attributes associated with the items.</p>"
|
1177
|
-
},
|
1178
|
-
"AttributesToGet":{
|
1179
|
-
"shape":"AttributeNameList",
|
1180
|
-
"documentation":"<p>One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.</p>"
|
1181
|
-
},
|
1182
|
-
"ConsistentRead":{
|
1183
|
-
"shape":"ConsistentRead",
|
1184
|
-
"documentation":"<p>The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used.</p>"
|
1185
|
-
}
|
1186
|
-
},
|
1187
|
-
"documentation":"<p>Represents a set of primary keys and, for each key, the attributes to retrieve from the table.</p> <p>For each primary key, you must provide <i>all</i> of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>"
|
1188
|
-
},
|
1189
|
-
"LimitExceededException":{
|
1190
|
-
"type":"structure",
|
1191
|
-
"members":{
|
1192
|
-
"message":{
|
1193
|
-
"shape":"ErrorMessage",
|
1194
|
-
"documentation":"<p>Too many operations for a given subscriber.</p>"
|
1195
|
-
}
|
1196
|
-
},
|
1197
|
-
"exception":true,
|
1198
|
-
"documentation":"<p>The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10.</p> <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>"
|
1199
|
-
},
|
1200
|
-
"ListTablesInput":{
|
1201
|
-
"type":"structure",
|
1202
|
-
"members":{
|
1203
|
-
"ExclusiveStartTableName":{
|
1204
|
-
"shape":"TableName",
|
1205
|
-
"documentation":"<p>The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</p>"
|
1206
|
-
},
|
1207
|
-
"Limit":{
|
1208
|
-
"shape":"ListTablesInputLimit",
|
1209
|
-
"documentation":"<p> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</p>"
|
1210
|
-
}
|
1211
|
-
},
|
1212
|
-
"documentation":"<p>Represents the input of a <i>ListTables</i> operation.</p>"
|
1213
|
-
},
|
1214
|
-
"ListTablesInputLimit":{
|
1215
|
-
"type":"integer",
|
1216
|
-
"min":1,
|
1217
|
-
"max":100
|
1218
|
-
},
|
1219
|
-
"ListTablesOutput":{
|
1220
|
-
"type":"structure",
|
1221
|
-
"members":{
|
1222
|
-
"TableNames":{
|
1223
|
-
"shape":"TableNameList",
|
1224
|
-
"documentation":"<p>The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. </p> <p>If <i>LastEvaluatedTableName</i> also appears in the output, you can use this value as the <i>ExclusiveStartTableName</i> parameter in a subsequent <i>ListTables</i> request and obtain the next page of results.</p>"
|
1225
|
-
},
|
1226
|
-
"LastEvaluatedTableName":{
|
1227
|
-
"shape":"TableName",
|
1228
|
-
"documentation":"<p>The name of the last table in the current page of results. Use this value as the <i>ExclusiveStartTableName</i> in a new request to obtain the next page of results, until all the table names are returned.</p> <p>If you do not receive a <i>LastEvaluatedTableName</i> value in the response, this means that there are no more table names to be retrieved.</p>"
|
1229
|
-
}
|
1230
|
-
},
|
1231
|
-
"documentation":"<p>Represents the output of a <i>ListTables</i> operation.</p>"
|
1232
|
-
},
|
1233
|
-
"LocalSecondaryIndex":{
|
1234
|
-
"type":"structure",
|
1235
|
-
"required":[
|
1236
|
-
"IndexName",
|
1237
|
-
"KeySchema",
|
1238
|
-
"Projection"
|
1239
|
-
],
|
1240
|
-
"members":{
|
1241
|
-
"IndexName":{
|
1242
|
-
"shape":"IndexName",
|
1243
|
-
"documentation":"<p>The name of the local secondary index. The name must be unique among all other indexes on this table.</p>"
|
1244
|
-
},
|
1245
|
-
"KeySchema":{
|
1246
|
-
"shape":"KeySchema",
|
1247
|
-
"documentation":"<p>The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types (<code>HASH</code> or <code>RANGE</code>).</p>"
|
1248
|
-
},
|
1249
|
-
"Projection":{"shape":"Projection"}
|
1250
|
-
},
|
1251
|
-
"documentation":"<p>Represents a local secondary index.</p>"
|
1252
|
-
},
|
1253
|
-
"LocalSecondaryIndexDescription":{
|
1254
|
-
"type":"structure",
|
1255
|
-
"members":{
|
1256
|
-
"IndexName":{
|
1257
|
-
"shape":"IndexName",
|
1258
|
-
"documentation":"<p>Represents the name of the local secondary index.</p>"
|
1259
|
-
},
|
1260
|
-
"KeySchema":{
|
1261
|
-
"shape":"KeySchema",
|
1262
|
-
"documentation":"The complete index key schema, which consists of one or more pairs of attribute names and key types (<code>HASH</code> or <code>RANGE</code>)."
|
1263
|
-
},
|
1264
|
-
"Projection":{"shape":"Projection"},
|
1265
|
-
"IndexSizeBytes":{
|
1266
|
-
"shape":"Long",
|
1267
|
-
"documentation":"<p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p>"
|
1268
|
-
},
|
1269
|
-
"ItemCount":{
|
1270
|
-
"shape":"Long",
|
1271
|
-
"documentation":"<p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p>"
|
1272
|
-
}
|
1273
|
-
},
|
1274
|
-
"documentation":"<p>Represents the properties of a local secondary index.</p>"
|
1275
|
-
},
|
1276
|
-
"LocalSecondaryIndexDescriptionList":{
|
1277
|
-
"type":"list",
|
1278
|
-
"member":{"shape":"LocalSecondaryIndexDescription"}
|
1279
|
-
},
|
1280
|
-
"LocalSecondaryIndexList":{
|
1281
|
-
"type":"list",
|
1282
|
-
"member":{"shape":"LocalSecondaryIndex"}
|
1283
|
-
},
|
1284
|
-
"Long":{"type":"long"},
|
1285
|
-
"NonKeyAttributeName":{
|
1286
|
-
"type":"string",
|
1287
|
-
"min":1,
|
1288
|
-
"max":255
|
1289
|
-
},
|
1290
|
-
"NonKeyAttributeNameList":{
|
1291
|
-
"type":"list",
|
1292
|
-
"member":{"shape":"NonKeyAttributeName"},
|
1293
|
-
"min":1,
|
1294
|
-
"max":20
|
1295
|
-
},
|
1296
|
-
"NumberAttributeValue":{"type":"string"},
|
1297
|
-
"NumberSetAttributeValue":{
|
1298
|
-
"type":"list",
|
1299
|
-
"member":{"shape":"NumberAttributeValue"}
|
1300
|
-
},
|
1301
|
-
"PositiveIntegerObject":{
|
1302
|
-
"type":"integer",
|
1303
|
-
"min":1
|
1304
|
-
},
|
1305
|
-
"PositiveLongObject":{
|
1306
|
-
"type":"long",
|
1307
|
-
"min":1
|
1308
|
-
},
|
1309
|
-
"Projection":{
|
1310
|
-
"type":"structure",
|
1311
|
-
"members":{
|
1312
|
-
"ProjectionType":{
|
1313
|
-
"shape":"ProjectionType",
|
1314
|
-
"documentation":"<p>The set of attributes that are projected into the index:</p> <ul> <li> <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>.</p> </li> <li> <p><code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul>"
|
1315
|
-
},
|
1316
|
-
"NonKeyAttributes":{
|
1317
|
-
"shape":"NonKeyAttributeNameList",
|
1318
|
-
"documentation":"<p>Represents the non-key attribute names which will be projected into the index.</p> <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p>"
|
1319
|
-
}
|
1320
|
-
},
|
1321
|
-
"documentation":"<p>Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>"
|
1322
|
-
},
|
1323
|
-
"ProjectionType":{
|
1324
|
-
"type":"string",
|
1325
|
-
"enum":[
|
1326
|
-
"ALL",
|
1327
|
-
"KEYS_ONLY",
|
1328
|
-
"INCLUDE"
|
1329
|
-
]
|
1330
|
-
},
|
1331
|
-
"ProvisionedThroughput":{
|
1332
|
-
"type":"structure",
|
1333
|
-
"required":[
|
1334
|
-
"ReadCapacityUnits",
|
1335
|
-
"WriteCapacityUnits"
|
1336
|
-
],
|
1337
|
-
"members":{
|
1338
|
-
"ReadCapacityUnits":{
|
1339
|
-
"shape":"PositiveLongObject",
|
1340
|
-
"documentation":"<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1341
|
-
},
|
1342
|
-
"WriteCapacityUnits":{
|
1343
|
-
"shape":"PositiveLongObject",
|
1344
|
-
"documentation":"<p>The maximum number of writes consumed per second before DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1345
|
-
}
|
1346
|
-
},
|
1347
|
-
"documentation":"<p>Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the <i>UpdateTable</i> operation.</p> <p>For current minimum and maximum provisioned throughput values, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Limits</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1348
|
-
},
|
1349
|
-
"ProvisionedThroughputDescription":{
|
1350
|
-
"type":"structure",
|
1351
|
-
"members":{
|
1352
|
-
"LastIncreaseDateTime":{
|
1353
|
-
"shape":"Date",
|
1354
|
-
"documentation":"<p>The date and time of the last provisioned throughput increase for this table.</p>"
|
1355
|
-
},
|
1356
|
-
"LastDecreaseDateTime":{
|
1357
|
-
"shape":"Date",
|
1358
|
-
"documentation":"<p>The date and time of the last provisioned throughput decrease for this table.</p>"
|
1359
|
-
},
|
1360
|
-
"NumberOfDecreasesToday":{
|
1361
|
-
"shape":"PositiveLongObject",
|
1362
|
-
"documentation":"<p>The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Limits</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1363
|
-
},
|
1364
|
-
"ReadCapacityUnits":{
|
1365
|
-
"shape":"PositiveLongObject",
|
1366
|
-
"documentation":"<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <i>ThrottlingException</i>. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 <i>ReadCapacityUnits</i> per second provides 100 eventually consistent <i>ReadCapacityUnits</i> per second.</p>"
|
1367
|
-
},
|
1368
|
-
"WriteCapacityUnits":{
|
1369
|
-
"shape":"PositiveLongObject",
|
1370
|
-
"documentation":"<p>The maximum number of writes consumed per second before DynamoDB returns a <i>ThrottlingException</i>.</p>"
|
1371
|
-
}
|
1372
|
-
},
|
1373
|
-
"documentation":"<p>Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.</p>"
|
1374
|
-
},
|
1375
|
-
"ProvisionedThroughputExceededException":{
|
1376
|
-
"type":"structure",
|
1377
|
-
"members":{
|
1378
|
-
"message":{
|
1379
|
-
"shape":"ErrorMessage",
|
1380
|
-
"documentation":"<p>You exceeded your maximum allowed provisioned throughput.</p>"
|
1381
|
-
}
|
1382
|
-
},
|
1383
|
-
"exception":true,
|
1384
|
-
"documentation":"<p>The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1385
|
-
},
|
1386
|
-
"PutItemInput":{
|
1387
|
-
"type":"structure",
|
1388
|
-
"required":[
|
1389
|
-
"TableName",
|
1390
|
-
"Item"
|
1391
|
-
],
|
1392
|
-
"members":{
|
1393
|
-
"TableName":{
|
1394
|
-
"shape":"TableName",
|
1395
|
-
"documentation":"<p>The name of the table to contain the item.</p>"
|
1396
|
-
},
|
1397
|
-
"Item":{
|
1398
|
-
"shape":"PutItemInputAttributeMap",
|
1399
|
-
"documentation":"<p>A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.</p> <p>You must provide <i>all</i> of the attributes for the primary key. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p> <p>If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</p> <p>For more information about primary keys, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey\">Primary Key</a> in the Amazon DynamoDB Developer Guide.</p> <p>Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</p>"
|
1400
|
-
},
|
1401
|
-
"Expected":{
|
1402
|
-
"shape":"ExpectedAttributeMap",
|
1403
|
-
"documentation":"<p>A map of attribute/condition pairs. This is the conditional block for the <i>PutItem</i> operation.</p> <p>Each element of <i>Expected</i> 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 <i>Expected</i> element, the result of the evaluation is either true or false.</p> <p>If you specify more than one element in the <i>Expected</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> 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.)</p> <p>If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails.</p> <p>Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with an <i>AttributeValueList</i> and a <i>ComparisonOperator</i>:</p> <ul> <li> <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\" >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p> </li> <li> <p><i>ComparisonOperator</i> - A comparator for evaluating attributes in the <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads.</p> <p>The following comparison operators are available:</p> <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p> <p>The following are descriptions of each comparison operator.</p> <ul> <li> <p><code>EQ</code> : Equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NE</code> : Not equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LE</code> : Less than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LT</code> : Less than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GE</code> : Greater than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GT</code> : Greater than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NOT_NULL</code> : The attribute exists. </p> </li> <li> <p><code>NULL</code> : The attribute does not exist. </p> </li> <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).</p> </li> <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).</p></li> <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).</p> <p/> </li> <li> <p><code>IN</code> : checks for exact matches.</p> <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.</p> </li> <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </p> <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). 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 <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p> </li> </ul> </li> </ul> <p>For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#ConditionalExpressions\" >Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1404
|
-
},
|
1405
|
-
"ReturnValues":{
|
1406
|
-
"shape":"ReturnValue",
|
1407
|
-
"documentation":"<p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were updated with the <i>PutItem</i> request. For <i>PutItem</i>, the valid values are:</p> <ul> <li> <p><code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This is the default for <i>ReturnValues</i>.)</p> </li> <li> <p><code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned.</p> </li> </ul>"
|
1408
|
-
},
|
1409
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"},
|
1410
|
-
"ReturnItemCollectionMetrics":{
|
1411
|
-
"shape":"ReturnItemCollectionMetrics",
|
1412
|
-
"documentation":"<p>If set to <code>SIZE</code>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>"
|
1413
|
-
},
|
1414
|
-
"ConditionalOperator":{
|
1415
|
-
"shape":"ConditionalOperator",
|
1416
|
-
"documentation":"<p>A logical operator to apply to the conditions in the <i>Expected</i> map:</p> <ul> <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> <li><p><code>OR</code> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> </ul> <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p> <p>The operation will succeed only if the entire map evaluates to true.</p>"
|
1417
|
-
}
|
1418
|
-
},
|
1419
|
-
"documentation":"<p>Represents the input of a <i>PutItem</i> operation.</p>"
|
1420
|
-
},
|
1421
|
-
"PutItemInputAttributeMap":{
|
1422
|
-
"type":"map",
|
1423
|
-
"key":{"shape":"AttributeName"},
|
1424
|
-
"value":{"shape":"AttributeValue"}
|
1425
|
-
},
|
1426
|
-
"PutItemOutput":{
|
1427
|
-
"type":"structure",
|
1428
|
-
"members":{
|
1429
|
-
"Attributes":{
|
1430
|
-
"shape":"AttributeMap",
|
1431
|
-
"documentation":"<p>The attribute values as they appeared before the <i>PutItem</i> operation, but only if <i>ReturnValues</i> is specified as <code>ALL_OLD</code> in the request. Each element consists of an attribute name and an attribute value.</p>"
|
1432
|
-
},
|
1433
|
-
"ConsumedCapacity":{"shape":"ConsumedCapacity"},
|
1434
|
-
"ItemCollectionMetrics":{
|
1435
|
-
"shape":"ItemCollectionMetrics",
|
1436
|
-
"documentation":"<p>Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the table does not have any local secondary indexes, this information is not returned in the response.</p> <p>Each <i>ItemCollectionMetrics</i> element consists of:</p> <ul> <li><p><i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as the hash key of the item.</p></li> <li><p><i>SizeEstimateRange</i> - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.</p> <p>The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.</p> </li> </ul>"
|
1437
|
-
}
|
1438
|
-
},
|
1439
|
-
"documentation":"<p>Represents the output of a <i>PutItem</i> operation.</p>"
|
1440
|
-
},
|
1441
|
-
"PutRequest":{
|
1442
|
-
"type":"structure",
|
1443
|
-
"required":["Item"],
|
1444
|
-
"members":{
|
1445
|
-
"Item":{
|
1446
|
-
"shape":"PutItemInputAttributeMap",
|
1447
|
-
"documentation":"<p>A map of attribute name to attribute values, representing the primary key of an item to be processed by <i>PutItem</i>. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.</p>"
|
1448
|
-
}
|
1449
|
-
},
|
1450
|
-
"documentation":"<p>Represents a request to perform a <i>PutItem</i> operation on an item.</p>"
|
1451
|
-
},
|
1452
|
-
"QueryInput":{
|
1453
|
-
"type":"structure",
|
1454
|
-
"required":[
|
1455
|
-
"TableName",
|
1456
|
-
"KeyConditions"
|
1457
|
-
],
|
1458
|
-
"members":{
|
1459
|
-
"TableName":{
|
1460
|
-
"shape":"TableName",
|
1461
|
-
"documentation":"<p>The name of the table containing the requested items. </p>"
|
1462
|
-
},
|
1463
|
-
"IndexName":{
|
1464
|
-
"shape":"IndexName",
|
1465
|
-
"documentation":"<p>The name of an index to query. This can be any local secondary index or global secondary index on the table.</p>"
|
1466
|
-
},
|
1467
|
-
"Select":{
|
1468
|
-
"shape":"Select",
|
1469
|
-
"documentation":"<p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p> <ul> <li> <p><code>ALL_ATTRIBUTES</code>: Returns all of the item attributes from the specified table or index. If you are querying a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required..</p> </li> <li> <p><code>ALL_PROJECTED_ATTRIBUTES</code>: Allowed only when querying an index. Retrieves all attributes which have been projected into the index. If the index is configured to project all attributes, this is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p> </li> <li> <p><code>COUNT</code>: Returns the number of matching items, rather than the matching items themselves.</p> </li> <li> <p> <code>SPECIFIC_ATTRIBUTES</code> : Returns only the attributes listed in <i>AttributesToGet</i>. This is equivalent to specifying <i>AttributesToGet</i> without specifying any value for <i>Select</i>.</p> <p>If you are querying a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p> <p>If you are querying a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p> </li> </ul> <p>If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <i>Select</i> and <i>AttributesToGet</i> together in a single request, <i>unless</i> the value for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.)</p>"
|
1470
|
-
},
|
1471
|
-
"AttributesToGet":{
|
1472
|
-
"shape":"AttributeNameList",
|
1473
|
-
"documentation":"<p>The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p> <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</p> <p>You cannot use both <i>AttributesToGet</i> and <i>Select</i> together in a <i>Query</i> request, <i>unless</i> the value for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.)</p> <p>If you are querying a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p> <p>If you are querying a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p>"
|
1474
|
-
},
|
1475
|
-
"Limit":{
|
1476
|
-
"shape":"PositiveIntegerObject",
|
1477
|
-
"documentation":"<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to continue the operation. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\" >Query and Scan</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1478
|
-
},
|
1479
|
-
"ConsistentRead":{
|
1480
|
-
"shape":"ConsistentRead",
|
1481
|
-
"documentation":"<p>If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.</p> <p>Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with <i>ConsistentRead</i> set to <code>true</code>, you will receive an error message.</p>"
|
1482
|
-
},
|
1483
|
-
"KeyConditions":{
|
1484
|
-
"shape":"KeyConditions",
|
1485
|
-
"documentation":"<p>The selection criteria for the query.</p> <p>For a query on a table, you can only have conditions on the table primary key attributes. You <i>must</i> specify the hash key attribute name and value as an <code>EQ</code> condition. You can <i>optionally</i> specify a second condition, referring to the range key attribute.</p> <p>For a query on an index, you can only have conditions on the index key attributes. You <i>must</i> specify the index hash attribute name and value as an EQ condition. You can <i>optionally</i> specify a second condition, referring to the index key range attribute.</p> <p>If you specify more than one condition in the <i>KeyConditions</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> 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.)</p> <p>Each <i>KeyConditions</i> element consists of an attribute name to compare, along with the following:</p> <ul> <li> <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p> </li> <li> <p><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p> <p>For <i>KeyConditions</i>, only the following comparison operators are supported:</p> <p> <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code> </p> <p>The following are descriptions of these comparison operators.</p> <ul> <li> <p><code>EQ</code> : Equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p></p> </li> <li> <p><code>LE</code> : Less than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LT</code> : Less than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GE</code> : Greater than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GT</code> : Greater than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).</p> <p/> </li> <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </p> <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). 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 <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p> </li> </ul> </li> </ul> <p>For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#ConditionalExpressions\">Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1486
|
-
},
|
1487
|
-
"QueryFilter":{
|
1488
|
-
"shape":"FilterConditionMap",
|
1489
|
-
"documentation":"<p>Evaluates the query results and returns only the desired values.</p> <p>If you specify more than one condition in the <i>QueryFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> 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.)</p> <p>Each <i>QueryFilter</i> element consists of an attribute name to compare, along with the following:</p> <ul> <li> <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p> <p>For information on specifying data types in JSON, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html\">JSON Data Format</a> in the Amazon DynamoDB Developer Guide.</p> </li> <li> <p><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p> <p>The following comparison operators are available:</p> <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p> <p>For complete descriptions of all comparison operators, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html\">API_Condition.html</a>.</p> </li> </ul>"
|
1490
|
-
},
|
1491
|
-
"ConditionalOperator":{
|
1492
|
-
"shape":"ConditionalOperator",
|
1493
|
-
"documentation":"<p>A logical operator to apply to the conditions in the <i>QueryFilter</i> map:</p> <ul> <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> <li><p><code>OR</code> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> </ul> <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p> <p>The operation will succeed only if the entire map evaluates to true.</p>"
|
1494
|
-
},
|
1495
|
-
"ScanIndexForward":{
|
1496
|
-
"shape":"BooleanObject",
|
1497
|
-
"documentation":"<p>Specifies ascending (true) or descending (false) traversal of the index. DynamoDB returns results reflecting the requested order determined by the range key. If the data type is Number, the results are returned in numeric order. For String, the results are returned in order of ASCII character code values. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.</p> <p>If <i>ScanIndexForward</i> is not specified, the results are returned in ascending order.</p>"
|
1498
|
-
},
|
1499
|
-
"ExclusiveStartKey":{
|
1500
|
-
"shape":"Key",
|
1501
|
-
"documentation":"<p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedKey</i> in the previous operation.</p> <p>The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed.</p>"
|
1502
|
-
},
|
1503
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}
|
1504
|
-
},
|
1505
|
-
"documentation":"<p>Represents the input of a <i>Query</i> operation.</p>"
|
1506
|
-
},
|
1507
|
-
"QueryOutput":{
|
1508
|
-
"type":"structure",
|
1509
|
-
"members":{
|
1510
|
-
"Items":{
|
1511
|
-
"shape":"ItemList",
|
1512
|
-
"documentation":"<p>An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.</p>"
|
1513
|
-
},
|
1514
|
-
"Count":{
|
1515
|
-
"shape":"Integer",
|
1516
|
-
"documentation":"<p>The number of items in the response.</p> <p>If you used a <i>QueryFilter</i> in the request, then <i>Count</i> is the number of items returned <i>after</i> the filter was applied, and <i>ScannedCount</i> is the number of matching items <i>before</i> the filter was applied.</p> <p>If you did not use a filter in the request, then <i>Count</i> and <i>ScannedCount</i> are the same.</p>"
|
1517
|
-
},
|
1518
|
-
"ScannedCount":{
|
1519
|
-
"shape":"Integer",
|
1520
|
-
"documentation":"<p>The number of items evaluated, <i>before</i> any <i>QueryFilter</i> is applied. A high <i>ScannedCount</i> value with few, or no, <i>Count</i> results indicates an inefficient <i>Query</i> operation. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count\">Count and ScannedCount</a> in the Amazon DynamoDB Developer Guide.</p> <p>If you did not use a filter in the request, then <i>ScannedCount</i> is the same as <i>Count</i>.</p>"
|
1521
|
-
},
|
1522
|
-
"LastEvaluatedKey":{
|
1523
|
-
"shape":"Key",
|
1524
|
-
"documentation":"<p>The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.</p> <p>If <i>LastEvaluatedKey</i> is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.</p> <p>If <i>LastEvaluatedKey</i> is not empty, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when <i>LastEvaluatedKey</i> is empty.</p>"
|
1525
|
-
},
|
1526
|
-
"ConsumedCapacity":{"shape":"ConsumedCapacity"}
|
1527
|
-
},
|
1528
|
-
"documentation":"<p>Represents the output of a <i>Query</i> operation.</p>"
|
1529
|
-
},
|
1530
|
-
"ResourceInUseException":{
|
1531
|
-
"type":"structure",
|
1532
|
-
"members":{
|
1533
|
-
"message":{
|
1534
|
-
"shape":"ErrorMessage",
|
1535
|
-
"documentation":"<p>The resource which is being attempted to be changed is in use.</p>"
|
1536
|
-
}
|
1537
|
-
},
|
1538
|
-
"exception":true,
|
1539
|
-
"documentation":"<p>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 <code>CREATING</code> state.</p>"
|
1540
|
-
},
|
1541
|
-
"ResourceNotFoundException":{
|
1542
|
-
"type":"structure",
|
1543
|
-
"members":{
|
1544
|
-
"message":{
|
1545
|
-
"shape":"ErrorMessage",
|
1546
|
-
"documentation":"<p>The resource which is being requested does not exist.</p>"
|
1547
|
-
}
|
1548
|
-
},
|
1549
|
-
"exception":true,
|
1550
|
-
"documentation":"<p>The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be <code>ACTIVE</code>.</p>"
|
1551
|
-
},
|
1552
|
-
"ReturnConsumedCapacity":{
|
1553
|
-
"type":"string",
|
1554
|
-
"enum":[
|
1555
|
-
"INDEXES",
|
1556
|
-
"TOTAL",
|
1557
|
-
"NONE"
|
1558
|
-
],
|
1559
|
-
"documentation":"<p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in the response.</p>"
|
1560
|
-
},
|
1561
|
-
"ReturnItemCollectionMetrics":{
|
1562
|
-
"type":"string",
|
1563
|
-
"enum":[
|
1564
|
-
"SIZE",
|
1565
|
-
"NONE"
|
1566
|
-
]
|
1567
|
-
},
|
1568
|
-
"ReturnValue":{
|
1569
|
-
"type":"string",
|
1570
|
-
"enum":[
|
1571
|
-
"NONE",
|
1572
|
-
"ALL_OLD",
|
1573
|
-
"UPDATED_OLD",
|
1574
|
-
"ALL_NEW",
|
1575
|
-
"UPDATED_NEW"
|
1576
|
-
]
|
1577
|
-
},
|
1578
|
-
"ScalarAttributeType":{
|
1579
|
-
"type":"string",
|
1580
|
-
"enum":[
|
1581
|
-
"S",
|
1582
|
-
"N",
|
1583
|
-
"B"
|
1584
|
-
]
|
1585
|
-
},
|
1586
|
-
"ScanInput":{
|
1587
|
-
"type":"structure",
|
1588
|
-
"required":["TableName"],
|
1589
|
-
"members":{
|
1590
|
-
"TableName":{
|
1591
|
-
"shape":"TableName",
|
1592
|
-
"documentation":"<p>The name of the table containing the requested items.</p>"
|
1593
|
-
},
|
1594
|
-
"AttributesToGet":{
|
1595
|
-
"shape":"AttributeNameList",
|
1596
|
-
"documentation":"<p>The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p> <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</p>"
|
1597
|
-
},
|
1598
|
-
"Limit":{
|
1599
|
-
"shape":"PositiveIntegerObject",
|
1600
|
-
"documentation":"<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to continue the operation. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\" >Query and Scan</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1601
|
-
},
|
1602
|
-
"Select":{
|
1603
|
-
"shape":"Select",
|
1604
|
-
"documentation":"<p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.</p> <ul> <li> <p><code>ALL_ATTRIBUTES</code>: Returns all of the item attributes.</p> </li> <li> <p><code>COUNT</code>: Returns the number of matching items, rather than the matching items themselves.</p> </li> <li> <p> <code>SPECIFIC_ATTRIBUTES</code> : Returns only the attributes listed in <i>AttributesToGet</i>. This is equivalent to specifying <i>AttributesToGet</i> without specifying any value for <i>Select</i>.</p> </li> </ul> <p>If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code>. You cannot use both <i>Select</i> and <i>AttributesToGet</i> together in a single request, <i>unless</i> the value for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.)</p>"
|
1605
|
-
},
|
1606
|
-
"ScanFilter":{
|
1607
|
-
"shape":"FilterConditionMap",
|
1608
|
-
"documentation":"<p>Evaluates the scan results and returns only the desired values.</p> <p>If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> 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.)</p> <p>Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following:</p> <ul> <li> <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p> <p>For information on specifying data types in JSON, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html\">JSON Data Format</a> in the Amazon DynamoDB Developer Guide.</p> </li> <li> <p><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p> <p>The following comparison operators are available:</p> <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p> <p>For complete descriptions of all comparison operators, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html\">Condition</a>.</p> </li> </ul>"
|
1609
|
-
},
|
1610
|
-
"ConditionalOperator":{
|
1611
|
-
"shape":"ConditionalOperator",
|
1612
|
-
"documentation":"<p>A logical operator to apply to the conditions in the <i>ScanFilter</i> map:</p> <ul> <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> <li><p><code>OR</code> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> </ul> <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p> <p>The operation will succeed only if the entire map evaluates to true.</p>"
|
1613
|
-
},
|
1614
|
-
"ExclusiveStartKey":{
|
1615
|
-
"shape":"Key",
|
1616
|
-
"documentation":"<p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedKey</i> in the previous operation.</p> <p>The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed.</p> <p>In a parallel scan, a <i>Scan</i> request that includes <i>ExclusiveStartKey</i> must specify the same segment whose previous <i>Scan</i> returned the corresponding value of <i>LastEvaluatedKey</i>.</p>"
|
1617
|
-
},
|
1618
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"},
|
1619
|
-
"TotalSegments":{
|
1620
|
-
"shape":"ScanTotalSegments",
|
1621
|
-
"documentation":"<p>For a parallel <i>Scan</i> request, <i>TotalSegments</i> represents the total number of segments into which the <i>Scan</i> operation will be divided. The value of <i>TotalSegments</i> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to scan a table using four application threads, you would specify a <i>TotalSegments</i> value of 4.</p> <p>The value for <i>TotalSegments</i> must be greater than or equal to 1, and less than or equal to 4096. If you specify a <i>TotalSegments</i> value of 1, the <i>Scan</i> will be sequential rather than parallel.</p> <p>If you specify <i>TotalSegments</i>, you must also specify <i>Segment</i>.</p>"
|
1622
|
-
},
|
1623
|
-
"Segment":{
|
1624
|
-
"shape":"ScanSegment",
|
1625
|
-
"documentation":"<p>For a parallel <i>Scan</i> request, <i>Segment</i> identifies an individual segment to be scanned by an application worker.</p> <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a <i>Segment</i> value of 0, the second thread would specify 1, and so on.</p> <p>The value of <i>LastEvaluatedKey</i> returned from a parallel <i>Scan</i> request must be used as <i>ExclusiveStartKey</i> with the same Segment ID in a subsequent <i>Scan</i> operation.</p> <p>The value for <i>Segment</i> must be greater than or equal to 0, and less than the value provided for <i>TotalSegments</i>.</p> <p>If you specify <i>Segment</i>, you must also specify <i>TotalSegments</i>.</p>"
|
1626
|
-
}
|
1627
|
-
},
|
1628
|
-
"documentation":"<p>Represents the input of a <i>Scan</i> operation.</p>"
|
1629
|
-
},
|
1630
|
-
"ScanOutput":{
|
1631
|
-
"type":"structure",
|
1632
|
-
"members":{
|
1633
|
-
"Items":{
|
1634
|
-
"shape":"ItemList",
|
1635
|
-
"documentation":"<p>An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.</p>"
|
1636
|
-
},
|
1637
|
-
"Count":{
|
1638
|
-
"shape":"Integer",
|
1639
|
-
"documentation":"<p>The number of items in the response.</p> <p>If you used a <i>ScanFilter</i> in the request, then <i>Count</i> is the number of items returned <i>after</i> the filter was applied, and <i>ScannedCount</i> is the number of matching items <i>before</i> the filter was applied.</p> <p>If you did not use a filter in the request, then <i>Count</i> is the same as <i>ScannedCount</i>.</p>"
|
1640
|
-
},
|
1641
|
-
"ScannedCount":{
|
1642
|
-
"shape":"Integer",
|
1643
|
-
"documentation":"<p>The number of items evaluated, <i>before</i> any <i>ScanFilter</i> is applied. A high <i>ScannedCount</i> value with few, or no, <i>Count</i> results indicates an inefficient <i>Scan</i> operation. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count\">Count and ScannedCount</a> in the Amazon DynamoDB Developer Guide.</p> <p>If you did not use a filter in the request, then <i>ScannedCount</i> is the same as <i>Count</i>.</p>"
|
1644
|
-
},
|
1645
|
-
"LastEvaluatedKey":{
|
1646
|
-
"shape":"Key",
|
1647
|
-
"documentation":"<p>The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.</p> <p>If <i>LastEvaluatedKey</i> is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.</p> <p>If <i>LastEvaluatedKey</i> is not empty, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when <i>LastEvaluatedKey</i> is empty.</p>"
|
1648
|
-
},
|
1649
|
-
"ConsumedCapacity":{"shape":"ConsumedCapacity"}
|
1650
|
-
},
|
1651
|
-
"documentation":"<p>Represents the output of a <i>Scan</i> operation.</p>"
|
1652
|
-
},
|
1653
|
-
"ScanSegment":{
|
1654
|
-
"type":"integer",
|
1655
|
-
"min":0,
|
1656
|
-
"max":999999
|
1657
|
-
},
|
1658
|
-
"ScanTotalSegments":{
|
1659
|
-
"type":"integer",
|
1660
|
-
"min":1,
|
1661
|
-
"max":1000000
|
1662
|
-
},
|
1663
|
-
"SecondaryIndexesCapacityMap":{
|
1664
|
-
"type":"map",
|
1665
|
-
"key":{"shape":"IndexName"},
|
1666
|
-
"value":{"shape":"Capacity"}
|
1667
|
-
},
|
1668
|
-
"Select":{
|
1669
|
-
"type":"string",
|
1670
|
-
"enum":[
|
1671
|
-
"ALL_ATTRIBUTES",
|
1672
|
-
"ALL_PROJECTED_ATTRIBUTES",
|
1673
|
-
"SPECIFIC_ATTRIBUTES",
|
1674
|
-
"COUNT"
|
1675
|
-
]
|
1676
|
-
},
|
1677
|
-
"StringAttributeValue":{"type":"string"},
|
1678
|
-
"StringSetAttributeValue":{
|
1679
|
-
"type":"list",
|
1680
|
-
"member":{"shape":"StringAttributeValue"}
|
1681
|
-
},
|
1682
|
-
"TableDescription":{
|
1683
|
-
"type":"structure",
|
1684
|
-
"members":{
|
1685
|
-
"AttributeDefinitions":{
|
1686
|
-
"shape":"AttributeDefinitions",
|
1687
|
-
"documentation":"<p>An array of <i>AttributeDefinition</i> objects. Each of these objects describes one attribute in the table and index key schema.</p> <p>Each <i>AttributeDefinition</i> object in this array is composed of:</p> <ul> <li> <p><i>AttributeName</i> - The name of the attribute.</p> </li> <li> <p><i>AttributeType</i> - The data type for the attribute.</p> </li> </ul>"
|
1688
|
-
},
|
1689
|
-
"TableName":{
|
1690
|
-
"shape":"TableName",
|
1691
|
-
"documentation":"<p>The name of the table.</p>"
|
1692
|
-
},
|
1693
|
-
"KeySchema":{
|
1694
|
-
"shape":"KeySchema",
|
1695
|
-
"documentation":"<p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p> <ul> <li> <p><i>AttributeName</i> - The name of the attribute.</p> </li> <li> <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or <code>RANGE</code>.</p> </li> </ul> <p>For more information about primary keys, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey\">Primary Key</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1696
|
-
},
|
1697
|
-
"TableStatus":{
|
1698
|
-
"shape":"TableStatus",
|
1699
|
-
"documentation":"<p>The current state of the table:</p> <ul> <li> <p><i>CREATING</i> - The table is being created, as the result of a <i>CreateTable</i> operation.</p> </li> <li> <p><i>UPDATING</i> - The table is being updated, as the result of an <i>UpdateTable</i> operation.</p> </li> <li> <p><i>DELETING</i> - The table is being deleted, as the result of a <i>DeleteTable</i> operation.</p> </li> <li> <p><i>ACTIVE</i> - The table is ready for use.</p> </li> </ul>"
|
1700
|
-
},
|
1701
|
-
"CreationDateTime":{
|
1702
|
-
"shape":"Date",
|
1703
|
-
"documentation":"<p>The date and time when the table was created, in <a href=\"http://www.epochconverter.com/\">UNIX epoch time</a> format.</p>"
|
1704
|
-
},
|
1705
|
-
"ProvisionedThroughput":{
|
1706
|
-
"shape":"ProvisionedThroughputDescription",
|
1707
|
-
"documentation":"<p>The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.</p>"
|
1708
|
-
},
|
1709
|
-
"TableSizeBytes":{
|
1710
|
-
"shape":"Long",
|
1711
|
-
"documentation":"<p>The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p>"
|
1712
|
-
},
|
1713
|
-
"ItemCount":{
|
1714
|
-
"shape":"Long",
|
1715
|
-
"documentation":"<p>The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p>"
|
1716
|
-
},
|
1717
|
-
"LocalSecondaryIndexes":{
|
1718
|
-
"shape":"LocalSecondaryIndexDescriptionList",
|
1719
|
-
"documentation":"<p>Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:</p> <ul> <li> <p><i>IndexName</i> - The name of the local secondary index.</p> </li> <li> <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.</p> </li> <li> <p><i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p><i>ProjectionType</i> - One of the following:</p> <ul> <li> <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>.</p> </li> <li> <p><code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> <li> <p><i>IndexSizeBytes</i> - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p> </li> <li> <p><i>ItemCount</i> - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p> </li> </ul> <p>If the table is in the <code>DELETING</code> state, no information about indexes will be returned.</p>"
|
1720
|
-
},
|
1721
|
-
"GlobalSecondaryIndexes":{
|
1722
|
-
"shape":"GlobalSecondaryIndexDescriptionList",
|
1723
|
-
"documentation":"<p>The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:</p> <ul> <li> <p><i>IndexName</i> - The name of the global secondary index.</p> </li> <li> <p><i>IndexSizeBytes</i> - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p> </li> <li> <p><i>IndexStatus</i> - The current status of the global secondary index:</p> <ul> <li> <p><i>CREATING</i> - The index is being created.</p> </li> <li> <p><i>UPDATING</i> - The index is being updated.</p> </li> <li> <p><i>DELETING</i> - The index is being deleted.</p> </li> <li> <p><i>ACTIVE</i> - The index is ready for use.</p> </li> </ul> </li> <li> <p><i>ItemCount</i> - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </p> </li> <li> <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.</p> </li> <li> <p><i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p><i>ProjectionType</i> - One of the following:</p> <ul> <li> <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>.</p> </li> <li> <p><code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> <li> <p><i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. </p> </li> </ul> <p>If the table is in the <code>DELETING</code> state, no information about indexes will be returned.</p>"
|
1724
|
-
}
|
1725
|
-
},
|
1726
|
-
"documentation":"<p>Represents the properties of a table.</p>"
|
1727
|
-
},
|
1728
|
-
"TableName":{
|
1729
|
-
"type":"string",
|
1730
|
-
"min":3,
|
1731
|
-
"max":255,
|
1732
|
-
"pattern":"[a-zA-Z0-9_.-]+"
|
1733
|
-
},
|
1734
|
-
"TableNameList":{
|
1735
|
-
"type":"list",
|
1736
|
-
"member":{"shape":"TableName"}
|
1737
|
-
},
|
1738
|
-
"TableStatus":{
|
1739
|
-
"type":"string",
|
1740
|
-
"enum":[
|
1741
|
-
"CREATING",
|
1742
|
-
"UPDATING",
|
1743
|
-
"DELETING",
|
1744
|
-
"ACTIVE"
|
1745
|
-
]
|
1746
|
-
},
|
1747
|
-
"UpdateGlobalSecondaryIndexAction":{
|
1748
|
-
"type":"structure",
|
1749
|
-
"required":[
|
1750
|
-
"IndexName",
|
1751
|
-
"ProvisionedThroughput"
|
1752
|
-
],
|
1753
|
-
"members":{
|
1754
|
-
"IndexName":{
|
1755
|
-
"shape":"IndexName",
|
1756
|
-
"documentation":"<p>The name of the global secondary index to be updated.</p>"
|
1757
|
-
},
|
1758
|
-
"ProvisionedThroughput":{"shape":"ProvisionedThroughput"}
|
1759
|
-
},
|
1760
|
-
"documentation":"<p>Represents the new provisioned throughput settings to be applied to a global secondary index.</p>"
|
1761
|
-
},
|
1762
|
-
"UpdateItemInput":{
|
1763
|
-
"type":"structure",
|
1764
|
-
"required":[
|
1765
|
-
"TableName",
|
1766
|
-
"Key"
|
1767
|
-
],
|
1768
|
-
"members":{
|
1769
|
-
"TableName":{
|
1770
|
-
"shape":"TableName",
|
1771
|
-
"documentation":"<p>The name of the table containing the item to update. </p>"
|
1772
|
-
},
|
1773
|
-
"Key":{
|
1774
|
-
"shape":"Key",
|
1775
|
-
"documentation":"<p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p> <p>For the primary key, you must provide <i>all</i> of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>"
|
1776
|
-
},
|
1777
|
-
"AttributeUpdates":{
|
1778
|
-
"shape":"AttributeUpdates",
|
1779
|
-
"documentation":"<p>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 <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes.</p> <p>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 <i>ValidationException</i>.</p> <p>Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following:</p> <ul> <li> <p><i>Value</i> - The new value, if applicable, for this attribute.</p> </li> <li> <p><i>Action</i> - Specifies how to perform the update. Valid values for <i>Action</i> are <code>PUT</code>, <code>DELETE</code>, and <code>ADD</code>. The behavior depends on whether the specified primary key already exists in the table.</p> <p> <b>If an item with the specified <i>Key</i> is found in the table:</b> </p> <ul> <li> <p><code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </p> </li> <li> <p><code>DELETE</code> - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.</p> <p>If a <i>set</i> of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <i>DELETE</i> action specified <code>[a,c]</code>, then the final attribute value would be <code>[b]</code>. Specifying an empty set is an error.</p> </li> <li> <p><code>ADD</code> - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute:</p> <ul> <li> <p>If the existing attribute is a number, and if <i>Value</i> is also a number, then the <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute.</p> </li> <li> <p>If the existing data type is a set, and if the <i>Value</i> is also a set, then the <i>Value</i> is added to the existing set. (This is a <i>set</i> operation, not mathematical addition.) For example, if the attribute value was the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value would be <code>[1,2,3]</code>. 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. </p> <p>Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the <i>Value</i> must also be a set of strings. The same holds true for number sets and binary sets.</p> </li> </ul> <p>This action is only valid for an existing attribute whose data type is number or is a set. Do not use <code>ADD</code> for any other data types.</p> </li> </ul> <p> <b>If no item with the specified <i>Key</i> is found:</b> </p> <ul> <li> <p><code>PUT</code> - DynamoDB creates a new item with the specified primary key, and then adds the attribute. </p> </li> <li> <p><code>DELETE</code> - Nothing happens; there is no attribute to delete.</p> </li> <li> <p><code>ADD</code> - DynamoDB creates 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; no other data types can be specified.</p> </li> </ul> </li> </ul> <p>If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</p>"
|
1780
|
-
},
|
1781
|
-
"Expected":{
|
1782
|
-
"shape":"ExpectedAttributeMap",
|
1783
|
-
"documentation":"<p>A map of attribute/condition pairs. This is the conditional block for the <i>UpdateItem</i> operation.</p> <p>Each element of <i>Expected</i> 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 <i>Expected</i> element, the result of the evaluation is either true or false.</p> <p>If you specify more than one element in the <i>Expected</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> 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.)</p> <p>If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails.</p> <p>Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with an <i>AttributeValueList</i> and a <i>ComparisonOperator</i>:</p> <ul> <li> <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p> <p>For type Number, value comparisons are numeric.</p> <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\" >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p> <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.</p> </li> <li> <p><i>ComparisonOperator</i> - A comparator for evaluating attributes in the <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads.</p> <p>The following comparison operators are available:</p> <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p> <p>The following are descriptions of each comparison operator.</p> <ul> <li> <p><code>EQ</code> : Equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NE</code> : Not equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LE</code> : Less than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>LT</code> : Less than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GE</code> : Greater than or equal. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>GT</code> : Greater than. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p> <p/> </li> <li> <p><code>NOT_NULL</code> : The attribute exists. </p> </li> <li> <p><code>NULL</code> : The attribute does not exist. </p> </li> <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).</p> </li> <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in a set.</p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).</p></li> <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p> <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).</p> <p/> </li> <li> <p><code>IN</code> : checks for exact matches.</p> <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.</p> </li> <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </p> <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). 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 <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also, <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p> </li> </ul> </li> </ul> <p>For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#ConditionalExpressions\" >Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>"
|
1784
|
-
},
|
1785
|
-
"ConditionalOperator":{
|
1786
|
-
"shape":"ConditionalOperator",
|
1787
|
-
"documentation":"<p>A logical operator to apply to the conditions in the <i>Expected</i> map:</p> <ul> <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> <li><p><code>OR</code> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li> </ul> <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p> <p>The operation will succeed only if the entire map evaluates to true.</p>"
|
1788
|
-
},
|
1789
|
-
"ReturnValues":{
|
1790
|
-
"shape":"ReturnValue",
|
1791
|
-
"documentation":"<p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before or after they were updated. For <i>UpdateItem</i>, the valid values are:</p> <ul> <li> <p><code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This is the default for <i>ReturnValues</i>.)</p> </li> <li> <p><code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned.</p> </li> <li> <p><code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned.</p> </li> <li> <p><code>ALL_NEW</code> - All of the attributes of the new version of the item are returned.</p> </li> <li> <p><code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned.</p> </li> </ul>"
|
1792
|
-
},
|
1793
|
-
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"},
|
1794
|
-
"ReturnItemCollectionMetrics":{
|
1795
|
-
"shape":"ReturnItemCollectionMetrics",
|
1796
|
-
"documentation":"<p>If set to <code>SIZE</code>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>"
|
1797
|
-
}
|
1798
|
-
},
|
1799
|
-
"documentation":"<p>Represents the input of an <i>UpdateItem</i> operation.</p>"
|
1800
|
-
},
|
1801
|
-
"UpdateItemOutput":{
|
1802
|
-
"type":"structure",
|
1803
|
-
"members":{
|
1804
|
-
"Attributes":{
|
1805
|
-
"shape":"AttributeMap",
|
1806
|
-
"documentation":"<p>A map of attribute values as they appeared before the <i>UpdateItem</i> operation, but only if <i>ReturnValues</i> was specified as something other than <code>NONE</code> in the request. Each element represents one attribute.</p>"
|
1807
|
-
},
|
1808
|
-
"ConsumedCapacity":{"shape":"ConsumedCapacity"},
|
1809
|
-
"ItemCollectionMetrics":{"shape":"ItemCollectionMetrics"}
|
1810
|
-
},
|
1811
|
-
"documentation":"<p>Represents the output of an <i>UpdateItem</i> operation.</p>"
|
1812
|
-
},
|
1813
|
-
"UpdateTableInput":{
|
1814
|
-
"type":"structure",
|
1815
|
-
"required":["TableName"],
|
1816
|
-
"members":{
|
1817
|
-
"TableName":{
|
1818
|
-
"shape":"TableName",
|
1819
|
-
"documentation":"<p>The name of the table to be updated.</p>"
|
1820
|
-
},
|
1821
|
-
"ProvisionedThroughput":{"shape":"ProvisionedThroughput"},
|
1822
|
-
"GlobalSecondaryIndexUpdates":{
|
1823
|
-
"shape":"GlobalSecondaryIndexUpdateList",
|
1824
|
-
"documentation":"<p>An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.</p>"
|
1825
|
-
}
|
1826
|
-
},
|
1827
|
-
"documentation":"<p>Represents the input of an <i>UpdateTable</i> operation.</p>"
|
1828
|
-
},
|
1829
|
-
"UpdateTableOutput":{
|
1830
|
-
"type":"structure",
|
1831
|
-
"members":{
|
1832
|
-
"TableDescription":{"shape":"TableDescription"}
|
1833
|
-
},
|
1834
|
-
"documentation":"<p>Represents the output of an <i>UpdateTable</i> operation.</p>"
|
1835
|
-
},
|
1836
|
-
"WriteRequest":{
|
1837
|
-
"type":"structure",
|
1838
|
-
"members":{
|
1839
|
-
"PutRequest":{
|
1840
|
-
"shape":"PutRequest",
|
1841
|
-
"documentation":"<p>A request to perform a <i>PutItem</i> operation.</p>"
|
1842
|
-
},
|
1843
|
-
"DeleteRequest":{
|
1844
|
-
"shape":"DeleteRequest",
|
1845
|
-
"documentation":"<p>A request to perform a <i>DeleteItem</i> operation.</p>"
|
1846
|
-
}
|
1847
|
-
},
|
1848
|
-
"documentation":"<p>Represents an operation to perform - either <i>DeleteItem</i> or <i>PutItem</i>. You can only specify one of these operations, not both, in a single <i>WriteRequest</i>. If you do need to perform both of these operations, you will need to specify two separate <i>WriteRequest</i> objects.</p>"
|
1849
|
-
},
|
1850
|
-
"WriteRequests":{
|
1851
|
-
"type":"list",
|
1852
|
-
"member":{"shape":"WriteRequest"},
|
1853
|
-
"min":1,
|
1854
|
-
"max":25
|
1855
|
-
}
|
1856
|
-
}
|
1857
|
-
}
|