aws-sdk-dynamodb 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -133,6 +133,12 @@ module Aws::DynamoDB
133
133
  data[:table_arn]
134
134
  end
135
135
 
136
+ # Unique identifier for the table for which the backup was created.
137
+ # @return [String]
138
+ def table_id
139
+ data[:table_id]
140
+ end
141
+
136
142
  # Represents one or more local secondary indexes on the table. Each
137
143
  # index is scoped to a given partition key value. Tables with one or
138
144
  # more local secondary indexes are subject to an item collection size
@@ -285,6 +291,12 @@ module Aws::DynamoDB
285
291
  data[:latest_stream_arn]
286
292
  end
287
293
 
294
+ # Contains details for the restore.
295
+ # @return [Types::RestoreSummary]
296
+ def restore_summary
297
+ data[:restore_summary]
298
+ end
299
+
288
300
  # @!endgroup
289
301
 
290
302
  # @return [Client]
@@ -279,6 +279,114 @@ module Aws::DynamoDB
279
279
  include Aws::Structure
280
280
  end
281
281
 
282
+ # Contains the description of the backup created for the table.
283
+ #
284
+ # @!attribute [rw] backup_details
285
+ # Contains the details of the backup created for the table.
286
+ # @return [Types::BackupDetails]
287
+ #
288
+ # @!attribute [rw] source_table_details
289
+ # Contains the details of the table when the backup was created.
290
+ # @return [Types::SourceTableDetails]
291
+ #
292
+ # @!attribute [rw] source_table_feature_details
293
+ # Contains the details of the features enabled on the table when the
294
+ # backup was created. For example, LSIs, GSIs, streams, TTL.
295
+ # @return [Types::SourceTableFeatureDetails]
296
+ #
297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BackupDescription AWS API Documentation
298
+ #
299
+ class BackupDescription < Struct.new(
300
+ :backup_details,
301
+ :source_table_details,
302
+ :source_table_feature_details)
303
+ include Aws::Structure
304
+ end
305
+
306
+ # Contains the details of the backup created for the table.
307
+ #
308
+ # @!attribute [rw] backup_arn
309
+ # ARN associated with the backup.
310
+ # @return [String]
311
+ #
312
+ # @!attribute [rw] backup_name
313
+ # Name of the requested backup.
314
+ # @return [String]
315
+ #
316
+ # @!attribute [rw] backup_size_bytes
317
+ # Size of the backup in bytes.
318
+ # @return [Integer]
319
+ #
320
+ # @!attribute [rw] backup_status
321
+ # Backup can be in one of the following states: CREATING, ACTIVE,
322
+ # DELETED.
323
+ # @return [String]
324
+ #
325
+ # @!attribute [rw] backup_creation_date_time
326
+ # Time at which the backup was created. This is the request time of
327
+ # the backup.
328
+ # @return [Time]
329
+ #
330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BackupDetails AWS API Documentation
331
+ #
332
+ class BackupDetails < Struct.new(
333
+ :backup_arn,
334
+ :backup_name,
335
+ :backup_size_bytes,
336
+ :backup_status,
337
+ :backup_creation_date_time)
338
+ include Aws::Structure
339
+ end
340
+
341
+ # Contains details for the backup.
342
+ #
343
+ # @!attribute [rw] table_name
344
+ # Name of the table.
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] table_id
348
+ # Unique identifier for the table.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] table_arn
352
+ # ARN associated with the table.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] backup_arn
356
+ # ARN associated with the backup.
357
+ # @return [String]
358
+ #
359
+ # @!attribute [rw] backup_name
360
+ # Name of the specified backup.
361
+ # @return [String]
362
+ #
363
+ # @!attribute [rw] backup_creation_date_time
364
+ # Time at which the backup was created.
365
+ # @return [Time]
366
+ #
367
+ # @!attribute [rw] backup_status
368
+ # Backup can be in one of the following states: CREATING, ACTIVE,
369
+ # DELETED.
370
+ # @return [String]
371
+ #
372
+ # @!attribute [rw] backup_size_bytes
373
+ # Size of the backup in bytes.
374
+ # @return [Integer]
375
+ #
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BackupSummary AWS API Documentation
377
+ #
378
+ class BackupSummary < Struct.new(
379
+ :table_name,
380
+ :table_id,
381
+ :table_arn,
382
+ :backup_arn,
383
+ :backup_name,
384
+ :backup_creation_date_time,
385
+ :backup_status,
386
+ :backup_size_bytes)
387
+ include Aws::Structure
388
+ end
389
+
282
390
  # Represents the input of a `BatchGetItem` operation.
283
391
  #
284
392
  # @note When making an API call, you may pass BatchGetItemInput
@@ -622,7 +730,7 @@ module Aws::DynamoDB
622
730
  # collection. This is the same as the partition key value of the
623
731
  # item.
624
732
  #
625
- # * `SizeEstimateRange` - An estimate of item collection size,
733
+ # * `SizeEstimateRangeGB` - An estimate of item collection size,
626
734
  # expressed in GB. This is a two-element array containing a lower
627
735
  # bound and an upper bound for the estimate. The estimate includes
628
736
  # the size of all the items in the table, plus the size of all
@@ -939,6 +1047,56 @@ module Aws::DynamoDB
939
1047
  include Aws::Structure
940
1048
  end
941
1049
 
1050
+ # Represents the backup and restore settings on the table when the
1051
+ # backup was created.
1052
+ #
1053
+ # @!attribute [rw] continuous_backups_status
1054
+ # ContinuousBackupsStatus can be one of the following states :
1055
+ # ENABLED, DISABLED
1056
+ # @return [String]
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ContinuousBackupsDescription AWS API Documentation
1059
+ #
1060
+ class ContinuousBackupsDescription < Struct.new(
1061
+ :continuous_backups_status)
1062
+ include Aws::Structure
1063
+ end
1064
+
1065
+ # @note When making an API call, you may pass CreateBackupInput
1066
+ # data as a hash:
1067
+ #
1068
+ # {
1069
+ # table_name: "TableName", # required
1070
+ # backup_name: "BackupName", # required
1071
+ # }
1072
+ #
1073
+ # @!attribute [rw] table_name
1074
+ # The name of the table.
1075
+ # @return [String]
1076
+ #
1077
+ # @!attribute [rw] backup_name
1078
+ # Specified name for the backup.
1079
+ # @return [String]
1080
+ #
1081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateBackupInput AWS API Documentation
1082
+ #
1083
+ class CreateBackupInput < Struct.new(
1084
+ :table_name,
1085
+ :backup_name)
1086
+ include Aws::Structure
1087
+ end
1088
+
1089
+ # @!attribute [rw] backup_details
1090
+ # Contains the details of the backup created for the table.
1091
+ # @return [Types::BackupDetails]
1092
+ #
1093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateBackupOutput AWS API Documentation
1094
+ #
1095
+ class CreateBackupOutput < Struct.new(
1096
+ :backup_details)
1097
+ include Aws::Structure
1098
+ end
1099
+
942
1100
  # Represents a new global secondary index to be added to an existing
943
1101
  # table.
944
1102
  #
@@ -999,6 +1157,65 @@ module Aws::DynamoDB
999
1157
  include Aws::Structure
1000
1158
  end
1001
1159
 
1160
+ # @note When making an API call, you may pass CreateGlobalTableInput
1161
+ # data as a hash:
1162
+ #
1163
+ # {
1164
+ # global_table_name: "TableName", # required
1165
+ # replication_group: [ # required
1166
+ # {
1167
+ # region_name: "RegionName",
1168
+ # },
1169
+ # ],
1170
+ # }
1171
+ #
1172
+ # @!attribute [rw] global_table_name
1173
+ # The global table name.
1174
+ # @return [String]
1175
+ #
1176
+ # @!attribute [rw] replication_group
1177
+ # The regions where the global table needs to be created.
1178
+ # @return [Array<Types::Replica>]
1179
+ #
1180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateGlobalTableInput AWS API Documentation
1181
+ #
1182
+ class CreateGlobalTableInput < Struct.new(
1183
+ :global_table_name,
1184
+ :replication_group)
1185
+ include Aws::Structure
1186
+ end
1187
+
1188
+ # @!attribute [rw] global_table_description
1189
+ # Contains the details of the global table.
1190
+ # @return [Types::GlobalTableDescription]
1191
+ #
1192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateGlobalTableOutput AWS API Documentation
1193
+ #
1194
+ class CreateGlobalTableOutput < Struct.new(
1195
+ :global_table_description)
1196
+ include Aws::Structure
1197
+ end
1198
+
1199
+ # Represents a replica to be added.
1200
+ #
1201
+ # @note When making an API call, you may pass CreateReplicaAction
1202
+ # data as a hash:
1203
+ #
1204
+ # {
1205
+ # region_name: "RegionName", # required
1206
+ # }
1207
+ #
1208
+ # @!attribute [rw] region_name
1209
+ # The region of the replica to be added.
1210
+ # @return [String]
1211
+ #
1212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateReplicaAction AWS API Documentation
1213
+ #
1214
+ class CreateReplicaAction < Struct.new(
1215
+ :region_name)
1216
+ include Aws::Structure
1217
+ end
1218
+
1002
1219
  # Represents the input of a `CreateTable` operation.
1003
1220
  #
1004
1221
  # @note When making an API call, you may pass CreateTableInput
@@ -1265,6 +1482,35 @@ module Aws::DynamoDB
1265
1482
  include Aws::Structure
1266
1483
  end
1267
1484
 
1485
+ # @note When making an API call, you may pass DeleteBackupInput
1486
+ # data as a hash:
1487
+ #
1488
+ # {
1489
+ # backup_arn: "BackupArn", # required
1490
+ # }
1491
+ #
1492
+ # @!attribute [rw] backup_arn
1493
+ # The ARN associated with the backup.
1494
+ # @return [String]
1495
+ #
1496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteBackupInput AWS API Documentation
1497
+ #
1498
+ class DeleteBackupInput < Struct.new(
1499
+ :backup_arn)
1500
+ include Aws::Structure
1501
+ end
1502
+
1503
+ # @!attribute [rw] backup_description
1504
+ # Contains the description of the backup created for the table.
1505
+ # @return [Types::BackupDescription]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteBackupOutput AWS API Documentation
1508
+ #
1509
+ class DeleteBackupOutput < Struct.new(
1510
+ :backup_description)
1511
+ include Aws::Structure
1512
+ end
1513
+
1268
1514
  # Represents a global secondary index to be deleted from an existing
1269
1515
  # table.
1270
1516
  #
@@ -1553,7 +1799,7 @@ module Aws::DynamoDB
1553
1799
  # collection. This is the same as the partition key value of the
1554
1800
  # item itself.
1555
1801
  #
1556
- # * `SizeEstimateRange` - An estimate of item collection size, in
1802
+ # * `SizeEstimateRangeGB` - An estimate of item collection size, in
1557
1803
  # gigabytes. This value is a two-element array containing a lower
1558
1804
  # bound and an upper bound for the estimate. The estimate includes
1559
1805
  # the size of all the items in the table, plus the size of all
@@ -1574,6 +1820,26 @@ module Aws::DynamoDB
1574
1820
  include Aws::Structure
1575
1821
  end
1576
1822
 
1823
+ # Represents a replica to be removed.
1824
+ #
1825
+ # @note When making an API call, you may pass DeleteReplicaAction
1826
+ # data as a hash:
1827
+ #
1828
+ # {
1829
+ # region_name: "RegionName", # required
1830
+ # }
1831
+ #
1832
+ # @!attribute [rw] region_name
1833
+ # The region of the replica to be removed.
1834
+ # @return [String]
1835
+ #
1836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteReplicaAction AWS API Documentation
1837
+ #
1838
+ class DeleteReplicaAction < Struct.new(
1839
+ :region_name)
1840
+ include Aws::Structure
1841
+ end
1842
+
1577
1843
  # Represents a request to perform a `DeleteItem` operation on an item.
1578
1844
  #
1579
1845
  # @note When making an API call, you may pass DeleteRequest
@@ -1632,6 +1898,95 @@ module Aws::DynamoDB
1632
1898
  include Aws::Structure
1633
1899
  end
1634
1900
 
1901
+ # @note When making an API call, you may pass DescribeBackupInput
1902
+ # data as a hash:
1903
+ #
1904
+ # {
1905
+ # backup_arn: "BackupArn", # required
1906
+ # }
1907
+ #
1908
+ # @!attribute [rw] backup_arn
1909
+ # The ARN associated with the backup.
1910
+ # @return [String]
1911
+ #
1912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBackupInput AWS API Documentation
1913
+ #
1914
+ class DescribeBackupInput < Struct.new(
1915
+ :backup_arn)
1916
+ include Aws::Structure
1917
+ end
1918
+
1919
+ # @!attribute [rw] backup_description
1920
+ # Contains the description of the backup created for the table.
1921
+ # @return [Types::BackupDescription]
1922
+ #
1923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBackupOutput AWS API Documentation
1924
+ #
1925
+ class DescribeBackupOutput < Struct.new(
1926
+ :backup_description)
1927
+ include Aws::Structure
1928
+ end
1929
+
1930
+ # @note When making an API call, you may pass DescribeContinuousBackupsInput
1931
+ # data as a hash:
1932
+ #
1933
+ # {
1934
+ # table_name: "TableName", # required
1935
+ # }
1936
+ #
1937
+ # @!attribute [rw] table_name
1938
+ # Name of the table for which the customer wants to check the backup
1939
+ # and restore settings.
1940
+ # @return [String]
1941
+ #
1942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContinuousBackupsInput AWS API Documentation
1943
+ #
1944
+ class DescribeContinuousBackupsInput < Struct.new(
1945
+ :table_name)
1946
+ include Aws::Structure
1947
+ end
1948
+
1949
+ # @!attribute [rw] continuous_backups_description
1950
+ # `ContinuousBackupsDescription` can be one of the following :
1951
+ # ENABLED, DISABLED.
1952
+ # @return [Types::ContinuousBackupsDescription]
1953
+ #
1954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContinuousBackupsOutput AWS API Documentation
1955
+ #
1956
+ class DescribeContinuousBackupsOutput < Struct.new(
1957
+ :continuous_backups_description)
1958
+ include Aws::Structure
1959
+ end
1960
+
1961
+ # @note When making an API call, you may pass DescribeGlobalTableInput
1962
+ # data as a hash:
1963
+ #
1964
+ # {
1965
+ # global_table_name: "TableName", # required
1966
+ # }
1967
+ #
1968
+ # @!attribute [rw] global_table_name
1969
+ # The name of the global table.
1970
+ # @return [String]
1971
+ #
1972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTableInput AWS API Documentation
1973
+ #
1974
+ class DescribeGlobalTableInput < Struct.new(
1975
+ :global_table_name)
1976
+ include Aws::Structure
1977
+ end
1978
+
1979
+ # @!attribute [rw] global_table_description
1980
+ # Contains the details of the global table.
1981
+ # @return [Types::GlobalTableDescription]
1982
+ #
1983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTableOutput AWS API Documentation
1984
+ #
1985
+ class DescribeGlobalTableOutput < Struct.new(
1986
+ :global_table_description)
1987
+ include Aws::Structure
1988
+ end
1989
+
1635
1990
  # Represents the input of a `DescribeLimits` operation. Has no content.
1636
1991
  #
1637
1992
  # @api private
@@ -2379,6 +2734,56 @@ module Aws::DynamoDB
2379
2734
  include Aws::Structure
2380
2735
  end
2381
2736
 
2737
+ # Represents the properties of a global secondary index for the table
2738
+ # when the backup was created.
2739
+ #
2740
+ # @!attribute [rw] index_name
2741
+ # The name of the global secondary index.
2742
+ # @return [String]
2743
+ #
2744
+ # @!attribute [rw] key_schema
2745
+ # The complete key schema for a global secondary index, which consists
2746
+ # of one or more pairs of attribute names and key types:
2747
+ #
2748
+ # * `HASH` - partition key
2749
+ #
2750
+ # * `RANGE` - sort key
2751
+ #
2752
+ # <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
2753
+ # The term "hash attribute" derives from DynamoDB' usage of an
2754
+ # internal hash function to evenly distribute data items across
2755
+ # partitions, based on their partition key values.
2756
+ #
2757
+ # The sort key of an item is also known as its *range attribute*. The
2758
+ # term "range attribute" derives from the way DynamoDB stores items
2759
+ # with the same partition key physically close together, in sorted
2760
+ # order by the sort key value.
2761
+ #
2762
+ # </note>
2763
+ # @return [Array<Types::KeySchemaElement>]
2764
+ #
2765
+ # @!attribute [rw] projection
2766
+ # Represents attributes that are copied (projected) from the table
2767
+ # into the global secondary index. These are in addition to the
2768
+ # primary key attributes and index key attributes, which are
2769
+ # automatically projected.
2770
+ # @return [Types::Projection]
2771
+ #
2772
+ # @!attribute [rw] provisioned_throughput
2773
+ # Represents the provisioned throughput settings for the specified
2774
+ # global secondary index.
2775
+ # @return [Types::ProvisionedThroughput]
2776
+ #
2777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GlobalSecondaryIndexInfo AWS API Documentation
2778
+ #
2779
+ class GlobalSecondaryIndexInfo < Struct.new(
2780
+ :index_name,
2781
+ :key_schema,
2782
+ :projection,
2783
+ :provisioned_throughput)
2784
+ include Aws::Structure
2785
+ end
2786
+
2382
2787
  # Represents one of the following:
2383
2788
  #
2384
2789
  # * A new global secondary index to be added to an existing table.
@@ -2455,6 +2860,65 @@ module Aws::DynamoDB
2455
2860
  include Aws::Structure
2456
2861
  end
2457
2862
 
2863
+ # Represents the properties of a global table.
2864
+ #
2865
+ # @!attribute [rw] global_table_name
2866
+ # The global table name.
2867
+ # @return [String]
2868
+ #
2869
+ # @!attribute [rw] replication_group
2870
+ # The regions where the global table has replicas.
2871
+ # @return [Array<Types::Replica>]
2872
+ #
2873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GlobalTable AWS API Documentation
2874
+ #
2875
+ class GlobalTable < Struct.new(
2876
+ :global_table_name,
2877
+ :replication_group)
2878
+ include Aws::Structure
2879
+ end
2880
+
2881
+ # Contains details about the global table.
2882
+ #
2883
+ # @!attribute [rw] replication_group
2884
+ # The regions where the global table has replicas.
2885
+ # @return [Array<Types::ReplicaDescription>]
2886
+ #
2887
+ # @!attribute [rw] global_table_arn
2888
+ # The unique identifier of the global table.
2889
+ # @return [String]
2890
+ #
2891
+ # @!attribute [rw] creation_date_time
2892
+ # The creation time of the global table.
2893
+ # @return [Time]
2894
+ #
2895
+ # @!attribute [rw] global_table_status
2896
+ # The current state of the global table:
2897
+ #
2898
+ # * `CREATING` - The global table is being created.
2899
+ #
2900
+ # * `UPDATING` - The global table is being updated.
2901
+ #
2902
+ # * `DELETING` - The global table is being deleted.
2903
+ #
2904
+ # * `ACTIVE` - The global table is ready for use.
2905
+ # @return [String]
2906
+ #
2907
+ # @!attribute [rw] global_table_name
2908
+ # The global table name.
2909
+ # @return [String]
2910
+ #
2911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GlobalTableDescription AWS API Documentation
2912
+ #
2913
+ class GlobalTableDescription < Struct.new(
2914
+ :replication_group,
2915
+ :global_table_arn,
2916
+ :creation_date_time,
2917
+ :global_table_status,
2918
+ :global_table_name)
2919
+ include Aws::Structure
2920
+ end
2921
+
2458
2922
  # Information about item collections, if any, that were affected by the
2459
2923
  # operation. `ItemCollectionMetrics` is only returned if the request
2460
2924
  # asked for it. If the table does not have any local secondary indexes,
@@ -2667,6 +3131,112 @@ module Aws::DynamoDB
2667
3131
  include Aws::Structure
2668
3132
  end
2669
3133
 
3134
+ # @note When making an API call, you may pass ListBackupsInput
3135
+ # data as a hash:
3136
+ #
3137
+ # {
3138
+ # table_name: "TableName",
3139
+ # limit: 1,
3140
+ # time_range_lower_bound: Time.now,
3141
+ # time_range_upper_bound: Time.now,
3142
+ # exclusive_start_backup_arn: "BackupArn",
3143
+ # }
3144
+ #
3145
+ # @!attribute [rw] table_name
3146
+ # The backups from the table specified by TableName are listed.
3147
+ # @return [String]
3148
+ #
3149
+ # @!attribute [rw] limit
3150
+ # Maximum number of backups to return at once.
3151
+ # @return [Integer]
3152
+ #
3153
+ # @!attribute [rw] time_range_lower_bound
3154
+ # Only backups created after this time are listed.
3155
+ # `TimeRangeLowerBound` is inclusive.
3156
+ # @return [Time]
3157
+ #
3158
+ # @!attribute [rw] time_range_upper_bound
3159
+ # Only backups created before this time are listed.
3160
+ # `TimeRangeUpperBound` is exclusive.
3161
+ # @return [Time]
3162
+ #
3163
+ # @!attribute [rw] exclusive_start_backup_arn
3164
+ # `LastEvaluatedBackupARN` returned by the previous ListBackups call.
3165
+ # @return [String]
3166
+ #
3167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBackupsInput AWS API Documentation
3168
+ #
3169
+ class ListBackupsInput < Struct.new(
3170
+ :table_name,
3171
+ :limit,
3172
+ :time_range_lower_bound,
3173
+ :time_range_upper_bound,
3174
+ :exclusive_start_backup_arn)
3175
+ include Aws::Structure
3176
+ end
3177
+
3178
+ # @!attribute [rw] backup_summaries
3179
+ # List of `BackupSummary` objects.
3180
+ # @return [Array<Types::BackupSummary>]
3181
+ #
3182
+ # @!attribute [rw] last_evaluated_backup_arn
3183
+ # Last evaluated BackupARN.
3184
+ # @return [String]
3185
+ #
3186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBackupsOutput AWS API Documentation
3187
+ #
3188
+ class ListBackupsOutput < Struct.new(
3189
+ :backup_summaries,
3190
+ :last_evaluated_backup_arn)
3191
+ include Aws::Structure
3192
+ end
3193
+
3194
+ # @note When making an API call, you may pass ListGlobalTablesInput
3195
+ # data as a hash:
3196
+ #
3197
+ # {
3198
+ # exclusive_start_global_table_name: "TableName",
3199
+ # limit: 1,
3200
+ # region_name: "RegionName",
3201
+ # }
3202
+ #
3203
+ # @!attribute [rw] exclusive_start_global_table_name
3204
+ # The first global table name that this operation will evaluate.
3205
+ # @return [String]
3206
+ #
3207
+ # @!attribute [rw] limit
3208
+ # The maximum number of table names to return.
3209
+ # @return [Integer]
3210
+ #
3211
+ # @!attribute [rw] region_name
3212
+ # Lists the global tables in a specific region.
3213
+ # @return [String]
3214
+ #
3215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListGlobalTablesInput AWS API Documentation
3216
+ #
3217
+ class ListGlobalTablesInput < Struct.new(
3218
+ :exclusive_start_global_table_name,
3219
+ :limit,
3220
+ :region_name)
3221
+ include Aws::Structure
3222
+ end
3223
+
3224
+ # @!attribute [rw] global_tables
3225
+ # List of global table names.
3226
+ # @return [Array<Types::GlobalTable>]
3227
+ #
3228
+ # @!attribute [rw] last_evaluated_global_table_name
3229
+ # Last evaluated global table name.
3230
+ # @return [String]
3231
+ #
3232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListGlobalTablesOutput AWS API Documentation
3233
+ #
3234
+ class ListGlobalTablesOutput < Struct.new(
3235
+ :global_tables,
3236
+ :last_evaluated_global_table_name)
3237
+ include Aws::Structure
3238
+ end
3239
+
2670
3240
  # Represents the input of a `ListTables` operation.
2671
3241
  #
2672
3242
  # @note When making an API call, you may pass ListTablesInput
@@ -2893,6 +3463,50 @@ module Aws::DynamoDB
2893
3463
  include Aws::Structure
2894
3464
  end
2895
3465
 
3466
+ # Represents the properties of a local secondary index for the table
3467
+ # when the backup was created.
3468
+ #
3469
+ # @!attribute [rw] index_name
3470
+ # Represents the name of the local secondary index.
3471
+ # @return [String]
3472
+ #
3473
+ # @!attribute [rw] key_schema
3474
+ # The complete key schema for a local secondary index, which consists
3475
+ # of one or more pairs of attribute names and key types:
3476
+ #
3477
+ # * `HASH` - partition key
3478
+ #
3479
+ # * `RANGE` - sort key
3480
+ #
3481
+ # <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
3482
+ # The term "hash attribute" derives from DynamoDB' usage of an
3483
+ # internal hash function to evenly distribute data items across
3484
+ # partitions, based on their partition key values.
3485
+ #
3486
+ # The sort key of an item is also known as its *range attribute*. The
3487
+ # term "range attribute" derives from the way DynamoDB stores items
3488
+ # with the same partition key physically close together, in sorted
3489
+ # order by the sort key value.
3490
+ #
3491
+ # </note>
3492
+ # @return [Array<Types::KeySchemaElement>]
3493
+ #
3494
+ # @!attribute [rw] projection
3495
+ # Represents attributes that are copied (projected) from the table
3496
+ # into the global secondary index. These are in addition to the
3497
+ # primary key attributes and index key attributes, which are
3498
+ # automatically projected.
3499
+ # @return [Types::Projection]
3500
+ #
3501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/LocalSecondaryIndexInfo AWS API Documentation
3502
+ #
3503
+ class LocalSecondaryIndexInfo < Struct.new(
3504
+ :index_name,
3505
+ :key_schema,
3506
+ :projection)
3507
+ include Aws::Structure
3508
+ end
3509
+
2896
3510
  # Represents attributes that are copied (projected) from the table into
2897
3511
  # an index. These are in addition to the primary key attributes and
2898
3512
  # index key attributes, which are automatically projected.
@@ -3316,7 +3930,7 @@ module Aws::DynamoDB
3316
3930
  # collection. This is the same as the partition key value of the
3317
3931
  # item itself.
3318
3932
  #
3319
- # * `SizeEstimateRange` - An estimate of item collection size, in
3933
+ # * `SizeEstimateRangeGB` - An estimate of item collection size, in
3320
3934
  # gigabytes. This value is a two-element array containing a lower
3321
3935
  # bound and an upper bound for the estimate. The estimate includes
3322
3936
  # the size of all the items in the table, plus the size of all
@@ -3886,6 +4500,139 @@ module Aws::DynamoDB
3886
4500
  include Aws::Structure
3887
4501
  end
3888
4502
 
4503
+ # Represents the properties of a replica.
4504
+ #
4505
+ # @note When making an API call, you may pass Replica
4506
+ # data as a hash:
4507
+ #
4508
+ # {
4509
+ # region_name: "RegionName",
4510
+ # }
4511
+ #
4512
+ # @!attribute [rw] region_name
4513
+ # The region where the replica needs to be created.
4514
+ # @return [String]
4515
+ #
4516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Replica AWS API Documentation
4517
+ #
4518
+ class Replica < Struct.new(
4519
+ :region_name)
4520
+ include Aws::Structure
4521
+ end
4522
+
4523
+ # Contains the details of the replica.
4524
+ #
4525
+ # @!attribute [rw] region_name
4526
+ # The name of the region.
4527
+ # @return [String]
4528
+ #
4529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ReplicaDescription AWS API Documentation
4530
+ #
4531
+ class ReplicaDescription < Struct.new(
4532
+ :region_name)
4533
+ include Aws::Structure
4534
+ end
4535
+
4536
+ # Represents one of the following:
4537
+ #
4538
+ # * A new replica to be added to an existing global table.
4539
+ #
4540
+ # * New parameters for an existing replica.
4541
+ #
4542
+ # * An existing replica to be removed from an existing global table.
4543
+ #
4544
+ # @note When making an API call, you may pass ReplicaUpdate
4545
+ # data as a hash:
4546
+ #
4547
+ # {
4548
+ # create: {
4549
+ # region_name: "RegionName", # required
4550
+ # },
4551
+ # delete: {
4552
+ # region_name: "RegionName", # required
4553
+ # },
4554
+ # }
4555
+ #
4556
+ # @!attribute [rw] create
4557
+ # The parameters required for creating a replica on an existing global
4558
+ # table.
4559
+ # @return [Types::CreateReplicaAction]
4560
+ #
4561
+ # @!attribute [rw] delete
4562
+ # The name of the existing replica to be removed.
4563
+ # @return [Types::DeleteReplicaAction]
4564
+ #
4565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ReplicaUpdate AWS API Documentation
4566
+ #
4567
+ class ReplicaUpdate < Struct.new(
4568
+ :create,
4569
+ :delete)
4570
+ include Aws::Structure
4571
+ end
4572
+
4573
+ # Contains details for the restore.
4574
+ #
4575
+ # @!attribute [rw] source_backup_arn
4576
+ # ARN of the backup from which the table was restored.
4577
+ # @return [String]
4578
+ #
4579
+ # @!attribute [rw] source_table_arn
4580
+ # ARN of the source table of the backup that is being restored.
4581
+ # @return [String]
4582
+ #
4583
+ # @!attribute [rw] restore_date_time
4584
+ # Point in time or source backup time.
4585
+ # @return [Time]
4586
+ #
4587
+ # @!attribute [rw] restore_in_progress
4588
+ # Indicates if a restore is in progress or not.
4589
+ # @return [Boolean]
4590
+ #
4591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreSummary AWS API Documentation
4592
+ #
4593
+ class RestoreSummary < Struct.new(
4594
+ :source_backup_arn,
4595
+ :source_table_arn,
4596
+ :restore_date_time,
4597
+ :restore_in_progress)
4598
+ include Aws::Structure
4599
+ end
4600
+
4601
+ # @note When making an API call, you may pass RestoreTableFromBackupInput
4602
+ # data as a hash:
4603
+ #
4604
+ # {
4605
+ # target_table_name: "TableName", # required
4606
+ # backup_arn: "BackupArn", # required
4607
+ # }
4608
+ #
4609
+ # @!attribute [rw] target_table_name
4610
+ # The name of the new table to which the backup must be restored.
4611
+ # @return [String]
4612
+ #
4613
+ # @!attribute [rw] backup_arn
4614
+ # The ARN associated with the backup.
4615
+ # @return [String]
4616
+ #
4617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableFromBackupInput AWS API Documentation
4618
+ #
4619
+ class RestoreTableFromBackupInput < Struct.new(
4620
+ :target_table_name,
4621
+ :backup_arn)
4622
+ include Aws::Structure
4623
+ end
4624
+
4625
+ # @!attribute [rw] table_description
4626
+ # The description of the table created from an existing backup.
4627
+ # @return [Types::TableDescription]
4628
+ #
4629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableFromBackupOutput AWS API Documentation
4630
+ #
4631
+ class RestoreTableFromBackupOutput < Struct.new(
4632
+ :table_description)
4633
+ include Aws::Structure
4634
+ end
4635
+
3889
4636
  # Represents the input of a `Scan` operation.
3890
4637
  #
3891
4638
  # @note When making an API call, you may pass ScanInput
@@ -4333,6 +5080,90 @@ module Aws::DynamoDB
4333
5080
  include Aws::Structure
4334
5081
  end
4335
5082
 
5083
+ # Contains the details of the table when the backup was created.
5084
+ #
5085
+ # @!attribute [rw] table_name
5086
+ # The name of the table for which the backup was created.
5087
+ # @return [String]
5088
+ #
5089
+ # @!attribute [rw] table_id
5090
+ # Unique identifier for the table for which the backup was created.
5091
+ # @return [String]
5092
+ #
5093
+ # @!attribute [rw] table_arn
5094
+ # ARN of the table for which backup was created.
5095
+ # @return [String]
5096
+ #
5097
+ # @!attribute [rw] table_size_bytes
5098
+ # Size of the table in bytes. Please note this is an approximate
5099
+ # value.
5100
+ # @return [Integer]
5101
+ #
5102
+ # @!attribute [rw] key_schema
5103
+ # Schema of the table.
5104
+ # @return [Array<Types::KeySchemaElement>]
5105
+ #
5106
+ # @!attribute [rw] table_creation_date_time
5107
+ # Time when the source table was created.
5108
+ # @return [Time]
5109
+ #
5110
+ # @!attribute [rw] provisioned_throughput
5111
+ # Read IOPs and Write IOPS on the table when the backup was created.
5112
+ # @return [Types::ProvisionedThroughput]
5113
+ #
5114
+ # @!attribute [rw] item_count
5115
+ # Number of items in the table. Please note this is an approximate
5116
+ # value.
5117
+ # @return [Integer]
5118
+ #
5119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/SourceTableDetails AWS API Documentation
5120
+ #
5121
+ class SourceTableDetails < Struct.new(
5122
+ :table_name,
5123
+ :table_id,
5124
+ :table_arn,
5125
+ :table_size_bytes,
5126
+ :key_schema,
5127
+ :table_creation_date_time,
5128
+ :provisioned_throughput,
5129
+ :item_count)
5130
+ include Aws::Structure
5131
+ end
5132
+
5133
+ # Contains the details of the features enabled on the table when the
5134
+ # backup was created. For example, LSIs, GSIs, streams, TTL.
5135
+ #
5136
+ # @!attribute [rw] local_secondary_indexes
5137
+ # Represents the LSI properties for the table when the backup was
5138
+ # created. It includes the IndexName, KeySchema and Projection for the
5139
+ # LSIs on the table at the time of backup.
5140
+ # @return [Array<Types::LocalSecondaryIndexInfo>]
5141
+ #
5142
+ # @!attribute [rw] global_secondary_indexes
5143
+ # Represents the GSI properties for the table when the backup was
5144
+ # created. It includes the IndexName, KeySchema, Projection and
5145
+ # ProvisionedThroughput for the GSIs on the table at the time of
5146
+ # backup.
5147
+ # @return [Array<Types::GlobalSecondaryIndexInfo>]
5148
+ #
5149
+ # @!attribute [rw] stream_description
5150
+ # Stream settings on the table when the backup was created.
5151
+ # @return [Types::StreamSpecification]
5152
+ #
5153
+ # @!attribute [rw] time_to_live_description
5154
+ # Time to Live settings on the table when the backup was created.
5155
+ # @return [Types::TimeToLiveDescription]
5156
+ #
5157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/SourceTableFeatureDetails AWS API Documentation
5158
+ #
5159
+ class SourceTableFeatureDetails < Struct.new(
5160
+ :local_secondary_indexes,
5161
+ :global_secondary_indexes,
5162
+ :stream_description,
5163
+ :time_to_live_description)
5164
+ include Aws::Structure
5165
+ end
5166
+
4336
5167
  # Represents the DynamoDB Streams configuration for a table in DynamoDB.
4337
5168
  #
4338
5169
  # @note When making an API call, you may pass StreamSpecification
@@ -4466,6 +5297,10 @@ module Aws::DynamoDB
4466
5297
  # The Amazon Resource Name (ARN) that uniquely identifies the table.
4467
5298
  # @return [String]
4468
5299
  #
5300
+ # @!attribute [rw] table_id
5301
+ # Unique identifier for the table for which the backup was created.
5302
+ # @return [String]
5303
+ #
4469
5304
  # @!attribute [rw] local_secondary_indexes
4470
5305
  # Represents one or more local secondary indexes on the table. Each
4471
5306
  # index is scoped to a given partition key value. Tables with one or
@@ -4610,6 +5445,10 @@ module Aws::DynamoDB
4610
5445
  # stream for this table.
4611
5446
  # @return [String]
4612
5447
  #
5448
+ # @!attribute [rw] restore_summary
5449
+ # Contains details for the restore.
5450
+ # @return [Types::RestoreSummary]
5451
+ #
4613
5452
  # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TableDescription AWS API Documentation
4614
5453
  #
4615
5454
  class TableDescription < Struct.new(
@@ -4622,11 +5461,13 @@ module Aws::DynamoDB
4622
5461
  :table_size_bytes,
4623
5462
  :item_count,
4624
5463
  :table_arn,
5464
+ :table_id,
4625
5465
  :local_secondary_indexes,
4626
5466
  :global_secondary_indexes,
4627
5467
  :stream_specification,
4628
5468
  :latest_stream_label,
4629
- :latest_stream_arn)
5469
+ :latest_stream_arn,
5470
+ :restore_summary)
4630
5471
  include Aws::Structure
4631
5472
  end
4632
5473
 
@@ -4816,6 +5657,51 @@ module Aws::DynamoDB
4816
5657
  include Aws::Structure
4817
5658
  end
4818
5659
 
5660
+ # @note When making an API call, you may pass UpdateGlobalTableInput
5661
+ # data as a hash:
5662
+ #
5663
+ # {
5664
+ # global_table_name: "TableName", # required
5665
+ # replica_updates: [ # required
5666
+ # {
5667
+ # create: {
5668
+ # region_name: "RegionName", # required
5669
+ # },
5670
+ # delete: {
5671
+ # region_name: "RegionName", # required
5672
+ # },
5673
+ # },
5674
+ # ],
5675
+ # }
5676
+ #
5677
+ # @!attribute [rw] global_table_name
5678
+ # The global table name.
5679
+ # @return [String]
5680
+ #
5681
+ # @!attribute [rw] replica_updates
5682
+ # A list of regions that should be added or removed from the global
5683
+ # table.
5684
+ # @return [Array<Types::ReplicaUpdate>]
5685
+ #
5686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTableInput AWS API Documentation
5687
+ #
5688
+ class UpdateGlobalTableInput < Struct.new(
5689
+ :global_table_name,
5690
+ :replica_updates)
5691
+ include Aws::Structure
5692
+ end
5693
+
5694
+ # @!attribute [rw] global_table_description
5695
+ # Contains the details of the global table.
5696
+ # @return [Types::GlobalTableDescription]
5697
+ #
5698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTableOutput AWS API Documentation
5699
+ #
5700
+ class UpdateGlobalTableOutput < Struct.new(
5701
+ :global_table_description)
5702
+ include Aws::Structure
5703
+ end
5704
+
4819
5705
  # Represents the input of an `UpdateItem` operation.
4820
5706
  #
4821
5707
  # @note When making an API call, you may pass UpdateItemInput
@@ -5209,7 +6095,7 @@ module Aws::DynamoDB
5209
6095
  # collection. This is the same as the partition key value of the
5210
6096
  # item itself.
5211
6097
  #
5212
- # * `SizeEstimateRange` - An estimate of item collection size, in
6098
+ # * `SizeEstimateRangeGB` - An estimate of item collection size, in
5213
6099
  # gigabytes. This value is a two-element array containing a lower
5214
6100
  # bound and an upper bound for the estimate. The estimate includes
5215
6101
  # the size of all the items in the table, plus the size of all