1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
|
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
class AWS::DynamoDB::Client::V20120810 < AWS::DynamoDB::Client
# client methods #
# @!method batch_get_item(options = {})
# Calls the BatchGetItem API operation.
# @param [Hash] options
#
# * `:request_items` - *required* - (Hash<String,Hash>) A map of one or
# more table names and, for each table, the corresponding primary
# keys for the items to retrieve. Each table name can be invoked only
# once. Each element in the map consists of the following: Keys - An
# array of primary key attribute values that define specific items in
# the table. AttributesToGet - One or more attributes to be retrieved
# from the table or index. By default, all attributes are returned.
# If a specified attribute is not found, it does not appear in the
# result. ConsistentRead - If `true` , a strongly consistent read is
# used; if `false` (the default), an eventually consistent read is
# used.
# * `:keys` - *required* - (Array<Hash<String,Hash>>) Represents the
# primary key attribute values that define the items and the
# attributes associated with the items.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:attributes_to_get` - (Array<String>) Represents one or more
# attributes to retrieve from the table or index. If no attribute
# names are specified then all attributes will be returned. If any
# of the specified attributes are not found, they will not appear
# in the result.
# * `:consistent_read` - (Boolean) Represents the consistency of a
# read operation. If set to `true` , then a strongly consistent
# read is used; otherwise, an eventually consistent read is used.
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:responses` - (Hash<String,Hash>)
# * `:member` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:unprocessed_keys` - (Hash<String,Hash>)
# * `:member` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:attributes_to_get` - (Array<String>)
# * `:consistent_read` - (Boolean)
# * `:consumed_capacity` - (Array<Hash>)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# @!method batch_write_item(options = {})
# Calls the BatchWriteItem API operation.
# @param [Hash] options
#
# * `:request_items` - *required* - (Hash<String,Array<Hash>>) A map of
# one or more table names and, for each table, a list of operations
# to be performed (DeleteRequest or PutRequest). Each element in the
# map consists of the following: DeleteRequest - Perform a DeleteItem
# operation on the specified item. The item to be deleted is
# identified by a Key subelement: Key - A map of primary key
# attribute values that uniquely identify the item. Each entry in
# this map consists of an attribute name and an attribute value.
# PutRequest - Perform a PutItem operation on the specified item. The
# item to be put is identified by an Item subelement: Item - A map of
# attributes and their values. Each entry in this map consists of an
# attribute name and an attribute value. Attribute values must not be
# null; string and binary type attributes must have lengths greater
# than zero; and set type attributes must not be empty. Requests that
# contain empty values will be rejected with a ValidationException.
# If you specify any attributes that are part of an index key, then
# the data types for those attributes must match those of the schema
# in the table's attribute definition.
# * `:put_request` - (Hash) Represents a request to perform a
# DeleteItem operation.
# * `:item` - *required* - (Hash<String,Hash>) A map of attribute
# name to attribute values, representing the primary key of an
# item to be processed by PutItem. All of the table's primary key
# attributes must be specified, and their data types must match
# those of the table's key schema. If any attributes are present
# in the item which are part of an index key schema for the
# table, their types must match the index key schema.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:delete_request` - (Hash) Represents a request to perform a
# PutItem operation.
# * `:key` - *required* - (Hash<String,Hash>) A map of attribute
# name to attribute values, representing the primary key of the
# item to delete. All of the table's primary key attributes must
# be specified, and their data types must match those of the
# table's key schema.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# * `:return_item_collection_metrics` - (String) Valid values include:
# * `SIZE`
# * `NONE`
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:unprocessed_items` - (Hash<String,Hash>)
# * `:value` - (Array<Hash>)
# * `:put_request` - (Hash)
# * `:item` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:delete_request` - (Hash)
# * `:key` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:item_collection_metrics` - (Hash<String,Hash>)
# * `:value` - (Array<Hash>)
# * `:item_collection_key` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:size_estimate_range_gb` - (Array<Float>)
# * `:consumed_capacity` - (Array<Hash>)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# @!method create_table(options = {})
# Calls the CreateTable API operation.
# @param [Hash] options
#
# * `:attribute_definitions` - *required* - (Array<Hash>) An array of
# attributes that describe the key schema for the table and indexes.
# * `:attribute_name` - *required* - (String) A name for the
# attribute.
# * `:attribute_type` - *required* - (String) The data type for the
# attribute. Valid values include:
# * `S`
# * `N`
# * `B`
# * `:table_name` - *required* - (String) The name of the table to
# create.
# * `:key_schema` - *required* - (Array<Hash>) Specifies the attributes
# that make up the primary key for the table. The attributes in
# KeySchema must also be defined in the AttributeDefinitions array.
# For more information, see Data Model . Each KeySchemaElement in the
# array is composed of: AttributeName - The name of this key
# attribute. KeyType - Determines whether the key attribute is HASH
# or RANGE. For a primary key that consists of a hash attribute, you
# must specify exactly one element with a KeyType of HASH. For a
# primary key that consists of hash and range attributes, you must
# specify exactly two elements, in this order: The first element must
# have a KeyType of HASH, and the second element must have a KeyType
# of RANGE. For more information, see Specifying the Primary Key .
# * `:attribute_name` - *required* - (String) Represents the name of
# a key attribute.
# * `:key_type` - *required* - (String) Represents the attribute
# data, consisting of the data type and the attribute value itself.
# Valid values include:
# * `HASH`
# * `RANGE`
# * `:local_secondary_indexes` - (Array<Hash>) One or more secondary
# indexes (the maximum is five) to be created on the table. Each
# index is scoped to a given hash key value. There is a 10 gigabyte
# size limit per hash key; otherwise, the size of a local secondary
# index is unconstrained. Each secondary index in the array includes
# the following: IndexName - The name of the secondary index. Must be
# unique only for this table. KeySchema - Specifies the key schema
# for the index. The key schema must begin with the same hash key
# attribute as the table.
# * `:index_name` - *required* - (String) Represents the name of the
# secondary index. The name must be unique among all other indexes
# on this table.
# * `:key_schema` - *required* - (Array<Hash>) Represents the
# complete index key schema, which consists of one or more pairs of
# attribute names and key types (HASH or RANGE).
# * `:attribute_name` - *required* - (String) Represents the name
# of a key attribute.
# * `:key_type` - *required* - (String) Represents the attribute
# data, consisting of the data type and the attribute value
# itself. Valid values include:
# * `HASH`
# * `RANGE`
# * `:projection` - *required* - (Hash)
# * `:projection_type` - (String) Represents the set of attributes
# that are projected into the index: KEYS_ONLY - Only the index
# and primary keys are projected into the index. INCLUDE - Only
# the specified table attributes are projected into the index.
# The list of projected attributes are in NonKeyAttributes. ALL -
# All of the table attributes are projected into the index. Valid
# values include:
# * `ALL`
# * `KEYS_ONLY`
# * `INCLUDE`
# * `:non_key_attributes` - (Array<String>) Represents the non-key
# attribute names which will be projected into the index. The
# total count of attributes specified in NonKeyAttributes, summed
# across all of the local secondary indexes, must not exceed 20.
# If you project the same attribute into two different indexes,
# this counts as two distinct attributes when determining the
# total.
# * `:provisioned_throughput` - *required* - (Hash)
# * `:read_capacity_units` - *required* - (Integer) The maximum
# number of strongly consistent reads consumed per second before
# returns a ThrottlingException. For more information, see
# Specifying Read and Write Requirements .
# * `:write_capacity_units` - *required* - (Integer) The maximum
# number of writes consumed per second before returns a
# ThrottlingException. For more information, see Specifying Read
# and Write Requirements .
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:table_description` - (Hash)
# * `:attribute_definitions` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:attribute_type` - (String)
# * `:table_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:table_status` - (String)
# * `:creation_date_time` - (Time)
# * `:provisioned_throughput` - (Hash)
# * `:last_increase_date_time` - (Time)
# * `:last_decrease_date_time` - (Time)
# * `:number_of_decreases_today` - (Integer)
# * `:read_capacity_units` - (Integer)
# * `:write_capacity_units` - (Integer)
# * `:table_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# * `:local_secondary_indexes` - (Array<Hash>)
# * `:index_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:projection` - (Hash)
# * `:projection_type` - (String)
# * `:non_key_attributes` - (Array<String>)
# * `:index_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# @!method delete_item(options = {})
# Calls the DeleteItem API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table from
# which to delete the item.
# * `:key` - *required* - (Hash<String,Hash>) A map of attribute names
# to AttributeValue objects, representing the primary key of the item
# to delete.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:expected` - (Hash<String,Hash>) A map of attribute/condition
# pairs. This is the conditional block for the DeleteItemoperation.
# All the conditions must be met for the operation to succeed.
# * `:value` - (Hash) Specify whether or not a value already exists
# and has a specific content for the attribute name-value pair.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:exists` - (Boolean) Causes to evaluate the value before
# attempting a conditional operation: If Exists is `true` , will
# check to see if that attribute value already exists in the table.
# If it is found, then the operation succeeds. If it is not found,
# the operation fails with a ConditionalCheckFailedException. If
# Exists is `false` , assumes that the attribute value does not
# exist in the table. If in fact the value does not exist, then the
# assumption is valid and the operation succeeds. If the value is
# found, despite the assumption that it does not exist, the
# operation fails with a ConditionalCheckFailedException. The
# default setting for Exists is `true` . If you supply a Value all
# by itself, assumes the attribute exists: You don't have to set
# Exists to `true` , because it is implied. returns a
# ValidationException if: Exists is `true` but there is no Value to
# check. (You expect a value to exist, but don't specify what that
# value is.) Exists is `false` but you also specify a Value. (You
# cannot expect an attribute to have a value, while also expecting
# it not to exist.) If you specify more than one condition for
# Exists, then all of the conditions must evaluate to `true` . (In
# other words, the conditions are ANDed together.) Otherwise, the
# conditional operation will fail.
# * `:return_values` - (String) Use ReturnValues if you want to get the
# item attributes as they appeared before they were deleted. For
# DeleteItem, the valid values are: NONE - If ReturnValues is not
# specified, or if its value is NONE, then nothing is returned. (This
# is the default for ReturnValues.) ALL_OLD - The content of the old
# item is returned. Valid values include:
# * `NONE`
# * `ALL_OLD`
# * `UPDATED_OLD`
# * `ALL_NEW`
# * `UPDATED_NEW`
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# * `:return_item_collection_metrics` - (String) Valid values include:
# * `SIZE`
# * `NONE`
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:attributes` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:consumed_capacity` - (Hash)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# * `:item_collection_metrics` - (Hash)
# * `:item_collection_key` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:size_estimate_range_gb` - (Array<Float>)
# @!method delete_table(options = {})
# Calls the DeleteTable API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table to
# delete.
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:table_description` - (Hash)
# * `:attribute_definitions` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:attribute_type` - (String)
# * `:table_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:table_status` - (String)
# * `:creation_date_time` - (Time)
# * `:provisioned_throughput` - (Hash)
# * `:last_increase_date_time` - (Time)
# * `:last_decrease_date_time` - (Time)
# * `:number_of_decreases_today` - (Integer)
# * `:read_capacity_units` - (Integer)
# * `:write_capacity_units` - (Integer)
# * `:table_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# * `:local_secondary_indexes` - (Array<Hash>)
# * `:index_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:projection` - (Hash)
# * `:projection_type` - (String)
# * `:non_key_attributes` - (Array<String>)
# * `:index_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# @!method describe_table(options = {})
# Calls the DescribeTable API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table to
# describe.
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:table` - (Hash)
# * `:attribute_definitions` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:attribute_type` - (String)
# * `:table_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:table_status` - (String)
# * `:creation_date_time` - (Time)
# * `:provisioned_throughput` - (Hash)
# * `:last_increase_date_time` - (Time)
# * `:last_decrease_date_time` - (Time)
# * `:number_of_decreases_today` - (Integer)
# * `:read_capacity_units` - (Integer)
# * `:write_capacity_units` - (Integer)
# * `:table_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# * `:local_secondary_indexes` - (Array<Hash>)
# * `:index_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:projection` - (Hash)
# * `:projection_type` - (String)
# * `:non_key_attributes` - (Array<String>)
# * `:index_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# @!method get_item(options = {})
# Calls the GetItem API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table
# containing the requested item.
# * `:key` - *required* - (Hash<String,Hash>) A map of attribute names
# to AttributeValue objects, representing the primary key of the item
# to retrieve.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:attributes_to_get` - (Array<String>)
# * `:consistent_read` - (Boolean)
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:item` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:consumed_capacity` - (Hash)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# @!method list_tables(options = {})
# Calls the ListTables API operation.
# @param [Hash] options
#
# * `:exclusive_start_table_name` - (String) The name of the table that
# starts the list. If you already ran a ListTables operation and
# received a LastEvaluatedTableName value in the response, use that
# value here to continue the list.
# * `:limit` - (Integer) A maximum number of table names to return.
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:table_names` - (Array<String>)
# * `:last_evaluated_table_name` - (String)
# @!method put_item(options = {})
# Calls the PutItem API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table to
# contain the item.
# * `:item` - *required* - (Hash<String,Hash>) A map of attribute
# name/value pairs, one for each attribute. Only the primary key
# attributes are required; you can optionally provide other attribute
# name-value pairs for the item. If you specify any attributes that
# are part of an index key, then the data types for those attributes
# must match those of the schema in the table's attribute definition.
# For more information about primary keys, see Primary Key . Each
# element in the Item map is an AttributeValue object.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:expected` - (Hash<String,Hash>) A map of attribute/condition
# pairs. This is the conditional block for the PutItem operation. All
# the conditions must be met for the operation to succeed.
# * `:value` - (Hash) Specify whether or not a value already exists
# and has a specific content for the attribute name-value pair.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:exists` - (Boolean) Causes to evaluate the value before
# attempting a conditional operation: If Exists is `true` , will
# check to see if that attribute value already exists in the table.
# If it is found, then the operation succeeds. If it is not found,
# the operation fails with a ConditionalCheckFailedException. If
# Exists is `false` , assumes that the attribute value does not
# exist in the table. If in fact the value does not exist, then the
# assumption is valid and the operation succeeds. If the value is
# found, despite the assumption that it does not exist, the
# operation fails with a ConditionalCheckFailedException. The
# default setting for Exists is `true` . If you supply a Value all
# by itself, assumes the attribute exists: You don't have to set
# Exists to `true` , because it is implied. returns a
# ValidationException if: Exists is `true` but there is no Value to
# check. (You expect a value to exist, but don't specify what that
# value is.) Exists is `false` but you also specify a Value. (You
# cannot expect an attribute to have a value, while also expecting
# it not to exist.) If you specify more than one condition for
# Exists, then all of the conditions must evaluate to `true` . (In
# other words, the conditions are ANDed together.) Otherwise, the
# conditional operation will fail.
# * `:return_values` - (String) Use ReturnValues if you want to get the
# item attributes as they appeared before they were updated with the
# PutItem request. For PutItem, the valid values are: NONE - If
# ReturnValues is not specified, or if its value is NONE, then
# nothing is returned. (This is the default for ReturnValues.)
# ALL_OLD - If PutItem overwrote an attribute name-value pair, then
# the content of the old item is returned. Valid values include:
# * `NONE`
# * `ALL_OLD`
# * `UPDATED_OLD`
# * `ALL_NEW`
# * `UPDATED_NEW`
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# * `:return_item_collection_metrics` - (String) Valid values include:
# * `SIZE`
# * `NONE`
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:attributes` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:consumed_capacity` - (Hash)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# * `:item_collection_metrics` - (Hash)
# * `:item_collection_key` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:size_estimate_range_gb` - (Array<Float>)
# @!method query(options = {})
# Calls the Query API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table
# containing the requested items.
# * `:index_name` - (String) The name of an index on the table to
# query.
# * `:select` - (String) The attributes to be returned in the result.
# You can retrieve all item attributes, specific item attributes, the
# count of matching items, or in the case of an index, some or all of
# the attributes projected into the index. ALL_ATTRIBUTES: Returns
# all of the item attributes. For a table, this is the default. For
# an index, this mode causes to fetch the full item from the table
# for each matching item in the index. If the index is configured to
# project all item attributes, the matching items will not be fetched
# from the table. Fetching items from the table incurs additional
# throughput cost and latency. ALL_PROJECTED_ATTRIBUTES: Allowed only
# when querying an index. Retrieves all attributes which have been
# projected into the index. If the index is configured to project all
# attributes, this is equivalent to specifying ALL_ATTRIBUTES. COUNT:
# Returns the number of matching items, rather than the matching
# items themselves. SPECIFIC_ATTRIBUTES : Returns only the attributes
# listed in AttributesToGet. This is equivalent to specifying
# AttributesToGet without specifying any value for Select. When
# neither Select nor AttributesToGet are specified, defaults to
# ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES
# when accessing an index. You cannot use both Select and
# AttributesToGet together in a single request, unless the value for
# Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to
# specifying AttributesToGet without any value for Select.) Valid
# values include:
# * `ALL_ATTRIBUTES`
# * `ALL_PROJECTED_ATTRIBUTES`
# * `SPECIFIC_ATTRIBUTES`
# * `COUNT`
# * `:attributes_to_get` - (Array<String>) You cannot use both
# AttributesToGet and Select together in a Query request, unless the
# value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent
# to specifying AttributesToGet without any value for Select.)
# * `:limit` - (Integer)
# * `:consistent_read` - (Boolean)
# * `:key_conditions` - (Hash<String,Hash>) The selection criteria for
# the query. For a query on a table, you can only have conditions on
# the table primary key attributes. you must specify the hash key
# attribute name and value as an EQ condition. You can optionally
# specify a second condition, referring to the range key attribute.
# For a query on a secondary index, you can only have conditions on
# the index key attributes. You must specify the index hash attribute
# name and value as an EQ condition. You can optionally specify a
# second condition, referring to the index key range attribute.
# Multiple conditions are evaluated using "AND"; in other words, all
# of the conditions must be met in order for an item to appear in the
# results results. Each KeyConditions element consists of an
# attribute name to compare, along with the following:
# AttributeValueList - One or more values to evaluate against the
# supplied attribute. This list contains exactly one value, except
# for a BETWEEN or IN comparison, in which case the list contains two
# values. For type Number, value comparisons are numeric. String
# value comparisons for greater than, equals, or less than are based
# on ASCII character code values. For example, a is greater than A,
# and aa is greater than B. For a list of code values, see
# http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. For
# Binary, treats each byte of the binary data as unsigned when it
# compares binary values, for example when evaluating query
# expressions. ComparisonOperator - A comparator for evaluating
# attributes. For example, equals, greater than, less than, etc. For
# information on specifying data types in JSON, see JSON Data Format
# . The following are descriptions of each comparison operator. EQ :
# Equal. AttributeValueList can contain only one AttributeValue of
# type String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does not
# equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2",
# "1"]}. LE : Less than or equal. AttributeValueList can contain only
# one AttributeValue of type String, Number, or Binary (not a set).
# If an item contains an AttributeValue of a different type than the
# one specified in the request, the value does not match. For
# example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does
# not compare to {"NS":["6", "2", "1"]}. LT : Less than.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does not
# equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6",
# "2", "1"]}. GE : Greater than or equal. AttributeValueList can
# contain only one AttributeValue of type String, Number, or Binary
# (not a set). If an item contains an AttributeValue of a different
# type than the one specified in the request, the value does not
# match. For example, {"S":"6"} does not equal {"N":"6"}. Also,
# {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GT : Greater
# than. AttributeValueList can contain only one AttributeValue of
# type String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does not
# equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6",
# "2", "1"]}. BEGINS_WITH : checks for a prefix. AttributeValueList
# can contain only one AttributeValue of type String or Binary (not a
# Number or a set). The target attribute of the comparison must be a
# String or Binary (not a Number or a set). BETWEEN : Greater than or
# equal to the first value, and less than or equal to the second
# value. AttributeValueList must contain two AttributeValue elements
# of the same type, either String, Number, or Binary (not a set). A
# target attribute matches if the target value is greater than, or
# equal to, the first element and less than, or equal to, the second
# element. If an item contains an AttributeValue of a different type
# than the one specified in the request, the value does not match.
# For example, {"S":"6"} does not compare to {"N":"6"}. Also,
# {"N":"6"} does not compare to {"NS":["6", "2", "1"]}
# * `:attribute_value_list` - (Array<Hash>) Represents one or more
# values to evaluate against the supplied attribute. This list
# contains exactly one value, except for a BETWEEN or IN
# comparison, in which case the list contains two values. For type
# Number, value comparisons are numeric. String value comparisons
# for greater than, equals, or less than are based on ASCII
# character code values. For example, a is greater than A, and aa
# is greater than B. For a list of code values, see
# http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
# For Binary, treats each byte of the binary data as unsigned when
# it compares binary values, for example when evaluating query
# expressions.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:comparison_operator` - *required* - (String) Represents a
# comparator for evaluating attributes. For example, equals,
# greater than, less than, etc. For information on specifying data
# types in JSON, see JSON Data Format . The following are
# descriptions of each comparison operator. EQ : Equal.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does
# not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6",
# "2", "1"]}. NE : Not equal. AttributeValueList can contain only
# one AttributeValue of type String, Number, or Binary (not a set).
# If an item contains an AttributeValue of a different type than
# the one specified in the request, the value does not match. For
# example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does
# not equal {"NS":["6", "2", "1"]}. LE : Less than or equal.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does
# not equal {"N":"6"}. Also, {"N":"6"} does not compare to
# {"NS":["6", "2", "1"]}. LT : Less than. AttributeValueList can
# contain only one AttributeValue of type String, Number, or Binary
# (not a set). If an item contains an AttributeValue of a different
# type than the one specified in the request, the value does not
# match. For example, {"S":"6"} does not equal {"N":"6"}. Also,
# {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GE :
# Greater than or equal. AttributeValueList can contain only one
# AttributeValue of type String, Number, or Binary (not a set). If
# an item contains an AttributeValue of a different type than the
# one specified in the request, the value does not match. For
# example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does
# not compare to {"NS":["6", "2", "1"]}. GT : Greater than.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does
# not equal {"N":"6"}. Also, {"N":"6"} does not compare to
# {"NS":["6", "2", "1"]}. NOT_NULL : The attribute exists. NULL :
# The attribute does not exist. CONTAINS : checks for a
# subsequence, or value in a set. AttributeValueList can contain
# only one AttributeValue of type String, Number, or Binary (not a
# set). If the target attribute of the comparison is a String, then
# the operation checks for a substring match. If the target
# attribute of the comparison is Binary, then the operation looks
# for a subsequence of the target that matches the input. If the
# target attribute of the comparison is a set ("SS", "NS", or
# "BS"), then the operation checks for a member of the set (not as
# a substring). NOT_CONTAINS : checks for absence of a subsequence,
# or absence of a value in a set. AttributeValueList can contain
# only one AttributeValue of type String, Number, or Binary (not a
# set). If the target attribute of the comparison is a String, then
# the operation checks for the absence of a substring match. If the
# target attribute of the comparison is Binary, then the operation
# checks for the absence of a subsequence of the target that
# matches the input. If the target attribute of the comparison is a
# set ("SS", "NS", or "BS"), then the operation checks for the
# absence of a member of the set (not as a substring). BEGINS_WITH
# : checks for a prefix. AttributeValueList can contain only one
# AttributeValue of type String or Binary (not a Number or a set).
# The target attribute of the comparison must be a String or Binary
# (not a Number or a set). IN : checks for exact matches.
# AttributeValueList can contain more than one AttributeValue of
# type String, Number, or Binary (not a set). The target attribute
# of the comparison must be of the same type and exact value to
# match. A String never matches a String set. BETWEEN : Greater
# than or equal to the first value, and less than or equal to the
# second value. AttributeValueList must contain two AttributeValue
# elements of the same type, either String, Number, or Binary (not
# a set). A target attribute matches if the target value is greater
# than, or equal to, the first element and less than, or equal to,
# the second element. If an item contains an AttributeValue of a
# different type than the one specified in the request, the value
# does not match. For example, {"S":"6"} does not compare to
# {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
# "1"]} Valid values include:
# * `EQ`
# * `NE`
# * `IN`
# * `LE`
# * `LT`
# * `GE`
# * `GT`
# * `BETWEEN`
# * `NOT_NULL`
# * `NULL`
# * `CONTAINS`
# * `NOT_CONTAINS`
# * `BEGINS_WITH`
# * `:scan_index_forward` - (Boolean) Specifies ascending ( `true` ) or
# descending ( `false` ) traversal of the index. returns results
# reflecting the requested order determined by the range key. If the
# data type is Number, the results are returned in numeric order. For
# String, the results are returned in order of ASCII character code
# values. For Binary, Amazon DynamoDB treats each byte of the binary
# data as unsigned when it compares binary values. If
# ScanIndexForward is not specified, the results are returned in
# ascending order.
# * `:exclusive_start_key` - (Hash<String,Hash>)
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:member` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:count` - (Integer)
# * `:last_evaluated_key` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:consumed_capacity` - (Hash)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# @!method scan(options = {})
# Calls the Scan API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table
# containing the requested items.
# * `:attributes_to_get` - (Array<String>)
# * `:limit` - (Integer)
# * `:select` - (String) The attributes to be returned in the result.
# You can retrieve all item attributes, specific item attributes, the
# count of matching items, or in the case of an index, some or all of
# the attributes projected into the index. ALL_ATTRIBUTES: Returns
# all of the item attributes. For a table, this is the default. For
# an index, this mode causes to fetch the full item from the table
# for each matching item in the index. If the index is configured to
# project all item attributes, the matching items will not be fetched
# from the table. Fetching items from the table incurs additional
# throughput cost and latency. ALL_PROJECTED_ATTRIBUTES: Retrieves
# all attributes which have been projected into the index. If the
# index is configured to project all attributes, this is equivalent
# to specifying ALL_ATTRIBUTES. COUNT: Returns the number of matching
# items, rather than the matching items themselves.
# SPECIFIC_ATTRIBUTES : Returns only the attributes listed in
# AttributesToGet. This is equivalent to specifying AttributesToGet
# without specifying any value for Select. When neither Select nor
# AttributesToGet are specified, defaults to ALL_ATTRIBUTES when
# accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
# index. You cannot use both Select and AttributesToGet together in a
# single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
# (This usage is equivalent to specifying AttributesToGet without any
# value for Select.) Valid values include:
# * `ALL_ATTRIBUTES`
# * `ALL_PROJECTED_ATTRIBUTES`
# * `SPECIFIC_ATTRIBUTES`
# * `COUNT`
# * `:scan_filter` - (Hash<String,Hash>) Evaluates the scan results and
# returns only the desired values. Multiple conditions are treated as
# "AND" operations: all conditions must be met to be included in the
# results. Each ScanConditions element consists of an attribute name
# to compare, along with the following: AttributeValueList - One or
# more values to evaluate against the supplied attribute. This list
# contains exactly one value, except for a BETWEEN or IN comparison,
# in which case the list contains two values. For type Number, value
# comparisons are numeric. String value comparisons for greater than,
# equals, or less than are based on ASCII character code values. For
# example, a is greater than A, and aa is greater than B. For a list
# of code values, see
# http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. For
# Binary, treats each byte of the binary data as unsigned when it
# compares binary values, for example when evaluating query
# expressions. ComparisonOperator - A comparator for evaluating
# attributes. For example, equals, greater than, less than, etc. For
# information on specifying data types in JSON, see JSON Data Format
# . The following are descriptions of each comparison operator. EQ :
# Equal. AttributeValueList can contain only one AttributeValue of
# type String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does not
# equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2",
# "1"]}. NE : Not equal. AttributeValueList can contain only one
# AttributeValue of type String, Number, or Binary (not a set). If an
# item contains an AttributeValue of a different type than the one
# specified in the request, the value does not match. For example,
# {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal
# {"NS":["6", "2", "1"]}. LE : Less than or equal. AttributeValueList
# can contain only one AttributeValue of type String, Number, or
# Binary (not a set). If an item contains an AttributeValue of a
# different type than the one specified in the request, the value
# does not match. For example, {"S":"6"} does not equal {"N":"6"}.
# Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. LT :
# Less than. AttributeValueList can contain only one AttributeValue
# of type String, Number, or Binary (not a set). If an item contains
# an AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does not
# equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6",
# "2", "1"]}. GE : Greater than or equal. AttributeValueList can
# contain only one AttributeValue of type String, Number, or Binary
# (not a set). If an item contains an AttributeValue of a different
# type than the one specified in the request, the value does not
# match. For example, {"S":"6"} does not equal {"N":"6"}. Also,
# {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GT : Greater
# than. AttributeValueList can contain only one AttributeValue of
# type String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does not
# equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6",
# "2", "1"]}. NOT_NULL : The attribute exists. NULL : The attribute
# does not exist. CONTAINS : checks for a subsequence, or value in a
# set. AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If the target attribute of
# the comparison is a String, then the operation checks for a
# substring match. If the target attribute of the comparison is
# Binary, then the operation looks for a subsequence of the target
# that matches the input. If the target attribute of the comparison
# is a set ("SS", "NS", or "BS"), then the operation checks for a
# member of the set (not as a substring). NOT_CONTAINS : checks for
# absence of a subsequence, or absence of a value in a set.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If the target attribute of
# the comparison is a String, then the operation checks for the
# absence of a substring match. If the target attribute of the
# comparison is Binary, then the operation checks for the absence of
# a subsequence of the target that matches the input. If the target
# attribute of the comparison is a set ("SS", "NS", or "BS"), then
# the operation checks for the absence of a member of the set (not as
# a substring). BEGINS_WITH : checks for a prefix. AttributeValueList
# can contain only one AttributeValue of type String or Binary (not a
# Number or a set). The target attribute of the comparison must be a
# String or Binary (not a Number or a set). IN : checks for exact
# matches. AttributeValueList can contain more than one
# AttributeValue of type String, Number, or Binary (not a set). The
# target attribute of the comparison must be of the same type and
# exact value to match. A String never matches a String set. BETWEEN
# : Greater than or equal to the first value, and less than or equal
# to the second value. AttributeValueList must contain two
# AttributeValue elements of the same type, either String, Number, or
# Binary (not a set). A target attribute matches if the target value
# is greater than, or equal to, the first element and less than, or
# equal to, the second element. If an item contains an AttributeValue
# of a different type than the one specified in the request, the
# value does not match. For example, {"S":"6"} does not compare to
# {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
# "1"]}
# * `:attribute_value_list` - (Array<Hash>) Represents one or more
# values to evaluate against the supplied attribute. This list
# contains exactly one value, except for a BETWEEN or IN
# comparison, in which case the list contains two values. For type
# Number, value comparisons are numeric. String value comparisons
# for greater than, equals, or less than are based on ASCII
# character code values. For example, a is greater than A, and aa
# is greater than B. For a list of code values, see
# http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
# For Binary, treats each byte of the binary data as unsigned when
# it compares binary values, for example when evaluating query
# expressions.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:comparison_operator` - *required* - (String) Represents a
# comparator for evaluating attributes. For example, equals,
# greater than, less than, etc. For information on specifying data
# types in JSON, see JSON Data Format . The following are
# descriptions of each comparison operator. EQ : Equal.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does
# not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6",
# "2", "1"]}. NE : Not equal. AttributeValueList can contain only
# one AttributeValue of type String, Number, or Binary (not a set).
# If an item contains an AttributeValue of a different type than
# the one specified in the request, the value does not match. For
# example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does
# not equal {"NS":["6", "2", "1"]}. LE : Less than or equal.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does
# not equal {"N":"6"}. Also, {"N":"6"} does not compare to
# {"NS":["6", "2", "1"]}. LT : Less than. AttributeValueList can
# contain only one AttributeValue of type String, Number, or Binary
# (not a set). If an item contains an AttributeValue of a different
# type than the one specified in the request, the value does not
# match. For example, {"S":"6"} does not equal {"N":"6"}. Also,
# {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GE :
# Greater than or equal. AttributeValueList can contain only one
# AttributeValue of type String, Number, or Binary (not a set). If
# an item contains an AttributeValue of a different type than the
# one specified in the request, the value does not match. For
# example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does
# not compare to {"NS":["6", "2", "1"]}. GT : Greater than.
# AttributeValueList can contain only one AttributeValue of type
# String, Number, or Binary (not a set). If an item contains an
# AttributeValue of a different type than the one specified in the
# request, the value does not match. For example, {"S":"6"} does
# not equal {"N":"6"}. Also, {"N":"6"} does not compare to
# {"NS":["6", "2", "1"]}. NOT_NULL : The attribute exists. NULL :
# The attribute does not exist. CONTAINS : checks for a
# subsequence, or value in a set. AttributeValueList can contain
# only one AttributeValue of type String, Number, or Binary (not a
# set). If the target attribute of the comparison is a String, then
# the operation checks for a substring match. If the target
# attribute of the comparison is Binary, then the operation looks
# for a subsequence of the target that matches the input. If the
# target attribute of the comparison is a set ("SS", "NS", or
# "BS"), then the operation checks for a member of the set (not as
# a substring). NOT_CONTAINS : checks for absence of a subsequence,
# or absence of a value in a set. AttributeValueList can contain
# only one AttributeValue of type String, Number, or Binary (not a
# set). If the target attribute of the comparison is a String, then
# the operation checks for the absence of a substring match. If the
# target attribute of the comparison is Binary, then the operation
# checks for the absence of a subsequence of the target that
# matches the input. If the target attribute of the comparison is a
# set ("SS", "NS", or "BS"), then the operation checks for the
# absence of a member of the set (not as a substring). BEGINS_WITH
# : checks for a prefix. AttributeValueList can contain only one
# AttributeValue of type String or Binary (not a Number or a set).
# The target attribute of the comparison must be a String or Binary
# (not a Number or a set). IN : checks for exact matches.
# AttributeValueList can contain more than one AttributeValue of
# type String, Number, or Binary (not a set). The target attribute
# of the comparison must be of the same type and exact value to
# match. A String never matches a String set. BETWEEN : Greater
# than or equal to the first value, and less than or equal to the
# second value. AttributeValueList must contain two AttributeValue
# elements of the same type, either String, Number, or Binary (not
# a set). A target attribute matches if the target value is greater
# than, or equal to, the first element and less than, or equal to,
# the second element. If an item contains an AttributeValue of a
# different type than the one specified in the request, the value
# does not match. For example, {"S":"6"} does not compare to
# {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
# "1"]} Valid values include:
# * `EQ`
# * `NE`
# * `IN`
# * `LE`
# * `LT`
# * `GE`
# * `GT`
# * `BETWEEN`
# * `NOT_NULL`
# * `NULL`
# * `CONTAINS`
# * `NOT_CONTAINS`
# * `BEGINS_WITH`
# * `:exclusive_start_key` - (Hash<String,Hash>) In a parallel scan, a
# Scan request that includes ExclusiveStartKey must specify the same
# segment whose previous Scan returned the corresponding value of
# LastEvaluatedKey.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# * `:total_segments` - (Integer) For a parallel Scan request,
# TotalSegments represents the total number of segments into which
# the Scan operation will be divided. The value of TotalSegments
# corresponds to the number of application workers that will perform
# the parallel scan. For example, if you want to scan a table using
# four application threads, you would specify a TotalSegments value
# of 4. The value for TotalSegments must be greater than or equal to
# 1, and less than or equal to 4096. If you specify a TotalSegments
# value of 1, the Scan will be sequential rather than parallel. If
# you specify TotalSegments, you must also specify Segment.
# * `:segment` - (Integer) For a parallel Scan request, Segment
# identifies an individual segment to be scanned by an application
# worker. Segment IDs are zero-based, so the first segment is always
# 0. For example, if you want to scan a table using four application
# threads, the first thread would specify a Segment value of 0, the
# second thread would specify 1, and so on. The value of
# LastEvaluatedKey returned from a parallel Scan request must be used
# as ExclusiveStartKey with the same Segment ID in a subsequent Scan
# operation. The value for Segment must be greater than or equal to
# 0, and less than the value provided for TotalSegments. If you
# specify Segment, you must also specify TotalSegments.
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:member` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:count` - (Integer)
# * `:scanned_count` - (Integer)
# * `:last_evaluated_key` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:consumed_capacity` - (Hash)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# @!method update_item(options = {})
# Calls the UpdateItem API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table
# containing the item to update.
# * `:key` - *required* - (Hash<String,Hash>) The primary key that
# defines the item. Each element consists of an attribute name and a
# value for that attribute.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:attribute_updates` - (Hash<String,Hash>) The names of attributes
# to be modified, the action to perform on each, and the new value
# for each. If you are updating an attribute that is an index key
# attribute for any indexes on that table, the attribute type must
# match the index key type defined in the AttributesDefinition of the
# table description. You can use UpdateItem to update any non-key
# attributes. Attribute values cannot be null. String and binary type
# attributes must have lengths greater than zero. Set type attributes
# must not be empty. Requests with empty values will be rejected with
# a ValidationException. Each AttributeUpdates element consists of an
# attribute name to modify, along with the following: Value - The new
# value, if applicable, for this attribute. Action - Specifies how to
# perform the update. Valid values for Action are PUT, DELETE, and
# ADD. The behavior depends on whether the specified primary key
# already exists in the table. If an item with the specified Key is
# found in the table: PUT - Adds the specified attribute to the item.
# If the attribute already exists, it is replaced by the new value.
# DELETE - If no value is specified, the attribute and its value are
# removed from the item. The data type of the specified value must
# match the existing value's data type. If a set of values is
# specified, then those values are subtracted from the old set. For
# example, if the attribute value was the set [a,b,c] and the DELETE
# action specified [a,c], then the final attribute value would be
# [b]. Specifying an empty set is an error. ADD - If the attribute
# does not already exist, then the attribute and its values are added
# to the item. If the attribute does exist, then the behavior of ADD
# depends on the data type of the attribute: If the existing
# attribute is a number, and if Value is also a number, then the
# Value is mathematically added to the existing attribute. If Value
# is a negative number, then it is subtracted from the existing
# attribute. If you use ADD to increment or decrement a number value
# for an item that doesn't exist before the update, uses 0 as the
# initial value. In addition, if you use ADD to update an existing
# item, and intend to increment or decrement an attribute value which
# does not yet exist, uses 0 as the initial value. For example,
# suppose that the item you want to update does not yet have an
# attribute named itemcount, but you decide to ADD the number 3 to
# this attribute anyway, even though it currently does not exist.
# will create the itemcount attribute, set its initial value to 0,
# and finally add 3 to it. The result will be a new itemcount
# attribute in the item, with a value of 3. If the existing data type
# is a set, and if the Value is also a set, then the Value is added
# to the existing set. (This is a set operation, not mathematical
# addition.) For example, if the attribute value was the set [1,2],
# and the ADD action specified [3], then the final attribute value
# would be [1,2,3]. An error occurs if an Add action is specified for
# a set attribute and the attribute type specified does not match the
# existing set type. Both sets must have the same primitive data
# type. For example, if the existing data type is a set of strings,
# the Value must also be a set of strings. The same holds `true` for
# number sets and binary sets. This action is only valid for an
# existing attribute whose data type is number or is a set. Do not
# use ADD for any other data types. If no item with the specified Key
# is found: PUT - creates a new item with the specified primary key,
# and then adds the attribute. DELETE - Nothing happens; there is no
# attribute to delete. ADD - creates an item with the supplied
# primary key and number (or set of numbers) for the attribute value.
# The only data types allowed are number and number set; no other
# data types can be specified. If you specify any attributes that are
# part of an index key, then the data types for those attributes must
# match those of the schema in the table's attribute definition.
# * `:value` - (Hash)
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:action` - (String) Specifies how to perform the update. Valid
# values are PUT, DELETE, and ADD. The behavior depends on whether
# the specified primary key already exists in the table. If an item
# with the specified Key is found in the table: PUT - Adds the
# specified attribute to the item. If the attribute already exists,
# it is replaced by the new value. DELETE - If no value is
# specified, the attribute and its value are removed from the item.
# The data type of the specified value must match the existing
# value's data type. If a set of values is specified, then those
# values are subtracted from the old set. For example, if the
# attribute value was the set [a,b,c] and the DELETE action
# specified [a,c], then the final attribute value would be [b].
# Specifying an empty set is an error. ADD - If the attribute does
# not already exist, then the attribute and its values are added to
# the item. If the attribute does exist, then the behavior of ADD
# depends on the data type of the attribute: If the existing
# attribute is a number, and if Value is also a number, then the
# Value is mathematically added to the existing attribute. If Value
# is a negative number, then it is subtracted from the existing
# attribute. If you use ADD to increment or decrement a number
# value for an item that doesn't exist before the update, uses 0 as
# the initial value. In addition, if you use ADD to update an
# existing item, and intend to increment or decrement an attribute
# value which does not yet exist, uses 0 as the initial value. For
# example, suppose that the item you want to update does not yet
# have an attribute named itemcount, but you decide to ADD the
# number 3 to this attribute anyway, even though it currently does
# not exist. will create the itemcount attribute, set its initial
# value to 0, and finally add 3 to it. The result will be a new
# itemcount attribute in the item, with a value of 3. If the
# existing data type is a set, and if the Value is also a set, then
# the Value is added to the existing set. (This is a set operation,
# not mathematical addition.) For example, if the attribute value
# was the set [1,2], and the ADD action specified [3], then the
# final attribute value would be [1,2,3]. An error occurs if an Add
# action is specified for a set attribute and the attribute type
# specified does not match the existing set type. Both sets must
# have the same primitive data type. For example, if the existing
# data type is a set of strings, the Value must also be a set of
# strings. The same holds `true` for number sets and binary sets.
# This action is only valid for an existing attribute whose data
# type is number or is a set. Do not use ADD for any other data
# types. If no item with the specified Key is found: PUT - creates
# a new item with the specified primary key, and then adds the
# attribute. DELETE - Nothing happens; there is no attribute to
# delete. ADD - creates an item with the supplied primary key and
# number (or set of numbers) for the attribute value. The only data
# types allowed are number and number set; no other data types can
# be specified. Valid values include:
# * `ADD`
# * `PUT`
# * `DELETE`
# * `:expected` - (Hash<String,Hash>) A map of attribute/condition
# pairs. This is the conditional block for the UpdateItem operation.
# All the conditions must be met for the operation to succeed.
# * `:value` - (Hash) Specify whether or not a value already exists
# and has a specific content for the attribute name-value pair.
# * `:s` - (String) Represents a String data type
# * `:n` - (String) Represents a Number data type
# * `:b` - (String) Represents a Binary data type
# * `:ss` - (Array<String>) Represents a String set data type
# * `:ns` - (Array<String>) Represents a Number set data type
# * `:bs` - (Array<String>) Represents a Binary set data type
# * `:exists` - (Boolean) Causes to evaluate the value before
# attempting a conditional operation: If Exists is `true` , will
# check to see if that attribute value already exists in the table.
# If it is found, then the operation succeeds. If it is not found,
# the operation fails with a ConditionalCheckFailedException. If
# Exists is `false` , assumes that the attribute value does not
# exist in the table. If in fact the value does not exist, then the
# assumption is valid and the operation succeeds. If the value is
# found, despite the assumption that it does not exist, the
# operation fails with a ConditionalCheckFailedException. The
# default setting for Exists is `true` . If you supply a Value all
# by itself, assumes the attribute exists: You don't have to set
# Exists to `true` , because it is implied. returns a
# ValidationException if: Exists is `true` but there is no Value to
# check. (You expect a value to exist, but don't specify what that
# value is.) Exists is `false` but you also specify a Value. (You
# cannot expect an attribute to have a value, while also expecting
# it not to exist.) If you specify more than one condition for
# Exists, then all of the conditions must evaluate to `true` . (In
# other words, the conditions are ANDed together.) Otherwise, the
# conditional operation will fail.
# * `:return_values` - (String) Use ReturnValues if you want to get the
# item attributes as they appeared either before or after they were
# updated. For UpdateItem, the valid values are: NONE - If
# ReturnValues is not specified, or if its value is NONE, then
# nothing is returned. (This is the default for ReturnValues.)
# ALL_OLD - If UpdateItem overwrote an attribute name-value pair,
# then the content of the old item is returned. UPDATED_OLD - The old
# versions of only the updated attributes are returned. ALL_NEW - All
# of the attributes of the new version of the item are returned.
# UPDATED_NEW - The new versions of only the updated attributes are
# returned. Valid values include:
# * `NONE`
# * `ALL_OLD`
# * `UPDATED_OLD`
# * `ALL_NEW`
# * `UPDATED_NEW`
# * `:return_consumed_capacity` - (String) Valid values include:
# * `TOTAL`
# * `NONE`
# * `:return_item_collection_metrics` - (String) Valid values include:
# * `SIZE`
# * `NONE`
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:attributes` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:consumed_capacity` - (Hash)
# * `:table_name` - (String)
# * `:capacity_units` - (Numeric)
# * `:item_collection_metrics` - (Hash)
# * `:item_collection_key` - (Hash<String,Hash>)
# * `:s` - (String)
# * `:n` - (String)
# * `:b` - (String)
# * `:ss` - (Array<String>)
# * `:ns` - (Array<String>)
# * `:bs` - (Array<Blob>)
# * `:size_estimate_range_gb` - (Array<Float>)
# @!method update_table(options = {})
# Calls the UpdateTable API operation.
# @param [Hash] options
#
# * `:table_name` - *required* - (String) The name of the table to be
# updated.
# * `:provisioned_throughput` - *required* - (Hash)
# * `:read_capacity_units` - *required* - (Integer) The maximum
# number of strongly consistent reads consumed per second before
# returns a ThrottlingException. For more information, see
# Specifying Read and Write Requirements .
# * `:write_capacity_units` - *required* - (Integer) The maximum
# number of writes consumed per second before returns a
# ThrottlingException. For more information, see Specifying Read
# and Write Requirements .
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:table_description` - (Hash)
# * `:attribute_definitions` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:attribute_type` - (String)
# * `:table_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:table_status` - (String)
# * `:creation_date_time` - (Time)
# * `:provisioned_throughput` - (Hash)
# * `:last_increase_date_time` - (Time)
# * `:last_decrease_date_time` - (Time)
# * `:number_of_decreases_today` - (Integer)
# * `:read_capacity_units` - (Integer)
# * `:write_capacity_units` - (Integer)
# * `:table_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# * `:local_secondary_indexes` - (Array<Hash>)
# * `:index_name` - (String)
# * `:key_schema` - (Array<Hash>)
# * `:attribute_name` - (String)
# * `:key_type` - (String)
# * `:projection` - (Hash)
# * `:projection_type` - (String)
# * `:non_key_attributes` - (Array<String>)
# * `:index_size_bytes` - (Integer)
# * `:item_count` - (Integer)
# end client methods #
define_client_methods('2012-08-10')
end
|