aws-sdk-core 2.0.0.rc7 → 2.0.0.rc8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -5
- data/README.md +2 -2
- data/apis/CloudFormation-2010-05-15.json +27 -0
- data/apis/CloudSearch-2013-01-01.json +16 -0
- data/apis/CloudWatch-2010-08-01.json +0 -185
- data/apis/ElastiCache-2014-03-24.json +7 -0
- data/apis/ElasticTranscoder-2012-09-25.json +118 -2
- data/apis/Glacier-2012-06-01.json +52 -0
- data/apis/RDS-2013-09-09.json +4 -0
- data/apis/S3-2006-03-01.json +490 -468
- data/apis/StorageGateway-2013-06-30.json +28 -0
- data/apis/source/cloudformation-2010-05-15.json +43 -7
- data/apis/source/cloudsearch-2013-01-01.json +38 -16
- data/apis/source/directconnect-2012-10-25.paginators.json +8 -2
- data/apis/source/dynamodb-2012-08-10.json +270 -269
- data/apis/source/ec2-2014-02-01.json +30 -30
- data/apis/source/elasticache-2014-03-24.paginators.json +6 -0
- data/apis/source/elastictranscoder-2012-09-25.json +184 -56
- data/apis/source/elastictranscoder-2012-09-25.paginators.json +4 -0
- data/apis/source/email-2010-12-01.json +1 -1
- data/apis/source/email-2010-12-01.waiters.json +14 -0
- data/apis/source/glacier-2012-06-01.json +77 -13
- data/apis/source/monitoring-2010-08-01.json +0 -308
- data/apis/source/rds-2013-01-10.json +7 -7
- data/apis/source/rds-2013-02-12.json +7 -7
- data/apis/source/rds-2013-09-09.json +76 -57
- data/apis/source/s3-2006-03-01.json +2213 -1209
- data/apis/source/s3-2006-03-01.waiters.json +5 -0
- data/apis/source/storagegateway-2013-06-30.json +441 -401
- data/apis/source/storagegateway-2013-06-30.paginators.json +6 -6
- data/apis/source/sts-2011-06-15.json +9 -9
- data/apis/source/swf-2012-01-25.json +627 -627
- data/doc-src/templates/default/layout/html/layout.erb +37 -0
- data/lib/aws/credential_provider_chain.rb +5 -7
- data/lib/aws/version.rb +1 -1
- data/spec/fixtures/operations/s3/head_object.yml +2 -2
- metadata +4 -5
- data/apis/source/cloudfront-2014-01-31.normal.json +0 -2905
- data/apis/source/elasticloadbalancing-2012-06-01.normal.json +0 -2107
- data/apis/source/kinesis-2013-12-02.normal.json +0 -761
|
@@ -63,6 +63,14 @@
|
|
|
63
63
|
"gateway_type": {
|
|
64
64
|
"type": "string",
|
|
65
65
|
"serialized_name": "GatewayType"
|
|
66
|
+
},
|
|
67
|
+
"tape_drive_type": {
|
|
68
|
+
"type": "string",
|
|
69
|
+
"serialized_name": "TapeDriveType"
|
|
70
|
+
},
|
|
71
|
+
"medium_changer_type": {
|
|
72
|
+
"type": "string",
|
|
73
|
+
"serialized_name": "MediumChangerType"
|
|
66
74
|
}
|
|
67
75
|
}
|
|
68
76
|
},
|
|
@@ -1222,6 +1230,10 @@
|
|
|
1222
1230
|
"tape_size_in_bytes": {
|
|
1223
1231
|
"type": "integer",
|
|
1224
1232
|
"serialized_name": "TapeSizeInBytes"
|
|
1233
|
+
},
|
|
1234
|
+
"tape_status": {
|
|
1235
|
+
"type": "string",
|
|
1236
|
+
"serialized_name": "TapeStatus"
|
|
1225
1237
|
}
|
|
1226
1238
|
}
|
|
1227
1239
|
}
|
|
@@ -1404,6 +1416,18 @@
|
|
|
1404
1416
|
"type": "string",
|
|
1405
1417
|
"serialized_name": "VTLDeviceARN"
|
|
1406
1418
|
},
|
|
1419
|
+
"vtl_device_type": {
|
|
1420
|
+
"type": "string",
|
|
1421
|
+
"serialized_name": "VTLDeviceType"
|
|
1422
|
+
},
|
|
1423
|
+
"vtl_device_vendor": {
|
|
1424
|
+
"type": "string",
|
|
1425
|
+
"serialized_name": "VTLDeviceVendor"
|
|
1426
|
+
},
|
|
1427
|
+
"vtl_device_product_identifier": {
|
|
1428
|
+
"type": "string",
|
|
1429
|
+
"serialized_name": "VTLDeviceProductIdentifier"
|
|
1430
|
+
},
|
|
1407
1431
|
"device_iscsi_attributes": {
|
|
1408
1432
|
"type": "structure",
|
|
1409
1433
|
"serialized_name": "DeviceiSCSIAttributes",
|
|
@@ -1539,6 +1563,10 @@
|
|
|
1539
1563
|
"gateway_type": {
|
|
1540
1564
|
"type": "string",
|
|
1541
1565
|
"serialized_name": "GatewayType"
|
|
1566
|
+
},
|
|
1567
|
+
"gateway_operational_state": {
|
|
1568
|
+
"type": "string",
|
|
1569
|
+
"serialized_name": "GatewayOperationalState"
|
|
1542
1570
|
}
|
|
1543
1571
|
}
|
|
1544
1572
|
}
|
|
@@ -70,6 +70,11 @@
|
|
|
70
70
|
"shape_name": "ParameterValue",
|
|
71
71
|
"type": "string",
|
|
72
72
|
"documentation": "\n <p>The value associated with the parameter.</p>\n "
|
|
73
|
+
},
|
|
74
|
+
"UsePreviousValue": {
|
|
75
|
+
"shape_name": "UsePreviousValue",
|
|
76
|
+
"type": "boolean",
|
|
77
|
+
"documentation": "\n <p>During a stack update, use the existing parameter value that is being used for the stack.</p>\n "
|
|
73
78
|
}
|
|
74
79
|
},
|
|
75
80
|
"documentation": "\n <p>The Parameter data type.</p>\n "
|
|
@@ -227,7 +232,7 @@
|
|
|
227
232
|
"StackName": {
|
|
228
233
|
"shape_name": "StackName",
|
|
229
234
|
"type": "string",
|
|
230
|
-
"documentation": "\n <p>The name or the unique identifier associated with the stack
|
|
235
|
+
"documentation": "\n <p>The name or the unique identifier associated with the stack, which are not always interchangeable:</p>\n <ul>\n <li>Running stacks: You can specify either the stack's name or its unique stack ID.</li>\n <li>Deleted stacks: You must specify the unique stack ID.</li>\n </ul>\n <p>Default: There is no default value.</p>\n "
|
|
231
236
|
},
|
|
232
237
|
"NextToken": {
|
|
233
238
|
"shape_name": "NextToken",
|
|
@@ -333,7 +338,7 @@
|
|
|
333
338
|
"errors": [
|
|
334
339
|
|
|
335
340
|
],
|
|
336
|
-
"documentation": "\n <p>Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html\">Stacks</a> in the AWS CloudFormation User Guide.</p>\n <note>
|
|
341
|
+
"documentation": "\n <p>Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html\">Stacks</a> in the AWS CloudFormation User Guide.</p>\n <note>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</note>\n\n <examples>\n <queryrequest>\nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStackEvents\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]</queryrequest>\n\n <queryresponse>\n<DescribeStackEventsResult>\n <StackEvents>\n <member>\n <EventId>Event-1-Id</EventId>\n <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>\n <StackName>MyStack</StackName>\n <LogicalResourceId>MyStack</LogicalResourceId>\n <PhysicalResourceId>MyStack_One</PhysicalResourceId>\n <ResourceType>AWS::CloudFormation::Stack</ResourceType>\n <Timestamp>2010-07-27T22:26:28Z</Timestamp>\n <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>\n <ResourceStatusReason>User initiated</ ResourceStatusReason>\n </member>\n <member>\n <EventId>Event-2-Id</EventId>\n <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>\n <StackName>MyStack</StackName>\n <LogicalResourceId>MyDBInstance</LogicalResourceId>\n <PhysicalResourceId>MyStack_DB1</PhysicalResourceId>\n <ResourceType>AWS::SecurityGroup</ResourceType>\n <Timestamp>2010-07-27T22:27:28Z</Timestamp>\n <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>\n <ResourceProperties>{\"GroupDescription\":...}</ResourceProperties>\n </member>\n <member>\n <EventId>Event-3-Id</EventId>\n <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>\n <StackName>MyStack</StackName>\n <LogicalResourceId>MySG1</LogicalResourceId>\n <PhysicalResourceId>MyStack_SG1</PhysicalResourceId>\n <ResourceType>AWS:: SecurityGroup</ResourceType>\n <Timestamp>2010-07-27T22:28:28Z</Timestamp>\n <ResourceStatus>CREATE_COMPLETE</ResourceStatus>\n </member>\n </StackEvents>\n</DescribeStackEventsResult></queryresponse>\n </examples>\n "
|
|
337
342
|
},
|
|
338
343
|
"DescribeStackResource": {
|
|
339
344
|
"name": "DescribeStackResource",
|
|
@@ -344,7 +349,7 @@
|
|
|
344
349
|
"StackName": {
|
|
345
350
|
"shape_name": "StackName",
|
|
346
351
|
"type": "string",
|
|
347
|
-
"documentation": "\n <p>The name or the unique identifier associated with the stack
|
|
352
|
+
"documentation": "\n <p>The name or the unique identifier associated with the stack, which are not always interchangeable:</p>\n <ul>\n <li>Running stacks: You can specify either the stack's name or its unique stack ID.</li>\n <li>Deleted stacks: You must specify the unique stack ID.</li>\n </ul>\n <p>Default: There is no default value.</p>\n ",
|
|
348
353
|
"required": true
|
|
349
354
|
},
|
|
350
355
|
"LogicalResourceId": {
|
|
@@ -449,7 +454,7 @@
|
|
|
449
454
|
"StackName": {
|
|
450
455
|
"shape_name": "StackName",
|
|
451
456
|
"type": "string",
|
|
452
|
-
"documentation": "\n <p>The name or the unique identifier associated with the stack.</p>\n <p>Required: Conditional. If you do not specify <code>StackName</code>, you must specify\n <code>PhysicalResourceId</code>.</p>\n
|
|
457
|
+
"documentation": "\n <p>The name or the unique identifier associated with the stack, which are not always interchangeable:</p>\n <ul>\n <li>Running stacks: You can specify either the stack's name or its unique stack ID.</li>\n <li>Deleted stacks: You must specify the unique stack ID.</li>\n </ul>\n <p>Default: There is no default value.</p>\n <p>Required: Conditional. If you do not specify <code>StackName</code>, you must specify\n <code>PhysicalResourceId</code>.</p>\n "
|
|
453
458
|
},
|
|
454
459
|
"LogicalResourceId": {
|
|
455
460
|
"shape_name": "LogicalResourceId",
|
|
@@ -557,7 +562,7 @@
|
|
|
557
562
|
"StackName": {
|
|
558
563
|
"shape_name": "StackName",
|
|
559
564
|
"type": "string",
|
|
560
|
-
"documentation": "\n <p>The name or the unique identifier associated with the stack
|
|
565
|
+
"documentation": "\n <p>The name or the unique identifier associated with the stack, which are not always interchangeable:</p>\n <ul>\n <li>Running stacks: You can specify either the stack's name or its unique stack ID.</li>\n <li>Deleted stacks: You must specify the unique stack ID.</li>\n </ul>\n <p>Default: There is no default value.</p>\n "
|
|
561
566
|
},
|
|
562
567
|
"NextToken": {
|
|
563
568
|
"shape_name": "NextToken",
|
|
@@ -612,6 +617,11 @@
|
|
|
612
617
|
"shape_name": "ParameterValue",
|
|
613
618
|
"type": "string",
|
|
614
619
|
"documentation": "\n <p>The value associated with the parameter.</p>\n "
|
|
620
|
+
},
|
|
621
|
+
"UsePreviousValue": {
|
|
622
|
+
"shape_name": "UsePreviousValue",
|
|
623
|
+
"type": "boolean",
|
|
624
|
+
"documentation": "\n <p>During a stack update, use the existing parameter value that is being used for the stack.</p>\n "
|
|
615
625
|
}
|
|
616
626
|
},
|
|
617
627
|
"documentation": "\n <p>The Parameter data type.</p>\n "
|
|
@@ -797,6 +807,11 @@
|
|
|
797
807
|
"shape_name": "ParameterValue",
|
|
798
808
|
"type": "string",
|
|
799
809
|
"documentation": "\n <p>The value associated with the parameter.</p>\n "
|
|
810
|
+
},
|
|
811
|
+
"UsePreviousValue": {
|
|
812
|
+
"shape_name": "UsePreviousValue",
|
|
813
|
+
"type": "boolean",
|
|
814
|
+
"documentation": "\n <p>During a stack update, use the existing parameter value that is being used for the stack.</p>\n "
|
|
800
815
|
}
|
|
801
816
|
},
|
|
802
817
|
"documentation": "\n <p>The Parameter data type.</p>\n "
|
|
@@ -978,7 +993,7 @@
|
|
|
978
993
|
"type": "string",
|
|
979
994
|
"min_length": 1,
|
|
980
995
|
"max_length": 1024,
|
|
981
|
-
"documentation": "\n <p>String that identifies the start of the next list of
|
|
996
|
+
"documentation": "\n <p>String that identifies the start of the next list of stack resources, if there is one.</p>\n "
|
|
982
997
|
}
|
|
983
998
|
},
|
|
984
999
|
"documentation": "\n <p>The output for a <a>ListStackResources</a> action.</p>\n "
|
|
@@ -1184,6 +1199,11 @@
|
|
|
1184
1199
|
"max_length": 1024,
|
|
1185
1200
|
"documentation": "\n <p>Location of file containing the template body. The URL must point to a template located in an S3 bucket in the\n same region as the stack. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a>\n in the AWS CloudFormation User Guide.</p>\n <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>\n "
|
|
1186
1201
|
},
|
|
1202
|
+
"UsePreviousTemplate": {
|
|
1203
|
+
"shape_name": "UsePreviousTemplate",
|
|
1204
|
+
"type": "boolean",
|
|
1205
|
+
"documentation": "\n <p>Reuse the existing template that is associated with the stack that you are updating.</p>\n "
|
|
1206
|
+
},
|
|
1187
1207
|
"StackPolicyDuringUpdateBody": {
|
|
1188
1208
|
"shape_name": "StackPolicyDuringUpdateBody",
|
|
1189
1209
|
"type": "string",
|
|
@@ -1214,6 +1234,11 @@
|
|
|
1214
1234
|
"shape_name": "ParameterValue",
|
|
1215
1235
|
"type": "string",
|
|
1216
1236
|
"documentation": "\n <p>The value associated with the parameter.</p>\n "
|
|
1237
|
+
},
|
|
1238
|
+
"UsePreviousValue": {
|
|
1239
|
+
"shape_name": "UsePreviousValue",
|
|
1240
|
+
"type": "boolean",
|
|
1241
|
+
"documentation": "\n <p>During a stack update, use the existing parameter value that is being used for the stack.</p>\n "
|
|
1217
1242
|
}
|
|
1218
1243
|
},
|
|
1219
1244
|
"documentation": "\n <p>The Parameter data type.</p>\n "
|
|
@@ -1246,6 +1271,17 @@
|
|
|
1246
1271
|
"min_length": 1,
|
|
1247
1272
|
"max_length": 1350,
|
|
1248
1273
|
"documentation": "\n <p>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack.\n You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>\n <p>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</p>\n "
|
|
1274
|
+
},
|
|
1275
|
+
"NotificationARNs": {
|
|
1276
|
+
"shape_name": "NotificationARNs",
|
|
1277
|
+
"type": "list",
|
|
1278
|
+
"members": {
|
|
1279
|
+
"shape_name": "NotificationARN",
|
|
1280
|
+
"type": "string",
|
|
1281
|
+
"documentation": null
|
|
1282
|
+
},
|
|
1283
|
+
"max_length": 5,
|
|
1284
|
+
"documentation": "\n <p>Update the ARNs for the Amazon SNS topics that are associated with the stack.</p>\n "
|
|
1249
1285
|
}
|
|
1250
1286
|
},
|
|
1251
1287
|
"documentation": "\n <p>The input for <a>UpdateStack</a> action.</p>\n "
|
|
@@ -1283,7 +1319,7 @@
|
|
|
1283
1319
|
"shape_name": "TemplateBody",
|
|
1284
1320
|
"type": "string",
|
|
1285
1321
|
"min_length": 1,
|
|
1286
|
-
"documentation": "\n <p>
|
|
1322
|
+
"documentation": "\n <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a>\n in the AWS CloudFormation User Guide.</p>\n <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only\n <code>TemplateBody</code> is used.</p>\n "
|
|
1287
1323
|
},
|
|
1288
1324
|
"TemplateURL": {
|
|
1289
1325
|
"shape_name": "TemplateURL",
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
"Endpoint": {
|
|
147
147
|
"shape_name": "ServiceUrl",
|
|
148
148
|
"type": "string",
|
|
149
|
-
"documentation": "\n <p>The
|
|
149
|
+
"documentation": "\n <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>\n "
|
|
150
150
|
}
|
|
151
151
|
},
|
|
152
152
|
"documentation": "\n <p>The service endpoint for updating documents in a search domain.</p>\n "
|
|
@@ -158,7 +158,7 @@
|
|
|
158
158
|
"Endpoint": {
|
|
159
159
|
"shape_name": "ServiceUrl",
|
|
160
160
|
"type": "string",
|
|
161
|
-
"documentation": "\n <p>The
|
|
161
|
+
"documentation": "\n <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>\n "
|
|
162
162
|
}
|
|
163
163
|
},
|
|
164
164
|
"documentation": "\n <p>The service endpoint for requesting search results from a search domain.</p>\n "
|
|
@@ -279,6 +279,7 @@
|
|
|
279
279
|
"fr",
|
|
280
280
|
"ga",
|
|
281
281
|
"gl",
|
|
282
|
+
"he",
|
|
282
283
|
"hi",
|
|
283
284
|
"hu",
|
|
284
285
|
"hy",
|
|
@@ -330,7 +331,7 @@
|
|
|
330
331
|
"light",
|
|
331
332
|
"full"
|
|
332
333
|
],
|
|
333
|
-
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing-settings
|
|
334
|
+
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings\" target=\"_blank\">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>\n "
|
|
334
335
|
}
|
|
335
336
|
},
|
|
336
337
|
"documentation": "\n <p>Synonyms, stopwords, and stemming options for an analysis scheme.</p>\n "
|
|
@@ -382,6 +383,7 @@
|
|
|
382
383
|
"fr",
|
|
383
384
|
"ga",
|
|
384
385
|
"gl",
|
|
386
|
+
"he",
|
|
385
387
|
"hi",
|
|
386
388
|
"hu",
|
|
387
389
|
"hy",
|
|
@@ -433,7 +435,7 @@
|
|
|
433
435
|
"light",
|
|
434
436
|
"full"
|
|
435
437
|
],
|
|
436
|
-
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing-settings
|
|
438
|
+
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings\" target=\"_blank\">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>\n "
|
|
437
439
|
}
|
|
438
440
|
},
|
|
439
441
|
"documentation": "\n <p>Synonyms, stopwords, and stemming options for an analysis scheme.</p>\n "
|
|
@@ -1976,7 +1978,7 @@
|
|
|
1976
1978
|
"documentation": "\n <p>The request was rejected because it attempted to reference a resource that does not exist.</p>\n "
|
|
1977
1979
|
}
|
|
1978
1980
|
],
|
|
1979
|
-
"documentation": "\n <p>Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-
|
|
1981
|
+
"documentation": "\n <p>Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
|
1980
1982
|
},
|
|
1981
1983
|
"DeleteAnalysisScheme": {
|
|
1982
1984
|
"name": "DeleteAnalysisScheme",
|
|
@@ -2045,6 +2047,7 @@
|
|
|
2045
2047
|
"fr",
|
|
2046
2048
|
"ga",
|
|
2047
2049
|
"gl",
|
|
2050
|
+
"he",
|
|
2048
2051
|
"hi",
|
|
2049
2052
|
"hu",
|
|
2050
2053
|
"hy",
|
|
@@ -2096,7 +2099,7 @@
|
|
|
2096
2099
|
"light",
|
|
2097
2100
|
"full"
|
|
2098
2101
|
],
|
|
2099
|
-
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing-settings
|
|
2102
|
+
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings\" target=\"_blank\">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>\n "
|
|
2100
2103
|
}
|
|
2101
2104
|
},
|
|
2102
2105
|
"documentation": "\n <p>Synonyms, stopwords, and stemming options for an analysis scheme.</p>\n "
|
|
@@ -2195,7 +2198,7 @@
|
|
|
2195
2198
|
"documentation": "\n <p>The request was rejected because it attempted to reference a resource that does not exist.</p>\n "
|
|
2196
2199
|
}
|
|
2197
2200
|
],
|
|
2198
|
-
"documentation": "\n <p>Deletes an analysis scheme. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html
|
|
2201
|
+
"documentation": "\n <p>Deletes an analysis scheme. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>\n "
|
|
2199
2202
|
},
|
|
2200
2203
|
"DeleteDomain": {
|
|
2201
2204
|
"name": "DeleteDomain",
|
|
@@ -2262,7 +2265,7 @@
|
|
|
2262
2265
|
"Endpoint": {
|
|
2263
2266
|
"shape_name": "ServiceUrl",
|
|
2264
2267
|
"type": "string",
|
|
2265
|
-
"documentation": "\n <p>The
|
|
2268
|
+
"documentation": "\n <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>\n "
|
|
2266
2269
|
}
|
|
2267
2270
|
},
|
|
2268
2271
|
"documentation": "\n <p>The service endpoint for updating documents in a search domain.</p>\n "
|
|
@@ -2274,7 +2277,7 @@
|
|
|
2274
2277
|
"Endpoint": {
|
|
2275
2278
|
"shape_name": "ServiceUrl",
|
|
2276
2279
|
"type": "string",
|
|
2277
|
-
"documentation": "\n <p>The
|
|
2280
|
+
"documentation": "\n <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>\n "
|
|
2278
2281
|
}
|
|
2279
2282
|
},
|
|
2280
2283
|
"documentation": "\n <p>The service endpoint for requesting search results from a search domain.</p>\n "
|
|
@@ -3251,7 +3254,7 @@
|
|
|
3251
3254
|
"documentation": "\n <p>The request was rejected because it attempted to reference a resource that does not exist.</p>\n "
|
|
3252
3255
|
}
|
|
3253
3256
|
],
|
|
3254
|
-
"documentation": "\n <p>Deletes a suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-
|
|
3257
|
+
"documentation": "\n <p>Deletes a suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
|
3255
3258
|
},
|
|
3256
3259
|
"DescribeAnalysisSchemes": {
|
|
3257
3260
|
"name": "DescribeAnalysisSchemes",
|
|
@@ -3332,6 +3335,7 @@
|
|
|
3332
3335
|
"fr",
|
|
3333
3336
|
"ga",
|
|
3334
3337
|
"gl",
|
|
3338
|
+
"he",
|
|
3335
3339
|
"hi",
|
|
3336
3340
|
"hu",
|
|
3337
3341
|
"hy",
|
|
@@ -3383,7 +3387,7 @@
|
|
|
3383
3387
|
"light",
|
|
3384
3388
|
"full"
|
|
3385
3389
|
],
|
|
3386
|
-
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing-settings
|
|
3390
|
+
"documentation": "\n <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings\" target=\"_blank\">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>\n "
|
|
3387
3391
|
}
|
|
3388
3392
|
},
|
|
3389
3393
|
"documentation": "\n <p>Synonyms, stopwords, and stemming options for an analysis scheme.</p>\n "
|
|
@@ -3693,7 +3697,7 @@
|
|
|
3693
3697
|
"Endpoint": {
|
|
3694
3698
|
"shape_name": "ServiceUrl",
|
|
3695
3699
|
"type": "string",
|
|
3696
|
-
"documentation": "\n <p>The
|
|
3700
|
+
"documentation": "\n <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>\n "
|
|
3697
3701
|
}
|
|
3698
3702
|
},
|
|
3699
3703
|
"documentation": "\n <p>The service endpoint for updating documents in a search domain.</p>\n "
|
|
@@ -3705,7 +3709,7 @@
|
|
|
3705
3709
|
"Endpoint": {
|
|
3706
3710
|
"shape_name": "ServiceUrl",
|
|
3707
3711
|
"type": "string",
|
|
3708
|
-
"documentation": "\n <p>The
|
|
3712
|
+
"documentation": "\n <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>\n "
|
|
3709
3713
|
}
|
|
3710
3714
|
},
|
|
3711
3715
|
"documentation": "\n <p>The service endpoint for requesting search results from a search domain.</p>\n "
|
|
@@ -3773,7 +3777,7 @@
|
|
|
3773
3777
|
"documentation": "\n <p>An internal error occurred while processing the request. If this problem persists,\n report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>\n "
|
|
3774
3778
|
}
|
|
3775
3779
|
],
|
|
3776
|
-
"documentation": "\n <p>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows\n all domains by default. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/
|
|
3780
|
+
"documentation": "\n <p>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows\n all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&q.parser=structured&size=0</code>. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html\" target=\"_blank\">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
|
3777
3781
|
},
|
|
3778
3782
|
"DescribeExpressions": {
|
|
3779
3783
|
"name": "DescribeExpressions",
|
|
@@ -4523,7 +4527,7 @@
|
|
|
4523
4527
|
"documentation": "\n <p>The request was rejected because it attempted to reference a resource that does not exist.</p>\n "
|
|
4524
4528
|
}
|
|
4525
4529
|
],
|
|
4526
|
-
"documentation": "\n <p>Gets information about the index fields configured for the search domain.\n Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/
|
|
4530
|
+
"documentation": "\n <p>Gets information about the index fields configured for the search domain.\n Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html\" target=\"_blank\">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
|
4527
4531
|
},
|
|
4528
4532
|
"DescribeScalingParameters": {
|
|
4529
4533
|
"name": "DescribeScalingParameters",
|
|
@@ -4571,6 +4575,12 @@
|
|
|
4571
4575
|
"type": "integer",
|
|
4572
4576
|
"min_length": 0,
|
|
4573
4577
|
"documentation": "\n <p>The number of replicas you want to preconfigure for each index partition.</p>\n "
|
|
4578
|
+
},
|
|
4579
|
+
"DesiredPartitionCount": {
|
|
4580
|
+
"shape_name": "UIntValue",
|
|
4581
|
+
"type": "integer",
|
|
4582
|
+
"min_length": 0,
|
|
4583
|
+
"documentation": "\n <p>The number of partitions you want to preconfigure for your domain. Only valid when\n you select <code>m2.2xlarge</code> as the desired instance type.</p>\n "
|
|
4574
4584
|
}
|
|
4575
4585
|
},
|
|
4576
4586
|
"documentation": "\n <p>The desired instance type and desired number of replicas of each index partition.</p>\n ",
|
|
@@ -4964,7 +4974,7 @@
|
|
|
4964
4974
|
"documentation": "\n <p>The request was rejected because it attempted to reference a resource that does not exist.</p>\n "
|
|
4965
4975
|
}
|
|
4966
4976
|
],
|
|
4967
|
-
"documentation": "\n <p>Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-
|
|
4977
|
+
"documentation": "\n <p>Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
|
4968
4978
|
},
|
|
4969
4979
|
"IndexDocuments": {
|
|
4970
4980
|
"name": "IndexDocuments",
|
|
@@ -5266,6 +5276,12 @@
|
|
|
5266
5276
|
"type": "integer",
|
|
5267
5277
|
"min_length": 0,
|
|
5268
5278
|
"documentation": "\n <p>The number of replicas you want to preconfigure for each index partition.</p>\n "
|
|
5279
|
+
},
|
|
5280
|
+
"DesiredPartitionCount": {
|
|
5281
|
+
"shape_name": "UIntValue",
|
|
5282
|
+
"type": "integer",
|
|
5283
|
+
"min_length": 0,
|
|
5284
|
+
"documentation": "\n <p>The number of partitions you want to preconfigure for your domain. Only valid when\n you select <code>m2.2xlarge</code> as the desired instance type.</p>\n "
|
|
5269
5285
|
}
|
|
5270
5286
|
},
|
|
5271
5287
|
"documentation": "\n <p>The desired instance type and desired number of replicas of each index partition.</p>\n ",
|
|
@@ -5302,6 +5318,12 @@
|
|
|
5302
5318
|
"type": "integer",
|
|
5303
5319
|
"min_length": 0,
|
|
5304
5320
|
"documentation": "\n <p>The number of replicas you want to preconfigure for each index partition.</p>\n "
|
|
5321
|
+
},
|
|
5322
|
+
"DesiredPartitionCount": {
|
|
5323
|
+
"shape_name": "UIntValue",
|
|
5324
|
+
"type": "integer",
|
|
5325
|
+
"min_length": 0,
|
|
5326
|
+
"documentation": "\n <p>The number of partitions you want to preconfigure for your domain. Only valid when\n you select <code>m2.2xlarge</code> as the desired instance type.</p>\n "
|
|
5305
5327
|
}
|
|
5306
5328
|
},
|
|
5307
5329
|
"documentation": "\n <p>The desired instance type and desired number of replicas of each index partition.</p>\n ",
|
|
@@ -3,8 +3,14 @@
|
|
|
3
3
|
"DescribeConnections": {
|
|
4
4
|
"result_key": "connections"
|
|
5
5
|
},
|
|
6
|
-
"
|
|
7
|
-
"result_key": "
|
|
6
|
+
"DescribeConnectionsOnInterconnect": {
|
|
7
|
+
"result_key": "connections"
|
|
8
|
+
},
|
|
9
|
+
"DescribeInterconnects": {
|
|
10
|
+
"result_key": "interconnects"
|
|
11
|
+
},
|
|
12
|
+
"DescribeLocations": {
|
|
13
|
+
"result_key": "locations"
|
|
8
14
|
},
|
|
9
15
|
"DescribeVirtualGateways": {
|
|
10
16
|
"result_key": "virtualGateways"
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"service_abbreviation": "DynamoDB",
|
|
9
9
|
"endpoint_prefix": "dynamodb",
|
|
10
10
|
"xmlnamespace": "http://dynamodb.amazonaws.com/doc/2012-08-10/",
|
|
11
|
-
"documentation": "\n <fullname>Amazon DynamoDB</fullname>\n <b>Overview</b>\n <p>This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the DynamoDB API
|
|
11
|
+
"documentation": "\n <fullname>Amazon DynamoDB</fullname>\n <b>Overview</b>\n <p>This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the low-level\n 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>\n\n <p>Instead of making the requests to the low-level DynamoDB API directly from your application, we\n recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in\n the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your\n application. The libraries take care of request authentication, serialization, and connection\n management. For more information, go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html\">Using the AWS\n SDKs with DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>\n\n <p>If you decide to code against the low-level DynamoDB API directly, you will need to write the\n necessary code to authenticate your requests. For more information on signing your requests,\n go to <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API.html\">Using the DynamoDB API</a> in the\n <i>Amazon DynamoDB Developer Guide</i>.</p>\n\n <p>The following are short descriptions of each low-level API action, organized by function.</p>\n <p>\n <b>Managing Tables</b>\n </p>\n <p>\n <ul>\n <li>\n <p><i>CreateTable</i> - Creates a table with user-specified provisioned throughput\n settings. You must designate one attribute as the hash primary key for the table; you\n can optionally designate a second attribute as the range primary key. DynamoDB creates\n indexes on these key attributes for fast data access. Optionally, you can create one or\n more secondary indexes, which provide fast data access using non-key attributes.</p>\n </li>\n <li>\n <p><i>DescribeTable</i> - Returns metadata for a table, such as table size, status, and\n index information.</p>\n </li>\n <li>\n <p><i>UpdateTable</i> - Modifies the provisioned throughput settings for a table.\n Optionally, you can modify the provisioned throughput settings for global secondary indexes on the\n table.</p>\n </li>\n <li>\n <p><i>ListTables</i> - Returns a list of all tables associated with the current AWS\n account and endpoint.</p>\n </li>\n <li>\n <p><i>DeleteTable</i> - Deletes a table and all of its indexes.</p>\n </li>\n </ul>\n </p>\n <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\n <i>Amazon DynamoDB Developer Guide</i>.</p>\n\n <p>\n <b>Reading Data</b>\n </p>\n <p>\n <ul>\n <li>\n <p><i>GetItem</i> - Returns a set of attributes for the item that has a given primary key.\n By default, <i>GetItem</i> performs an eventually consistent read; however, applications\n can specify a strongly consistent read instead.</p>\n </li>\n <li>\n <p><i>BatchGetItem</i> - Performs multiple <i>GetItem</i> requests for data items using\n their primary keys, from one table or multiple tables. The response from\n <i>BatchGetItem</i> has a size limit of 1 MB and returns a maximum of\n 100 items. Both eventually consistent and strongly\n consistent reads can be used.</p>\n </li>\n <li>\n <p><i>Query</i> - Returns one or more items from a table or a secondary index. You must provide a\n specific hash key value. You can narrow the scope of the query using comparison\n operators against a range key value, or on the index key. <i>Query</i> supports either\n eventual or strong consistency. A single response has a size limit of\n 1 MB.</p>\n </li>\n <li>\n <p><i>Scan</i> - Reads every item in a table; the result set is eventually consistent. You\n can limit the number of items returned by filtering the data attributes, using\n conditional expressions. <i>Scan</i> can be used to enable ad-hoc querying of a table\n against non-key attributes; however, since this is a full table scan without using an\n index, <i>Scan</i> should not be used for any application query use case that requires\n predictable performance.</p>\n </li>\n </ul>\n </p>\n <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\n <i>Amazon DynamoDB Developer Guide</i>.</p>\n\n <p>\n <b>Modifying Data</b>\n </p>\n <p>\n <ul>\n <li>\n <p><i>PutItem</i> - Creates a new item, or replaces an existing item with a new item\n (including all the attributes). By default, if an item in the table already exists with\n the same primary key, the new item completely replaces the existing item. You can use\n conditional operators to replace an item only if its attribute values match certain\n conditions, or to insert a new item only if that item doesn't already exist.</p>\n </li>\n <li>\n <p><i>UpdateItem</i> - Modifies the attributes of an existing item. You can also use\n conditional operators to perform an update only if the item's attribute values match\n certain conditions.</p>\n </li>\n <li>\n <p><i>DeleteItem</i> - Deletes an item in a table by primary key. You can use conditional\n operators to perform a delete an item only if the item's attribute values match certain\n conditions.</p>\n </li>\n <li>\n <p><i>BatchWriteItem</i> - Performs multiple <i>PutItem</i> and <i>DeleteItem</i> requests\n across multiple tables in a single request. A failure of any request(s) in the batch\n will not cause the entire <i>BatchWriteItem</i> operation to fail. Supports batches of\n up to 25 items to put or delete, with a maximum total\n request size of 1 MB. </p>\n </li>\n </ul>\n </p>\n <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\n <i>Amazon DynamoDB Developer Guide</i>.</p>\n\n ",
|
|
12
12
|
"operations": {
|
|
13
13
|
"BatchGetItem": {
|
|
14
14
|
"name": "BatchGetItem",
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
},
|
|
100
100
|
"min_length": 1,
|
|
101
101
|
"max_length": 100,
|
|
102
|
-
"documentation": "\n <p>The primary key attribute values that define the items and the attributes
|
|
102
|
+
"documentation": "\n <p>The primary key attribute values that define the items and the attributes associated with the\n items.</p>\n ",
|
|
103
103
|
"required": true
|
|
104
104
|
},
|
|
105
105
|
"AttributesToGet": {
|
|
@@ -112,19 +112,19 @@
|
|
|
112
112
|
"documentation": null
|
|
113
113
|
},
|
|
114
114
|
"min_length": 1,
|
|
115
|
-
"documentation": "\n <p>One or more attributes to retrieve from the table or index. If no attribute names are
|
|
115
|
+
"documentation": "\n <p>One or more attributes to retrieve from the table or index. If no attribute names are\n specified then all attributes will be returned. If any of the specified attributes are not\n found, they will not appear in the result.</p>\n "
|
|
116
116
|
},
|
|
117
117
|
"ConsistentRead": {
|
|
118
118
|
"shape_name": "ConsistentRead",
|
|
119
119
|
"type": "boolean",
|
|
120
|
-
"documentation": "\n <p>The consistency of a read operation. If set to <code>true</code>, then a strongly\n
|
|
120
|
+
"documentation": "\n <p>The consistency of a read operation. If set to <code>true</code>, then a strongly consistent\n read is used; otherwise, an eventually consistent read is used.</p>\n "
|
|
121
121
|
}
|
|
122
122
|
},
|
|
123
|
-
"documentation": "\n <p>Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.</p>\n "
|
|
123
|
+
"documentation": "\n <p>Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.</p>\n <p>For each primary key, you must provide <i>all</i> of the key attributes. For example, with a\n hash type primary key, you only need to specify the hash attribute. For a hash-and-range type\n primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>\n "
|
|
124
124
|
},
|
|
125
125
|
"min_length": 1,
|
|
126
126
|
"max_length": 100,
|
|
127
|
-
"documentation": "\n <p>A map of one or more table names and, for each table, the corresponding primary keys for the
|
|
127
|
+
"documentation": "\n <p>A map of one or more table names and, for each table, the corresponding primary keys for the\n items to retrieve. Each table name can be invoked only once.</p>\n <p>Each element in the map consists of the following:</p>\n <ul>\n <li>\n <p><i>Keys</i> - An array of primary key attribute values that define specific items in the\n table. For each primary key, you must provide <i>all</i> of the key attributes. For\n example, with a hash type primary key, you only need to specify the hash attribute. For a\n hash-and-range type primary key, you must specify <i>both</i> the hash attribute and the\n range attribute.</p>\n </li>\n\n <li>\n <p><i>AttributesToGet</i> - One or more attributes to be retrieved from the table. By\n default, all attributes are returned. If a specified attribute is not found, it does not\n appear in the result.</p>\n <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption.\n DynamoDB determines capacity units consumed based on item size, not on the amount of data\n that is returned to an application.</p>\n </li>\n\n <li>\n <p><i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if\n <code>false</code> (the default), an eventually consistent read is used.</p>\n </li>\n </ul>\n ",
|
|
128
128
|
"required": true
|
|
129
129
|
},
|
|
130
130
|
"ReturnConsumedCapacity": {
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
"TOTAL",
|
|
136
136
|
"NONE"
|
|
137
137
|
],
|
|
138
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
138
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
139
139
|
}
|
|
140
140
|
},
|
|
141
141
|
"documentation": "\n <p>Represents the input of a <i>BatchGetItem</i> operation.</p>\n "
|
|
@@ -223,7 +223,7 @@
|
|
|
223
223
|
},
|
|
224
224
|
"documentation": null
|
|
225
225
|
},
|
|
226
|
-
"documentation": "\n <p>A map of table name to a list of items.
|
|
226
|
+
"documentation": "\n <p>A map of table name to a list of items. Each object in <i>Responses</i> consists of a table\n name, along with a map of attribute data consisting of the data type and attribute value.</p>\n "
|
|
227
227
|
},
|
|
228
228
|
"UnprocessedKeys": {
|
|
229
229
|
"shape_name": "BatchGetRequestMap",
|
|
@@ -308,7 +308,7 @@
|
|
|
308
308
|
},
|
|
309
309
|
"min_length": 1,
|
|
310
310
|
"max_length": 100,
|
|
311
|
-
"documentation": "\n <p>The primary key attribute values that define the items and the attributes
|
|
311
|
+
"documentation": "\n <p>The primary key attribute values that define the items and the attributes associated with the\n items.</p>\n ",
|
|
312
312
|
"required": true
|
|
313
313
|
},
|
|
314
314
|
"AttributesToGet": {
|
|
@@ -321,19 +321,19 @@
|
|
|
321
321
|
"documentation": null
|
|
322
322
|
},
|
|
323
323
|
"min_length": 1,
|
|
324
|
-
"documentation": "\n <p>One or more attributes to retrieve from the table or index. If no attribute names are
|
|
324
|
+
"documentation": "\n <p>One or more attributes to retrieve from the table or index. If no attribute names are\n specified then all attributes will be returned. If any of the specified attributes are not\n found, they will not appear in the result.</p>\n "
|
|
325
325
|
},
|
|
326
326
|
"ConsistentRead": {
|
|
327
327
|
"shape_name": "ConsistentRead",
|
|
328
328
|
"type": "boolean",
|
|
329
|
-
"documentation": "\n <p>The consistency of a read operation. If set to <code>true</code>, then a strongly\n
|
|
329
|
+
"documentation": "\n <p>The consistency of a read operation. If set to <code>true</code>, then a strongly consistent\n read is used; otherwise, an eventually consistent read is used.</p>\n "
|
|
330
330
|
}
|
|
331
331
|
},
|
|
332
|
-
"documentation": "\n <p>Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.</p>\n "
|
|
332
|
+
"documentation": "\n <p>Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.</p>\n <p>For each primary key, you must provide <i>all</i> of the key attributes. For example, with a\n hash type primary key, you only need to specify the hash attribute. For a hash-and-range type\n primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>\n "
|
|
333
333
|
},
|
|
334
334
|
"min_length": 1,
|
|
335
335
|
"max_length": 100,
|
|
336
|
-
"documentation": "\n <p>A map of tables and their respective keys that were not processed with the current response.\n The <i>UnprocessedKeys</i> value is in the same form as <i>RequestItems</i>, so the value can\n be provided directly to a subsequent <i>BatchGetItem</i> operation. For more information, see\n <i>RequestItems</i> in the Request Parameters section.</p>\n <p>Each element consists of:</p>\n <ul>\n <li>\n <p><i>Keys</i> - An array of primary key attribute values that define specific items in the
|
|
336
|
+
"documentation": "\n <p>A map of tables and their respective keys that were not processed with the current response.\n The <i>UnprocessedKeys</i> value is in the same form as <i>RequestItems</i>, so the value can\n be provided directly to a subsequent <i>BatchGetItem</i> operation. For more information, see\n <i>RequestItems</i> in the Request Parameters section.</p>\n <p>Each element consists of:</p>\n <ul>\n <li>\n <p><i>Keys</i> - An array of primary key attribute values that define specific items in the\n table.</p>\n </li>\n <li>\n <p><i>AttributesToGet</i> - One or more attributes to be retrieved from the table or index.\n By default, all attributes are returned. If a specified attribute is not found, it does\n not appear in the result.</p>\n </li>\n <li>\n <p><i>ConsistentRead</i> - The consistency of a read operation. If set to <code>true</code>,\n then a strongly consistent read is used; otherwise, an eventually consistent read is\n used.</p>\n </li>\n </ul>\n <p>If there are no unprocessed keys remaining, the response contains an empty\n <i>UnprocessedKeys</i> map.</p>\n\n "
|
|
337
337
|
},
|
|
338
338
|
"ConsumedCapacity": {
|
|
339
339
|
"shape_name": "ConsumedCapacityMultiple",
|
|
@@ -388,7 +388,7 @@
|
|
|
388
388
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
389
389
|
}
|
|
390
390
|
},
|
|
391
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
391
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
392
392
|
},
|
|
393
393
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
394
394
|
},
|
|
@@ -413,12 +413,12 @@
|
|
|
413
413
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
414
414
|
}
|
|
415
415
|
},
|
|
416
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
416
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
417
417
|
},
|
|
418
418
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
419
419
|
}
|
|
420
420
|
},
|
|
421
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
421
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
422
422
|
},
|
|
423
423
|
"documentation": "\n <p>The write capacity units consumed by the operation.</p>\n <p>Each element consists of:</p>\n <ul>\n <li>\n <p><i>TableName</i> - The table that consumed the provisioned throughput.</p>\n </li>\n\n <li>\n <p><i>CapacityUnits</i> - The total number of capacity units consumed.</p>\n </li>\n </ul>\n "
|
|
424
424
|
}
|
|
@@ -436,7 +436,7 @@
|
|
|
436
436
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
437
437
|
}
|
|
438
438
|
},
|
|
439
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
439
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
440
440
|
},
|
|
441
441
|
{
|
|
442
442
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -448,7 +448,7 @@
|
|
|
448
448
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
449
449
|
}
|
|
450
450
|
},
|
|
451
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
451
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
452
452
|
},
|
|
453
453
|
{
|
|
454
454
|
"shape_name": "InternalServerError",
|
|
@@ -463,7 +463,7 @@
|
|
|
463
463
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
464
464
|
}
|
|
465
465
|
],
|
|
466
|
-
"documentation": "\n <p>The
|
|
466
|
+
"documentation": "\n <p>The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or\n more tables. You identify requested items by primary key.</p>\n <p>A single operation can retrieve up to 1 MB of data, which can contain as many\n as 100 items. <i>BatchGetItem</i> will return a partial result\n if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an\n internal processing failure occurs. If a partial result is returned, the operation returns a\n value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with\n the next item to get.</p>\n <p>For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the\n system returns 20 items (1 MB) and an appropriate <i>UnprocessedKeys</i> value\n so you can get the next page of results. If desired, your application can include its own\n logic to assemble the pages of results into one dataset.</p>\n <p>If <i>none</i> of the items can be processed due to insufficient provisioned throughput on\n all of the tables in the request, then <i>BatchGetItem</i> will throw a\n <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is\n successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the\n keys of the unread items in <i>UnprocessedKeys</i>.</p>\n <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>\n <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>\n <p>By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the\n request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to\n <code>true</code> for any or all tables.</p>\n <p>In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel.</p>\n <p>When designing your application, keep in mind that DynamoDB does not return attributes in any\n particular order. To help parse the response by item, include the primary key values for the\n items in your request in the <i>AttributesToGet</i> parameter.</p>\n <p>If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read. For\n 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>\n\n <examples>\n <example>\n <name>Retrieve Items From Multiple Tables</name>\n <description>The following sample requests attributes from two different\n tables.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.BatchGetItem \n\n{\n \"RequestItems\": {\n \"Forum\": {\n \"Keys\": [\n {\n \"Name\":{\"S\":\"Amazon DynamoDB\"}\n },\n {\n \"Name\":{\"S\":\"Amazon RDS\"}\n },\n {\n \"Name\":{\"S\":\"Amazon Redshift\"}\n }\n ],\n \"AttributesToGet\": [\n \"Name\",\"Threads\",\"Messages\",\"Views\"\n ]\n },\n \"Thread\": {\n \"Keys\": [\n {\n \"ForumName\":{\"S\":\"Amazon DynamoDB\"},\n \"Subject\":{\"S\":\"Concurrent reads\"}\n }\n ],\n \"AttributesToGet\": [\n \"Tags\",\"Message\"\n ]\n }\n },\n \"ReturnConsumedCapacity\": \"TOTAL\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"Responses\": {\n \"Forum\": [\n {\n \"Name\":{\n \"S\":\"Amazon DynamoDB\"\n },\n \"Threads\":{\n \"N\":\"5\"\n },\n \"Messages\":{\n \"N\":\"19\"\n },\n \"Views\":{\n \"N\":\"35\"\n }\n },\n {\n \"Name\":{\n \"S\":\"Amazon RDS\"\n },\n \"Threads\":{\n \"N\":\"8\"\n },\n \"Messages\":{\n \"N\":\"32\"\n },\n \"Views\":{\n \"N\":\"38\"\n }\n },\n {\n \"Name\":{\n \"S\":\"Amazon Redshift\"\n },\n \"Threads\":{\n \"N\":\"12\"\n },\n \"Messages\":{\n \"N\":\"55\"\n },\n \"Views\":{\n \"N\":\"47\"\n }\n }\n ]\n \"Thread\": [\n {\n \"Tags\":{\n \"SS\":[\"Reads\",\"MultipleUsers\"]\n },\n \"Message\":{\n \"S\":\"How many users can read a single data item at a time? Are there any limits?\"\n }\n }\n ]\n },\n \"UnprocessedKeys\": {\n },\n \"ConsumedCapacity\": [\n {\n \"TableName\": \"Forum\",\n \"CapacityUnits\": 3\n },\n {\n \"TableName\": \"Thread\",\n \"CapacityUnits\": 1\n }\n ]\n}\n </response>\n </example>\n </examples>\n "
|
|
467
467
|
},
|
|
468
468
|
"BatchWriteItem": {
|
|
469
469
|
"name": "BatchWriteItem",
|
|
@@ -625,14 +625,14 @@
|
|
|
625
625
|
},
|
|
626
626
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
627
627
|
},
|
|
628
|
-
"documentation": "\n <p>A map of attribute name to attribute values, representing the primary key of the item to
|
|
628
|
+
"documentation": "\n <p>A map of attribute name to attribute values, representing the primary key of the item to\n delete. All of the table's primary key attributes must be specified, and their data types must\n match those of the table's key schema.</p>\n ",
|
|
629
629
|
"required": true
|
|
630
630
|
}
|
|
631
631
|
},
|
|
632
632
|
"documentation": "\n <p>A request to perform a <i>DeleteItem</i> operation.</p>\n "
|
|
633
633
|
}
|
|
634
634
|
},
|
|
635
|
-
"documentation": "\n <p>Represents an operation to perform - either <i>DeleteItem</i> or <i>PutItem</i>.
|
|
635
|
+
"documentation": "\n <p>Represents an operation to perform - either <i>DeleteItem</i> or <i>PutItem</i>. You can only\n specify one of these operations, not both, in a single <i>WriteRequest</i>. If you do need to\n perform both of these operations, you will need to specify two separate <i>WriteRequest</i>\n objects.</p>\n "
|
|
636
636
|
},
|
|
637
637
|
"min_length": 1,
|
|
638
638
|
"max_length": 25,
|
|
@@ -640,7 +640,7 @@
|
|
|
640
640
|
},
|
|
641
641
|
"min_length": 1,
|
|
642
642
|
"max_length": 25,
|
|
643
|
-
"documentation": "\n <p>A map of one or more table names and, for each table, a list of operations to be performed\n (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the
|
|
643
|
+
"documentation": "\n <p>A map of one or more table names and, for each table, a list of operations to be performed\n (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the\n following:</p>\n <ul>\n <li>\n <p><i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The\n item to be deleted is identified by a <i>Key</i> subelement:</p>\n <ul>\n <li>\n <p><i>Key</i> - A map of primary key attribute values that uniquely identify the ! item.\n Each entry in this map consists of an attribute name and an attribute value. For each\n primary key, you must provide <i>all</i> of the key attributes. For example, with a\n hash type primary key, you only need to specify the hash attribute. For a\n hash-and-range type primary key, you must specify <i>both</i> the hash attribute and\n the range attribute.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to\n be put is identified by an <i>Item</i> subelement:</p>\n <ul>\n <li>\n <p><i>Item</i> - A map of attributes and their values. Each entry in this map consists\n of an attribute name and an attribute value. Attribute values must not be null; string\n and binary type attributes must have lengths greater than zero; and set type\n attributes must not be empty. Requests that contain empty values will be rejected with\n a <i>ValidationException</i>.</p>\n <p>If you specify any attributes that are part of an index key, then the data types for\n those attributes must match those of the schema in the table's attribute\n definition.</p>\n </li>\n </ul>\n </li>\n </ul>\n ",
|
|
644
644
|
"required": true
|
|
645
645
|
},
|
|
646
646
|
"ReturnConsumedCapacity": {
|
|
@@ -651,7 +651,7 @@
|
|
|
651
651
|
"TOTAL",
|
|
652
652
|
"NONE"
|
|
653
653
|
],
|
|
654
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
654
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
655
655
|
},
|
|
656
656
|
"ReturnItemCollectionMetrics": {
|
|
657
657
|
"shape_name": "ReturnItemCollectionMetrics",
|
|
@@ -823,14 +823,14 @@
|
|
|
823
823
|
},
|
|
824
824
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
825
825
|
},
|
|
826
|
-
"documentation": "\n <p>A map of attribute name to attribute values, representing the primary key of the item to
|
|
826
|
+
"documentation": "\n <p>A map of attribute name to attribute values, representing the primary key of the item to\n delete. All of the table's primary key attributes must be specified, and their data types must\n match those of the table's key schema.</p>\n ",
|
|
827
827
|
"required": true
|
|
828
828
|
}
|
|
829
829
|
},
|
|
830
830
|
"documentation": "\n <p>A request to perform a <i>DeleteItem</i> operation.</p>\n "
|
|
831
831
|
}
|
|
832
832
|
},
|
|
833
|
-
"documentation": "\n <p>Represents an operation to perform - either <i>DeleteItem</i> or <i>PutItem</i>.
|
|
833
|
+
"documentation": "\n <p>Represents an operation to perform - either <i>DeleteItem</i> or <i>PutItem</i>. You can only\n specify one of these operations, not both, in a single <i>WriteRequest</i>. If you do need to\n perform both of these operations, you will need to specify two separate <i>WriteRequest</i>\n objects.</p>\n "
|
|
834
834
|
},
|
|
835
835
|
"min_length": 1,
|
|
836
836
|
"max_length": 25,
|
|
@@ -838,7 +838,7 @@
|
|
|
838
838
|
},
|
|
839
839
|
"min_length": 1,
|
|
840
840
|
"max_length": 25,
|
|
841
|
-
"documentation": "\n <p>A map of tables and requests against those tables that were not processed. The\n <i>
|
|
841
|
+
"documentation": "\n <p>A map of tables and requests against those tables that were not processed. The\n <i>UnprocessedItems</i> value is in the same form as <i>RequestItems</i>, so you can provide\n this value directly to a subsequent <i>BatchGetItem</i> operation. For more information, see\n <i>RequestItems</i> in the Request Parameters section.</p>\n <p>Each <i>UnprocessedItems</i> entry consists of a table name and, for that table, a list of\n operations to perform (<i>DeleteRequest</i> or <i>PutRequest</i>).</p>\n <ul>\n <li>\n <p><i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The\n item to be deleted is identified by a <i>Key</i> subelement:</p>\n <ul>\n <li>\n <p><i>Key</i> - A map of primary key attribute values that uniquely identify the item.\n Each entry in this map consists of an attribute name and an attribute value.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to\n be put is identified by an <i>Item</i> subelement:</p>\n <ul>\n <li>\n <p><i>Item</i> - A map of attributes and their values. Each entry in this map consists\n of an attribute name and an attribute value. Attribute values must not be null; string\n and binary type attributes must have lengths greater than zero; and set type\n attributes must not be empty. Requests that contain empty values will be rejected with\n a <i>ValidationException</i>.</p>\n <p>If you specify any attributes that are part of an index key, then the data types for\n those attributes must match those of the schema in the table's attribute\n definition.</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>If there are no unprocessed items remaining, the response contains an empty\n <i>UnprocessedItems</i> map.</p>\n "
|
|
842
842
|
},
|
|
843
843
|
"ItemCollectionMetrics": {
|
|
844
844
|
"shape_name": "ItemCollectionMetricsPerTable",
|
|
@@ -919,7 +919,7 @@
|
|
|
919
919
|
},
|
|
920
920
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
921
921
|
},
|
|
922
|
-
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p
|
|
922
|
+
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p>\n "
|
|
923
923
|
},
|
|
924
924
|
"SizeEstimateRangeGB": {
|
|
925
925
|
"shape_name": "ItemCollectionSizeEstimateRange",
|
|
@@ -929,14 +929,14 @@
|
|
|
929
929
|
"type": "double",
|
|
930
930
|
"documentation": null
|
|
931
931
|
},
|
|
932
|
-
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a
|
|
932
|
+
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the size\n of all the items in the table, plus the size of all attributes projected into all of the\n local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size\n limit.</p>\n <p>The estimate is subject to change over time; therefore, do not rely on the precision or\n accuracy of the estimate.</p>\n "
|
|
933
933
|
}
|
|
934
934
|
},
|
|
935
|
-
"documentation": "\n <p>Information about item collections, if any, that were affected by the operation
|
|
935
|
+
"documentation": "\n <p>Information about item collections, if any, that were affected by the operation.\n <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the\n table does not have any local secondary indexes, this information is not returned in the response.</p>\n "
|
|
936
936
|
},
|
|
937
937
|
"documentation": null
|
|
938
938
|
},
|
|
939
|
-
"documentation": "\n <p>A list of tables that were processed by <i>BatchWriteItem</i> and, for each table,\n information about any item collections that were affected by individual <i>DeleteItem</i> or\n <i>PutItem</i> operations.</p>\n <p>Each entry consists of the following subelements:</p>\n <ul>\n <li>\n <p><i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as
|
|
939
|
+
"documentation": "\n <p>A list of tables that were processed by <i>BatchWriteItem</i> and, for each table,\n information about any item collections that were affected by individual <i>DeleteItem</i> or\n <i>PutItem</i> operations.</p>\n <p>Each entry consists of the following subelements:</p>\n <ul>\n <li>\n <p><i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as\n the hash key of the item.</p>\n </li>\n <li>\n <p><i>SizeEstimateRange</i> - An estimate of item collection size, expressed in GB. This is\n a two-element array containing a lower bound and an upper bound for the estimate. The\n estimate includes the size of all the items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on the table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.</p>\n <p>The estimate is subject to change over time; therefore, do not rely on the precision or\n accuracy of the estimate.</p>\n </li>\n </ul>\n "
|
|
940
940
|
},
|
|
941
941
|
"ConsumedCapacity": {
|
|
942
942
|
"shape_name": "ConsumedCapacityMultiple",
|
|
@@ -991,7 +991,7 @@
|
|
|
991
991
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
992
992
|
}
|
|
993
993
|
},
|
|
994
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
994
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
995
995
|
},
|
|
996
996
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
997
997
|
},
|
|
@@ -1016,12 +1016,12 @@
|
|
|
1016
1016
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
1017
1017
|
}
|
|
1018
1018
|
},
|
|
1019
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
1019
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
1020
1020
|
},
|
|
1021
1021
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
1022
1022
|
}
|
|
1023
1023
|
},
|
|
1024
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
1024
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
1025
1025
|
},
|
|
1026
1026
|
"documentation": "\n <p>The capacity units consumed by the operation.</p>\n <p>Each element consists of:</p>\n <ul>\n <li>\n <p><i>TableName</i> - The table that consumed the provisioned throughput.</p>\n </li>\n <li>\n <p><i>CapacityUnits</i> - The total number of capacity units consumed.</p>\n </li>\n </ul>\n "
|
|
1027
1027
|
}
|
|
@@ -1039,7 +1039,7 @@
|
|
|
1039
1039
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
1040
1040
|
}
|
|
1041
1041
|
},
|
|
1042
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
1042
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
1043
1043
|
},
|
|
1044
1044
|
{
|
|
1045
1045
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -1051,7 +1051,7 @@
|
|
|
1051
1051
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
1052
1052
|
}
|
|
1053
1053
|
},
|
|
1054
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
1054
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
1055
1055
|
},
|
|
1056
1056
|
{
|
|
1057
1057
|
"shape_name": "ItemCollectionSizeLimitExceededException",
|
|
@@ -1078,7 +1078,7 @@
|
|
|
1078
1078
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
1079
1079
|
}
|
|
1080
1080
|
],
|
|
1081
|
-
"documentation": "\n <p>The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A\n single call to <i>BatchWriteItem</i> can write up to 1 MB of data, which can
|
|
1081
|
+
"documentation": "\n <p>The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A\n single call to <i>BatchWriteItem</i> can write up to 1 MB of data, which can\n comprise as many as 25 put or delete requests. Individual items\n to be written can be as large as 64 KB.</p>\n <note>\n <p><i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i>\n API.</p>\n </note>\n <p>The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in\n <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any\n requested operations fail because the table's provisioned throughput is exceeded or an\n internal processing failure occurs, the failed operations are returned in the\n <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the\n requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would\n check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those\n unprocessed items until all items have been processed.</p>\n <p>Note that if <i>none</i> of the items can be processed due to insufficient provisioned\n throughput on all of the tables in the request, then <i>BatchGetItem</i> will throw a\n <i>ProvisionedThroughputExceededException</i>.</p>\n <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>\n <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>\n \n <p>With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such\n as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not\n behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would For\n example, you cannot specify conditions on individual put and delete requests, and\n <i>BatchWriteItem</i> does not return deleted items in the response.</p>\n <p>If you use a programming language that supports concurrency, such as Java, you can use\n threads to write items in parallel. Your application must include the necessary logic to\n manage the threads. With languages that don't support threading, such as PHP, you must update\n or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i>\n provides an alternative where the API performs the specified put and delete operations in\n parallel, giving you the power of the thread pool approach without having to introduce\n complexity into your application.</p>\n <p>Parallel processing reduces latency, but each specified put and delete request consumes the\n same number of write capacity units whether it is processed in parallel or not. Delete\n operations on nonexistent items consume one write capacity unit.</p>\n <p>If one or more of the following is true, DynamoDB rejects the entire batch write operation:</p>\n <ul>\n <li>\n <p>One or more tables specified in the <i>BatchWriteItem</i> request does not exist.</p>\n </li>\n <li>\n <p>Primary key attributes specified on an item in the request do not match those in the\n corresponding table's primary key schema.</p>\n </li>\n <li>\n <p>You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i>\n request. For example, you cannot put and delete the same item in the same\n <i>BatchWriteItem</i> request. </p>\n </li>\n <li>\n <p>The total request size exceeds 1 MB.</p>\n </li>\n <li>\n <p>Any individual item in a batch exceeds 64 KB.</p>\n </li>\n </ul>\n\n <examples>\n <example>\n <name>Multiple Operations on One Table</name>\n <description>This example writes several items to the Forum table. The response shows that\n the final put operation failed, possibly because the application exceeded the provisioned\n throughput on the table. The UnprocessedItems object shows the unsuccessful put request.\n The application can call BatchWriteItem again to address such unprocessed\n requests.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.BatchWriteItem \n\n{\n \"RequestItems\": {\n \"Forum\": [\n {\n \"PutRequest\": {\n \"Item\": {\n \"Name\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"Category\": {\n \"S\": \"Amazon Web Services\"\n }\n }\n }\n },\n {\n \"PutRequest\": {\n \"Item\": {\n \"Name\": {\n \"S\": \"Amazon RDS\"\n },\n \"Category\": {\n \"S\": \"Amazon Web Services\"\n }\n }\n }\n },\n {\n \"PutRequest\": {\n \"Item\": {\n \"Name\": {\n \"S\": \"Amazon Redshift\"\n },\n \"Category\": {\n \"S\": \"Amazon Web Services\"\n }\n }\n }\n },\n {\n \"PutRequest\": {\n \"Item\": {\n \"Name\": {\n \"S\": \"Amazon ElastiCache\"\n },\n \"Category\": {\n \"S\": \"Amazon Web Services\"\n }\n }\n }\n }\n ]\n },\n \"ReturnConsumedCapacity\": \"TOTAL\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"UnprocessedItems\": {\n \"Forum\": [\n {\n \"PutRequest\": {\n \"Item\": {\n \"Name\": {\n \"S\": \"Amazon ElastiCache\"\n },\n \"Category\": {\n \"S\": \"Amazon Web Services\"\n }\n }\n }\n }\n ]\n },\n \"ConsumedCapacity\": [\n {\n \"TableName\": \"Forum\",\n \"CapacityUnits\": 3\n }\n ]\n}\n </response>\n </example>\n </examples>\n "
|
|
1082
1082
|
},
|
|
1083
1083
|
"CreateTable": {
|
|
1084
1084
|
"name": "CreateTable",
|
|
@@ -1149,15 +1149,15 @@
|
|
|
1149
1149
|
"HASH",
|
|
1150
1150
|
"RANGE"
|
|
1151
1151
|
],
|
|
1152
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
1152
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
1153
1153
|
"required": true
|
|
1154
1154
|
}
|
|
1155
1155
|
},
|
|
1156
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
1156
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
1157
1157
|
},
|
|
1158
1158
|
"min_length": 1,
|
|
1159
1159
|
"max_length": 2,
|
|
1160
|
-
"documentation": "\n <p>Specifies the attributes that make up the primary key for a table or an index. The attributes
|
|
1160
|
+
"documentation": "\n <p>Specifies the attributes that make up the primary key for a table or an index. The attributes\n in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more\n information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html\">Data Model</a> in the\n Amazon DynamoDB Developer Guide.</p>\n <p>Each <i>KeySchemaElement</i> in the array is composed of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of this key attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - Determines whether the key attribute is <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <p>For a primary key that consists of a hash attribute, you must specify exactly one element\n with a <i>KeyType</i> of <code>HASH</code>.</p>\n <p>For a primary key that consists of hash and range attributes, you must specify exactly two\n elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>,\n and the second element must have a <i>KeyType</i> of <code>RANGE</code>.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key\">Specifying the\n Primary Key</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
1161
1161
|
"required": true
|
|
1162
1162
|
},
|
|
1163
1163
|
"LocalSecondaryIndexes": {
|
|
@@ -1173,7 +1173,7 @@
|
|
|
1173
1173
|
"min_length": 3,
|
|
1174
1174
|
"max_length": 255,
|
|
1175
1175
|
"pattern": "[a-zA-Z0-9_.-]+",
|
|
1176
|
-
"documentation": "\n <p>The name of the local secondary index. The name must be unique among all other indexes
|
|
1176
|
+
"documentation": "\n <p>The name of the local secondary index. The name must be unique among all other indexes on this table.</p>\n ",
|
|
1177
1177
|
"required": true
|
|
1178
1178
|
},
|
|
1179
1179
|
"KeySchema": {
|
|
@@ -1198,15 +1198,15 @@
|
|
|
1198
1198
|
"HASH",
|
|
1199
1199
|
"RANGE"
|
|
1200
1200
|
],
|
|
1201
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
1201
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
1202
1202
|
"required": true
|
|
1203
1203
|
}
|
|
1204
1204
|
},
|
|
1205
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
1205
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
1206
1206
|
},
|
|
1207
1207
|
"min_length": 1,
|
|
1208
1208
|
"max_length": 2,
|
|
1209
|
-
"documentation": "\n <p>The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and
|
|
1209
|
+
"documentation": "\n <p>The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and\n key types (<code>HASH</code> or <code>RANGE</code>).</p>\n ",
|
|
1210
1210
|
"required": true
|
|
1211
1211
|
},
|
|
1212
1212
|
"Projection": {
|
|
@@ -1221,7 +1221,7 @@
|
|
|
1221
1221
|
"KEYS_ONLY",
|
|
1222
1222
|
"INCLUDE"
|
|
1223
1223
|
],
|
|
1224
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
1224
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
1225
1225
|
},
|
|
1226
1226
|
"NonKeyAttributes": {
|
|
1227
1227
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -1235,7 +1235,7 @@
|
|
|
1235
1235
|
},
|
|
1236
1236
|
"min_length": 1,
|
|
1237
1237
|
"max_length": 20,
|
|
1238
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
1238
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
1239
1239
|
}
|
|
1240
1240
|
},
|
|
1241
1241
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n ",
|
|
@@ -1244,7 +1244,7 @@
|
|
|
1244
1244
|
},
|
|
1245
1245
|
"documentation": "\n <p>Represents a local secondary index.</p>\n "
|
|
1246
1246
|
},
|
|
1247
|
-
"documentation": "\n <p>One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to
|
|
1247
|
+
"documentation": "\n <p>One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to\n a given hash key value. There is a 10 GB size limit per hash key;\n otherwise, the size of a local secondary index is unconstrained.</p>\n <p>Each local secondary index in the array includes the following:</p>\n <ul>\n <li>\n <p><i>IndexName</i> - The name of the local secondary index. Must be unique only for this table.</p>\n <p></p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the key schema for the local secondary index. The key schema must begin with\n the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n </ul>\n "
|
|
1248
1248
|
},
|
|
1249
1249
|
"GlobalSecondaryIndexes": {
|
|
1250
1250
|
"shape_name": "GlobalSecondaryIndexList",
|
|
@@ -1284,15 +1284,15 @@
|
|
|
1284
1284
|
"HASH",
|
|
1285
1285
|
"RANGE"
|
|
1286
1286
|
],
|
|
1287
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
1287
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
1288
1288
|
"required": true
|
|
1289
1289
|
}
|
|
1290
1290
|
},
|
|
1291
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
1291
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
1292
1292
|
},
|
|
1293
1293
|
"min_length": 1,
|
|
1294
1294
|
"max_length": 2,
|
|
1295
|
-
"documentation": "\n <p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute\n
|
|
1295
|
+
"documentation": "\n <p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names\n and key types (<code>HASH</code> or <code>RANGE</code>).</p>\n ",
|
|
1296
1296
|
"required": true
|
|
1297
1297
|
},
|
|
1298
1298
|
"Projection": {
|
|
@@ -1307,7 +1307,7 @@
|
|
|
1307
1307
|
"KEYS_ONLY",
|
|
1308
1308
|
"INCLUDE"
|
|
1309
1309
|
],
|
|
1310
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
1310
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
1311
1311
|
},
|
|
1312
1312
|
"NonKeyAttributes": {
|
|
1313
1313
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -1321,7 +1321,7 @@
|
|
|
1321
1321
|
},
|
|
1322
1322
|
"min_length": 1,
|
|
1323
1323
|
"max_length": 20,
|
|
1324
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
1324
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
1325
1325
|
}
|
|
1326
1326
|
},
|
|
1327
1327
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n ",
|
|
@@ -1335,24 +1335,24 @@
|
|
|
1335
1335
|
"shape_name": "PositiveLongObject",
|
|
1336
1336
|
"type": "long",
|
|
1337
1337
|
"min_length": 1,
|
|
1338
|
-
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n
|
|
1338
|
+
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
1339
1339
|
"required": true
|
|
1340
1340
|
},
|
|
1341
1341
|
"WriteCapacityUnits": {
|
|
1342
1342
|
"shape_name": "PositiveLongObject",
|
|
1343
1343
|
"type": "long",
|
|
1344
1344
|
"min_length": 1,
|
|
1345
|
-
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n
|
|
1345
|
+
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
1346
1346
|
"required": true
|
|
1347
1347
|
}
|
|
1348
1348
|
},
|
|
1349
|
-
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings
|
|
1349
|
+
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the <i>UpdateTable</i> operation.</p>\n <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>\n ",
|
|
1350
1350
|
"required": true
|
|
1351
1351
|
}
|
|
1352
1352
|
},
|
|
1353
1353
|
"documentation": "\n <p>Represents a global secondary index.</p>\n "
|
|
1354
1354
|
},
|
|
1355
|
-
"documentation": "\n <p>One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array
|
|
1355
|
+
"documentation": "\n <p>One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array\n includes the following:</p>\n <ul>\n <li>\n <p><i>IndexName</i> - The name of the global secondary index. Must be unique only for this table.</p>\n <p></p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the key schema for the global secondary index.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units.</p>\n </li>\n </ul>\n "
|
|
1356
1356
|
},
|
|
1357
1357
|
"ProvisionedThroughput": {
|
|
1358
1358
|
"shape_name": "ProvisionedThroughput",
|
|
@@ -1362,18 +1362,18 @@
|
|
|
1362
1362
|
"shape_name": "PositiveLongObject",
|
|
1363
1363
|
"type": "long",
|
|
1364
1364
|
"min_length": 1,
|
|
1365
|
-
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n
|
|
1365
|
+
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
1366
1366
|
"required": true
|
|
1367
1367
|
},
|
|
1368
1368
|
"WriteCapacityUnits": {
|
|
1369
1369
|
"shape_name": "PositiveLongObject",
|
|
1370
1370
|
"type": "long",
|
|
1371
1371
|
"min_length": 1,
|
|
1372
|
-
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n
|
|
1372
|
+
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
1373
1373
|
"required": true
|
|
1374
1374
|
}
|
|
1375
1375
|
},
|
|
1376
|
-
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings
|
|
1376
|
+
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the <i>UpdateTable</i> operation.</p>\n <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>\n ",
|
|
1377
1377
|
"required": true
|
|
1378
1378
|
}
|
|
1379
1379
|
},
|
|
@@ -1416,7 +1416,7 @@
|
|
|
1416
1416
|
},
|
|
1417
1417
|
"documentation": "\n <p>Represents an attribute for describing the key schema for the table and indexes.</p>\n "
|
|
1418
1418
|
},
|
|
1419
|
-
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects.
|
|
1419
|
+
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects. Each of these objects describes one attribute\n in the table and index key schema.</p>\n <p>Each <i>AttributeDefinition</i> object in this array is composed of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>AttributeType</i> - The data type for the attribute.</p>\n </li>\n </ul>\n "
|
|
1420
1420
|
},
|
|
1421
1421
|
"TableName": {
|
|
1422
1422
|
"shape_name": "TableName",
|
|
@@ -1448,15 +1448,15 @@
|
|
|
1448
1448
|
"HASH",
|
|
1449
1449
|
"RANGE"
|
|
1450
1450
|
],
|
|
1451
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
1451
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
1452
1452
|
"required": true
|
|
1453
1453
|
}
|
|
1454
1454
|
},
|
|
1455
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
1455
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
1456
1456
|
},
|
|
1457
1457
|
"min_length": 1,
|
|
1458
1458
|
"max_length": 2,
|
|
1459
|
-
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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
|
|
1459
|
+
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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\n Amazon DynamoDB Developer Guide.</p>\n "
|
|
1460
1460
|
},
|
|
1461
1461
|
"TableStatus": {
|
|
1462
1462
|
"shape_name": "TableStatus",
|
|
@@ -1507,7 +1507,7 @@
|
|
|
1507
1507
|
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>.</p>\n "
|
|
1508
1508
|
}
|
|
1509
1509
|
},
|
|
1510
|
-
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write\n
|
|
1510
|
+
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write capacity\n units, along with data about increases and decreases.</p>\n "
|
|
1511
1511
|
},
|
|
1512
1512
|
"TableSizeBytes": {
|
|
1513
1513
|
"shape_name": "Long",
|
|
@@ -1556,15 +1556,15 @@
|
|
|
1556
1556
|
"HASH",
|
|
1557
1557
|
"RANGE"
|
|
1558
1558
|
],
|
|
1559
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
1559
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
1560
1560
|
"required": true
|
|
1561
1561
|
}
|
|
1562
1562
|
},
|
|
1563
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
1563
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
1564
1564
|
},
|
|
1565
1565
|
"min_length": 1,
|
|
1566
1566
|
"max_length": 2,
|
|
1567
|
-
"documentation": "The complete index
|
|
1567
|
+
"documentation": "The complete index key schema,\n which consists of one or more pairs of attribute names and key types (<code>HASH</code> or\n <code>RANGE</code>). "
|
|
1568
1568
|
},
|
|
1569
1569
|
"Projection": {
|
|
1570
1570
|
"shape_name": "Projection",
|
|
@@ -1578,7 +1578,7 @@
|
|
|
1578
1578
|
"KEYS_ONLY",
|
|
1579
1579
|
"INCLUDE"
|
|
1580
1580
|
],
|
|
1581
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
1581
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
1582
1582
|
},
|
|
1583
1583
|
"NonKeyAttributes": {
|
|
1584
1584
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -1592,7 +1592,7 @@
|
|
|
1592
1592
|
},
|
|
1593
1593
|
"min_length": 1,
|
|
1594
1594
|
"max_length": 20,
|
|
1595
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
1595
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
1596
1596
|
}
|
|
1597
1597
|
},
|
|
1598
1598
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -1610,7 +1610,7 @@
|
|
|
1610
1610
|
},
|
|
1611
1611
|
"documentation": "\n <p>Represents the properties of a local secondary index.</p>\n "
|
|
1612
1612
|
},
|
|
1613
|
-
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given
|
|
1613
|
+
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value.\n Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount\n of data within a given item collection cannot exceed 10 GB. Each element is composed of:</p>\n <ul>\n <li>\n <p><i>IndexName</i> - The name of the local secondary index.</p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - Represents the total size of the index, in bytes. DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.</p>\n </li>\n <li>\n <p><i>ItemCount</i> - Represents the number of items in the index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.</p>\n </li>\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
1614
1614
|
},
|
|
1615
1615
|
"GlobalSecondaryIndexes": {
|
|
1616
1616
|
"shape_name": "GlobalSecondaryIndexDescriptionList",
|
|
@@ -1649,15 +1649,15 @@
|
|
|
1649
1649
|
"HASH",
|
|
1650
1650
|
"RANGE"
|
|
1651
1651
|
],
|
|
1652
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
1652
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
1653
1653
|
"required": true
|
|
1654
1654
|
}
|
|
1655
1655
|
},
|
|
1656
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
1656
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
1657
1657
|
},
|
|
1658
1658
|
"min_length": 1,
|
|
1659
1659
|
"max_length": 2,
|
|
1660
|
-
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and
|
|
1660
|
+
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and\n key types (<code>HASH</code> or <code>RANGE</code>).</p>\n "
|
|
1661
1661
|
},
|
|
1662
1662
|
"Projection": {
|
|
1663
1663
|
"shape_name": "Projection",
|
|
@@ -1671,7 +1671,7 @@
|
|
|
1671
1671
|
"KEYS_ONLY",
|
|
1672
1672
|
"INCLUDE"
|
|
1673
1673
|
],
|
|
1674
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
1674
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
1675
1675
|
},
|
|
1676
1676
|
"NonKeyAttributes": {
|
|
1677
1677
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -1685,7 +1685,7 @@
|
|
|
1685
1685
|
},
|
|
1686
1686
|
"min_length": 1,
|
|
1687
1687
|
"max_length": 20,
|
|
1688
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
1688
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
1689
1689
|
}
|
|
1690
1690
|
},
|
|
1691
1691
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -1699,7 +1699,7 @@
|
|
|
1699
1699
|
"DELETING",
|
|
1700
1700
|
"ACTIVE"
|
|
1701
1701
|
],
|
|
1702
|
-
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or
|
|
1702
|
+
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted, as the result of a <i>DeleteTable</i>\n operation.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n "
|
|
1703
1703
|
},
|
|
1704
1704
|
"ProvisionedThroughput": {
|
|
1705
1705
|
"shape_name": "ProvisionedThroughputDescription",
|
|
@@ -1749,7 +1749,7 @@
|
|
|
1749
1749
|
},
|
|
1750
1750
|
"documentation": "\n <p>Represents the properties of a global secondary index.</p>\n "
|
|
1751
1751
|
},
|
|
1752
|
-
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given
|
|
1752
|
+
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each\n element is composed of:</p>\n <ul>\n\n <li>\n <p><i>IndexName</i> - The name of the global secondary index.</p>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>IndexStatus</i> - The current status of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ItemCount</i> - The number of items in the global secondary index. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases. </p>\n </li>\n\n\n\n\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
1753
1753
|
}
|
|
1754
1754
|
},
|
|
1755
1755
|
"documentation": "\n <p>Represents the properties of a table.</p>\n "
|
|
@@ -1780,7 +1780,7 @@
|
|
|
1780
1780
|
"documentation": "\n <p>Too many operations for a given subscriber.</p>\n "
|
|
1781
1781
|
}
|
|
1782
1782
|
},
|
|
1783
|
-
"documentation": "\n <p>The number of concurrent table requests (cumulative number of tables in the\n <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the\n maximum allowed of 10.</p>\n <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code
|
|
1783
|
+
"documentation": "\n <p>The number of concurrent table requests (cumulative number of tables in the\n <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the\n maximum allowed of 10.</p>\n <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code>\n state at any point in time. Do not attempt to create more than one such table\n simultaneously.</p>\n <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>\n "
|
|
1784
1784
|
},
|
|
1785
1785
|
{
|
|
1786
1786
|
"shape_name": "InternalServerError",
|
|
@@ -1795,7 +1795,7 @@
|
|
|
1795
1795
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
1796
1796
|
}
|
|
1797
1797
|
],
|
|
1798
|
-
"documentation": "\n <p>The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table\n names must be unique within each region. That is, you can have two tables with same name if
|
|
1798
|
+
"documentation": "\n <p>The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table\n names must be unique within each region. That is, you can have two tables with same name if\n you create the tables in different regions.</p>\n <p><i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request,\n DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After\n the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can\n perform read and write operations only on an <code>ACTIVE</code> table. </p>\n <p>If you want to create multiple tables with secondary indexes on them, you must create them sequentially.\n Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time.</p>\n <p>You can use the <i>DescribeTable</i> API to check the table status.</p>\n <examples>\n <example>\n <name>Create a Table</name>\n <description>This example creates a table named Thread. The table primary key consists of\n ForumName (hash) and Subject (range). A local secondary index is also created; its key consists of\n ForumName (hash) and LastPostDateTime (range).</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.CreateTable \n\n{\n \"AttributeDefinitions\": [\n {\n \"AttributeName\": \"ForumName\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"AttributeType\": \"S\"\n }\n ],\n \"TableName\": \"Thread\",\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"LocalSecondaryIndexes\": [\n {\n \"IndexName\": \"LastPostIndex\",\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"Projection\": {\n \"ProjectionType\": \"KEYS_ONLY\"\n }\n }\n ],\n \"ProvisionedThroughput\": {\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n }\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"TableDescription\": {\n \"AttributeDefinitions\": [\n {\n \"AttributeName\": \"ForumName\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"AttributeType\": \"S\"\n }\n ],\n \"CreationDateTime\": 1.36372808007E9,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"LocalSecondaryIndexes\": [\n {\n \"IndexName\": \"LastPostIndex\",\n \"IndexSizeBytes\": 0,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"Projection\": {\n \"ProjectionType\": \"KEYS_ONLY\"\n }\n }\n ],\n \"ProvisionedThroughput\": {\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Thread\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"CREATING\"\n }\n}\n </response>\n </example>\n </examples>\n "
|
|
1799
1799
|
},
|
|
1800
1800
|
"DeleteItem": {
|
|
1801
1801
|
"name": "DeleteItem",
|
|
@@ -1873,7 +1873,7 @@
|
|
|
1873
1873
|
},
|
|
1874
1874
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
1875
1875
|
},
|
|
1876
|
-
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of
|
|
1876
|
+
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of\n the item to delete.</p>\n <p>For the primary key, you must provide <i>all</i> of the attributes. For example, with a hash\n type primary key, you only need to specify the hash attribute. For a hash-and-range type\n primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>\n ",
|
|
1877
1877
|
"required": true
|
|
1878
1878
|
},
|
|
1879
1879
|
"Expected": {
|
|
@@ -1944,7 +1944,7 @@
|
|
|
1944
1944
|
"Exists": {
|
|
1945
1945
|
"shape_name": "BooleanObject",
|
|
1946
1946
|
"type": "boolean",
|
|
1947
|
-
"documentation": "\n <p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n
|
|
1947
|
+
"documentation": "\n <p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute value\n already exists in the table. If it is found, then the operation succeeds. If it is not\n found, the operation fails with a <i>ConditionalCheckFailedException</i>.</p>\n </li>\n <li>\n <p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does\n <i>not</i> exist in the table. If in fact the value does not exist, then the assumption\n is valid and the operation succeeds. If the value is found, despite the assumption that it\n does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>.</p>\n </li>\n </ul>\n <p>The default setting for <i>Exists</i> is <code>true</code>. If you supply a <i>Value</i> all\n by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to\n <code>true</code>, because it is implied.</p>\n <p>DynamoDB returns a <i>ValidationException</i> if:</p>\n <ul>\n <li>\n <p><i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect a\n value to exist, but don't specify what that value is.)</p>\n </li>\n <li>\n <p><i>Exists</i> is <code>false</code> but you also specify a <i>Value</i>. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)</p>\n </li>\n </ul>\n "
|
|
1948
1948
|
},
|
|
1949
1949
|
"ComparisonOperator": {
|
|
1950
1950
|
"shape_name": "ComparisonOperator",
|
|
@@ -1964,7 +1964,7 @@
|
|
|
1964
1964
|
"NOT_CONTAINS",
|
|
1965
1965
|
"BEGINS_WITH"
|
|
1966
1966
|
],
|
|
1967
|
-
"documentation":
|
|
1967
|
+
"documentation": "\n <p>A comparator for evaluating attributes in the <i>AttributeValueList</i>. For example, equals,\n greater than, less than, etc.</p> \n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n \n <p>The following are descriptions of each comparison operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n "
|
|
1968
1968
|
},
|
|
1969
1969
|
"AttributeValueList": {
|
|
1970
1970
|
"shape_name": "AttributeValueList",
|
|
@@ -2021,12 +2021,12 @@
|
|
|
2021
2021
|
},
|
|
2022
2022
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
2023
2023
|
},
|
|
2024
|
-
"documentation":
|
|
2024
|
+
"documentation": "\n <p>One or more values to evaluate against the supplied attribute.\n The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code>\n 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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n <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>\n "
|
|
2025
2025
|
}
|
|
2026
2026
|
},
|
|
2027
|
-
"documentation": "\n <p>Represents an attribute value used
|
|
2027
|
+
"documentation": "\n <p>Represents a condition to be compared with an attribute value. This condition can be used\n with <i>DeleteItem</i>, <i>PutItem</i> or <i>UpdateItem</i> operations; if the comparison\n evaluates to true, the operation succeeds; if not the operation fails. You can use\n <i>ExpectedAttributeValue</i> in one of two different ways:</p>\n <ul>\n <li>\n <p>Use <i>AttributeValueList</i> to specify one or more values to compare against an\n attribute. Use <i>ComparisonOperator</i> to specify how you want to perform the\n comparison. If the comparison evaluates to true, then the conditional operation\n succeeds.</p>\n </li>\n <li>\n <p>Use <i>Value</i> to specify a value that DynamoDB will compare against an attribute. If the\n values match, then <i>ExpectedAttributeValue</i> evaluates to true and the conditional\n operation succeeds. Optionally, you can also set <i>Exists</i> to false, indicating that\n you <i>do not</i> expect to find the attribute value in the table. In this case, the\n conditional operation succeeds only if the comparison evaluates to false.</p>\n </li>\n </ul>\n <p><i>Value</i> and <i>Exists</i> are incompatible with <i>AttributeValueList</i> and \n <i>ComparisonOperator</i>. If you attempt to use both sets of parameters at once, DynamoDB will\n throw a <i>ValidationException</i>.</p>\n\n <important>\n <p>The <i>Value</i> and <i>Exists</i> parameters are deprecated. Even though DynamoDB will\n continue to support these parameters, we recommend that you use <i>AttributeValueList</i>\n and <i>ComparisonOperator</i> instead. <i>AttributeValueList</i> and\n <i>ComparisonOperator</i> let you construct a much wider range of conditions than is\n possible with <i>Value</i> and <i>Exists</i>.</p>\n </important>\n "
|
|
2028
2028
|
},
|
|
2029
|
-
"documentation": "\n <p>A map of attribute/condition pairs. This is the conditional block for the <i>DeleteItem</i> operation. All the conditions must be met for the operation to succeed.</p> <p><i>Expected</i> allows you to\n provide an attribute name, and whether or not DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.</p>\n <p>Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with\n the following: </p>\n <ul>\n <li>\n <p><i>Value</i> - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used.</p>\n </li>\n <li>\n <p><i>Exists</i> - Causes DynamoDB to evaluate the value before attempting a conditional\n operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n <i>ConditionalCheckFailedException</i>.</p>\n </li>\n <li>\n <p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does\n <i>not</i> exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n <i>ConditionalCheckFailedException</i>.</p>\n </li>\n </ul>\n <p>The default setting for <i>Exists</i> is <code>true</code>. If you supply a <i>Value</i>\n all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <code>true</code>, because it is\n implied.</p>\n <p>DynamoDB returns a <i>ValidationException</i> if:</p>\n <ul>\n <li>\n <p><i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect\n a value to exist, but don't specify what that value is.)</p>\n </li>\n <li>\n <p><i>Exists</i> is <code>false</code> but you also specify a <i>Value</i>. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>If you specify more than one condition for <i>Exists</i>, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.</p>\n\n "
|
|
2029
|
+
"documentation": "\n <p>A map of attribute/condition pairs. This is the conditional block for the <i>DeleteItem</i>\n 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>\n\n <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>\n <p>If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails.</p>\n \n <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>\n \n <ul>\n <li>\n <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied\n attribute. The number of values in the list depends on the <i>ComparisonOperator</i>\n being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, <code>a</code> is greater than <code>A</code>, and\n <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a\n href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\"\n >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n </li>\n <li>\n <p><i>ComparisonOperator</i> - A comparator for evaluating attributes in the\n <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads.</p>\n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n\n <p>The following are descriptions of each comparison operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n </li>\n </ul>\n <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\"\n >Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>\n <note>\n <p>For backward compatibility with previous DynamoDB releases, the following parameters can be\n used instead of <i>AttributeValueList</i> and <i>ComparisonOperator</i>:</p>\n <ul>\n <li>\n <p><i>Value</i> - A value for DynamoDB to compare with an attribute.</p>\n </li>\n <li>\n <p><i>Exists</i> - Causes DynamoDB to evaluate the value before attempting the conditional\n operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the condition evaluates to\n true; otherwise the condition evaluate to false.</p>\n </li>\n <li><p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value\n does <i>not</i> exist in the table. If in fact the value does not exist, then the\n assumption is valid and the condition evaluates to true. If the value is found,\n despite the assumption that it does not exist, the condition evaluates to\n false.</p></li>\n </ul>\n </li>\n </ul>\n <p>Even though DynamoDB continues to accept the <i>Value</i> and <i>Exists</i> parameters, they\n are now deprecated. We recommend that you use <i>AttributeValueList</i> and\n <i>ComparisonOperator</i> instead, since they allow you to construct a much wider range of\n conditions.</p>\n <p>The <i>Value</i> and <i>Exists</i> parameters are incompatible with\n <i>AttributeValueList</i> and <i>ComparisonOperator</i>. If you attempt to use both sets\n of parameters at once, DynamoDB will throw a <i>ValidationException</i>.</p>\n </note>\n "
|
|
2030
2030
|
},
|
|
2031
2031
|
"ConditionalOperator": {
|
|
2032
2032
|
"shape_name": "ConditionalOperator",
|
|
@@ -2035,7 +2035,7 @@
|
|
|
2035
2035
|
"AND",
|
|
2036
2036
|
"OR"
|
|
2037
2037
|
],
|
|
2038
|
-
"documentation":
|
|
2038
|
+
"documentation": "\n <p>A logical operator to apply to the conditions in the <i>Expected</i> map:</p>\n <ul>\n <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li>\n <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>\n </ul>\n <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p>\n <p>The operation will succeed only if the entire map evaluates to true.</p>\n "
|
|
2039
2039
|
},
|
|
2040
2040
|
"ReturnValues": {
|
|
2041
2041
|
"shape_name": "ReturnValue",
|
|
@@ -2047,7 +2047,7 @@
|
|
|
2047
2047
|
"ALL_NEW",
|
|
2048
2048
|
"UPDATED_NEW"
|
|
2049
2049
|
],
|
|
2050
|
-
"documentation": "\n <p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they
|
|
2050
|
+
"documentation": "\n <p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they\n were deleted. For <i>DeleteItem</i>, the valid values are:</p>\n <ul>\n <li>\n <p><code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is\n <code>NONE</code>, then nothing is returned. (This is the default for\n <i>ReturnValues</i>.)</p>\n </li>\n <li>\n <p><code>ALL_OLD</code> - The content of the old item is returned.</p>\n </li>\n </ul>\n "
|
|
2051
2051
|
},
|
|
2052
2052
|
"ReturnConsumedCapacity": {
|
|
2053
2053
|
"shape_name": "ReturnConsumedCapacity",
|
|
@@ -2057,7 +2057,7 @@
|
|
|
2057
2057
|
"TOTAL",
|
|
2058
2058
|
"NONE"
|
|
2059
2059
|
],
|
|
2060
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
2060
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
2061
2061
|
},
|
|
2062
2062
|
"ReturnItemCollectionMetrics": {
|
|
2063
2063
|
"shape_name": "ReturnItemCollectionMetrics",
|
|
@@ -2136,7 +2136,7 @@
|
|
|
2136
2136
|
},
|
|
2137
2137
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
2138
2138
|
},
|
|
2139
|
-
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, representing the item as it
|
|
2139
|
+
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, representing the item as it\n appeared before the <i>DeleteItem</i> operation. This map appears in the response only if\n <i>ReturnValues</i> was specified as <code>ALL_OLD</code> in the request.</p>\n "
|
|
2140
2140
|
},
|
|
2141
2141
|
"ConsumedCapacity": {
|
|
2142
2142
|
"shape_name": "ConsumedCapacity",
|
|
@@ -2188,7 +2188,7 @@
|
|
|
2188
2188
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
2189
2189
|
}
|
|
2190
2190
|
},
|
|
2191
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
2191
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
2192
2192
|
},
|
|
2193
2193
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
2194
2194
|
},
|
|
@@ -2213,12 +2213,12 @@
|
|
|
2213
2213
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
2214
2214
|
}
|
|
2215
2215
|
},
|
|
2216
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
2216
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
2217
2217
|
},
|
|
2218
2218
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
2219
2219
|
}
|
|
2220
2220
|
},
|
|
2221
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
2221
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
2222
2222
|
},
|
|
2223
2223
|
"ItemCollectionMetrics": {
|
|
2224
2224
|
"shape_name": "ItemCollectionMetrics",
|
|
@@ -2285,7 +2285,7 @@
|
|
|
2285
2285
|
},
|
|
2286
2286
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
2287
2287
|
},
|
|
2288
|
-
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p
|
|
2288
|
+
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p>\n "
|
|
2289
2289
|
},
|
|
2290
2290
|
"SizeEstimateRangeGB": {
|
|
2291
2291
|
"shape_name": "ItemCollectionSizeEstimateRange",
|
|
@@ -2295,7 +2295,7 @@
|
|
|
2295
2295
|
"type": "double",
|
|
2296
2296
|
"documentation": null
|
|
2297
2297
|
},
|
|
2298
|
-
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a
|
|
2298
|
+
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the size\n of all the items in the table, plus the size of all attributes projected into all of the\n local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size\n limit.</p>\n <p>The estimate is subject to change over time; therefore, do not rely on the precision or\n accuracy of the estimate.</p>\n "
|
|
2299
2299
|
}
|
|
2300
2300
|
},
|
|
2301
2301
|
"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\n does not have any local secondary indexes, this information is not\n returned in the response.</p>\n <p>Each <i>ItemCollectionMetrics</i>\n element consists of:</p>\n <ul>\n <li><p><i>ItemCollectionKey</i> - The hash key value of the item\n collection. This is the same as the hash key of the item.</p></li>\n <li><p><i>SizeEstimateRange</i> - An estimate of item collection size,\n measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.</p>\n <p>The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.</p>\n</li>\n </ul>\n "
|
|
@@ -2326,7 +2326,7 @@
|
|
|
2326
2326
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
2327
2327
|
}
|
|
2328
2328
|
},
|
|
2329
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
2329
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
2330
2330
|
},
|
|
2331
2331
|
{
|
|
2332
2332
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -2338,7 +2338,7 @@
|
|
|
2338
2338
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
2339
2339
|
}
|
|
2340
2340
|
},
|
|
2341
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
2341
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
2342
2342
|
},
|
|
2343
2343
|
{
|
|
2344
2344
|
"shape_name": "ItemCollectionSizeLimitExceededException",
|
|
@@ -2365,7 +2365,7 @@
|
|
|
2365
2365
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
2366
2366
|
}
|
|
2367
2367
|
],
|
|
2368
|
-
"documentation": "\n <p>Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute value.</p>\n <p>In addition to deleting an item, you can also return the item's attribute values in the same
|
|
2368
|
+
"documentation": "\n <p>Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute value.</p>\n <p>In addition to deleting an item, you can also return the item's attribute values in the same\n operation, using the <i>ReturnValues</i> parameter.</p>\n <p>Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it\n multiple times on the same item or attribute does <i>not</i> result in an error response.</p>\n <p>Conditional deletes are useful for only deleting items if specific conditions are met. If\n those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </p>\n <examples>\n <example>\n <name>Delete an Item</name>\n <description>This example deletes an item from the Thread table, but only if that item does\n not have an attribute named Replies. Because ReturnValues is set to ALL_OLD, the response\n contains the item as it appeared before the delete.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.DeleteItem \n\n{\n \"TableName\": \"Thread\",\n \"Key\": {\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"Subject\": {\n \"S\": \"How do I update multiple items?\"\n }\n },\n \"Expected\": {\n \"Replies\": {\n \"ComparisonOperator\": \"NULL\"\n }\n },\n \"ReturnValues\": \"ALL_OLD\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"Attributes\": {\n \"LastPostedBy\": {\n \"S\": \"fred@example.com\"\n },\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"LastPostDateTime\": {\n \"S\": \"201303201023\"\n },\n \"Tags\": {\n \"SS\": [\"Update\",\"Multiple Items\",\"HelpMe\"]\n },\n \"Subject\": {\n \"S\": \"How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"I want to update multiple items in a single API call. What's the best way to do that?\"\n }\n }\n}\n </response>\n </example>\n </examples>\n "
|
|
2369
2369
|
},
|
|
2370
2370
|
"DeleteTable": {
|
|
2371
2371
|
"name": "DeleteTable",
|
|
@@ -2422,7 +2422,7 @@
|
|
|
2422
2422
|
},
|
|
2423
2423
|
"documentation": "\n <p>Represents an attribute for describing the key schema for the table and indexes.</p>\n "
|
|
2424
2424
|
},
|
|
2425
|
-
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects.
|
|
2425
|
+
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects. Each of these objects describes one attribute\n in the table and index key schema.</p>\n <p>Each <i>AttributeDefinition</i> object in this array is composed of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>AttributeType</i> - The data type for the attribute.</p>\n </li>\n </ul>\n "
|
|
2426
2426
|
},
|
|
2427
2427
|
"TableName": {
|
|
2428
2428
|
"shape_name": "TableName",
|
|
@@ -2454,15 +2454,15 @@
|
|
|
2454
2454
|
"HASH",
|
|
2455
2455
|
"RANGE"
|
|
2456
2456
|
],
|
|
2457
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
2457
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
2458
2458
|
"required": true
|
|
2459
2459
|
}
|
|
2460
2460
|
},
|
|
2461
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
2461
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
2462
2462
|
},
|
|
2463
2463
|
"min_length": 1,
|
|
2464
2464
|
"max_length": 2,
|
|
2465
|
-
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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
|
|
2465
|
+
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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\n Amazon DynamoDB Developer Guide.</p>\n "
|
|
2466
2466
|
},
|
|
2467
2467
|
"TableStatus": {
|
|
2468
2468
|
"shape_name": "TableStatus",
|
|
@@ -2513,7 +2513,7 @@
|
|
|
2513
2513
|
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>.</p>\n "
|
|
2514
2514
|
}
|
|
2515
2515
|
},
|
|
2516
|
-
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write\n
|
|
2516
|
+
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write capacity\n units, along with data about increases and decreases.</p>\n "
|
|
2517
2517
|
},
|
|
2518
2518
|
"TableSizeBytes": {
|
|
2519
2519
|
"shape_name": "Long",
|
|
@@ -2562,15 +2562,15 @@
|
|
|
2562
2562
|
"HASH",
|
|
2563
2563
|
"RANGE"
|
|
2564
2564
|
],
|
|
2565
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
2565
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
2566
2566
|
"required": true
|
|
2567
2567
|
}
|
|
2568
2568
|
},
|
|
2569
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
2569
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
2570
2570
|
},
|
|
2571
2571
|
"min_length": 1,
|
|
2572
2572
|
"max_length": 2,
|
|
2573
|
-
"documentation": "The complete index
|
|
2573
|
+
"documentation": "The complete index key schema,\n which consists of one or more pairs of attribute names and key types (<code>HASH</code> or\n <code>RANGE</code>). "
|
|
2574
2574
|
},
|
|
2575
2575
|
"Projection": {
|
|
2576
2576
|
"shape_name": "Projection",
|
|
@@ -2584,7 +2584,7 @@
|
|
|
2584
2584
|
"KEYS_ONLY",
|
|
2585
2585
|
"INCLUDE"
|
|
2586
2586
|
],
|
|
2587
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
2587
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
2588
2588
|
},
|
|
2589
2589
|
"NonKeyAttributes": {
|
|
2590
2590
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -2598,7 +2598,7 @@
|
|
|
2598
2598
|
},
|
|
2599
2599
|
"min_length": 1,
|
|
2600
2600
|
"max_length": 20,
|
|
2601
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
2601
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
2602
2602
|
}
|
|
2603
2603
|
},
|
|
2604
2604
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -2616,7 +2616,7 @@
|
|
|
2616
2616
|
},
|
|
2617
2617
|
"documentation": "\n <p>Represents the properties of a local secondary index.</p>\n "
|
|
2618
2618
|
},
|
|
2619
|
-
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given
|
|
2619
|
+
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value.\n Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount\n of data within a given item collection cannot exceed 10 GB. Each element is composed of:</p>\n <ul>\n <li>\n <p><i>IndexName</i> - The name of the local secondary index.</p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - Represents the total size of the index, in bytes. DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.</p>\n </li>\n <li>\n <p><i>ItemCount</i> - Represents the number of items in the index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.</p>\n </li>\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
2620
2620
|
},
|
|
2621
2621
|
"GlobalSecondaryIndexes": {
|
|
2622
2622
|
"shape_name": "GlobalSecondaryIndexDescriptionList",
|
|
@@ -2655,15 +2655,15 @@
|
|
|
2655
2655
|
"HASH",
|
|
2656
2656
|
"RANGE"
|
|
2657
2657
|
],
|
|
2658
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
2658
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
2659
2659
|
"required": true
|
|
2660
2660
|
}
|
|
2661
2661
|
},
|
|
2662
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
2662
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
2663
2663
|
},
|
|
2664
2664
|
"min_length": 1,
|
|
2665
2665
|
"max_length": 2,
|
|
2666
|
-
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and
|
|
2666
|
+
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and\n key types (<code>HASH</code> or <code>RANGE</code>).</p>\n "
|
|
2667
2667
|
},
|
|
2668
2668
|
"Projection": {
|
|
2669
2669
|
"shape_name": "Projection",
|
|
@@ -2677,7 +2677,7 @@
|
|
|
2677
2677
|
"KEYS_ONLY",
|
|
2678
2678
|
"INCLUDE"
|
|
2679
2679
|
],
|
|
2680
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
2680
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
2681
2681
|
},
|
|
2682
2682
|
"NonKeyAttributes": {
|
|
2683
2683
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -2691,7 +2691,7 @@
|
|
|
2691
2691
|
},
|
|
2692
2692
|
"min_length": 1,
|
|
2693
2693
|
"max_length": 20,
|
|
2694
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
2694
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
2695
2695
|
}
|
|
2696
2696
|
},
|
|
2697
2697
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -2705,7 +2705,7 @@
|
|
|
2705
2705
|
"DELETING",
|
|
2706
2706
|
"ACTIVE"
|
|
2707
2707
|
],
|
|
2708
|
-
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or
|
|
2708
|
+
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted, as the result of a <i>DeleteTable</i>\n operation.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n "
|
|
2709
2709
|
},
|
|
2710
2710
|
"ProvisionedThroughput": {
|
|
2711
2711
|
"shape_name": "ProvisionedThroughputDescription",
|
|
@@ -2755,7 +2755,7 @@
|
|
|
2755
2755
|
},
|
|
2756
2756
|
"documentation": "\n <p>Represents the properties of a global secondary index.</p>\n "
|
|
2757
2757
|
},
|
|
2758
|
-
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given
|
|
2758
|
+
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each\n element is composed of:</p>\n <ul>\n\n <li>\n <p><i>IndexName</i> - The name of the global secondary index.</p>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>IndexStatus</i> - The current status of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ItemCount</i> - The number of items in the global secondary index. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases. </p>\n </li>\n\n\n\n\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
2759
2759
|
}
|
|
2760
2760
|
},
|
|
2761
2761
|
"documentation": "\n <p>Represents the properties of a table.</p>\n "
|
|
@@ -2786,7 +2786,7 @@
|
|
|
2786
2786
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
2787
2787
|
}
|
|
2788
2788
|
},
|
|
2789
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
2789
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
2790
2790
|
},
|
|
2791
2791
|
{
|
|
2792
2792
|
"shape_name": "LimitExceededException",
|
|
@@ -2798,7 +2798,7 @@
|
|
|
2798
2798
|
"documentation": "\n <p>Too many operations for a given subscriber.</p>\n "
|
|
2799
2799
|
}
|
|
2800
2800
|
},
|
|
2801
|
-
"documentation": "\n <p>The number of concurrent table requests (cumulative number of tables in the\n <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the\n maximum allowed of 10.</p>\n <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code
|
|
2801
|
+
"documentation": "\n <p>The number of concurrent table requests (cumulative number of tables in the\n <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the\n maximum allowed of 10.</p>\n <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code>\n state at any point in time. Do not attempt to create more than one such table\n simultaneously.</p>\n <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>\n "
|
|
2802
2802
|
},
|
|
2803
2803
|
{
|
|
2804
2804
|
"shape_name": "InternalServerError",
|
|
@@ -2813,7 +2813,7 @@
|
|
|
2813
2813
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
2814
2814
|
}
|
|
2815
2815
|
],
|
|
2816
|
-
"documentation": "\n <p>The <i>DeleteTable</i> operation deletes a table and all of its items. After a\n <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until\n DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete\n it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns\n a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a\n <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no\n error is returned. </p>\n <note>\n <p>DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and\n <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is\n complete.</p>\n </note>\n
|
|
2816
|
+
"documentation": "\n <p>The <i>DeleteTable</i> operation deletes a table and all of its items. After a\n <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until\n DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete\n it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns\n a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a\n <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no\n error is returned. </p>\n <note>\n <p>DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and\n <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is\n complete.</p>\n </note>\n <p>When you delete a table, any indexes on that table are also deleted.</p>\n\n <p>Use the <i>DescribeTable</i> API to check the status of the table. </p>\n\n <examples>\n <example>\n <name>Delete a Table</name>\n <description>This example deletes the Reply table.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.DeleteTable \n\n{\n \"TableName\": \"Reply\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"TableDescription\": {\n \"ItemCount\": 0,\n \"ProvisionedThroughput\": {\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Reply\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"DELETING\"\n }\n}\n </response>\n </example>\n </examples>\n "
|
|
2817
2817
|
},
|
|
2818
2818
|
"DescribeTable": {
|
|
2819
2819
|
"name": "DescribeTable",
|
|
@@ -2870,7 +2870,7 @@
|
|
|
2870
2870
|
},
|
|
2871
2871
|
"documentation": "\n <p>Represents an attribute for describing the key schema for the table and indexes.</p>\n "
|
|
2872
2872
|
},
|
|
2873
|
-
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects.
|
|
2873
|
+
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects. Each of these objects describes one attribute\n in the table and index key schema.</p>\n <p>Each <i>AttributeDefinition</i> object in this array is composed of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>AttributeType</i> - The data type for the attribute.</p>\n </li>\n </ul>\n "
|
|
2874
2874
|
},
|
|
2875
2875
|
"TableName": {
|
|
2876
2876
|
"shape_name": "TableName",
|
|
@@ -2902,15 +2902,15 @@
|
|
|
2902
2902
|
"HASH",
|
|
2903
2903
|
"RANGE"
|
|
2904
2904
|
],
|
|
2905
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
2905
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
2906
2906
|
"required": true
|
|
2907
2907
|
}
|
|
2908
2908
|
},
|
|
2909
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
2909
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
2910
2910
|
},
|
|
2911
2911
|
"min_length": 1,
|
|
2912
2912
|
"max_length": 2,
|
|
2913
|
-
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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
|
|
2913
|
+
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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\n Amazon DynamoDB Developer Guide.</p>\n "
|
|
2914
2914
|
},
|
|
2915
2915
|
"TableStatus": {
|
|
2916
2916
|
"shape_name": "TableStatus",
|
|
@@ -2961,7 +2961,7 @@
|
|
|
2961
2961
|
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>.</p>\n "
|
|
2962
2962
|
}
|
|
2963
2963
|
},
|
|
2964
|
-
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write\n
|
|
2964
|
+
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write capacity\n units, along with data about increases and decreases.</p>\n "
|
|
2965
2965
|
},
|
|
2966
2966
|
"TableSizeBytes": {
|
|
2967
2967
|
"shape_name": "Long",
|
|
@@ -3010,15 +3010,15 @@
|
|
|
3010
3010
|
"HASH",
|
|
3011
3011
|
"RANGE"
|
|
3012
3012
|
],
|
|
3013
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
3013
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
3014
3014
|
"required": true
|
|
3015
3015
|
}
|
|
3016
3016
|
},
|
|
3017
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
3017
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
3018
3018
|
},
|
|
3019
3019
|
"min_length": 1,
|
|
3020
3020
|
"max_length": 2,
|
|
3021
|
-
"documentation": "The complete index
|
|
3021
|
+
"documentation": "The complete index key schema,\n which consists of one or more pairs of attribute names and key types (<code>HASH</code> or\n <code>RANGE</code>). "
|
|
3022
3022
|
},
|
|
3023
3023
|
"Projection": {
|
|
3024
3024
|
"shape_name": "Projection",
|
|
@@ -3032,7 +3032,7 @@
|
|
|
3032
3032
|
"KEYS_ONLY",
|
|
3033
3033
|
"INCLUDE"
|
|
3034
3034
|
],
|
|
3035
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
3035
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
3036
3036
|
},
|
|
3037
3037
|
"NonKeyAttributes": {
|
|
3038
3038
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -3046,7 +3046,7 @@
|
|
|
3046
3046
|
},
|
|
3047
3047
|
"min_length": 1,
|
|
3048
3048
|
"max_length": 20,
|
|
3049
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
3049
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
3050
3050
|
}
|
|
3051
3051
|
},
|
|
3052
3052
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -3064,7 +3064,7 @@
|
|
|
3064
3064
|
},
|
|
3065
3065
|
"documentation": "\n <p>Represents the properties of a local secondary index.</p>\n "
|
|
3066
3066
|
},
|
|
3067
|
-
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given
|
|
3067
|
+
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value.\n Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount\n of data within a given item collection cannot exceed 10 GB. Each element is composed of:</p>\n <ul>\n <li>\n <p><i>IndexName</i> - The name of the local secondary index.</p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - Represents the total size of the index, in bytes. DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.</p>\n </li>\n <li>\n <p><i>ItemCount</i> - Represents the number of items in the index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.</p>\n </li>\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
3068
3068
|
},
|
|
3069
3069
|
"GlobalSecondaryIndexes": {
|
|
3070
3070
|
"shape_name": "GlobalSecondaryIndexDescriptionList",
|
|
@@ -3103,15 +3103,15 @@
|
|
|
3103
3103
|
"HASH",
|
|
3104
3104
|
"RANGE"
|
|
3105
3105
|
],
|
|
3106
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
3106
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
3107
3107
|
"required": true
|
|
3108
3108
|
}
|
|
3109
3109
|
},
|
|
3110
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
3110
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
3111
3111
|
},
|
|
3112
3112
|
"min_length": 1,
|
|
3113
3113
|
"max_length": 2,
|
|
3114
|
-
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and
|
|
3114
|
+
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and\n key types (<code>HASH</code> or <code>RANGE</code>).</p>\n "
|
|
3115
3115
|
},
|
|
3116
3116
|
"Projection": {
|
|
3117
3117
|
"shape_name": "Projection",
|
|
@@ -3125,7 +3125,7 @@
|
|
|
3125
3125
|
"KEYS_ONLY",
|
|
3126
3126
|
"INCLUDE"
|
|
3127
3127
|
],
|
|
3128
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
3128
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
3129
3129
|
},
|
|
3130
3130
|
"NonKeyAttributes": {
|
|
3131
3131
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -3139,7 +3139,7 @@
|
|
|
3139
3139
|
},
|
|
3140
3140
|
"min_length": 1,
|
|
3141
3141
|
"max_length": 20,
|
|
3142
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
3142
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
3143
3143
|
}
|
|
3144
3144
|
},
|
|
3145
3145
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -3153,7 +3153,7 @@
|
|
|
3153
3153
|
"DELETING",
|
|
3154
3154
|
"ACTIVE"
|
|
3155
3155
|
],
|
|
3156
|
-
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or
|
|
3156
|
+
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted, as the result of a <i>DeleteTable</i>\n operation.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n "
|
|
3157
3157
|
},
|
|
3158
3158
|
"ProvisionedThroughput": {
|
|
3159
3159
|
"shape_name": "ProvisionedThroughputDescription",
|
|
@@ -3203,7 +3203,7 @@
|
|
|
3203
3203
|
},
|
|
3204
3204
|
"documentation": "\n <p>Represents the properties of a global secondary index.</p>\n "
|
|
3205
3205
|
},
|
|
3206
|
-
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given
|
|
3206
|
+
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each\n element is composed of:</p>\n <ul>\n\n <li>\n <p><i>IndexName</i> - The name of the global secondary index.</p>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>IndexStatus</i> - The current status of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ItemCount</i> - The number of items in the global secondary index. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases. </p>\n </li>\n\n\n\n\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
3207
3207
|
}
|
|
3208
3208
|
},
|
|
3209
3209
|
"documentation": "\n <p>Represents the properties of a table.</p>\n "
|
|
@@ -3222,7 +3222,7 @@
|
|
|
3222
3222
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
3223
3223
|
}
|
|
3224
3224
|
},
|
|
3225
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
3225
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
3226
3226
|
},
|
|
3227
3227
|
{
|
|
3228
3228
|
"shape_name": "InternalServerError",
|
|
@@ -3237,7 +3237,7 @@
|
|
|
3237
3237
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
3238
3238
|
}
|
|
3239
3239
|
],
|
|
3240
|
-
"documentation": "\n <p>Returns information about the table, including the current status of the table, when it was\n created, the primary key schema, and any indexes on the table.</p>\n <examples>\n <example>\n <name>Describe a Table</name>\n <description>\n <p>This example describes the Thread table.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]
|
|
3240
|
+
"documentation": "\n <p>Returns information about the table, including the current status of the table, when it was\n created, the primary key schema, and any indexes on the table.</p>\n <examples>\n <example>\n <name>Describe a Table</name>\n <description>\n <p>This example describes the Thread table.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.DescribeTable \n\n{\n \"TableName\":\"Thread\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"Table\": {\n \"AttributeDefinitions\": [\n {\n \"AttributeName\": \"ForumName\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"AttributeType\": \"S\"\n }\n ],\n \"CreationDateTime\": 1.363729002358E9,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"LocalSecondaryIndexes\": [\n {\n \"IndexName\": \"LastPostIndex\",\n \"IndexSizeBytes\": 0,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"Projection\": {\n \"ProjectionType\": \"KEYS_ONLY\"\n }\n }\n ],\n \"ProvisionedThroughput\": {\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Thread\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"ACTIVE\"\n }\n}\n </response>\n </example>\n </examples>\n "
|
|
3241
3241
|
},
|
|
3242
3242
|
"GetItem": {
|
|
3243
3243
|
"name": "GetItem",
|
|
@@ -3315,7 +3315,7 @@
|
|
|
3315
3315
|
},
|
|
3316
3316
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
3317
3317
|
},
|
|
3318
|
-
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of
|
|
3318
|
+
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of\n the item to retrieve.</p>\n <p>For the primary key, you must provide <i>all</i> of the attributes. For example, with a hash\n type primary key, you only need to specify the hash attribute. For a hash-and-range type\n primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>\n ",
|
|
3319
3319
|
"required": true
|
|
3320
3320
|
},
|
|
3321
3321
|
"AttributesToGet": {
|
|
@@ -3328,7 +3328,7 @@
|
|
|
3328
3328
|
"documentation": null
|
|
3329
3329
|
},
|
|
3330
3330
|
"min_length": 1,
|
|
3331
|
-
"documentation": " <p>The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.</p>\n "
|
|
3331
|
+
"documentation": " <p>The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.</p>\n <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. \n DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</p>\n "
|
|
3332
3332
|
},
|
|
3333
3333
|
"ConsistentRead": {
|
|
3334
3334
|
"shape_name": "ConsistentRead",
|
|
@@ -3343,7 +3343,7 @@
|
|
|
3343
3343
|
"TOTAL",
|
|
3344
3344
|
"NONE"
|
|
3345
3345
|
],
|
|
3346
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
3346
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
3347
3347
|
}
|
|
3348
3348
|
},
|
|
3349
3349
|
"documentation": "\n <p>Represents the input of a <i>GetItem</i> operation.</p>\n "
|
|
@@ -3413,7 +3413,7 @@
|
|
|
3413
3413
|
},
|
|
3414
3414
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
3415
3415
|
},
|
|
3416
|
-
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, as specified by
|
|
3416
|
+
"documentation": "\n <p>A map of attribute names to <i>AttributeValue</i> objects, as specified by\n <i>AttributesToGet</i>.</p>\n "
|
|
3417
3417
|
},
|
|
3418
3418
|
"ConsumedCapacity": {
|
|
3419
3419
|
"shape_name": "ConsumedCapacity",
|
|
@@ -3465,7 +3465,7 @@
|
|
|
3465
3465
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
3466
3466
|
}
|
|
3467
3467
|
},
|
|
3468
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
3468
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
3469
3469
|
},
|
|
3470
3470
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
3471
3471
|
},
|
|
@@ -3490,12 +3490,12 @@
|
|
|
3490
3490
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
3491
3491
|
}
|
|
3492
3492
|
},
|
|
3493
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
3493
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
3494
3494
|
},
|
|
3495
3495
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
3496
3496
|
}
|
|
3497
3497
|
},
|
|
3498
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
3498
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
3499
3499
|
}
|
|
3500
3500
|
},
|
|
3501
3501
|
"documentation": "\n <p>Represents the output of a <i>GetItem</i> operation.</p>\n "
|
|
@@ -3511,7 +3511,7 @@
|
|
|
3511
3511
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
3512
3512
|
}
|
|
3513
3513
|
},
|
|
3514
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
3514
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
3515
3515
|
},
|
|
3516
3516
|
{
|
|
3517
3517
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -3523,7 +3523,7 @@
|
|
|
3523
3523
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
3524
3524
|
}
|
|
3525
3525
|
},
|
|
3526
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
3526
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
3527
3527
|
},
|
|
3528
3528
|
{
|
|
3529
3529
|
"shape_name": "InternalServerError",
|
|
@@ -3538,7 +3538,7 @@
|
|
|
3538
3538
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
3539
3539
|
}
|
|
3540
3540
|
],
|
|
3541
|
-
"documentation": "\n <p>The <i>GetItem</i> operation returns a set of attributes for the item with the given primary\n key. If there is no matching item, <i>GetItem</i> does not return any data.</p>\n <p><i>GetItem</i> provides an eventually consistent read by default. If your application\n requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although\n a strongly consistent read might take more time than an eventually consistent read, it always\n returns the last updated value.</p>\n <examples>\n <example>\n <name>Retrieve Item Attributes</name>\n <description>This example retrieves three attributes from the Thread table. In the response,\n the ConsumedCapacityUnits value is 1, because ConsistentRead is set to true. If\n ConsistentRead had been set to false (or not specified) for the same request, an\n eventually consistent read would have been used and ConsumedCapacityUnits would have been\n 0.5.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]
|
|
3541
|
+
"documentation": "\n <p>The <i>GetItem</i> operation returns a set of attributes for the item with the given primary\n key. If there is no matching item, <i>GetItem</i> does not return any data.</p>\n <p><i>GetItem</i> provides an eventually consistent read by default. If your application\n requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although\n a strongly consistent read might take more time than an eventually consistent read, it always\n returns the last updated value.</p>\n <examples>\n <example>\n <name>Retrieve Item Attributes</name>\n <description>This example retrieves three attributes from the Thread table. In the response,\n the ConsumedCapacityUnits value is 1, because ConsistentRead is set to true. If\n ConsistentRead had been set to false (or not specified) for the same request, an\n eventually consistent read would have been used and ConsumedCapacityUnits would have been\n 0.5.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.GetItem \n\n{\n \"TableName\": \"Thread\",\n \"Key\": {\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"Subject\": {\n \"S\": \"How do I update multiple items?\"\n }\n },\n \"AttributesToGet\": [\"LastPostDateTime\",\"Message\",\"Tags\"],\n \"ConsistentRead\": true,\n \"ReturnConsumedCapacity\": \"TOTAL\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"ConsumedCapacity\": {\n \"CapacityUnits\": 1,\n \"TableName\": \"Thread\"\n },\n \"Item\": {\n \"Tags\": {\n \"SS\": [\"Update\",\"Multiple Items\",\"HelpMe\"]\n },\n \"LastPostDateTime\": {\n \"S\": \"201303190436\"\n },\n \"Message\": {\n \"S\": \"I want to update multiple items in a single API call. What's the best way to do that?\"\n }\n }\n}\n </response>\n </example>\n </examples>\n "
|
|
3542
3542
|
},
|
|
3543
3543
|
"ListTables": {
|
|
3544
3544
|
"name": "ListTables",
|
|
@@ -3552,14 +3552,14 @@
|
|
|
3552
3552
|
"min_length": 3,
|
|
3553
3553
|
"max_length": 255,
|
|
3554
3554
|
"pattern": "[a-zA-Z0-9_.-]+",
|
|
3555
|
-
"documentation": "\n <p>The
|
|
3555
|
+
"documentation": "\n <p>The first table name that this operation will evaluate. Use the value that was returned for\n <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page\n of results.</p>\n "
|
|
3556
3556
|
},
|
|
3557
3557
|
"Limit": {
|
|
3558
3558
|
"shape_name": "ListTablesInputLimit",
|
|
3559
3559
|
"type": "integer",
|
|
3560
3560
|
"min_length": 1,
|
|
3561
3561
|
"max_length": 100,
|
|
3562
|
-
"documentation": "\n <p> A maximum number of table names to return.</p>\n "
|
|
3562
|
+
"documentation": "\n <p> A maximum number of table names to return. If this parameter is not specified, the limit is\n 100.</p>\n "
|
|
3563
3563
|
}
|
|
3564
3564
|
},
|
|
3565
3565
|
"documentation": "\n <p>Represents the input of a <i>ListTables</i> operation.</p>\n "
|
|
@@ -3579,7 +3579,7 @@
|
|
|
3579
3579
|
"pattern": "[a-zA-Z0-9_.-]+",
|
|
3580
3580
|
"documentation": null
|
|
3581
3581
|
},
|
|
3582
|
-
"documentation": "\n <p>The names of the tables associated with the current account at the current endpoint.</p>\n "
|
|
3582
|
+
"documentation": "\n <p>The names of the tables associated with the current account at the current endpoint. The\n maximum size of this array is 100. </p>\n <p>If <i>LastEvaluatedTableName</i> also appears in the output, you can use this value as the\n <i>ExclusiveStartTableName</i> parameter in a subsequent <i>ListTables</i> request and\n obtain the next page of results.</p>\n "
|
|
3583
3583
|
},
|
|
3584
3584
|
"LastEvaluatedTableName": {
|
|
3585
3585
|
"shape_name": "TableName",
|
|
@@ -3587,7 +3587,7 @@
|
|
|
3587
3587
|
"min_length": 3,
|
|
3588
3588
|
"max_length": 255,
|
|
3589
3589
|
"pattern": "[a-zA-Z0-9_.-]+",
|
|
3590
|
-
"documentation": "\n <p>The name of the last table in the current
|
|
3590
|
+
"documentation": "\n <p>The name of the last table in the current page of results. Use this value as the\n <i>ExclusiveStartTableName</i> in a new request to obtain the next page of results, until\n all the table names are returned.</p>\n <p>If you do not receive a <i>LastEvaluatedTableName</i> value in the response, this means that\n there are no more table names to be retrieved.</p>\n "
|
|
3591
3591
|
}
|
|
3592
3592
|
},
|
|
3593
3593
|
"documentation": "\n <p>Represents the output of a <i>ListTables</i> operation.</p>\n "
|
|
@@ -3606,7 +3606,7 @@
|
|
|
3606
3606
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
3607
3607
|
}
|
|
3608
3608
|
],
|
|
3609
|
-
"documentation": "\n <p>Returns an array of
|
|
3609
|
+
"documentation": "\n <p>Returns an array of table names associated with the current account and endpoint. The output\n from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table\n names.</p>\n <examples>\n <example>\n <name>List Tables</name>\n <description>\n <p>This example requests a list of tables, starting with a table named <i>Forum</i> and\n ending after three table names have been returned.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.ListTables \n\n{\n \"ExclusiveStartTableName\": \"Forum\",\n \"Limit\": 3\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"LastEvaluatedTableName\": \"Thread\",\n \"TableNames\": [\"Forum\",\"Reply\",\"Thread\"]\n}\n </response>\n </example>\n </examples>\n "
|
|
3610
3610
|
},
|
|
3611
3611
|
"PutItem": {
|
|
3612
3612
|
"name": "PutItem",
|
|
@@ -3684,7 +3684,7 @@
|
|
|
3684
3684
|
},
|
|
3685
3685
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
3686
3686
|
},
|
|
3687
|
-
"documentation": "\n <p>A map of attribute name/value pairs, one for each attribute. Only the primary key\n
|
|
3687
|
+
"documentation": "\n <p>A map of attribute name/value pairs, one for each attribute. Only the primary key attributes\n are required; you can optionally provide other attribute name-value pairs for the item.</p>\n <p>You must provide <i>all</i> of the attributes for the primary key. For example, with a hash\n type primary key, you only need to specify the hash attribute. For a hash-and-range type\n primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>\n <p>If you specify any attributes that are part of an index key, then the data types for those\n attributes must match those of the schema in the table's attribute definition.</p>\n <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\n Amazon DynamoDB Developer Guide.</p>\n <p>Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</p>\n ",
|
|
3688
3688
|
"required": true
|
|
3689
3689
|
},
|
|
3690
3690
|
"Expected": {
|
|
@@ -3755,7 +3755,7 @@
|
|
|
3755
3755
|
"Exists": {
|
|
3756
3756
|
"shape_name": "BooleanObject",
|
|
3757
3757
|
"type": "boolean",
|
|
3758
|
-
"documentation": "\n <p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n
|
|
3758
|
+
"documentation": "\n <p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute value\n already exists in the table. If it is found, then the operation succeeds. If it is not\n found, the operation fails with a <i>ConditionalCheckFailedException</i>.</p>\n </li>\n <li>\n <p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does\n <i>not</i> exist in the table. If in fact the value does not exist, then the assumption\n is valid and the operation succeeds. If the value is found, despite the assumption that it\n does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>.</p>\n </li>\n </ul>\n <p>The default setting for <i>Exists</i> is <code>true</code>. If you supply a <i>Value</i> all\n by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to\n <code>true</code>, because it is implied.</p>\n <p>DynamoDB returns a <i>ValidationException</i> if:</p>\n <ul>\n <li>\n <p><i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect a\n value to exist, but don't specify what that value is.)</p>\n </li>\n <li>\n <p><i>Exists</i> is <code>false</code> but you also specify a <i>Value</i>. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)</p>\n </li>\n </ul>\n "
|
|
3759
3759
|
},
|
|
3760
3760
|
"ComparisonOperator": {
|
|
3761
3761
|
"shape_name": "ComparisonOperator",
|
|
@@ -3775,7 +3775,7 @@
|
|
|
3775
3775
|
"NOT_CONTAINS",
|
|
3776
3776
|
"BEGINS_WITH"
|
|
3777
3777
|
],
|
|
3778
|
-
"documentation":
|
|
3778
|
+
"documentation": "\n <p>A comparator for evaluating attributes in the <i>AttributeValueList</i>. For example, equals,\n greater than, less than, etc.</p> \n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n \n <p>The following are descriptions of each comparison operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n "
|
|
3779
3779
|
},
|
|
3780
3780
|
"AttributeValueList": {
|
|
3781
3781
|
"shape_name": "AttributeValueList",
|
|
@@ -3832,12 +3832,12 @@
|
|
|
3832
3832
|
},
|
|
3833
3833
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
3834
3834
|
},
|
|
3835
|
-
"documentation":
|
|
3835
|
+
"documentation": "\n <p>One or more values to evaluate against the supplied attribute.\n The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code>\n 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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n <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>\n "
|
|
3836
3836
|
}
|
|
3837
3837
|
},
|
|
3838
|
-
"documentation": "\n <p>Represents an attribute value used
|
|
3838
|
+
"documentation": "\n <p>Represents a condition to be compared with an attribute value. This condition can be used\n with <i>DeleteItem</i>, <i>PutItem</i> or <i>UpdateItem</i> operations; if the comparison\n evaluates to true, the operation succeeds; if not the operation fails. You can use\n <i>ExpectedAttributeValue</i> in one of two different ways:</p>\n <ul>\n <li>\n <p>Use <i>AttributeValueList</i> to specify one or more values to compare against an\n attribute. Use <i>ComparisonOperator</i> to specify how you want to perform the\n comparison. If the comparison evaluates to true, then the conditional operation\n succeeds.</p>\n </li>\n <li>\n <p>Use <i>Value</i> to specify a value that DynamoDB will compare against an attribute. If the\n values match, then <i>ExpectedAttributeValue</i> evaluates to true and the conditional\n operation succeeds. Optionally, you can also set <i>Exists</i> to false, indicating that\n you <i>do not</i> expect to find the attribute value in the table. In this case, the\n conditional operation succeeds only if the comparison evaluates to false.</p>\n </li>\n </ul>\n <p><i>Value</i> and <i>Exists</i> are incompatible with <i>AttributeValueList</i> and \n <i>ComparisonOperator</i>. If you attempt to use both sets of parameters at once, DynamoDB will\n throw a <i>ValidationException</i>.</p>\n\n <important>\n <p>The <i>Value</i> and <i>Exists</i> parameters are deprecated. Even though DynamoDB will\n continue to support these parameters, we recommend that you use <i>AttributeValueList</i>\n and <i>ComparisonOperator</i> instead. <i>AttributeValueList</i> and\n <i>ComparisonOperator</i> let you construct a much wider range of conditions than is\n possible with <i>Value</i> and <i>Exists</i>.</p>\n </important>\n "
|
|
3839
3839
|
},
|
|
3840
|
-
"documentation": "\n <p>A map of attribute/condition pairs. This is the conditional block for the <i>PutItem</i> operation. All the conditions must be met for the operation to succeed.</p> <p><i>Expected</i> allows you to\n provide an attribute name, and whether or not DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.</p>\n <p>Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with\n the following: </p>\n <ul>\n <li>\n <p><i>Value</i> - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used.</p>\n </li>\n <li>\n <p><i>Exists</i> - Causes DynamoDB to evaluate the value before attempting a conditional\n operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n <i>ConditionalCheckFailedException</i>.</p>\n </li>\n <li>\n <p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does\n <i>not</i> exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n <i>ConditionalCheckFailedException</i>.</p>\n </li>\n </ul>\n <p>The default setting for <i>Exists</i> is <code>true</code>. If you supply a <i>Value</i>\n all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <code>true</code>, because it is\n implied.</p>\n <p>DynamoDB returns a <i>ValidationException</i> if:</p>\n <ul>\n <li>\n <p><i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect\n a value to exist, but don't specify what that value is.)</p>\n </li>\n <li>\n <p><i>Exists</i> is <code>false</code> but you also specify a <i>Value</i>. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>If you specify more than one condition for <i>Exists</i>, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.</p>\n \n "
|
|
3840
|
+
"documentation": "\n <p>A map of attribute/condition pairs. This is the conditional block for the <i>PutItem</i>\n 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>\n\n <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>\n <p>If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails.</p>\n \n <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>\n \n <ul>\n <li>\n <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied\n attribute. The number of values in the list depends on the <i>ComparisonOperator</i>\n being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, <code>a</code> is greater than <code>A</code>, and\n <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a\n href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\"\n >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n </li>\n <li>\n <p><i>ComparisonOperator</i> - A comparator for evaluating attributes in the\n <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads.</p>\n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n\n <p>The following are descriptions of each comparison operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n </li>\n </ul>\n <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\"\n >Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>\n <note>\n <p>For backward compatibility with previous DynamoDB releases, the following parameters can be\n used instead of <i>AttributeValueList</i> and <i>ComparisonOperator</i>:</p>\n <ul>\n <li>\n <p><i>Value</i> - A value for DynamoDB to compare with an attribute.</p>\n </li>\n <li>\n <p><i>Exists</i> - Causes DynamoDB to evaluate the value before attempting the conditional\n operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the condition evaluates to\n true; otherwise the condition evaluate to false.</p>\n </li>\n <li><p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value\n does <i>not</i> exist in the table. If in fact the value does not exist, then the\n assumption is valid and the condition evaluates to true. If the value is found,\n despite the assumption that it does not exist, the condition evaluates to\n false.</p></li>\n </ul>\n </li>\n </ul>\n <p>Even though DynamoDB continues to accept the <i>Value</i> and <i>Exists</i> parameters, they\n are now deprecated. We recommend that you use <i>AttributeValueList</i> and\n <i>ComparisonOperator</i> instead, since they allow you to construct a much wider range of\n conditions.</p>\n <p>The <i>Value</i> and <i>Exists</i> parameters are incompatible with\n <i>AttributeValueList</i> and <i>ComparisonOperator</i>. If you attempt to use both sets\n of parameters at once, DynamoDB will throw a <i>ValidationException</i>.</p>\n </note>\n "
|
|
3841
3841
|
},
|
|
3842
3842
|
"ReturnValues": {
|
|
3843
3843
|
"shape_name": "ReturnValue",
|
|
@@ -3849,7 +3849,7 @@
|
|
|
3849
3849
|
"ALL_NEW",
|
|
3850
3850
|
"UPDATED_NEW"
|
|
3851
3851
|
],
|
|
3852
|
-
"documentation": "\n <p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they
|
|
3852
|
+
"documentation": "\n <p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they\n were updated with the <i>PutItem</i> request. For <i>PutItem</i>, the valid values are:</p>\n <ul>\n <li>\n <p><code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is\n <code>NONE</code>, then nothing is returned. (This is the default for\n <i>ReturnValues</i>.)</p>\n </li>\n <li>\n <p><code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the\n content of the old item is returned.</p>\n </li>\n </ul>\n\n "
|
|
3853
3853
|
},
|
|
3854
3854
|
"ReturnConsumedCapacity": {
|
|
3855
3855
|
"shape_name": "ReturnConsumedCapacity",
|
|
@@ -3859,7 +3859,7 @@
|
|
|
3859
3859
|
"TOTAL",
|
|
3860
3860
|
"NONE"
|
|
3861
3861
|
],
|
|
3862
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
3862
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
3863
3863
|
},
|
|
3864
3864
|
"ReturnItemCollectionMetrics": {
|
|
3865
3865
|
"shape_name": "ReturnItemCollectionMetrics",
|
|
@@ -3877,7 +3877,7 @@
|
|
|
3877
3877
|
"AND",
|
|
3878
3878
|
"OR"
|
|
3879
3879
|
],
|
|
3880
|
-
"documentation":
|
|
3880
|
+
"documentation": "\n <p>A logical operator to apply to the conditions in the <i>Expected</i> map:</p>\n <ul>\n <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li>\n <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>\n </ul>\n <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p>\n <p>The operation will succeed only if the entire map evaluates to true.</p>\n "
|
|
3881
3881
|
}
|
|
3882
3882
|
},
|
|
3883
3883
|
"documentation": "\n <p>Represents the input of a <i>PutItem</i> operation.</p>\n "
|
|
@@ -3947,7 +3947,7 @@
|
|
|
3947
3947
|
},
|
|
3948
3948
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
3949
3949
|
},
|
|
3950
|
-
"documentation": "\n <p>The attribute values as they appeared before the <i>PutItem</i> operation, but only if
|
|
3950
|
+
"documentation": "\n <p>The attribute values as they appeared before the <i>PutItem</i> operation, but only if\n <i>ReturnValues</i> is specified as <code>ALL_OLD</code> in the request. Each element\n consists of an attribute name and an attribute value.</p>\n "
|
|
3951
3951
|
},
|
|
3952
3952
|
"ConsumedCapacity": {
|
|
3953
3953
|
"shape_name": "ConsumedCapacity",
|
|
@@ -3999,7 +3999,7 @@
|
|
|
3999
3999
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
4000
4000
|
}
|
|
4001
4001
|
},
|
|
4002
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
4002
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
4003
4003
|
},
|
|
4004
4004
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
4005
4005
|
},
|
|
@@ -4024,12 +4024,12 @@
|
|
|
4024
4024
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
4025
4025
|
}
|
|
4026
4026
|
},
|
|
4027
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
4027
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
4028
4028
|
},
|
|
4029
4029
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
4030
4030
|
}
|
|
4031
4031
|
},
|
|
4032
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
4032
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4033
4033
|
},
|
|
4034
4034
|
"ItemCollectionMetrics": {
|
|
4035
4035
|
"shape_name": "ItemCollectionMetrics",
|
|
@@ -4096,7 +4096,7 @@
|
|
|
4096
4096
|
},
|
|
4097
4097
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
4098
4098
|
},
|
|
4099
|
-
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p
|
|
4099
|
+
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p>\n "
|
|
4100
4100
|
},
|
|
4101
4101
|
"SizeEstimateRangeGB": {
|
|
4102
4102
|
"shape_name": "ItemCollectionSizeEstimateRange",
|
|
@@ -4106,7 +4106,7 @@
|
|
|
4106
4106
|
"type": "double",
|
|
4107
4107
|
"documentation": null
|
|
4108
4108
|
},
|
|
4109
|
-
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a
|
|
4109
|
+
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the size\n of all the items in the table, plus the size of all attributes projected into all of the\n local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size\n limit.</p>\n <p>The estimate is subject to change over time; therefore, do not rely on the precision or\n accuracy of the estimate.</p>\n "
|
|
4110
4110
|
}
|
|
4111
4111
|
},
|
|
4112
4112
|
"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\n does not have any local secondary indexes, this information is not\n returned in the response.</p>\n <p>Each <i>ItemCollectionMetrics</i>\n element consists of:</p>\n <ul>\n <li><p><i>ItemCollectionKey</i> - The hash key value of the item\n collection. This is the same as the hash key of the item.</p></li>\n <li><p><i>SizeEstimateRange</i> - An estimate of item collection size,\n measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.</p>\n <p>The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.</p>\n</li>\n </ul>\n "
|
|
@@ -4137,7 +4137,7 @@
|
|
|
4137
4137
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
4138
4138
|
}
|
|
4139
4139
|
},
|
|
4140
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
4140
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4141
4141
|
},
|
|
4142
4142
|
{
|
|
4143
4143
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -4149,7 +4149,7 @@
|
|
|
4149
4149
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
4150
4150
|
}
|
|
4151
4151
|
},
|
|
4152
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
4152
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
4153
4153
|
},
|
|
4154
4154
|
{
|
|
4155
4155
|
"shape_name": "ItemCollectionSizeLimitExceededException",
|
|
@@ -4176,7 +4176,7 @@
|
|
|
4176
4176
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
4177
4177
|
}
|
|
4178
4178
|
],
|
|
4179
|
-
"documentation": "\n <p>Creates a new item, or replaces an old item with a new item. If an item already exists in the\n specified table with the same primary key, the new item completely replaces the existing item.\n You can perform a conditional put (insert a new item if one with the specified primary key\n doesn't exist), or replace an existing item if it has certain attribute values. </p>\n <p>In addition to putting an item, you can also return the item's attribute values in the same
|
|
4179
|
+
"documentation": "\n <p>Creates a new item, or replaces an old item with a new item. If an item already exists in the\n specified table with the same primary key, the new item completely replaces the existing item.\n You can perform a conditional put (insert a new item if one with the specified primary key\n doesn't exist), or replace an existing item if it has certain attribute values. </p>\n <p>In addition to putting an item, you can also return the item's attribute values in the same\n operation, using the <i>ReturnValues</i> parameter.</p>\n <p>When you add an item, the primary key attribute(s) are the only required attributes.\n Attribute values cannot be null. String and binary type attributes must have lengths greater\n than zero. Set type attributes cannot be empty. Requests with empty values will be rejected\n with a <i>ValidationException</i>.</p>\n <p>You can request that <i>PutItem</i> return either a copy of the old item (before the update)\n or a copy of the new item (after the update). For more information, see the\n <i>ReturnValues</i> description.</p>\n <note>\n <p>To prevent a new item from replacing an existing item, use a conditional put operation with\n <i>ComparisonOperator</i> set to <code>NULL</code> for the primary key attribute, or attributes.</p>\n </note>\n <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>\n <examples>\n <example>\n <name>Put an Item</name>\n <description>\n <p>This example puts a new item into the Thread table. To prevent this new item from\n overwriting an existing item, \"ComparisonOperator\" is set to NULL for the primary key\n attributes.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.PutItem \n\n{\n \"TableName\": \"Thread\",\n \"Item\": {\n \"LastPostDateTime\": {\n \"S\": \"201303190422\"\n },\n \"Tags\": {\n \"SS\": [\"Update\",\"Multiple Items\",\"HelpMe\"]\n },\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"Message\": {\n \"S\": \"I want to update multiple items in a single API call. What's the best way to do that?\"\n },\n \"Subject\": {\n \"S\": \"How do I update multiple items?\"\n },\n \"LastPostedBy\": {\n \"S\": \"fred@example.com\"\n }\n },\n \"Expected\": {\n \"ForumName\": {\n \"ComparisonOperator\": \"NULL\",\n },\n \"Subject\": {\n \"ComparisonOperator\": \"NULL\",\n }\n }\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n}\n </response>\n </example>\n </examples>\n "
|
|
4180
4180
|
},
|
|
4181
4181
|
"Query": {
|
|
4182
4182
|
"name": "Query",
|
|
@@ -4210,7 +4210,7 @@
|
|
|
4210
4210
|
"SPECIFIC_ATTRIBUTES",
|
|
4211
4211
|
"COUNT"
|
|
4212
4212
|
],
|
|
4213
|
-
"documentation": "\n <p>The attributes to be returned in the result. You can
|
|
4213
|
+
"documentation": "\n <p>The attributes to be returned in the result. You can retrieve all item attributes, specific\n item attributes, the count of matching items, or in the case of an index, some or all of the\n attributes projected into the index.</p>\n <ul>\n <li>\n <p><code>ALL_ATTRIBUTES</code>: Returns all of the item attributes from the specified table\n or index. If you are querying a local secondary index, then for each matching item in the index DynamoDB will\n fetch the entire item from the parent table. If the index is configured to project all\n item attributes, then all of the data can be obtained from the local secondary index, and no fetching is\n required..</p>\n </li>\n <li>\n <p><code>ALL_PROJECTED_ATTRIBUTES</code>: Allowed only when querying an index. Retrieves all\n attributes which have been projected into the index. If the index is configured to project\n all attributes, this is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p>\n </li>\n <li>\n <p><code>COUNT</code>: Returns the number of matching items, rather than the matching items\n themselves.</p>\n </li>\n <li>\n <p>\n <code>SPECIFIC_ATTRIBUTES</code> : Returns only the attributes listed in\n <i>AttributesToGet</i>. This is equivalent to specifying <i>AttributesToGet</i> without\n 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>\n\n<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>\n </li>\n </ul>\n <p>If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to\n <code>ALL_ATTRIBUTES</code> when accessing a table, and\n <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both\n <i>Select</i> and <i>AttributesToGet</i> together in a single request, <i>unless</i> the\n value for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to\n specifying <i>AttributesToGet</i> without any value for <i>Select</i>.)</p>\n "
|
|
4214
4214
|
},
|
|
4215
4215
|
"AttributesToGet": {
|
|
4216
4216
|
"shape_name": "AttributeNameList",
|
|
@@ -4222,18 +4222,18 @@
|
|
|
4222
4222
|
"documentation": null
|
|
4223
4223
|
},
|
|
4224
4224
|
"min_length": 1,
|
|
4225
|
-
"documentation": " <p>The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.</p>\n \n <p>You cannot use both
|
|
4225
|
+
"documentation": " <p>The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.</p>\n <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. \n DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</p>\n <p>You cannot use both\n <i>AttributesToGet</i> and <i>Select</i> together in a <i>Query</i> request, <i>unless</i>\n the value for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to\n 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>\n\n<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>\n "
|
|
4226
4226
|
},
|
|
4227
4227
|
"Limit": {
|
|
4228
4228
|
"shape_name": "PositiveIntegerObject",
|
|
4229
4229
|
"type": "integer",
|
|
4230
4230
|
"min_length": 1,
|
|
4231
|
-
"documentation": " <p>The maximum number of items to evaluate (not necessarily the number of matching items). If\n DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to\n continue the operation. For more information see <a\n href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\"\n >Query and Scan</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4231
|
+
"documentation": " <p>The maximum number of items to evaluate (not necessarily the number of matching items). If\n DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to\n continue the operation. For more information, see <a\n href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\"\n >Query and Scan</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4232
4232
|
},
|
|
4233
4233
|
"ConsistentRead": {
|
|
4234
4234
|
"shape_name": "ConsistentRead",
|
|
4235
4235
|
"type": "boolean",
|
|
4236
|
-
"documentation": " <p>If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, eventually\n consistent reads are used.</p>\n
|
|
4236
|
+
"documentation": " <p>If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, eventually\n consistent reads are used.</p>\n <p>Strongly consistent reads\n are not supported on global secondary indexes. If you query a global secondary index with <i>ConsistentRead</i> set to\n <code>true</code>, you will receive an error message.</p>\n "
|
|
4237
4237
|
},
|
|
4238
4238
|
"KeyConditions": {
|
|
4239
4239
|
"shape_name": "KeyConditions",
|
|
@@ -4303,7 +4303,7 @@
|
|
|
4303
4303
|
},
|
|
4304
4304
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
4305
4305
|
},
|
|
4306
|
-
"documentation": "\n <p>One or more values to evaluate against the supplied attribute.
|
|
4306
|
+
"documentation": "\n <p>One or more values to evaluate against the supplied attribute. The number of values in the\n list depends on the <i>ComparisonOperator</i> being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code>\n 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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n\n "
|
|
4307
4307
|
},
|
|
4308
4308
|
"ComparisonOperator": {
|
|
4309
4309
|
"shape_name": "ComparisonOperator",
|
|
@@ -4323,13 +4323,14 @@
|
|
|
4323
4323
|
"NOT_CONTAINS",
|
|
4324
4324
|
"BEGINS_WITH"
|
|
4325
4325
|
],
|
|
4326
|
-
"documentation": "\n <p>A comparator for evaluating attributes. For example, equals, greater than, less
|
|
4326
|
+
"documentation": "\n <p>A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.</p> \n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n \n <p>The following are descriptions of each comparison\n operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n <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>\n ",
|
|
4327
4327
|
"required": true
|
|
4328
4328
|
}
|
|
4329
4329
|
},
|
|
4330
|
-
"documentation": "\n <p>Represents
|
|
4330
|
+
"documentation": "\n <p>Represents the selection criteria for a <i>Query</i> or <i>Scan</i> operation:</p>\n <ul>\n <li>\n <p>For a <i>Query</i> operation, <i>Condition</i> is used for specifying the\n <i>KeyConditions</i> to use when querying a table or an index. For <i>KeyConditions</i>,\n only the following comparison operators are supported:</p>\n <p>\n <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code>\n </p>\n <p><i>Condition</i> is also used in a <i>QueryFilter</i>, which evaluates the query results\n and returns only the desired values.</p>\n </li>\n <li>\n <p>For a <i>Scan</i> operation, <i>Condition</i> is used in a <i>ScanFilter</i>, which\n evaluates the scan results and returns only the desired values.</p>\n </li>\n </ul>\n "
|
|
4331
4331
|
},
|
|
4332
|
-
"documentation": "\n <p>The selection criteria for the query.</p>\n <p>For a query on a table, you can only have conditions on the table primary key attributes. You\n
|
|
4332
|
+
"documentation": "\n <p>The selection criteria for the query.</p>\n <p>For a query on a table, you can only have conditions on the table primary key attributes. You\n <i>must</i> specify the hash key attribute name and value as an <code>EQ</code> condition.\n You can <i>optionally</i> specify a second condition, referring to the range key\n attribute.</p>\n <p>For a query on an index, you can only have conditions on the index key attributes. You\n <i>must</i> specify the index hash attribute name and value as an EQ condition. You can\n <i>optionally</i> specify a second condition, referring to the index key range\n attribute.</p>\n <p>If you specify more than one condition in the <i>KeyConditions</i> map, then by default all\n of the conditions must evaluate to true. In other words, the conditions are ANDed together.\n (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do\n this, then at least one of the conditions must evaluate to true, rather than all of them.)</p>\n <p>Each <i>KeyConditions</i> element consists of an attribute name to compare, along with the\n following:</p>\n <ul>\n <li>\n <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied\n attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being\n used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, <code>a</code> is greater than <code>A</code>, and\n <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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n </li>\n <li>\n <p><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals,\n greater than, less than, etc.</p>\n\n <p>For <i>KeyConditions</i>, only the following comparison operators are supported:</p>\n <p>\n <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code>\n </p>\n <p>The following are descriptions of these comparison operators.</p>\n <ul>\n <li>\n <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a\n different type than the one specified in the request, the value does not match. For\n example, <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p></p>\n </li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n </li>\n </ul>\n <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>\n in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
4333
|
+
"required": true
|
|
4333
4334
|
},
|
|
4334
4335
|
"QueryFilter": {
|
|
4335
4336
|
"shape_name": "FilterConditionMap",
|
|
@@ -4399,7 +4400,7 @@
|
|
|
4399
4400
|
},
|
|
4400
4401
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
4401
4402
|
},
|
|
4402
|
-
"documentation": "\n <p>One or more values to evaluate against the supplied attribute.
|
|
4403
|
+
"documentation": "\n <p>One or more values to evaluate against the supplied attribute. The number of values in the\n list depends on the <i>ComparisonOperator</i> being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code>\n 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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n\n "
|
|
4403
4404
|
},
|
|
4404
4405
|
"ComparisonOperator": {
|
|
4405
4406
|
"shape_name": "ComparisonOperator",
|
|
@@ -4419,13 +4420,13 @@
|
|
|
4419
4420
|
"NOT_CONTAINS",
|
|
4420
4421
|
"BEGINS_WITH"
|
|
4421
4422
|
],
|
|
4422
|
-
"documentation": "\n <p>A comparator for evaluating attributes. For example, equals, greater than, less
|
|
4423
|
+
"documentation": "\n <p>A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.</p> \n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n \n <p>The following are descriptions of each comparison\n operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n <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>\n ",
|
|
4423
4424
|
"required": true
|
|
4424
4425
|
}
|
|
4425
4426
|
},
|
|
4426
|
-
"documentation": "\n <p>Represents
|
|
4427
|
+
"documentation": "\n <p>Represents the selection criteria for a <i>Query</i> or <i>Scan</i> operation:</p>\n <ul>\n <li>\n <p>For a <i>Query</i> operation, <i>Condition</i> is used for specifying the\n <i>KeyConditions</i> to use when querying a table or an index. For <i>KeyConditions</i>,\n only the following comparison operators are supported:</p>\n <p>\n <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code>\n </p>\n <p><i>Condition</i> is also used in a <i>QueryFilter</i>, which evaluates the query results\n and returns only the desired values.</p>\n </li>\n <li>\n <p>For a <i>Scan</i> operation, <i>Condition</i> is used in a <i>ScanFilter</i>, which\n evaluates the scan results and returns only the desired values.</p>\n </li>\n </ul>\n "
|
|
4427
4428
|
},
|
|
4428
|
-
"documentation":
|
|
4429
|
+
"documentation": "\n <p>Evaluates the query results and returns only the desired values.</p>\n <p>If you specify more than one condition in the <i>QueryFilter</i> map, then by default all of\n the conditions must evaluate to true. In other words, the conditions are ANDed together. (You\n can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this,\n then at least one of the conditions must evaluate to true, rather than all of them.)</p>\n <p>Each <i>QueryFilter</i> element consists of an attribute name to compare, along with the\n following:</p>\n <ul>\n <li>\n <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied\n attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being\n used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, <code>a</code> is greater than <code>A</code>, and\n <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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n <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>\n </li>\n <li>\n<p><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example,\n equals, greater than, less than, etc.</p> <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n <p>For complete\n descriptions of all comparison operators, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html\">API_Condition.html</a>.</p>\n </li>\n </ul>\n "
|
|
4429
4430
|
},
|
|
4430
4431
|
"ConditionalOperator": {
|
|
4431
4432
|
"shape_name": "ConditionalOperator",
|
|
@@ -4434,12 +4435,12 @@
|
|
|
4434
4435
|
"AND",
|
|
4435
4436
|
"OR"
|
|
4436
4437
|
],
|
|
4437
|
-
"documentation":
|
|
4438
|
+
"documentation": "\n <p>A logical operator to apply to the conditions in the <i>QueryFilter</i> map:</p>\n <ul>\n <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li>\n <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>\n </ul>\n <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p>\n <p>The operation will succeed only if the entire map evaluates to true.</p>\n "
|
|
4438
4439
|
},
|
|
4439
4440
|
"ScanIndexForward": {
|
|
4440
4441
|
"shape_name": "BooleanObject",
|
|
4441
4442
|
"type": "boolean",
|
|
4442
|
-
"documentation": "\n <p>Specifies ascending (true) or descending (false) traversal of the index. DynamoDB returns
|
|
4443
|
+
"documentation": "\n <p>Specifies ascending (true) or descending (false) traversal of the index. DynamoDB returns\n results reflecting the requested order determined by the range key. If the data type is\n Number, the results are returned in numeric order. For String, the results are returned in\n order of ASCII character code values. For Binary, DynamoDB treats each byte of the binary data as\n unsigned when it compares binary values.</p>\n <p>If <i>ScanIndexForward</i> is not specified, the results are returned in ascending order.</p>\n "
|
|
4443
4444
|
},
|
|
4444
4445
|
"ExclusiveStartKey": {
|
|
4445
4446
|
"shape_name": "Key",
|
|
@@ -4502,7 +4503,7 @@
|
|
|
4502
4503
|
},
|
|
4503
4504
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
4504
4505
|
},
|
|
4505
|
-
"documentation": " <p>The primary key of the first item that this operation will
|
|
4506
|
+
"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>\n <p>The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed.</p> \n "
|
|
4506
4507
|
},
|
|
4507
4508
|
"ReturnConsumedCapacity": {
|
|
4508
4509
|
"shape_name": "ReturnConsumedCapacity",
|
|
@@ -4512,7 +4513,7 @@
|
|
|
4512
4513
|
"TOTAL",
|
|
4513
4514
|
"NONE"
|
|
4514
4515
|
],
|
|
4515
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
4516
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
4516
4517
|
}
|
|
4517
4518
|
},
|
|
4518
4519
|
"documentation": "\n <p>Represents the input of a <i>Query</i> operation.</p>\n "
|
|
@@ -4587,17 +4588,17 @@
|
|
|
4587
4588
|
},
|
|
4588
4589
|
"documentation": null
|
|
4589
4590
|
},
|
|
4590
|
-
"documentation": "\n <p>An array of item attributes that match the query criteria. Each element in this array
|
|
4591
|
+
"documentation": "\n <p>An array of item attributes that match the query criteria. Each element in this array\n consists of an attribute name and the value for that attribute.</p>\n "
|
|
4591
4592
|
},
|
|
4592
4593
|
"Count": {
|
|
4593
4594
|
"shape_name": "Integer",
|
|
4594
4595
|
"type": "integer",
|
|
4595
|
-
"documentation": "\n <p>The number of items in the response.</p>\n "
|
|
4596
|
+
"documentation": "\n <p>The number of items in the response.</p>\n <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>\n <p>If you did not use a filter in the request, then <i>Count</i> and <i>ScannedCount</i> are the same.</p>\n "
|
|
4596
4597
|
},
|
|
4597
4598
|
"ScannedCount": {
|
|
4598
4599
|
"shape_name": "Integer",
|
|
4599
4600
|
"type": "integer",
|
|
4600
|
-
"documentation":
|
|
4601
|
+
"documentation": "\n <p>The number of items evaluated, <i>before</i> any <i>QueryFilter</i> is applied. A high\n <i>ScannedCount</i> value with few, or no, <i>Count</i> results indicates an inefficient\n <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\n Amazon DynamoDB Developer Guide.</p>\n <p>If you did not use a filter in the request, then <i>ScannedCount</i> is the same as <i>Count</i>.</p>\n\n "
|
|
4601
4602
|
},
|
|
4602
4603
|
"LastEvaluatedKey": {
|
|
4603
4604
|
"shape_name": "Key",
|
|
@@ -4660,7 +4661,7 @@
|
|
|
4660
4661
|
},
|
|
4661
4662
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
4662
4663
|
},
|
|
4663
|
-
"documentation": " <p>The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.</p>\n <p>If <i>LastEvaluatedKey</i> is
|
|
4664
|
+
"documentation": " <p>The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.</p>\n <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>\n <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>\n "
|
|
4664
4665
|
},
|
|
4665
4666
|
"ConsumedCapacity": {
|
|
4666
4667
|
"shape_name": "ConsumedCapacity",
|
|
@@ -4712,7 +4713,7 @@
|
|
|
4712
4713
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
4713
4714
|
}
|
|
4714
4715
|
},
|
|
4715
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
4716
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
4716
4717
|
},
|
|
4717
4718
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
4718
4719
|
},
|
|
@@ -4737,12 +4738,12 @@
|
|
|
4737
4738
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
4738
4739
|
}
|
|
4739
4740
|
},
|
|
4740
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
4741
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
4741
4742
|
},
|
|
4742
4743
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
4743
4744
|
}
|
|
4744
4745
|
},
|
|
4745
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
4746
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4746
4747
|
}
|
|
4747
4748
|
},
|
|
4748
4749
|
"documentation": "\n <p>Represents the output of a <i>Query</i> operation.</p>\n "
|
|
@@ -4758,7 +4759,7 @@
|
|
|
4758
4759
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
4759
4760
|
}
|
|
4760
4761
|
},
|
|
4761
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
4762
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4762
4763
|
},
|
|
4763
4764
|
{
|
|
4764
4765
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -4770,7 +4771,7 @@
|
|
|
4770
4771
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
4771
4772
|
}
|
|
4772
4773
|
},
|
|
4773
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
4774
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
4774
4775
|
},
|
|
4775
4776
|
{
|
|
4776
4777
|
"shape_name": "InternalServerError",
|
|
@@ -4785,7 +4786,7 @@
|
|
|
4785
4786
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
4786
4787
|
}
|
|
4787
4788
|
],
|
|
4788
|
-
"documentation": "\n <p>A <i>Query</i> operation directly accesses items from a table using the table primary key, or\n from an index using the index key. You must provide a specific hash key value. You can narrow\n the scope of the query by using comparison operators on the range key value, or on the index\n key. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse\n order, by range key or by index key. </p>\n <p>Queries that do not return results consume the minimum read capacity units according to the\n type of read.</p>\n
|
|
4789
|
+
"documentation": "\n <p>A <i>Query</i> operation directly accesses items from a table using the table primary key, or\n from an index using the index key. You must provide a specific hash key value. You can narrow\n the scope of the query by using comparison operators on the range key value, or on the index\n key. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse\n order, by range key or by index key. </p>\n <p>Queries that do not return results consume the minimum read capacity units according to the\n type of read.</p>\n <p>If the total number of items meeting the query criteria exceeds the result set size limit of\n 1 MB, the query stops and results are returned to the user with a\n <i>LastEvaluatedKey</i> to continue the query in a subsequent operation. Unlike a\n <i>Scan</i> operation, a <i>Query</i> operation never returns an empty result set <i>and</i>\n a <i>LastEvaluatedKey</i>. The <i>LastEvaluatedKey</i> is only provided if the results exceed\n 1 MB, or if you have used <i>Limit</i>. </p>\n <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\n <i>ConsistentRead</i> to true and obtain a strongly consistent result. Global secondary indexes support\n eventually consistent reads only, so do not specify <i>ConsistentRead</i> when querying a\n global secondary index.</p>\n <examples>\n <example>\n <name>Retrieving a Range of Items</name>\n <description>\n <p>This example queries the <i>Thread</i> table for postings between two dates. There is\n an index on <i>LastPostDateTime</i> to facilitate fast lookups on this attribute.</p>\n <p>All of the attributes will be returned. Any attributes that are not projected into the\n index will cause DynamoDB to fetch those attributes from the <i>Thread</i> table; this\n fetching occurs automatically.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.Query \n\n{\n \"TableName\": \"Thread\",\n \"IndexName\": \"LastPostIndex\",\n \"Select\": \"ALL_ATTRIBUTES\",\n \"Limit\":3,\n \"ConsistentRead\": true,\n \"KeyConditions\": {\n \"LastPostDateTime\": {\n \"AttributeValueList\": [\n {\n \"S\": \"20130101\"\n },\n {\n \"S\": \"20130115\"\n }\n ],\n \"ComparisonOperator\": \"BETWEEN\"\n },\n \"ForumName\": {\n \"AttributeValueList\": [\n {\n \"S\": \"Amazon DynamoDB\"\n }\n ],\n \"ComparisonOperator\": \"EQ\"\n }\n },\n \"ReturnConsumedCapacity\": \"TOTAL\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"Count\": 3,\n \"Items\": [\n {\n \"LastPostedBy\": {\n \"S\": \"fred@example.com\"\n },\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"LastPostDateTime\": {\n \"S\": \"20130102054211\"\n },\n \"Tags\": {\n \"SS\": [\"Problem\",\"Question\"]\n }\n },\n {\n \"LastPostedBy\": {\n \"S\": \"alice@example.com\"\n },\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"LastPostDateTime\": {\n \"S\": \"20130105111307\"\n },\n \"Tags\": {\n \"SS\": [\"Idea\"]\n }\n },\n {\n \"LastPostedBy\": {\n \"S\": \"bob@example.com\"\n },\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"LastPostDateTime\": {\n \"S\": \"20130108094417\"\n },\n \"Tags\": {\n \"SS\": [\"AppDesign\", \"HelpMe\"]\n }\n }\n ],\n \"ConsumedCapacity\": {\n \"TableName\": \"Thread\",\n \"CapacityUnits\": 1\n }\n}\n </response>\n </example>\n <example>\n <name>Counting Items</name>\n <description>\n <p>This example returns the number of items in the Thread table for a particular\n forum.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.Query \n\n{\n \"TableName\": \"Thread\",\n \"Select\": \"COUNT\",\n \"ConsistentRead\": true,\n \"KeyConditions\": {\n \"ForumName\": {\n \"AttributeValueList\": [\n {\n \"S\": \"Amazon DynamoDB\"\n }\n ],\n \"ComparisonOperator\": \"EQ\"\n }\n }\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"Count\":`17\n}\n </response>\n </example>\n </examples>\n "
|
|
4789
4790
|
},
|
|
4790
4791
|
"Scan": {
|
|
4791
4792
|
"name": "Scan",
|
|
@@ -4812,13 +4813,13 @@
|
|
|
4812
4813
|
"documentation": null
|
|
4813
4814
|
},
|
|
4814
4815
|
"min_length": 1,
|
|
4815
|
-
"documentation": " <p>The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.</p>\n "
|
|
4816
|
+
"documentation": " <p>The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.</p>\n <p>Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. \n DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</p>\n "
|
|
4816
4817
|
},
|
|
4817
4818
|
"Limit": {
|
|
4818
4819
|
"shape_name": "PositiveIntegerObject",
|
|
4819
4820
|
"type": "integer",
|
|
4820
4821
|
"min_length": 1,
|
|
4821
|
-
"documentation": " <p>The maximum number of items to evaluate (not necessarily the number of matching items). If\n DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to\n continue the operation. For more information see <a\n href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\"\n >Query and Scan</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4822
|
+
"documentation": " <p>The maximum number of items to evaluate (not necessarily the number of matching items). If\n DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to\n continue the operation. For more information, see <a\n href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html\"\n >Query and Scan</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
4822
4823
|
},
|
|
4823
4824
|
"Select": {
|
|
4824
4825
|
"shape_name": "Select",
|
|
@@ -4829,7 +4830,7 @@
|
|
|
4829
4830
|
"SPECIFIC_ATTRIBUTES",
|
|
4830
4831
|
"COUNT"
|
|
4831
4832
|
],
|
|
4832
|
-
"documentation": "\n <p>The attributes to be returned in the result. You can
|
|
4833
|
+
"documentation": "\n <p>The attributes to be returned in the result. You can retrieve all item attributes, specific\n item attributes, or the count of matching items.</p>\n <ul>\n <li>\n <p><code>ALL_ATTRIBUTES</code>: Returns all of the item attributes.</p>\n </li>\n <li>\n <p><code>COUNT</code>: Returns the number of matching items, rather than the matching items\n themselves.</p>\n </li>\n <li>\n <p>\n <code>SPECIFIC_ATTRIBUTES</code> : Returns only the attributes listed in\n <i>AttributesToGet</i>. This is equivalent to specifying <i>AttributesToGet</i> without\n specifying any value for <i>Select</i>.</p>\n </li>\n </ul>\n <p>If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to\n <code>ALL_ATTRIBUTES</code>. You cannot use both <i>Select</i> and <i>AttributesToGet</i>\n together in a single request, <i>unless</i> the value for <i>Select</i> is\n <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying\n <i>AttributesToGet</i> without any value for <i>Select</i>.)</p>\n "
|
|
4833
4834
|
},
|
|
4834
4835
|
"ScanFilter": {
|
|
4835
4836
|
"shape_name": "FilterConditionMap",
|
|
@@ -4899,7 +4900,7 @@
|
|
|
4899
4900
|
},
|
|
4900
4901
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
4901
4902
|
},
|
|
4902
|
-
"documentation": "\n <p>One or more values to evaluate against the supplied attribute.
|
|
4903
|
+
"documentation": "\n <p>One or more values to evaluate against the supplied attribute. The number of values in the\n list depends on the <i>ComparisonOperator</i> being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code>\n 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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n\n "
|
|
4903
4904
|
},
|
|
4904
4905
|
"ComparisonOperator": {
|
|
4905
4906
|
"shape_name": "ComparisonOperator",
|
|
@@ -4919,13 +4920,13 @@
|
|
|
4919
4920
|
"NOT_CONTAINS",
|
|
4920
4921
|
"BEGINS_WITH"
|
|
4921
4922
|
],
|
|
4922
|
-
"documentation": "\n <p>A comparator for evaluating attributes. For example, equals, greater than, less
|
|
4923
|
+
"documentation": "\n <p>A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.</p> \n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n \n <p>The following are descriptions of each comparison\n operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n <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>\n ",
|
|
4923
4924
|
"required": true
|
|
4924
4925
|
}
|
|
4925
4926
|
},
|
|
4926
|
-
"documentation": "\n <p>Represents
|
|
4927
|
+
"documentation": "\n <p>Represents the selection criteria for a <i>Query</i> or <i>Scan</i> operation:</p>\n <ul>\n <li>\n <p>For a <i>Query</i> operation, <i>Condition</i> is used for specifying the\n <i>KeyConditions</i> to use when querying a table or an index. For <i>KeyConditions</i>,\n only the following comparison operators are supported:</p>\n <p>\n <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code>\n </p>\n <p><i>Condition</i> is also used in a <i>QueryFilter</i>, which evaluates the query results\n and returns only the desired values.</p>\n </li>\n <li>\n <p>For a <i>Scan</i> operation, <i>Condition</i> is used in a <i>ScanFilter</i>, which\n evaluates the scan results and returns only the desired values.</p>\n </li>\n </ul>\n "
|
|
4927
4928
|
},
|
|
4928
|
-
"documentation": "\n <p>Evaluates the scan results and returns only the desired values.
|
|
4929
|
+
"documentation": "\n <p>Evaluates the scan results and returns only the desired values.</p>\n\n <p>If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of\n the conditions must evaluate to true. In other words, the conditions are ANDed together. (You\n can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this,\n then at least one of the conditions must evaluate to true, rather than all of them.)</p>\n <p>Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the\n following:</p>\n <ul>\n <li>\n <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied\n attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being\n used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, <code>a</code> is greater than <code>A</code>, and\n <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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n <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>\n </li>\n <li>\n<p><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example,\n equals, greater than, less than, etc.</p> <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n <p>For complete\n descriptions of all comparison operators, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html\">Condition</a>.</p>\n </li>\n </ul>\n "
|
|
4929
4930
|
},
|
|
4930
4931
|
"ConditionalOperator": {
|
|
4931
4932
|
"shape_name": "ConditionalOperator",
|
|
@@ -4934,7 +4935,7 @@
|
|
|
4934
4935
|
"AND",
|
|
4935
4936
|
"OR"
|
|
4936
4937
|
],
|
|
4937
|
-
"documentation":
|
|
4938
|
+
"documentation": "\n <p>A logical operator to apply to the conditions in the <i>ScanFilter</i> map:</p>\n <ul>\n <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li>\n <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>\n </ul>\n <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p>\n <p>The operation will succeed only if the entire map evaluates to true.</p>\n "
|
|
4938
4939
|
},
|
|
4939
4940
|
"ExclusiveStartKey": {
|
|
4940
4941
|
"shape_name": "Key",
|
|
@@ -4997,7 +4998,7 @@
|
|
|
4997
4998
|
},
|
|
4998
4999
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
4999
5000
|
},
|
|
5000
|
-
"documentation": " <p>The primary key of the first item that this operation will
|
|
5001
|
+
"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>\n <p>The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed.</p> \n <p>In a parallel scan, a\n <i>Scan</i> request that includes <i>ExclusiveStartKey</i> must specify the same segment\n whose previous <i>Scan</i> returned the corresponding value of <i>LastEvaluatedKey</i>.</p>\n "
|
|
5001
5002
|
},
|
|
5002
5003
|
"ReturnConsumedCapacity": {
|
|
5003
5004
|
"shape_name": "ReturnConsumedCapacity",
|
|
@@ -5007,21 +5008,21 @@
|
|
|
5007
5008
|
"TOTAL",
|
|
5008
5009
|
"NONE"
|
|
5009
5010
|
],
|
|
5010
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
5011
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
5011
5012
|
},
|
|
5012
5013
|
"TotalSegments": {
|
|
5013
5014
|
"shape_name": "ScanTotalSegments",
|
|
5014
5015
|
"type": "integer",
|
|
5015
5016
|
"min_length": 1,
|
|
5016
5017
|
"max_length": 1000000,
|
|
5017
|
-
"documentation": "\n <p>For a parallel <i>Scan</i> request, <i>TotalSegments</i> represents the total number of
|
|
5018
|
+
"documentation": "\n <p>For a parallel <i>Scan</i> request, <i>TotalSegments</i> represents the total number of\n segments into which the <i>Scan</i> operation will be divided. The value of\n <i>TotalSegments</i> corresponds to the number of application workers that will perform the\n parallel scan. For example, if you want to scan a table using four application threads, you\n would specify a <i>TotalSegments</i> value of 4.</p>\n <p>The value for <i>TotalSegments</i> must be greater than or equal to 1, and less than or equal\n to 4096. If you specify a <i>TotalSegments</i> value of 1, the <i>Scan</i> will be sequential\n rather than parallel.</p>\n <p>If you specify <i>TotalSegments</i>, you must also specify <i>Segment</i>.</p>\n "
|
|
5018
5019
|
},
|
|
5019
5020
|
"Segment": {
|
|
5020
5021
|
"shape_name": "ScanSegment",
|
|
5021
5022
|
"type": "integer",
|
|
5022
5023
|
"min_length": 0,
|
|
5023
5024
|
"max_length": 999999,
|
|
5024
|
-
"documentation": "\n <p>For a parallel <i>Scan</i> request, <i>Segment</i> identifies an individual segment to be
|
|
5025
|
+
"documentation": "\n <p>For a parallel <i>Scan</i> request, <i>Segment</i> identifies an individual segment to be\n scanned by an application worker.</p>\n <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to\n scan a table using four application threads, the first thread would specify a <i>Segment</i>\n value of 0, the second thread would specify 1, and so on.</p>\n <p>The value of <i>LastEvaluatedKey</i> returned from a parallel <i>Scan</i> request must be\n used as <i>ExclusiveStartKey</i> with the same Segment ID in a subsequent <i>Scan</i>\n operation.</p>\n <p>The value for <i>Segment</i> must be greater than or equal to 0, and less than the value\n provided for <i>TotalSegments</i>.</p>\n <p>If you specify <i>Segment</i>, you must also specify <i>TotalSegments</i>.</p>\n "
|
|
5025
5026
|
}
|
|
5026
5027
|
},
|
|
5027
5028
|
"documentation": "\n <p>Represents the input of a <i>Scan</i> operation.</p>\n "
|
|
@@ -5096,17 +5097,17 @@
|
|
|
5096
5097
|
},
|
|
5097
5098
|
"documentation": null
|
|
5098
5099
|
},
|
|
5099
|
-
"documentation": "\n <p>An array of item attributes that match the scan criteria. Each element in this array consists
|
|
5100
|
+
"documentation": "\n <p>An array of item attributes that match the scan criteria. Each element in this array consists\n of an attribute name and the value for that attribute.</p>\n "
|
|
5100
5101
|
},
|
|
5101
5102
|
"Count": {
|
|
5102
5103
|
"shape_name": "Integer",
|
|
5103
5104
|
"type": "integer",
|
|
5104
|
-
"documentation": "\n <p>The number of items in the response.</p>\n "
|
|
5105
|
+
"documentation": "\n <p>The number of items in the response.</p>\n <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>\n <p>If you did not use a filter in the request, then <i>Count</i> is the same as <i>ScannedCount</i>.</p>\n "
|
|
5105
5106
|
},
|
|
5106
5107
|
"ScannedCount": {
|
|
5107
5108
|
"shape_name": "Integer",
|
|
5108
5109
|
"type": "integer",
|
|
5109
|
-
"documentation": "\n <p>The number of items
|
|
5110
|
+
"documentation": "\n <p>The number of items evaluated, <i>before</i> any <i>ScanFilter</i> is applied. A high\n <i>ScannedCount</i> value with few, or no, <i>Count</i> results indicates an inefficient\n <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\n Amazon DynamoDB Developer Guide.</p>\n <p>If you did not use a filter in the request, then <i>ScannedCount</i> is the same as <i>Count</i>.</p>\n "
|
|
5110
5111
|
},
|
|
5111
5112
|
"LastEvaluatedKey": {
|
|
5112
5113
|
"shape_name": "Key",
|
|
@@ -5169,7 +5170,7 @@
|
|
|
5169
5170
|
},
|
|
5170
5171
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
5171
5172
|
},
|
|
5172
|
-
"documentation": " <p>The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.</p>\n <p>If <i>LastEvaluatedKey</i> is
|
|
5173
|
+
"documentation": " <p>The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.</p>\n <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>\n <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>\n "
|
|
5173
5174
|
},
|
|
5174
5175
|
"ConsumedCapacity": {
|
|
5175
5176
|
"shape_name": "ConsumedCapacity",
|
|
@@ -5221,7 +5222,7 @@
|
|
|
5221
5222
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
5222
5223
|
}
|
|
5223
5224
|
},
|
|
5224
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
5225
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
5225
5226
|
},
|
|
5226
5227
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
5227
5228
|
},
|
|
@@ -5246,12 +5247,12 @@
|
|
|
5246
5247
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
5247
5248
|
}
|
|
5248
5249
|
},
|
|
5249
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
5250
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
5250
5251
|
},
|
|
5251
5252
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
5252
5253
|
}
|
|
5253
5254
|
},
|
|
5254
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
5255
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
5255
5256
|
}
|
|
5256
5257
|
},
|
|
5257
5258
|
"documentation": "\n <p>Represents the output of a <i>Scan</i> operation.</p>\n "
|
|
@@ -5267,7 +5268,7 @@
|
|
|
5267
5268
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
5268
5269
|
}
|
|
5269
5270
|
},
|
|
5270
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
5271
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
5271
5272
|
},
|
|
5272
5273
|
{
|
|
5273
5274
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -5279,7 +5280,7 @@
|
|
|
5279
5280
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
5280
5281
|
}
|
|
5281
5282
|
},
|
|
5282
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
5283
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
5283
5284
|
},
|
|
5284
5285
|
{
|
|
5285
5286
|
"shape_name": "InternalServerError",
|
|
@@ -5294,7 +5295,7 @@
|
|
|
5294
5295
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
5295
5296
|
}
|
|
5296
5297
|
],
|
|
5297
|
-
"documentation": "\n <p>The <i>Scan</i> operation returns one or more items and item attributes by accessing every
|
|
5298
|
+
"documentation": "\n <p>The <i>Scan</i> operation returns one or more items and item attributes by accessing every\n item in the table. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i>.</p>\n\n <p>If the total number of scanned items exceeds the maximum data set size limit of\n 1 MB, the scan stops and results are returned to the user with a\n <i>LastEvaluatedKey</i> to continue the scan in a subsequent operation. The results also\n include the number of items exceeding the limit. A scan can result in no table data meeting\n the filter criteria. </p>\n <p>The result set is eventually consistent. </p>\n <p>By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on\n large tables, applications can request a parallel <i>Scan</i> by specifying the <i>Segment</i>\n 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\n Amazon DynamoDB Developer Guide.</p>\n <examples>\n <example>\n <name>Returning All Items</name>\n <description>This example returns all of the items in a table. No scan filter is\n applied.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.Scan \n\n{\n \"TableName\": \"Reply\",\n \"ReturnConsumedCapacity\": \"TOTAL\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"ConsumedCapacity\": {\n \"CapacityUnits\": 0.5,\n \"TableName\": \"Reply\"\n },\n \"Count\": 4,\n \"Items\": [\n {\n \"PostedBy\": {\n \"S\": \"joe@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115336\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"Have you looked at the BatchWriteItem API?\"\n }\n },\n {\n \"PostedBy\": {\n \"S\": \"fred@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115342\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"No, I didn't know about that. Where can I find more information?\"\n }\n },\n {\n \"PostedBy\": {\n \"S\": \"joe@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115347\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"BatchWriteItem is documented in the Amazon DynamoDB API Reference.\"\n }\n },\n {\n \"PostedBy\": {\n \"S\": \"fred@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115352\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"OK, I'll take a look at that. Thanks!\"\n }\n }\n ],\n \"ScannedCount\": 4\n}\n </response>\n </example>\n <example>\n <name>Using a Scan Filter</name>\n <description>This example returns only those items matching specific criteria.</description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.Scan \n\n{\n \"TableName\": \"Reply\",\n \"ScanFilter\": {\n \"PostedBy\": {\n \"AttributeValueList\": [\n {\n \"S\": \"joe@example.com\"\n }\n ],\n \"ComparisonOperator\": \"EQ\"\n }\n },\n \"ReturnConsumedCapacity\": \"TOTAL\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"ConsumedCapacity\": {\n \"CapacityUnits\": 0.5,\n \"TableName\": \"Reply\"\n },\n \"Count\": 2,\n \"Items\": [\n {\n \"PostedBy\": {\n \"S\": \"joe@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115336\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"Have you looked at the BatchWriteItem API?\"\n }\n },\n {\n \"PostedBy\": {\n \"S\": \"joe@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115347\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"BatchWriteItem is documented in the Amazon DynamoDB API Reference.\"\n }\n }\n ],\n \"ScannedCount\": 4\n}\n </response>\n </example>\n </examples>\n "
|
|
5298
5299
|
},
|
|
5299
5300
|
"UpdateItem": {
|
|
5300
5301
|
"name": "UpdateItem",
|
|
@@ -5372,7 +5373,7 @@
|
|
|
5372
5373
|
},
|
|
5373
5374
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
5374
5375
|
},
|
|
5375
|
-
"documentation": "\n <p>The primary key
|
|
5376
|
+
"documentation": "\n <p>The primary key of the item to be updated. Each element consists of an attribute name and a\n value for that attribute.</p>\n <p>For the primary key, you must provide <i>all</i> of the attributes. For example, with a hash\n type primary key, you only need to specify the hash attribute. For a hash-and-range type\n primary key, you must specify <i>both</i> the hash attribute and the range attribute.</p>\n\n ",
|
|
5376
5377
|
"required": true
|
|
5377
5378
|
},
|
|
5378
5379
|
"AttributeUpdates": {
|
|
@@ -5448,12 +5449,12 @@
|
|
|
5448
5449
|
"PUT",
|
|
5449
5450
|
"DELETE"
|
|
5450
5451
|
],
|
|
5451
|
-
"documentation": "\n <p>Specifies how to perform the update. Valid values are <code>PUT</code>, <code>DELETE</code>,\n and <code>ADD</code>. The behavior depends on whether the specified primary key already exists\n in the table.</p>\n
|
|
5452
|
+
"documentation": "\n <p>Specifies how to perform the update. Valid values are <code>PUT</code>, <code>DELETE</code>,\n and <code>ADD</code>. The behavior depends on whether the specified primary key already exists\n in the table.</p>\n\n <p>\n <b>If an item with the specified <i>Key</i> is found in the table:</b>\n </p>\n\n <ul>\n <li>\n <p><code>PUT</code> - Adds the specified attribute to the item. If the attribute already\n exists, it is replaced by the new value. </p>\n </li>\n <li>\n <p><code>DELETE</code> - If no value is specified, the attribute and its value are removed\n from the item. The data type of the specified value must match the existing value's data\n type.</p>\n <p>If a <i>set</i> of values is specified, then those values are subtracted from the old\n set. For example, if the attribute value was the set <code>[a,b,c]</code> and the\n <i>DELETE</i> action specified <code>[a,c]</code>, then the final attribute value would\n be <code>[b]</code>. Specifying an empty set is an error.</p>\n </li>\n <li>\n <p><code>ADD</code> - If the attribute does not already exist, then the attribute and its\n values are added to the item. If the attribute does exist, then the behavior of\n <code>ADD</code> depends on the data type of the attribute:</p>\n <ul>\n <li>\n <p>If the existing attribute is a number, and if <i>Value</i> is also a number, then the\n <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a\n negative number, then it is subtracted from the existing attribute.</p>\n <note>\n <p> If you use <code>ADD</code> to increment or decrement a number value for an item\n that doesn't exist before the update, DynamoDB uses 0 as the initial value.</p>\n <p>In addition, if you use <code>ADD</code> to update an existing item, and intend to\n increment or decrement an attribute value which does not yet exist, DynamoDB uses\n <code>0</code> as the initial value. For example, suppose that the item you want\n to update does not yet have an attribute named <i>itemcount</i>, but you decide to\n <code>ADD</code> the number <code>3</code> to this attribute anyway, even though\n it currently does not exist. DynamoDB will create the <i>itemcount</i> attribute, set\n its initial value to <code>0</code>, and finally add <code>3</code> to it. The\n result will be a new <i>itemcount</i> attribute in the item, with a value of\n <code>3</code>.</p>\n </note>\n </li>\n <li>\n <p>If the existing data type is a set, and if the <i>Value</i> is also a set, then the\n <i>Value</i> is added to the existing set. (This is a <i>set</i> operation, not\n mathematical addition.) For example, if the attribute value was the set\n <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then\n the final attribute value would be <code>[1,2,3]</code>. An error occurs if an Add\n action is specified for a set attribute and the attribute type specified does not\n match the existing set type. </p>\n <p>Both sets must have the same primitive data type. For example, if the existing data\n type is a set of strings, the <i>Value</i> must also be a set of strings. The same\n holds true for number sets and binary sets.</p>\n </li>\n </ul>\n <p>This action is only valid for an existing attribute whose data type is number or is a\n set. Do not use <code>ADD</code> for any other data types.</p>\n </li>\n </ul>\n\n <p>\n <b>If no item with the specified <i>Key</i> is found:</b>\n </p>\n\n <ul>\n <li>\n <p><code>PUT</code> - DynamoDB creates a new item with the specified primary key, and then adds\n the attribute. </p>\n </li>\n <li>\n <p><code>DELETE</code> - Nothing happens; there is no attribute to delete.</p>\n </li>\n <li>\n <p><code>ADD</code> - DynamoDB creates an item with the supplied primary key and number (or set\n of numbers) for the attribute value. The only data types allowed are number and number\n set; no other data types can be specified.</p>\n </li>\n </ul>\n "
|
|
5452
5453
|
}
|
|
5453
5454
|
},
|
|
5454
|
-
"documentation": "\n <p>For the <i>UpdateItem</i> operation, represents the attributes to be modified,the action to
|
|
5455
|
+
"documentation": "\n <p>For the <i>UpdateItem</i> operation, represents the attributes to be modified, the action to\n perform on each, and the new value for each.</p>\n <note>\n <p>You cannot use <i>UpdateItem</i> to update any primary key attributes. Instead, you will\n need to delete the item, and then use <i>PutItem</i> to create a new item with new\n attributes.</p>\n </note>\n <p>Attribute values cannot be null; string and binary type attributes must have lengths greater\n than zero; and set type attributes must not be empty. Requests with empty values will be\n rejected with a <i>ValidationException</i>.</p>\n "
|
|
5455
5456
|
},
|
|
5456
|
-
"documentation": "\n <p>The names of attributes to be modified, the action to perform on each, and the new value for\n each. If you are updating an attribute that is an index key attribute for any indexes on that\n table, the attribute type must match the index key type defined in the
|
|
5457
|
+
"documentation": "\n <p>The names of attributes to be modified, the action to perform on each, and the new value for\n each. If you are updating an attribute that is an index key attribute for any indexes on that\n table, the attribute type must match the index key type defined in the\n <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to\n update any non-key attributes.</p>\n <p>Attribute values cannot be null. String and binary type attributes must have lengths greater\n than zero. Set type attributes must not be empty. Requests with empty values will be rejected\n with a <i>ValidationException</i>.</p>\n <p>Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the\n following:</p>\n <ul>\n <li>\n <p><i>Value</i> - The new value, if applicable, for this attribute.</p>\n </li>\n <li>\n <p><i>Action</i> - Specifies how to perform the update. Valid values for <i>Action</i> are\n <code>PUT</code>, <code>DELETE</code>, and <code>ADD</code>. The behavior depends on\n whether the specified primary key already exists in the table.</p>\n\n <p>\n <b>If an item with the specified <i>Key</i> is found in the table:</b>\n </p>\n\n <ul>\n <li>\n <p><code>PUT</code> - Adds the specified attribute to the item. If the attribute already\n exists, it is replaced by the new value. </p>\n </li>\n <li>\n <p><code>DELETE</code> - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the existing\n value's data type.</p>\n <p>If a <i>set</i> of values is specified, then those values are subtracted from the old\n set. For example, if the attribute value was the set <code>[a,b,c]</code> and the\n <i>DELETE</i> action specified <code>[a,c]</code>, then the final attribute value\n would be <code>[b]</code>. Specifying an empty set is an error.</p>\n </li>\n <li>\n <p><code>ADD</code> - If the attribute does not already exist, then the attribute and\n its values are added to the item. If the attribute does exist, then the behavior of\n <code>ADD</code> depends on the data type of the attribute:</p>\n <ul>\n <li>\n <p>If the existing attribute is a number, and if <i>Value</i> is also a number, then\n the <i>Value</i> is mathematically added to the existing attribute. If\n <i>Value</i> is a negative number, then it is subtracted from the existing\n attribute.</p>\n <note>\n <p> If you use <code>ADD</code> to increment or decrement a number value for an\n item that doesn't exist before the update, DynamoDB uses 0 as the initial\n value.</p>\n <p>In addition, if you use <code>ADD</code> to update an existing item, and intend\n to increment or decrement an attribute value which does not yet exist, DynamoDB\n uses <code>0</code> as the initial value. For example, suppose that the item you\n want to update does not yet have an attribute named <i>itemcount</i>, but you\n decide to <code>ADD</code> the number <code>3</code> to this attribute anyway,\n even though it currently does not exist. DynamoDB will create the <i>itemcount</i>\n attribute, set its initial value to <code>0</code>, and finally add\n <code>3</code> to it. The result will be a new <i>itemcount</i> attribute in\n the item, with a value of <code>3</code>.</p>\n </note>\n </li>\n <li>\n <p>If the existing data type is a set, and if the <i>Value</i> is also a set, then\n the <i>Value</i> is added to the existing set. (This is a <i>set</i> operation,\n not mathematical addition.) For example, if the attribute value was the set\n <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>,\n then the final attribute value would be <code>[1,2,3]</code>. An error occurs if\n an Add action is specified for a set attribute and the attribute type specified\n does not match the existing set type. </p>\n <p>Both sets must have the same primitive data type. For example, if the existing\n data type is a set of strings, the <i>Value</i> must also be a set of strings. The\n same holds true for number sets and binary sets.</p>\n </li>\n </ul>\n <p>This action is only valid for an existing attribute whose data type is number or is a\n set. Do not use <code>ADD</code> for any other data types.</p>\n </li>\n </ul>\n\n <p>\n <b>If no item with the specified <i>Key</i> is found:</b>\n </p>\n\n <ul>\n <li>\n <p><code>PUT</code> - DynamoDB creates a new item with the specified primary key, and then\n adds the attribute. </p>\n </li>\n <li>\n <p><code>DELETE</code> - Nothing happens; there is no attribute to delete.</p>\n </li>\n <li>\n <p><code>ADD</code> - DynamoDB creates an item with the supplied primary key and number (or\n set of numbers) for the attribute value. The only data types allowed are number and\n number set; no other data types can be specified.</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>If you specify any attributes that are part of an index key, then the data types for those\n attributes must match those of the schema in the table's attribute definition.</p>\n "
|
|
5457
5458
|
},
|
|
5458
5459
|
"Expected": {
|
|
5459
5460
|
"shape_name": "ExpectedAttributeMap",
|
|
@@ -5523,7 +5524,7 @@
|
|
|
5523
5524
|
"Exists": {
|
|
5524
5525
|
"shape_name": "BooleanObject",
|
|
5525
5526
|
"type": "boolean",
|
|
5526
|
-
"documentation": "\n <p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n
|
|
5527
|
+
"documentation": "\n <p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute value\n already exists in the table. If it is found, then the operation succeeds. If it is not\n found, the operation fails with a <i>ConditionalCheckFailedException</i>.</p>\n </li>\n <li>\n <p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does\n <i>not</i> exist in the table. If in fact the value does not exist, then the assumption\n is valid and the operation succeeds. If the value is found, despite the assumption that it\n does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>.</p>\n </li>\n </ul>\n <p>The default setting for <i>Exists</i> is <code>true</code>. If you supply a <i>Value</i> all\n by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to\n <code>true</code>, because it is implied.</p>\n <p>DynamoDB returns a <i>ValidationException</i> if:</p>\n <ul>\n <li>\n <p><i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect a\n value to exist, but don't specify what that value is.)</p>\n </li>\n <li>\n <p><i>Exists</i> is <code>false</code> but you also specify a <i>Value</i>. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)</p>\n </li>\n </ul>\n "
|
|
5527
5528
|
},
|
|
5528
5529
|
"ComparisonOperator": {
|
|
5529
5530
|
"shape_name": "ComparisonOperator",
|
|
@@ -5543,7 +5544,7 @@
|
|
|
5543
5544
|
"NOT_CONTAINS",
|
|
5544
5545
|
"BEGINS_WITH"
|
|
5545
5546
|
],
|
|
5546
|
-
"documentation":
|
|
5547
|
+
"documentation": "\n <p>A comparator for evaluating attributes in the <i>AttributeValueList</i>. For example, equals,\n greater than, less than, etc.</p> \n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n \n <p>The following are descriptions of each comparison operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n "
|
|
5547
5548
|
},
|
|
5548
5549
|
"AttributeValueList": {
|
|
5549
5550
|
"shape_name": "AttributeValueList",
|
|
@@ -5600,12 +5601,12 @@
|
|
|
5600
5601
|
},
|
|
5601
5602
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
5602
5603
|
},
|
|
5603
|
-
"documentation":
|
|
5604
|
+
"documentation": "\n <p>One or more values to evaluate against the supplied attribute.\n The number of values in the list depends on the <i>ComparisonOperator</i> being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, <code>a</code> is greater than <code>A</code>, and <code>aa</code>\n 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>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n <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>\n "
|
|
5604
5605
|
}
|
|
5605
5606
|
},
|
|
5606
|
-
"documentation": "\n <p>Represents an attribute value used
|
|
5607
|
+
"documentation": "\n <p>Represents a condition to be compared with an attribute value. This condition can be used\n with <i>DeleteItem</i>, <i>PutItem</i> or <i>UpdateItem</i> operations; if the comparison\n evaluates to true, the operation succeeds; if not the operation fails. You can use\n <i>ExpectedAttributeValue</i> in one of two different ways:</p>\n <ul>\n <li>\n <p>Use <i>AttributeValueList</i> to specify one or more values to compare against an\n attribute. Use <i>ComparisonOperator</i> to specify how you want to perform the\n comparison. If the comparison evaluates to true, then the conditional operation\n succeeds.</p>\n </li>\n <li>\n <p>Use <i>Value</i> to specify a value that DynamoDB will compare against an attribute. If the\n values match, then <i>ExpectedAttributeValue</i> evaluates to true and the conditional\n operation succeeds. Optionally, you can also set <i>Exists</i> to false, indicating that\n you <i>do not</i> expect to find the attribute value in the table. In this case, the\n conditional operation succeeds only if the comparison evaluates to false.</p>\n </li>\n </ul>\n <p><i>Value</i> and <i>Exists</i> are incompatible with <i>AttributeValueList</i> and \n <i>ComparisonOperator</i>. If you attempt to use both sets of parameters at once, DynamoDB will\n throw a <i>ValidationException</i>.</p>\n\n <important>\n <p>The <i>Value</i> and <i>Exists</i> parameters are deprecated. Even though DynamoDB will\n continue to support these parameters, we recommend that you use <i>AttributeValueList</i>\n and <i>ComparisonOperator</i> instead. <i>AttributeValueList</i> and\n <i>ComparisonOperator</i> let you construct a much wider range of conditions than is\n possible with <i>Value</i> and <i>Exists</i>.</p>\n </important>\n "
|
|
5607
5608
|
},
|
|
5608
|
-
"documentation": "\n <p>A map of attribute/condition pairs. This is the conditional block for the <i>UpdateItem</i> operation. All the conditions must be met for the operation to succeed.</p>\n <p><i>Expected</i> allows you to\n provide an attribute name, and whether or not DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.</p>\n <p>Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with\n the following: </p>\n <ul>\n <li>\n <p><i>Value</i> - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used.</p>\n </li>\n <li>\n <p><i>Exists</i> - Causes DynamoDB to evaluate the value before attempting a conditional\n operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n <i>ConditionalCheckFailedException</i>.</p>\n </li>\n <li>\n <p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does\n <i>not</i> exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n <i>ConditionalCheckFailedException</i>.</p>\n </li>\n </ul>\n <p>The default setting for <i>Exists</i> is <code>true</code>. If you supply a <i>Value</i>\n all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <code>true</code>, because it is\n implied.</p>\n <p>DynamoDB returns a <i>ValidationException</i> if:</p>\n <ul>\n <li>\n <p><i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect\n a value to exist, but don't specify what that value is.)</p>\n </li>\n <li>\n <p><i>Exists</i> is <code>false</code> but you also specify a <i>Value</i>. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>If you specify more than one condition for <i>Exists</i>, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.</p>\n\n "
|
|
5609
|
+
"documentation": "\n <p>A map of attribute/condition pairs. This is the conditional block for the <i>UpdateItem</i>\n operation.</p>\n <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>\n\n <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>\n <p>If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails.</p>\n \n <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>\n \n <ul>\n <li>\n <p><i>AttributeValueList</i> - One or more values to evaluate against the supplied\n attribute. The number of values in the list depends on the <i>ComparisonOperator</i>\n being used.</p>\n <p>For type Number, value comparisons are numeric.</p>\n <p>String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, <code>a</code> is greater than <code>A</code>, and\n <code>aa</code> is greater than <code>B</code>. For a list of code values, see <a\n href=\"http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters\"\n >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>\n <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.</p>\n </li>\n <li>\n <p><i>ComparisonOperator</i> - A comparator for evaluating attributes in the\n <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads.</p>\n <p>The following comparison operators are available:</p>\n <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>\n\n <p>The following are descriptions of each comparison operator.</p>\n <ul>\n <li> <p><code>EQ</code> : Equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NE</code> : Not equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not equal <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LE</code> : Less than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>LT</code> : Less than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GE</code> : Greater than or equal. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>GT</code> : Greater than. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different\n type than the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not equal <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code>.</p>\n <p/>\n</li>\n <li> <p><code>NOT_NULL</code> : The attribute exists. </p>\n</li>\n <li> <p><code>NULL</code> : The attribute does not exist. </p>\n</li>\n <li> <p><code>CONTAINS</code> : checks for a subsequence, or value in a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).</p>\n</li>\n <li> <p><code>NOT_CONTAINS</code> : checks for absence of a subsequence, or absence of a value in\n a set.</p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).</p></li>\n <li> <p><code>BEGINS_WITH</code> : checks for a prefix. </p>\n <p><i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).</p>\n <p/>\n</li>\n <li> <p><code>IN</code> : checks for exact matches.</p>\n <p><i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.</p>\n</li>\n <li> <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal\n to the second value. </p>\n <p><i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an <i>AttributeValue</i> of a different type than\n the one specified in the request, the value does not match. For example,\n <code>{\"S\":\"6\"}</code> does not compare to <code>{\"N\":\"6\"}</code>. Also,\n <code>{\"N\":\"6\"}</code> does not compare to <code>{\"NS\":[\"6\", \"2\", \"1\"]}</code></p>\n</li>\n </ul>\n </li>\n </ul>\n <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\"\n >Conditional Expressions</a> in the Amazon DynamoDB Developer Guide.</p>\n <note>\n <p>For backward compatibility with previous DynamoDB releases, the following parameters can be\n used instead of <i>AttributeValueList</i> and <i>ComparisonOperator</i>:</p>\n <ul>\n <li>\n <p><i>Value</i> - A value for DynamoDB to compare with an attribute.</p>\n </li>\n <li>\n <p><i>Exists</i> - Causes DynamoDB to evaluate the value before attempting the conditional\n operation:</p>\n <ul>\n <li>\n <p>If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the condition evaluates to\n true; otherwise the condition evaluate to false.</p>\n </li>\n <li><p>If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value\n does <i>not</i> exist in the table. If in fact the value does not exist, then the\n assumption is valid and the condition evaluates to true. If the value is found,\n despite the assumption that it does not exist, the condition evaluates to\n false.</p></li>\n </ul>\n </li>\n </ul>\n <p>Even though DynamoDB continues to accept the <i>Value</i> and <i>Exists</i> parameters, they\n are now deprecated. We recommend that you use <i>AttributeValueList</i> and\n <i>ComparisonOperator</i> instead, since they allow you to construct a much wider range of\n conditions.</p>\n <p>The <i>Value</i> and <i>Exists</i> parameters are incompatible with\n <i>AttributeValueList</i> and <i>ComparisonOperator</i>. If you attempt to use both sets\n of parameters at once, DynamoDB will throw a <i>ValidationException</i>.</p>\n </note>\n "
|
|
5609
5610
|
},
|
|
5610
5611
|
"ConditionalOperator": {
|
|
5611
5612
|
"shape_name": "ConditionalOperator",
|
|
@@ -5614,7 +5615,7 @@
|
|
|
5614
5615
|
"AND",
|
|
5615
5616
|
"OR"
|
|
5616
5617
|
],
|
|
5617
|
-
"documentation":
|
|
5618
|
+
"documentation": "\n <p>A logical operator to apply to the conditions in the <i>Expected</i> map:</p>\n <ul>\n <li><p><code>AND</code> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</p></li>\n <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>\n </ul>\n <p>If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default.</p>\n <p>The operation will succeed only if the entire map evaluates to true.</p>\n "
|
|
5618
5619
|
},
|
|
5619
5620
|
"ReturnValues": {
|
|
5620
5621
|
"shape_name": "ReturnValue",
|
|
@@ -5626,7 +5627,7 @@
|
|
|
5626
5627
|
"ALL_NEW",
|
|
5627
5628
|
"UPDATED_NEW"
|
|
5628
5629
|
],
|
|
5629
|
-
"documentation": "\n <p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before\n or after they were updated. For <i>UpdateItem</i>, the valid values are:</p>\n <ul>\n <li>\n <p><code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its
|
|
5630
|
+
"documentation": "\n <p>Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before\n or after they were updated. For <i>UpdateItem</i>, the valid values are:</p>\n <ul>\n <li>\n <p><code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is\n <code>NONE</code>, then nothing is returned. (This is the default for\n <i>ReturnValues</i>.)</p>\n </li>\n <li>\n <p><code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then\n the content of the old item is returned.</p>\n </li>\n <li>\n <p><code>UPDATED_OLD</code> - The old versions of only the updated attributes are\n returned.</p>\n </li>\n <li>\n <p><code>ALL_NEW</code> - All of the attributes of the new version of the item are\n returned.</p>\n </li>\n <li>\n <p><code>UPDATED_NEW</code> - The new versions of only the updated attributes are\n returned.</p>\n </li>\n </ul>\n "
|
|
5630
5631
|
},
|
|
5631
5632
|
"ReturnConsumedCapacity": {
|
|
5632
5633
|
"shape_name": "ReturnConsumedCapacity",
|
|
@@ -5636,7 +5637,7 @@
|
|
|
5636
5637
|
"TOTAL",
|
|
5637
5638
|
"NONE"
|
|
5638
5639
|
],
|
|
5639
|
-
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables
|
|
5640
|
+
"documentation": "\n <p>If set to <code>TOTAL</code>, the response includes <i>ConsumedCapacity</i> data for tables\n and indexes. If set to <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> for\n indexes. If set to <code>NONE</code> (the default), <i>ConsumedCapacity</i> is not included in\n the response.</p>\n "
|
|
5640
5641
|
},
|
|
5641
5642
|
"ReturnItemCollectionMetrics": {
|
|
5642
5643
|
"shape_name": "ReturnItemCollectionMetrics",
|
|
@@ -5715,7 +5716,7 @@
|
|
|
5715
5716
|
},
|
|
5716
5717
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
5717
5718
|
},
|
|
5718
|
-
"documentation": "\n <p>A map of attribute values as they appeared before the <i>UpdateItem</i> operation, but only
|
|
5719
|
+
"documentation": "\n <p>A map of attribute values as they appeared before the <i>UpdateItem</i> operation, but only\n if <i>ReturnValues</i> was specified as something other than <code>NONE</code> in the request.\n Each element represents one attribute.</p>\n "
|
|
5719
5720
|
},
|
|
5720
5721
|
"ConsumedCapacity": {
|
|
5721
5722
|
"shape_name": "ConsumedCapacity",
|
|
@@ -5767,7 +5768,7 @@
|
|
|
5767
5768
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
5768
5769
|
}
|
|
5769
5770
|
},
|
|
5770
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
5771
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
5771
5772
|
},
|
|
5772
5773
|
"documentation": "\n <p>The amount of throughput consumed on each local index affected by the operation.</p>\n "
|
|
5773
5774
|
},
|
|
@@ -5792,12 +5793,12 @@
|
|
|
5792
5793
|
"documentation": "\n <p>The total number of capacity units consumed on a table or an index.</p>\n "
|
|
5793
5794
|
}
|
|
5794
5795
|
},
|
|
5795
|
-
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index
|
|
5796
|
+
"documentation": "\n <p>Represents the amount of provisioned throughput capacity consumed on a table or an index.\n </p>\n "
|
|
5796
5797
|
},
|
|
5797
5798
|
"documentation": "\n <p>The amount of throughput consumed on each global index affected by the operation.</p>\n "
|
|
5798
5799
|
}
|
|
5799
5800
|
},
|
|
5800
|
-
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total
|
|
5801
|
+
"documentation": "\n <p>Represents the capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request.\n For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html\">Provisioned\n Throughput</a> in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
5801
5802
|
},
|
|
5802
5803
|
"ItemCollectionMetrics": {
|
|
5803
5804
|
"shape_name": "ItemCollectionMetrics",
|
|
@@ -5864,7 +5865,7 @@
|
|
|
5864
5865
|
},
|
|
5865
5866
|
"documentation": "\n <p>Represents the data for an attribute. You can set one, and only one, of the elements.</p>\n "
|
|
5866
5867
|
},
|
|
5867
|
-
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p
|
|
5868
|
+
"documentation": "\n <p>The hash key value of the item collection. This is the same as the hash key of the item.</p>\n "
|
|
5868
5869
|
},
|
|
5869
5870
|
"SizeEstimateRangeGB": {
|
|
5870
5871
|
"shape_name": "ItemCollectionSizeEstimateRange",
|
|
@@ -5874,10 +5875,10 @@
|
|
|
5874
5875
|
"type": "double",
|
|
5875
5876
|
"documentation": null
|
|
5876
5877
|
},
|
|
5877
|
-
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a
|
|
5878
|
+
"documentation": "\n <p>An estimate of item collection size, measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the size\n of all the items in the table, plus the size of all attributes projected into all of the\n local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size\n limit.</p>\n <p>The estimate is subject to change over time; therefore, do not rely on the precision or\n accuracy of the estimate.</p>\n "
|
|
5878
5879
|
}
|
|
5879
5880
|
},
|
|
5880
|
-
"documentation": "\n <p>Information about item collections, if any, that were affected by the operation
|
|
5881
|
+
"documentation": "\n <p>Information about item collections, if any, that were affected by the operation.\n <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the\n table does not have any local secondary indexes, this information is not returned in the response.</p>\n "
|
|
5881
5882
|
}
|
|
5882
5883
|
},
|
|
5883
5884
|
"documentation": "\n <p>Represents the output of an <i>UpdateItem</i> operation.</p>\n "
|
|
@@ -5905,7 +5906,7 @@
|
|
|
5905
5906
|
"documentation": "\n <p>You exceeded your maximum allowed provisioned throughput.</p>\n "
|
|
5906
5907
|
}
|
|
5907
5908
|
},
|
|
5908
|
-
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception
|
|
5909
|
+
"documentation": "\n <p>The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore,\n your request will eventually succeed, unless the request is too large or your retry queue is\n 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>\n in the Amazon DynamoDB Developer Guide.</p>\n "
|
|
5909
5910
|
},
|
|
5910
5911
|
{
|
|
5911
5912
|
"shape_name": "ResourceNotFoundException",
|
|
@@ -5917,7 +5918,7 @@
|
|
|
5917
5918
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
5918
5919
|
}
|
|
5919
5920
|
},
|
|
5920
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
5921
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
5921
5922
|
},
|
|
5922
5923
|
{
|
|
5923
5924
|
"shape_name": "ItemCollectionSizeLimitExceededException",
|
|
@@ -5944,7 +5945,7 @@
|
|
|
5944
5945
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
5945
5946
|
}
|
|
5946
5947
|
],
|
|
5947
|
-
"documentation": "\n <p> Edits an existing item's attributes, or inserts a new item if it does not already exist. You
|
|
5948
|
+
"documentation": "\n <p> Edits an existing item's attributes, or inserts a new item if it does not already exist. You\n can put, delete, or add attribute values. You can also perform a conditional update (insert a\n new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if\n it has certain expected attribute values).</p>\n <p>In addition to updating an item, you can also return the item's attribute values in the same\n operation, using the <i>ReturnValues</i> parameter.</p>\n <examples>\n <example>\n <name>Conditional Update</name>\n <description>\n <p>This example updates the Thread table, changing the LastPostedBy attribute-but only if\n LastPostedBy is currently \"fred@example.com\". All of the item's attributes, as they\n appear after the update, are returned in the response.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.UpdateItem \n\n{\n \"TableName\": \"Thread\",\n \"Key\": {\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"Subject\": {\n \"S\": \"Maximum number of items?\"\n }\n },\n \"AttributeUpdates\": {\n \"LastPostedBy\": {\n \"Value\": {\n \"S\": \"alice@example.com\"\n },\n \"Action\": \"PUT\"\n }\n },\n \"Expected\": {\n \"LastPostedBy\": {\n \"ComparisonOperator\":\"EQ\",\n \"AttributeValueList\": [ { \"S\": \"fred@example.com\"} ]\n }\n },\n \"ReturnValues\": \"ALL_NEW\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> {\n \"Attributes\": {\n \"LastPostedBy\": {\n \"S\": \"alice@example.com\"\n },\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"LastPostDateTime\": {\n \"S\": \"20130320010350\"\n },\n \"Tags\": {\n \"SS\": [\"Update\",\"Multiple Items\",\"HelpMe\"]\n },\n \"Subject\": {\n \"S\": \"Maximum number of items?\"\n },\n \"Views\": {\n \"N\": \"5\"\n },\n \"Message\": {\n \"S\": \"I want to put 10 million data items to an Amazon DynamoDB table. Is there an upper limit?\"\n }\n }\n}\n </response>\n </example>\n <example>\n <name>Atomic Counter</name>\n <description>\n <p>This example increments the Replies attribute in the Thread table whenever someone\n posts a reply. Because ReturnValues is set to NONE, no output appears in the response\n payload.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.UpdateItem \n\n{\n \"TableName\": \"Thread\",\n \"Key\": {\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"Subject\": {\n \"S\": \"A question about updates\"\n }\n },\n \"AttributeUpdates\": {\n \"Replies\": {\n \"Action\": \"ADD\",\n \"Value\": {\"N\": \"1\"}\n }\n },\n \"ReturnValues\" : \"NONE\"\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> { \n}\n </response>\n </example>\n </examples>\n "
|
|
5948
5949
|
},
|
|
5949
5950
|
"UpdateTable": {
|
|
5950
5951
|
"name": "UpdateTable",
|
|
@@ -5969,18 +5970,18 @@
|
|
|
5969
5970
|
"shape_name": "PositiveLongObject",
|
|
5970
5971
|
"type": "long",
|
|
5971
5972
|
"min_length": 1,
|
|
5972
|
-
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n
|
|
5973
|
+
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
5973
5974
|
"required": true
|
|
5974
5975
|
},
|
|
5975
5976
|
"WriteCapacityUnits": {
|
|
5976
5977
|
"shape_name": "PositiveLongObject",
|
|
5977
5978
|
"type": "long",
|
|
5978
5979
|
"min_length": 1,
|
|
5979
|
-
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n
|
|
5980
|
+
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
5980
5981
|
"required": true
|
|
5981
5982
|
}
|
|
5982
5983
|
},
|
|
5983
|
-
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings
|
|
5984
|
+
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the <i>UpdateTable</i> operation.</p>\n <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>\n "
|
|
5984
5985
|
},
|
|
5985
5986
|
"GlobalSecondaryIndexUpdates": {
|
|
5986
5987
|
"shape_name": "GlobalSecondaryIndexUpdateList",
|
|
@@ -6010,27 +6011,27 @@
|
|
|
6010
6011
|
"shape_name": "PositiveLongObject",
|
|
6011
6012
|
"type": "long",
|
|
6012
6013
|
"min_length": 1,
|
|
6013
|
-
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n
|
|
6014
|
+
"documentation": "\n <p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
6014
6015
|
"required": true
|
|
6015
6016
|
},
|
|
6016
6017
|
"WriteCapacityUnits": {
|
|
6017
6018
|
"shape_name": "PositiveLongObject",
|
|
6018
6019
|
"type": "long",
|
|
6019
6020
|
"min_length": 1,
|
|
6020
|
-
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n
|
|
6021
|
+
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write\n Requirements</a> in the Amazon DynamoDB Developer Guide.</p>\n ",
|
|
6021
6022
|
"required": true
|
|
6022
6023
|
}
|
|
6023
6024
|
},
|
|
6024
|
-
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings
|
|
6025
|
+
"documentation": "\n <p>Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the <i>UpdateTable</i> operation.</p>\n <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>\n ",
|
|
6025
6026
|
"required": true
|
|
6026
6027
|
}
|
|
6027
6028
|
},
|
|
6028
|
-
"documentation": "\n <p>The name of a global secondary index, along with the updated provisioned throughput settings that are to be
|
|
6029
|
+
"documentation": "\n <p>The name of a global secondary index, along with the updated provisioned throughput settings that are to be\n applied to that index.</p>\n "
|
|
6029
6030
|
}
|
|
6030
6031
|
},
|
|
6031
6032
|
"documentation": "\n <p>Represents the new provisioned throughput settings to apply to a global secondary index.</p>\n "
|
|
6032
6033
|
},
|
|
6033
|
-
"documentation": "\n <p>An array of one or more global secondary indexes on the table, together with provisioned throughput settings
|
|
6034
|
+
"documentation": "\n <p>An array of one or more global secondary indexes on the table, together with provisioned throughput settings\n for each index.</p>\n "
|
|
6034
6035
|
}
|
|
6035
6036
|
},
|
|
6036
6037
|
"documentation": "\n <p>Represents the input of an <i>UpdateTable</i> operation.</p>\n "
|
|
@@ -6072,7 +6073,7 @@
|
|
|
6072
6073
|
},
|
|
6073
6074
|
"documentation": "\n <p>Represents an attribute for describing the key schema for the table and indexes.</p>\n "
|
|
6074
6075
|
},
|
|
6075
|
-
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects.
|
|
6076
|
+
"documentation": "\n <p>An array of <i>AttributeDefinition</i> objects. Each of these objects describes one attribute\n in the table and index key schema.</p>\n <p>Each <i>AttributeDefinition</i> object in this array is composed of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>AttributeType</i> - The data type for the attribute.</p>\n </li>\n </ul>\n "
|
|
6076
6077
|
},
|
|
6077
6078
|
"TableName": {
|
|
6078
6079
|
"shape_name": "TableName",
|
|
@@ -6104,15 +6105,15 @@
|
|
|
6104
6105
|
"HASH",
|
|
6105
6106
|
"RANGE"
|
|
6106
6107
|
],
|
|
6107
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
6108
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
6108
6109
|
"required": true
|
|
6109
6110
|
}
|
|
6110
6111
|
},
|
|
6111
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
6112
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
6112
6113
|
},
|
|
6113
6114
|
"min_length": 1,
|
|
6114
6115
|
"max_length": 2,
|
|
6115
|
-
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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
|
|
6116
|
+
"documentation": "\n <p>The primary key structure for the table. Each <i>KeySchemaElement</i> consists of:</p>\n <ul>\n <li>\n <p><i>AttributeName</i> - The name of the attribute.</p>\n </li>\n <li>\n <p><i>KeyType</i> - The key type for the attribute. Can be either <code>HASH</code> or\n <code>RANGE</code>.</p>\n </li>\n </ul>\n <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\n Amazon DynamoDB Developer Guide.</p>\n "
|
|
6116
6117
|
},
|
|
6117
6118
|
"TableStatus": {
|
|
6118
6119
|
"shape_name": "TableStatus",
|
|
@@ -6163,7 +6164,7 @@
|
|
|
6163
6164
|
"documentation": "\n <p>The maximum number of writes consumed per second before DynamoDB returns a\n <i>ThrottlingException</i>.</p>\n "
|
|
6164
6165
|
}
|
|
6165
6166
|
},
|
|
6166
|
-
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write\n
|
|
6167
|
+
"documentation": "\n <p>The provisioned throughput settings for the table, consisting of read and write capacity\n units, along with data about increases and decreases.</p>\n "
|
|
6167
6168
|
},
|
|
6168
6169
|
"TableSizeBytes": {
|
|
6169
6170
|
"shape_name": "Long",
|
|
@@ -6212,15 +6213,15 @@
|
|
|
6212
6213
|
"HASH",
|
|
6213
6214
|
"RANGE"
|
|
6214
6215
|
],
|
|
6215
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
6216
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
6216
6217
|
"required": true
|
|
6217
6218
|
}
|
|
6218
6219
|
},
|
|
6219
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
6220
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
6220
6221
|
},
|
|
6221
6222
|
"min_length": 1,
|
|
6222
6223
|
"max_length": 2,
|
|
6223
|
-
"documentation": "The complete index
|
|
6224
|
+
"documentation": "The complete index key schema,\n which consists of one or more pairs of attribute names and key types (<code>HASH</code> or\n <code>RANGE</code>). "
|
|
6224
6225
|
},
|
|
6225
6226
|
"Projection": {
|
|
6226
6227
|
"shape_name": "Projection",
|
|
@@ -6234,7 +6235,7 @@
|
|
|
6234
6235
|
"KEYS_ONLY",
|
|
6235
6236
|
"INCLUDE"
|
|
6236
6237
|
],
|
|
6237
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
6238
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
6238
6239
|
},
|
|
6239
6240
|
"NonKeyAttributes": {
|
|
6240
6241
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -6248,7 +6249,7 @@
|
|
|
6248
6249
|
},
|
|
6249
6250
|
"min_length": 1,
|
|
6250
6251
|
"max_length": 20,
|
|
6251
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
6252
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
6252
6253
|
}
|
|
6253
6254
|
},
|
|
6254
6255
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -6266,7 +6267,7 @@
|
|
|
6266
6267
|
},
|
|
6267
6268
|
"documentation": "\n <p>Represents the properties of a local secondary index.</p>\n "
|
|
6268
6269
|
},
|
|
6269
|
-
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given
|
|
6270
|
+
"documentation": "\n <p>Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value.\n Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount\n of data within a given item collection cannot exceed 10 GB. Each element is composed of:</p>\n <ul>\n <li>\n <p><i>IndexName</i> - The name of the local secondary index.</p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - Represents the total size of the index, in bytes. DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.</p>\n </li>\n <li>\n <p><i>ItemCount</i> - Represents the number of items in the index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.</p>\n </li>\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
6270
6271
|
},
|
|
6271
6272
|
"GlobalSecondaryIndexes": {
|
|
6272
6273
|
"shape_name": "GlobalSecondaryIndexDescriptionList",
|
|
@@ -6305,15 +6306,15 @@
|
|
|
6305
6306
|
"HASH",
|
|
6306
6307
|
"RANGE"
|
|
6307
6308
|
],
|
|
6308
|
-
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value
|
|
6309
|
+
"documentation": "\n <p>The attribute data, consisting of the data type and the attribute value itself.</p>\n ",
|
|
6309
6310
|
"required": true
|
|
6310
6311
|
}
|
|
6311
6312
|
},
|
|
6312
|
-
"documentation": "\n <p>Represents a single element of a key schema. A key schema specifies the attributes
|
|
6313
|
+
"documentation": "\n <p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.</p>\n <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a\n hash type primary key would be represented by one <i>KeySchemaElement</i>. A hash-and-range\n type primary key would require one <i>KeySchemaElement</i> for the hash attribute, and another\n <i>KeySchemaElement</i> for the range attribute.</p>\n "
|
|
6313
6314
|
},
|
|
6314
6315
|
"min_length": 1,
|
|
6315
6316
|
"max_length": 2,
|
|
6316
|
-
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and
|
|
6317
|
+
"documentation": "\n <p>The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and\n key types (<code>HASH</code> or <code>RANGE</code>).</p>\n "
|
|
6317
6318
|
},
|
|
6318
6319
|
"Projection": {
|
|
6319
6320
|
"shape_name": "Projection",
|
|
@@ -6327,7 +6328,7 @@
|
|
|
6327
6328
|
"KEYS_ONLY",
|
|
6328
6329
|
"INCLUDE"
|
|
6329
6330
|
],
|
|
6330
|
-
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the
|
|
6331
|
+
"documentation": "\n <p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the index.\n The list of projected attributes are in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the index.</p>\n </li>\n </ul>\n "
|
|
6331
6332
|
},
|
|
6332
6333
|
"NonKeyAttributes": {
|
|
6333
6334
|
"shape_name": "NonKeyAttributeNameList",
|
|
@@ -6341,7 +6342,7 @@
|
|
|
6341
6342
|
},
|
|
6342
6343
|
"min_length": 1,
|
|
6343
6344
|
"max_length": 20,
|
|
6344
|
-
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n
|
|
6345
|
+
"documentation": "\n <p>Represents the non-key attribute names which will be projected into the index.</p>\n <p>For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.</p>\n "
|
|
6345
6346
|
}
|
|
6346
6347
|
},
|
|
6347
6348
|
"documentation": "\n <p>Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.</p>\n "
|
|
@@ -6355,7 +6356,7 @@
|
|
|
6355
6356
|
"DELETING",
|
|
6356
6357
|
"ACTIVE"
|
|
6357
6358
|
],
|
|
6358
|
-
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or
|
|
6359
|
+
"documentation": "\n <p>The current state of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated, as the result of a <i>CreateTable</i> or\n <i>UpdateTable</i> operation.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted, as the result of a <i>DeleteTable</i>\n operation.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n "
|
|
6359
6360
|
},
|
|
6360
6361
|
"ProvisionedThroughput": {
|
|
6361
6362
|
"shape_name": "ProvisionedThroughputDescription",
|
|
@@ -6405,7 +6406,7 @@
|
|
|
6405
6406
|
},
|
|
6406
6407
|
"documentation": "\n <p>Represents the properties of a global secondary index.</p>\n "
|
|
6407
6408
|
},
|
|
6408
|
-
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given
|
|
6409
|
+
"documentation": "\n <p>The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each\n element is composed of:</p>\n <ul>\n\n <li>\n <p><i>IndexName</i> - The name of the global secondary index.</p>\n </li>\n <li>\n <p><i>IndexSizeBytes</i> - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>IndexStatus</i> - The current status of the global secondary index:</p>\n <ul>\n <li>\n <p><i>CREATING</i> - The index is being created.</p>\n </li>\n <li>\n <p><i>UPDATING</i> - The index is being updated.</p>\n </li>\n <li>\n <p><i>DELETING</i> - The index is being deleted.</p>\n </li>\n <li>\n <p><i>ACTIVE</i> - The index is ready for use.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ItemCount</i> - The number of items in the global secondary index. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n </p>\n </li>\n <li>\n <p><i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin\n with the same hash key attribute as the table.</p>\n </li>\n <li> <p><i>Projection</i> - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:</p>\n <ul>\n <li>\n <p><i>ProjectionType</i> - One\n of the following:</p>\n <ul>\n <li>\n <p><code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p><code>INCLUDE</code> - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in <i>NonKeyAttributes</i>.</p>\n </li>\n <li>\n <p><code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n </li>\n <li>\n <p><i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are \n 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>\n </li>\n </ul>\n </li>\n <li>\n <p><i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases. </p>\n </li>\n\n\n\n\n </ul>\n <p>If the table is in the <code>DELETING</code> state, no information about indexes will be\n returned.</p>\n "
|
|
6409
6410
|
}
|
|
6410
6411
|
},
|
|
6411
6412
|
"documentation": "\n <p>Represents the properties of a table.</p>\n "
|
|
@@ -6436,7 +6437,7 @@
|
|
|
6436
6437
|
"documentation": "\n <p>The resource which is being requested does not exist.</p>\n "
|
|
6437
6438
|
}
|
|
6438
6439
|
},
|
|
6439
|
-
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified
|
|
6440
|
+
"documentation": "\n <p>The operation tried to access a nonexistent table or index. The resource may not be specified\n correctly, or its status may not be <code>ACTIVE</code>.</p>\n "
|
|
6440
6441
|
},
|
|
6441
6442
|
{
|
|
6442
6443
|
"shape_name": "LimitExceededException",
|
|
@@ -6448,7 +6449,7 @@
|
|
|
6448
6449
|
"documentation": "\n <p>Too many operations for a given subscriber.</p>\n "
|
|
6449
6450
|
}
|
|
6450
6451
|
},
|
|
6451
|
-
"documentation": "\n <p>The number of concurrent table requests (cumulative number of tables in the\n <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the\n maximum allowed of 10.</p>\n <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code
|
|
6452
|
+
"documentation": "\n <p>The number of concurrent table requests (cumulative number of tables in the\n <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the\n maximum allowed of 10.</p>\n <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code>\n state at any point in time. Do not attempt to create more than one such table\n simultaneously.</p>\n <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>\n "
|
|
6452
6453
|
},
|
|
6453
6454
|
{
|
|
6454
6455
|
"shape_name": "InternalServerError",
|
|
@@ -6463,7 +6464,7 @@
|
|
|
6463
6464
|
"documentation": "\n <p>An error occurred on the server side.</p>\n "
|
|
6464
6465
|
}
|
|
6465
6466
|
],
|
|
6466
|
-
"documentation": "\n <p>Updates the provisioned throughput for the given table. Setting the throughput for a table\n helps you manage performance and is part of the provisioned throughput feature of DynamoDB.</p>\n <p>The provisioned throughput values can be upgraded or downgraded based on the maximums and\n minimums listed in the <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Limits</a> section in the
|
|
6467
|
+
"documentation": "\n <p>Updates the provisioned throughput for the given table. Setting the throughput for a table\n helps you manage performance and is part of the provisioned throughput feature of DynamoDB.</p>\n <p>The provisioned throughput values can be upgraded or downgraded based on the maximums and\n minimums listed in the <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Limits</a> section in the\n Amazon DynamoDB Developer Guide.</p>\n <p>The table must be in the <code>ACTIVE</code> state for this operation to succeed.\n <i>UpdateTable</i> is an asynchronous operation; while executing the operation, the table is\n in the <code>UPDATING</code> state. While the table is in the <code>UPDATING</code> state, the\n table still has the provisioned throughput from before the call. The new provisioned\n throughput setting is in effect only when the table returns to the <code>ACTIVE</code> state\n after the <i>UpdateTable</i> operation. </p>\n <p>You cannot add, modify or delete indexes using <i>UpdateTable</i>. Indexes can only be\n defined at table creation time.</p>\n\n <examples>\n <example>\n <name>Modify Provisioned Write Throughput</name>\n <description>\n <p> This example changes both the provisioned read and write throughput of the Thread\n table to 10 capacity units.</p>\n </description>\n <request><![CDATA[\nPOST / HTTP/1.1\nHost: dynamodb.<region>.<domain>;\nX-Amz-Date: <Date>\nAuthorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=<Signature>\nUser-Agent: <UserAgentString>\nx-amz-content-sha256: <PayloadHash>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes> \nConnection: Keep-Alive]]> X-Amz-Target: DynamoDB_20120810.UpdateTable \n\n{\n \"TableName\": \"Thread\",\n \"ProvisionedThroughput\": {\n \"ReadCapacityUnits\": 10,\n \"WriteCapacityUnits\": 10\n }\n}\n </request>\n <response><![CDATA[\nHTTP/1.1 200 OK\nx-amzn-RequestId: <RequestId> \nx-amz-crc32: <Checksum>\nContent-Type: application/x-amz-json-1.0\nContent-Length: <PayloadSizeBytes>\nDate: <Date>\n]]> { \n \"TableDescription\": {\n \"AttributeDefinitions\": [\n {\n \"AttributeName\": \"ForumName\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"AttributeType\": \"S\"\n }\n ],\n \"CreationDateTime\": 1.363801528686E9,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"LocalSecondaryIndexes\": [\n {\n \"IndexName\": \"LastPostIndex\",\n \"IndexSizeBytes\": 0,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"Projection\": {\n \"ProjectionType\": \"KEYS_ONLY\"\n }\n }\n ],\n \"ProvisionedThroughput\": {\n \"LastIncreaseDateTime\": 1.363801701282E9,\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Thread\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"UPDATING\"\n }\n}\n </response>\n </example>\n </examples>\n "
|
|
6467
6468
|
}
|
|
6468
6469
|
}
|
|
6469
6470
|
}
|