aws-sdk-redshiftserverless 1.4.0 → 1.5.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.
@@ -30,14 +30,6 @@ module Aws::RedshiftServerless
30
30
  # An array of key-value pairs to set for advanced control over Amazon
31
31
  # Redshift Serverless.
32
32
  #
33
- # @note When making an API call, you may pass ConfigParameter
34
- # data as a hash:
35
- #
36
- # {
37
- # parameter_key: "ParameterKey",
38
- # parameter_value: "ParameterValue",
39
- # }
40
- #
41
33
  # @!attribute [rw] parameter_key
42
34
  # The key of the parameter. The options are `datestyle`,
43
35
  # `enable_user_activity_logging`, `query_group`, `search_path`, and
@@ -70,15 +62,6 @@ module Aws::RedshiftServerless
70
62
  include Aws::Structure
71
63
  end
72
64
 
73
- # @note When making an API call, you may pass ConvertRecoveryPointToSnapshotRequest
74
- # data as a hash:
75
- #
76
- # {
77
- # recovery_point_id: "String", # required
78
- # retention_period: 1,
79
- # snapshot_name: "String", # required
80
- # }
81
- #
82
65
  # @!attribute [rw] recovery_point_id
83
66
  # The unique identifier of the recovery point.
84
67
  # @return [String]
@@ -91,12 +74,21 @@ module Aws::RedshiftServerless
91
74
  # The name of the snapshot.
92
75
  # @return [String]
93
76
  #
77
+ # @!attribute [rw] tags
78
+ # An array of [Tag objects][1] to associate with the created snapshot.
79
+ #
80
+ #
81
+ #
82
+ # [1]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html
83
+ # @return [Array<Types::Tag>]
84
+ #
94
85
  # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshotRequest AWS API Documentation
95
86
  #
96
87
  class ConvertRecoveryPointToSnapshotRequest < Struct.new(
97
88
  :recovery_point_id,
98
89
  :retention_period,
99
- :snapshot_name)
90
+ :snapshot_name,
91
+ :tags)
100
92
  SENSITIVE = []
101
93
  include Aws::Structure
102
94
  end
@@ -113,16 +105,6 @@ module Aws::RedshiftServerless
113
105
  include Aws::Structure
114
106
  end
115
107
 
116
- # @note When making an API call, you may pass CreateEndpointAccessRequest
117
- # data as a hash:
118
- #
119
- # {
120
- # endpoint_name: "String", # required
121
- # subnet_ids: ["SubnetId"], # required
122
- # vpc_security_group_ids: ["VpcSecurityGroupId"],
123
- # workgroup_name: "String", # required
124
- # }
125
- #
126
108
  # @!attribute [rw] endpoint_name
127
109
  # The name of the VPC endpoint. An endpoint name must contain 1-30
128
110
  # characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The
@@ -168,26 +150,6 @@ module Aws::RedshiftServerless
168
150
  include Aws::Structure
169
151
  end
170
152
 
171
- # @note When making an API call, you may pass CreateNamespaceRequest
172
- # data as a hash:
173
- #
174
- # {
175
- # admin_user_password: "DbPassword",
176
- # admin_username: "DbUser",
177
- # db_name: "String",
178
- # default_iam_role_arn: "String",
179
- # iam_roles: ["IamRoleArn"],
180
- # kms_key_id: "String",
181
- # log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
182
- # namespace_name: "NamespaceName", # required
183
- # tags: [
184
- # {
185
- # key: "TagKey", # required
186
- # value: "TagValue", # required
187
- # },
188
- # ],
189
- # }
190
- #
191
153
  # @!attribute [rw] admin_user_password
192
154
  # The password of the administrator for the first database created in
193
155
  # the namespace.
@@ -257,15 +219,6 @@ module Aws::RedshiftServerless
257
219
  include Aws::Structure
258
220
  end
259
221
 
260
- # @note When making an API call, you may pass CreateSnapshotRequest
261
- # data as a hash:
262
- #
263
- # {
264
- # namespace_name: "String", # required
265
- # retention_period: 1,
266
- # snapshot_name: "String", # required
267
- # }
268
- #
269
222
  # @!attribute [rw] namespace_name
270
223
  # The namespace to create a snapshot for.
271
224
  # @return [String]
@@ -278,12 +231,21 @@ module Aws::RedshiftServerless
278
231
  # The name of the snapshot.
279
232
  # @return [String]
280
233
  #
234
+ # @!attribute [rw] tags
235
+ # An array of [Tag objects][1] to associate with the snapshot.
236
+ #
237
+ #
238
+ #
239
+ # [1]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html
240
+ # @return [Array<Types::Tag>]
241
+ #
281
242
  # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateSnapshotRequest AWS API Documentation
282
243
  #
283
244
  class CreateSnapshotRequest < Struct.new(
284
245
  :namespace_name,
285
246
  :retention_period,
286
- :snapshot_name)
247
+ :snapshot_name,
248
+ :tags)
287
249
  SENSITIVE = []
288
250
  include Aws::Structure
289
251
  end
@@ -300,17 +262,6 @@ module Aws::RedshiftServerless
300
262
  include Aws::Structure
301
263
  end
302
264
 
303
- # @note When making an API call, you may pass CreateUsageLimitRequest
304
- # data as a hash:
305
- #
306
- # {
307
- # amount: 1, # required
308
- # breach_action: "log", # accepts log, emit-metric, deactivate
309
- # period: "daily", # accepts daily, weekly, monthly
310
- # resource_arn: "String", # required
311
- # usage_type: "serverless-compute", # required, accepts serverless-compute, cross-region-datasharing
312
- # }
313
- #
314
265
  # @!attribute [rw] amount
315
266
  # The limit amount. If time-based, this amount is in Redshift
316
267
  # Processing Units (RPU) consumed per hour. If data-based, this amount
@@ -362,31 +313,6 @@ module Aws::RedshiftServerless
362
313
  include Aws::Structure
363
314
  end
364
315
 
365
- # @note When making an API call, you may pass CreateWorkgroupRequest
366
- # data as a hash:
367
- #
368
- # {
369
- # base_capacity: 1,
370
- # config_parameters: [
371
- # {
372
- # parameter_key: "ParameterKey",
373
- # parameter_value: "ParameterValue",
374
- # },
375
- # ],
376
- # enhanced_vpc_routing: false,
377
- # namespace_name: "NamespaceName", # required
378
- # publicly_accessible: false,
379
- # security_group_ids: ["SecurityGroupId"],
380
- # subnet_ids: ["SubnetId"],
381
- # tags: [
382
- # {
383
- # key: "TagKey", # required
384
- # value: "TagValue", # required
385
- # },
386
- # ],
387
- # workgroup_name: "WorkgroupName", # required
388
- # }
389
- #
390
316
  # @!attribute [rw] base_capacity
391
317
  # The base data warehouse capacity of the workgroup in Redshift
392
318
  # Processing Units (RPUs).
@@ -409,6 +335,11 @@ module Aws::RedshiftServerless
409
335
  # The name of the namespace to associate with the workgroup.
410
336
  # @return [String]
411
337
  #
338
+ # @!attribute [rw] port
339
+ # The custom port to use when connecting to a workgroup. Valid port
340
+ # ranges are 5431-5455 and 8191-8215. The default is 5439.
341
+ # @return [Integer]
342
+ #
412
343
  # @!attribute [rw] publicly_accessible
413
344
  # A value that specifies whether the workgroup can be accessed from a
414
345
  # public network.
@@ -437,6 +368,7 @@ module Aws::RedshiftServerless
437
368
  :config_parameters,
438
369
  :enhanced_vpc_routing,
439
370
  :namespace_name,
371
+ :port,
440
372
  :publicly_accessible,
441
373
  :security_group_ids,
442
374
  :subnet_ids,
@@ -458,13 +390,6 @@ module Aws::RedshiftServerless
458
390
  include Aws::Structure
459
391
  end
460
392
 
461
- # @note When making an API call, you may pass DeleteEndpointAccessRequest
462
- # data as a hash:
463
- #
464
- # {
465
- # endpoint_name: "String", # required
466
- # }
467
- #
468
393
  # @!attribute [rw] endpoint_name
469
394
  # The name of the VPC endpoint to delete.
470
395
  # @return [String]
@@ -489,15 +414,6 @@ module Aws::RedshiftServerless
489
414
  include Aws::Structure
490
415
  end
491
416
 
492
- # @note When making an API call, you may pass DeleteNamespaceRequest
493
- # data as a hash:
494
- #
495
- # {
496
- # final_snapshot_name: "String",
497
- # final_snapshot_retention_period: 1,
498
- # namespace_name: "NamespaceName", # required
499
- # }
500
- #
501
417
  # @!attribute [rw] final_snapshot_name
502
418
  # The name of the snapshot to be created before the namespace is
503
419
  # deleted.
@@ -533,13 +449,6 @@ module Aws::RedshiftServerless
533
449
  include Aws::Structure
534
450
  end
535
451
 
536
- # @note When making an API call, you may pass DeleteResourcePolicyRequest
537
- # data as a hash:
538
- #
539
- # {
540
- # resource_arn: "String", # required
541
- # }
542
- #
543
452
  # @!attribute [rw] resource_arn
544
453
  # The Amazon Resource Name (ARN) of the policy to delete.
545
454
  # @return [String]
@@ -556,13 +465,6 @@ module Aws::RedshiftServerless
556
465
  #
557
466
  class DeleteResourcePolicyResponse < Aws::EmptyStructure; end
558
467
 
559
- # @note When making an API call, you may pass DeleteSnapshotRequest
560
- # data as a hash:
561
- #
562
- # {
563
- # snapshot_name: "String", # required
564
- # }
565
- #
566
468
  # @!attribute [rw] snapshot_name
567
469
  # The name of the snapshot to be deleted.
568
470
  # @return [String]
@@ -587,13 +489,6 @@ module Aws::RedshiftServerless
587
489
  include Aws::Structure
588
490
  end
589
491
 
590
- # @note When making an API call, you may pass DeleteUsageLimitRequest
591
- # data as a hash:
592
- #
593
- # {
594
- # usage_limit_id: "String", # required
595
- # }
596
- #
597
492
  # @!attribute [rw] usage_limit_id
598
493
  # The unique identifier of the usage limit to delete.
599
494
  # @return [String]
@@ -618,13 +513,6 @@ module Aws::RedshiftServerless
618
513
  include Aws::Structure
619
514
  end
620
515
 
621
- # @note When making an API call, you may pass DeleteWorkgroupRequest
622
- # data as a hash:
623
- #
624
- # {
625
- # workgroup_name: "WorkgroupName", # required
626
- # }
627
- #
628
516
  # @!attribute [rw] workgroup_name
629
517
  # The name of the workgroup to be deleted.
630
518
  # @return [String]
@@ -735,15 +623,6 @@ module Aws::RedshiftServerless
735
623
  include Aws::Structure
736
624
  end
737
625
 
738
- # @note When making an API call, you may pass GetCredentialsRequest
739
- # data as a hash:
740
- #
741
- # {
742
- # db_name: "DbName",
743
- # duration_seconds: 1,
744
- # workgroup_name: "WorkgroupName", # required
745
- # }
746
- #
747
626
  # @!attribute [rw] db_name
748
627
  # The name of the database to get temporary authorization to log on
749
628
  # to.
@@ -752,8 +631,8 @@ module Aws::RedshiftServerless
752
631
  #
753
632
  # * Must be 1 to 64 alphanumeric characters or hyphens.
754
633
  #
755
- # * Must contain only lowercase letters, numbers, underscore, plus
756
- # sign, period (dot), at symbol (@), or hyphen.
634
+ # * Must contain only uppercase or lowercase letters, numbers,
635
+ # underscore, plus sign, period (dot), at symbol (@), or hyphen.
757
636
  #
758
637
  # * The first character must be a letter.
759
638
  #
@@ -820,13 +699,6 @@ module Aws::RedshiftServerless
820
699
  include Aws::Structure
821
700
  end
822
701
 
823
- # @note When making an API call, you may pass GetEndpointAccessRequest
824
- # data as a hash:
825
- #
826
- # {
827
- # endpoint_name: "String", # required
828
- # }
829
- #
830
702
  # @!attribute [rw] endpoint_name
831
703
  # The name of the VPC endpoint to return information for.
832
704
  # @return [String]
@@ -851,13 +723,6 @@ module Aws::RedshiftServerless
851
723
  include Aws::Structure
852
724
  end
853
725
 
854
- # @note When making an API call, you may pass GetNamespaceRequest
855
- # data as a hash:
856
- #
857
- # {
858
- # namespace_name: "NamespaceName", # required
859
- # }
860
- #
861
726
  # @!attribute [rw] namespace_name
862
727
  # The name of the namespace to retrieve information for.
863
728
  # @return [String]
@@ -882,13 +747,6 @@ module Aws::RedshiftServerless
882
747
  include Aws::Structure
883
748
  end
884
749
 
885
- # @note When making an API call, you may pass GetRecoveryPointRequest
886
- # data as a hash:
887
- #
888
- # {
889
- # recovery_point_id: "String", # required
890
- # }
891
- #
892
750
  # @!attribute [rw] recovery_point_id
893
751
  # The unique identifier of the recovery point to return information
894
752
  # for.
@@ -914,13 +772,6 @@ module Aws::RedshiftServerless
914
772
  include Aws::Structure
915
773
  end
916
774
 
917
- # @note When making an API call, you may pass GetResourcePolicyRequest
918
- # data as a hash:
919
- #
920
- # {
921
- # resource_arn: "String", # required
922
- # }
923
- #
924
775
  # @!attribute [rw] resource_arn
925
776
  # The Amazon Resource Name (ARN) of the resource to return.
926
777
  # @return [String]
@@ -945,15 +796,6 @@ module Aws::RedshiftServerless
945
796
  include Aws::Structure
946
797
  end
947
798
 
948
- # @note When making an API call, you may pass GetSnapshotRequest
949
- # data as a hash:
950
- #
951
- # {
952
- # owner_account: "String",
953
- # snapshot_arn: "String",
954
- # snapshot_name: "String",
955
- # }
956
- #
957
799
  # @!attribute [rw] owner_account
958
800
  # The owner Amazon Web Services account of a snapshot shared with
959
801
  # another user.
@@ -989,13 +831,32 @@ module Aws::RedshiftServerless
989
831
  include Aws::Structure
990
832
  end
991
833
 
992
- # @note When making an API call, you may pass GetUsageLimitRequest
993
- # data as a hash:
834
+ # @!attribute [rw] table_restore_request_id
835
+ # The ID of the `RestoreTableFromSnapshot` request to return status
836
+ # for.
837
+ # @return [String]
994
838
  #
995
- # {
996
- # usage_limit_id: "String", # required
997
- # }
839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetTableRestoreStatusRequest AWS API Documentation
998
840
  #
841
+ class GetTableRestoreStatusRequest < Struct.new(
842
+ :table_restore_request_id)
843
+ SENSITIVE = []
844
+ include Aws::Structure
845
+ end
846
+
847
+ # @!attribute [rw] table_restore_status
848
+ # The returned `TableRestoreStatus` object that contains information
849
+ # about the status of your `RestoreTableFromSnapshot` request.
850
+ # @return [Types::TableRestoreStatus]
851
+ #
852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetTableRestoreStatusResponse AWS API Documentation
853
+ #
854
+ class GetTableRestoreStatusResponse < Struct.new(
855
+ :table_restore_status)
856
+ SENSITIVE = []
857
+ include Aws::Structure
858
+ end
859
+
999
860
  # @!attribute [rw] usage_limit_id
1000
861
  # The unique identifier of the usage limit to return information for.
1001
862
  # @return [String]
@@ -1020,13 +881,6 @@ module Aws::RedshiftServerless
1020
881
  include Aws::Structure
1021
882
  end
1022
883
 
1023
- # @note When making an API call, you may pass GetWorkgroupRequest
1024
- # data as a hash:
1025
- #
1026
- # {
1027
- # workgroup_name: "WorkgroupName", # required
1028
- # }
1029
- #
1030
884
  # @!attribute [rw] workgroup_name
1031
885
  # The name of the workgroup to return information for.
1032
886
  # @return [String]
@@ -1091,24 +945,15 @@ module Aws::RedshiftServerless
1091
945
  include Aws::Structure
1092
946
  end
1093
947
 
1094
- # @note When making an API call, you may pass ListEndpointAccessRequest
1095
- # data as a hash:
1096
- #
1097
- # {
1098
- # max_results: 1,
1099
- # next_token: "String",
1100
- # vpc_id: "String",
1101
- # workgroup_name: "String",
1102
- # }
1103
- #
1104
948
  # @!attribute [rw] max_results
1105
949
  # An optional parameter that specifies the maximum number of results
1106
- # to return. You can use `nextToken` to get the next page of results.
950
+ # to return. You can use `nextToken` to display the next page of
951
+ # results.
1107
952
  # @return [Integer]
1108
953
  #
1109
954
  # @!attribute [rw] next_token
1110
955
  # If your initial `ListEndpointAccess` operation returns a
1111
- # `nextToken`, you can include the returned `nextToken` in subsequent
956
+ # `nextToken`, you can include the returned `nextToken` in following
1112
957
  # `ListEndpointAccess` operations, which returns results in the next
1113
958
  # page.
1114
959
  # @return [String]
@@ -1154,22 +999,15 @@ module Aws::RedshiftServerless
1154
999
  include Aws::Structure
1155
1000
  end
1156
1001
 
1157
- # @note When making an API call, you may pass ListNamespacesRequest
1158
- # data as a hash:
1159
- #
1160
- # {
1161
- # max_results: 1,
1162
- # next_token: "String",
1163
- # }
1164
- #
1165
1002
  # @!attribute [rw] max_results
1166
1003
  # An optional parameter that specifies the maximum number of results
1167
- # to return. You can use `nextToken` to get the next page of results.
1004
+ # to return. You can use `nextToken` to display the next page of
1005
+ # results.
1168
1006
  # @return [Integer]
1169
1007
  #
1170
1008
  # @!attribute [rw] next_token
1171
1009
  # If your initial `ListNamespaces` operation returns a `nextToken`,
1172
- # you can include the returned `nextToken` in subsequent
1010
+ # you can include the returned `nextToken` in following
1173
1011
  # `ListNamespaces` operations, which returns results in the next page.
1174
1012
  # @return [String]
1175
1013
  #
@@ -1202,33 +1040,28 @@ module Aws::RedshiftServerless
1202
1040
  include Aws::Structure
1203
1041
  end
1204
1042
 
1205
- # @note When making an API call, you may pass ListRecoveryPointsRequest
1206
- # data as a hash:
1207
- #
1208
- # {
1209
- # end_time: Time.now,
1210
- # max_results: 1,
1211
- # namespace_name: "NamespaceName",
1212
- # next_token: "String",
1213
- # start_time: Time.now,
1214
- # }
1215
- #
1216
1043
  # @!attribute [rw] end_time
1217
1044
  # The time when creation of the recovery point finished.
1218
1045
  # @return [Time]
1219
1046
  #
1220
1047
  # @!attribute [rw] max_results
1221
1048
  # An optional parameter that specifies the maximum number of results
1222
- # to return. You can use `nextToken` to get the next page of results.
1049
+ # to return. You can use `nextToken` to display the next page of
1050
+ # results.
1223
1051
  # @return [Integer]
1224
1052
  #
1053
+ # @!attribute [rw] namespace_arn
1054
+ # The Amazon Resource Name (ARN) of the namespace from which to list
1055
+ # recovery points.
1056
+ # @return [String]
1057
+ #
1225
1058
  # @!attribute [rw] namespace_name
1226
1059
  # The name of the namespace to list recovery points for.
1227
1060
  # @return [String]
1228
1061
  #
1229
1062
  # @!attribute [rw] next_token
1230
1063
  # If your initial `ListRecoveryPoints` operation returns a
1231
- # `nextToken`, you can include the returned `nextToken` in subsequent
1064
+ # `nextToken`, you can include the returned `nextToken` in following
1232
1065
  # `ListRecoveryPoints` operations, which returns results in the next
1233
1066
  # page.
1234
1067
  # @return [String]
@@ -1242,6 +1075,7 @@ module Aws::RedshiftServerless
1242
1075
  class ListRecoveryPointsRequest < Struct.new(
1243
1076
  :end_time,
1244
1077
  :max_results,
1078
+ :namespace_arn,
1245
1079
  :namespace_name,
1246
1080
  :next_token,
1247
1081
  :start_time)
@@ -1269,26 +1103,14 @@ module Aws::RedshiftServerless
1269
1103
  include Aws::Structure
1270
1104
  end
1271
1105
 
1272
- # @note When making an API call, you may pass ListSnapshotsRequest
1273
- # data as a hash:
1274
- #
1275
- # {
1276
- # end_time: Time.now,
1277
- # max_results: 1,
1278
- # namespace_arn: "String",
1279
- # namespace_name: "String",
1280
- # next_token: "String",
1281
- # owner_account: "String",
1282
- # start_time: Time.now,
1283
- # }
1284
- #
1285
1106
  # @!attribute [rw] end_time
1286
1107
  # The timestamp showing when the snapshot creation finished.
1287
1108
  # @return [Time]
1288
1109
  #
1289
1110
  # @!attribute [rw] max_results
1290
1111
  # An optional parameter that specifies the maximum number of results
1291
- # to return. You can use `nextToken` to get the next page of results.
1112
+ # to return. You can use `nextToken` to display the next page of
1113
+ # results.
1292
1114
  # @return [Integer]
1293
1115
  #
1294
1116
  # @!attribute [rw] namespace_arn
@@ -1349,13 +1171,60 @@ module Aws::RedshiftServerless
1349
1171
  include Aws::Structure
1350
1172
  end
1351
1173
 
1352
- # @note When making an API call, you may pass ListTagsForResourceRequest
1353
- # data as a hash:
1174
+ # @!attribute [rw] max_results
1175
+ # An optional parameter that specifies the maximum number of results
1176
+ # to return. You can use nextToken to display the next page of
1177
+ # results.
1178
+ # @return [Integer]
1354
1179
  #
1355
- # {
1356
- # resource_arn: "AmazonResourceName", # required
1357
- # }
1180
+ # @!attribute [rw] namespace_name
1181
+ # The namespace from which to list all of the statuses of
1182
+ # `RestoreTableFromSnapshot` operations .
1183
+ # @return [String]
1184
+ #
1185
+ # @!attribute [rw] next_token
1186
+ # If your initial `ListTableRestoreStatus` operation returns a
1187
+ # nextToken, you can include the returned `nextToken` in following
1188
+ # `ListTableRestoreStatus` operations. This will return results on the
1189
+ # next page.
1190
+ # @return [String]
1191
+ #
1192
+ # @!attribute [rw] workgroup_name
1193
+ # The workgroup from which to list all of the statuses of
1194
+ # `RestoreTableFromSnapshot` operations.
1195
+ # @return [String]
1196
+ #
1197
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListTableRestoreStatusRequest AWS API Documentation
1198
+ #
1199
+ class ListTableRestoreStatusRequest < Struct.new(
1200
+ :max_results,
1201
+ :namespace_name,
1202
+ :next_token,
1203
+ :workgroup_name)
1204
+ SENSITIVE = []
1205
+ include Aws::Structure
1206
+ end
1207
+
1208
+ # @!attribute [rw] next_token
1209
+ # If your initial `ListTableRestoreStatus` operation returns a
1210
+ # `nextToken`, you can include the returned `nextToken` in following
1211
+ # `ListTableRestoreStatus` operations. This will returns results on
1212
+ # the next page.
1213
+ # @return [String]
1214
+ #
1215
+ # @!attribute [rw] table_restore_statuses
1216
+ # The array of returned `TableRestoreStatus` objects.
1217
+ # @return [Array<Types::TableRestoreStatus>]
1358
1218
  #
1219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListTableRestoreStatusResponse AWS API Documentation
1220
+ #
1221
+ class ListTableRestoreStatusResponse < Struct.new(
1222
+ :next_token,
1223
+ :table_restore_statuses)
1224
+ SENSITIVE = []
1225
+ include Aws::Structure
1226
+ end
1227
+
1359
1228
  # @!attribute [rw] resource_arn
1360
1229
  # The Amazon Resource Name (ARN) of the resource to list tags for.
1361
1230
  # @return [String]
@@ -1380,16 +1249,6 @@ module Aws::RedshiftServerless
1380
1249
  include Aws::Structure
1381
1250
  end
1382
1251
 
1383
- # @note When making an API call, you may pass ListUsageLimitsRequest
1384
- # data as a hash:
1385
- #
1386
- # {
1387
- # max_results: 1,
1388
- # next_token: "PaginationToken",
1389
- # resource_arn: "String",
1390
- # usage_type: "serverless-compute", # accepts serverless-compute, cross-region-datasharing
1391
- # }
1392
- #
1393
1252
  # @!attribute [rw] max_results
1394
1253
  # An optional parameter that specifies the maximum number of results
1395
1254
  # to return. You can use `nextToken` to get the next page of results.
@@ -1398,7 +1257,7 @@ module Aws::RedshiftServerless
1398
1257
  #
1399
1258
  # @!attribute [rw] next_token
1400
1259
  # If your initial `ListUsageLimits` operation returns a `nextToken`,
1401
- # you can include the returned `nextToken` in subsequent
1260
+ # you can include the returned `nextToken` in following
1402
1261
  # `ListUsageLimits` operations, which returns results in the next
1403
1262
  # page.
1404
1263
  # @return [String]
@@ -1443,22 +1302,15 @@ module Aws::RedshiftServerless
1443
1302
  include Aws::Structure
1444
1303
  end
1445
1304
 
1446
- # @note When making an API call, you may pass ListWorkgroupsRequest
1447
- # data as a hash:
1448
- #
1449
- # {
1450
- # max_results: 1,
1451
- # next_token: "String",
1452
- # }
1453
- #
1454
1305
  # @!attribute [rw] max_results
1455
1306
  # An optional parameter that specifies the maximum number of results
1456
- # to return. You can use `nextToken` to get the next page of results.
1307
+ # to return. You can use `nextToken` to display the next page of
1308
+ # results.
1457
1309
  # @return [Integer]
1458
1310
  #
1459
1311
  # @!attribute [rw] next_token
1460
1312
  # If your initial ListWorkgroups operation returns a `nextToken`, you
1461
- # can include the returned `nextToken` in subsequent ListNamespaces
1313
+ # can include the returned `nextToken` in following ListNamespaces
1462
1314
  # operations, which returns results in the next page.
1463
1315
  # @return [String]
1464
1316
  #
@@ -1596,14 +1448,6 @@ module Aws::RedshiftServerless
1596
1448
  include Aws::Structure
1597
1449
  end
1598
1450
 
1599
- # @note When making an API call, you may pass PutResourcePolicyRequest
1600
- # data as a hash:
1601
- #
1602
- # {
1603
- # policy: "String", # required
1604
- # resource_arn: "String", # required
1605
- # }
1606
- #
1607
1451
  # @!attribute [rw] policy
1608
1452
  # The policy to create or update. For example, the following policy
1609
1453
  # grants a user authorization to restore a snapshot.
@@ -1644,6 +1488,11 @@ module Aws::RedshiftServerless
1644
1488
  # The automatically created recovery point of a namespace. Recovery
1645
1489
  # points are created every 30 minutes and kept for 24 hours.
1646
1490
  #
1491
+ # @!attribute [rw] namespace_arn
1492
+ # The Amazon Resource Name (ARN) of the namespace the recovery point
1493
+ # is associated with.
1494
+ # @return [String]
1495
+ #
1647
1496
  # @!attribute [rw] namespace_name
1648
1497
  # The name of the namespace the recovery point is associated with.
1649
1498
  # @return [String]
@@ -1667,6 +1516,7 @@ module Aws::RedshiftServerless
1667
1516
  # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RecoveryPoint AWS API Documentation
1668
1517
  #
1669
1518
  class RecoveryPoint < Struct.new(
1519
+ :namespace_arn,
1670
1520
  :namespace_name,
1671
1521
  :recovery_point_create_time,
1672
1522
  :recovery_point_id,
@@ -1714,15 +1564,6 @@ module Aws::RedshiftServerless
1714
1564
  include Aws::Structure
1715
1565
  end
1716
1566
 
1717
- # @note When making an API call, you may pass RestoreFromRecoveryPointRequest
1718
- # data as a hash:
1719
- #
1720
- # {
1721
- # namespace_name: "NamespaceName", # required
1722
- # recovery_point_id: "String", # required
1723
- # workgroup_name: "WorkgroupName", # required
1724
- # }
1725
- #
1726
1567
  # @!attribute [rw] namespace_name
1727
1568
  # The name of the namespace to restore data into.
1728
1569
  # @return [String]
@@ -1762,17 +1603,6 @@ module Aws::RedshiftServerless
1762
1603
  include Aws::Structure
1763
1604
  end
1764
1605
 
1765
- # @note When making an API call, you may pass RestoreFromSnapshotRequest
1766
- # data as a hash:
1767
- #
1768
- # {
1769
- # namespace_name: "NamespaceName", # required
1770
- # owner_account: "String",
1771
- # snapshot_arn: "String",
1772
- # snapshot_name: "String",
1773
- # workgroup_name: "WorkgroupName", # required
1774
- # }
1775
- #
1776
1606
  # @!attribute [rw] namespace_name
1777
1607
  # The name of the namespace to restore the snapshot to.
1778
1608
  # @return [String]
@@ -1783,10 +1613,17 @@ module Aws::RedshiftServerless
1783
1613
  #
1784
1614
  # @!attribute [rw] snapshot_arn
1785
1615
  # The Amazon Resource Name (ARN) of the snapshot to restore from.
1616
+ # Required if restoring from Amazon Redshift Serverless to a
1617
+ # provisioned cluster. Must not be specified at the same time as
1618
+ # `snapshotName`.
1619
+ #
1620
+ # The format of the ARN is
1621
+ # arn:aws:redshift:&lt;region&gt;\:&lt;account\_id&gt;\:snapshot:&lt;cluster\_identifier&gt;/&lt;snapshot\_identifier&gt;.
1786
1622
  # @return [String]
1787
1623
  #
1788
1624
  # @!attribute [rw] snapshot_name
1789
- # The name of the snapshot to restore from.
1625
+ # The name of the snapshot to restore from. Must not be specified at
1626
+ # the same time as `snapshotArn`.
1790
1627
  # @return [String]
1791
1628
  #
1792
1629
  # @!attribute [rw] workgroup_name
@@ -1828,6 +1665,80 @@ module Aws::RedshiftServerless
1828
1665
  include Aws::Structure
1829
1666
  end
1830
1667
 
1668
+ # @!attribute [rw] activate_case_sensitive_identifier
1669
+ # Indicates whether name identifiers for database, schema, and table
1670
+ # are case sensitive. If true, the names are case sensitive. If false,
1671
+ # the names are not case sensitive. The default is false.
1672
+ # @return [Boolean]
1673
+ #
1674
+ # @!attribute [rw] namespace_name
1675
+ # The namespace of the snapshot to restore from.
1676
+ # @return [String]
1677
+ #
1678
+ # @!attribute [rw] new_table_name
1679
+ # The name of the table to create from the restore operation.
1680
+ # @return [String]
1681
+ #
1682
+ # @!attribute [rw] snapshot_name
1683
+ # The name of the snapshot to restore the table from.
1684
+ # @return [String]
1685
+ #
1686
+ # @!attribute [rw] source_database_name
1687
+ # The name of the source database that contains the table being
1688
+ # restored.
1689
+ # @return [String]
1690
+ #
1691
+ # @!attribute [rw] source_schema_name
1692
+ # The name of the source schema that contains the table being
1693
+ # restored.
1694
+ # @return [String]
1695
+ #
1696
+ # @!attribute [rw] source_table_name
1697
+ # The name of the source table being restored.
1698
+ # @return [String]
1699
+ #
1700
+ # @!attribute [rw] target_database_name
1701
+ # The name of the database to restore the table to.
1702
+ # @return [String]
1703
+ #
1704
+ # @!attribute [rw] target_schema_name
1705
+ # The name of the schema to restore the table to.
1706
+ # @return [String]
1707
+ #
1708
+ # @!attribute [rw] workgroup_name
1709
+ # The workgroup to restore the table to.
1710
+ # @return [String]
1711
+ #
1712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RestoreTableFromSnapshotRequest AWS API Documentation
1713
+ #
1714
+ class RestoreTableFromSnapshotRequest < Struct.new(
1715
+ :activate_case_sensitive_identifier,
1716
+ :namespace_name,
1717
+ :new_table_name,
1718
+ :snapshot_name,
1719
+ :source_database_name,
1720
+ :source_schema_name,
1721
+ :source_table_name,
1722
+ :target_database_name,
1723
+ :target_schema_name,
1724
+ :workgroup_name)
1725
+ SENSITIVE = []
1726
+ include Aws::Structure
1727
+ end
1728
+
1729
+ # @!attribute [rw] table_restore_status
1730
+ # The TableRestoreStatus object that contains the status of the
1731
+ # restore operation.
1732
+ # @return [Types::TableRestoreStatus]
1733
+ #
1734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RestoreTableFromSnapshotResponse AWS API Documentation
1735
+ #
1736
+ class RestoreTableFromSnapshotResponse < Struct.new(
1737
+ :table_restore_status)
1738
+ SENSITIVE = []
1739
+ include Aws::Structure
1740
+ end
1741
+
1831
1742
  # The service limit was exceeded.
1832
1743
  #
1833
1744
  # @!attribute [rw] message
@@ -1956,15 +1867,98 @@ module Aws::RedshiftServerless
1956
1867
  include Aws::Structure
1957
1868
  end
1958
1869
 
1959
- # A map of key-value pairs.
1870
+ # Contains information about a table restore request.
1960
1871
  #
1961
- # @note When making an API call, you may pass Tag
1962
- # data as a hash:
1872
+ # @!attribute [rw] message
1873
+ # A description of the status of the table restore request. Status
1874
+ # values include `SUCCEEDED`, `FAILED`, `CANCELED`, `PENDING`,
1875
+ # `IN_PROGRESS`.
1876
+ # @return [String]
1963
1877
  #
1964
- # {
1965
- # key: "TagKey", # required
1966
- # value: "TagValue", # required
1967
- # }
1878
+ # @!attribute [rw] namespace_name
1879
+ # The namespace of the table being restored from.
1880
+ # @return [String]
1881
+ #
1882
+ # @!attribute [rw] new_table_name
1883
+ # The name of the table to create from the restore operation.
1884
+ # @return [String]
1885
+ #
1886
+ # @!attribute [rw] progress_in_mega_bytes
1887
+ # The amount of data restored to the new table so far, in megabytes
1888
+ # (MB).
1889
+ # @return [Integer]
1890
+ #
1891
+ # @!attribute [rw] request_time
1892
+ # The time that the table restore request was made, in Universal
1893
+ # Coordinated Time (UTC).
1894
+ # @return [Time]
1895
+ #
1896
+ # @!attribute [rw] snapshot_name
1897
+ # The name of the snapshot being restored from.
1898
+ # @return [String]
1899
+ #
1900
+ # @!attribute [rw] source_database_name
1901
+ # The name of the source database being restored from.
1902
+ # @return [String]
1903
+ #
1904
+ # @!attribute [rw] source_schema_name
1905
+ # The name of the source schema being restored from.
1906
+ # @return [String]
1907
+ #
1908
+ # @!attribute [rw] source_table_name
1909
+ # The name of the source table being restored from.
1910
+ # @return [String]
1911
+ #
1912
+ # @!attribute [rw] status
1913
+ # A value that describes the current state of the table restore
1914
+ # request. Possible values include `SUCCEEDED`, `FAILED`, `CANCELED`,
1915
+ # `PENDING`, `IN_PROGRESS`.
1916
+ # @return [String]
1917
+ #
1918
+ # @!attribute [rw] table_restore_request_id
1919
+ # The ID of the RestoreTableFromSnapshot request.
1920
+ # @return [String]
1921
+ #
1922
+ # @!attribute [rw] target_database_name
1923
+ # The name of the database to restore to.
1924
+ # @return [String]
1925
+ #
1926
+ # @!attribute [rw] target_schema_name
1927
+ # The name of the schema to restore to.
1928
+ # @return [String]
1929
+ #
1930
+ # @!attribute [rw] total_data_in_mega_bytes
1931
+ # The total amount of data to restore to the new table, in megabytes
1932
+ # (MB).
1933
+ # @return [Integer]
1934
+ #
1935
+ # @!attribute [rw] workgroup_name
1936
+ # The name of the workgroup being restored from.
1937
+ # @return [String]
1938
+ #
1939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/TableRestoreStatus AWS API Documentation
1940
+ #
1941
+ class TableRestoreStatus < Struct.new(
1942
+ :message,
1943
+ :namespace_name,
1944
+ :new_table_name,
1945
+ :progress_in_mega_bytes,
1946
+ :request_time,
1947
+ :snapshot_name,
1948
+ :source_database_name,
1949
+ :source_schema_name,
1950
+ :source_table_name,
1951
+ :status,
1952
+ :table_restore_request_id,
1953
+ :target_database_name,
1954
+ :target_schema_name,
1955
+ :total_data_in_mega_bytes,
1956
+ :workgroup_name)
1957
+ SENSITIVE = []
1958
+ include Aws::Structure
1959
+ end
1960
+
1961
+ # A map of key-value pairs.
1968
1962
  #
1969
1963
  # @!attribute [rw] key
1970
1964
  # The key to use in the tag.
@@ -1983,19 +1977,6 @@ module Aws::RedshiftServerless
1983
1977
  include Aws::Structure
1984
1978
  end
1985
1979
 
1986
- # @note When making an API call, you may pass TagResourceRequest
1987
- # data as a hash:
1988
- #
1989
- # {
1990
- # resource_arn: "AmazonResourceName", # required
1991
- # tags: [ # required
1992
- # {
1993
- # key: "TagKey", # required
1994
- # value: "TagValue", # required
1995
- # },
1996
- # ],
1997
- # }
1998
- #
1999
1980
  # @!attribute [rw] resource_arn
2000
1981
  # The Amazon Resource Name (ARN) of the resource to tag.
2001
1982
  # @return [String]
@@ -2053,14 +2034,6 @@ module Aws::RedshiftServerless
2053
2034
  include Aws::Structure
2054
2035
  end
2055
2036
 
2056
- # @note When making an API call, you may pass UntagResourceRequest
2057
- # data as a hash:
2058
- #
2059
- # {
2060
- # resource_arn: "AmazonResourceName", # required
2061
- # tag_keys: ["TagKey"], # required
2062
- # }
2063
- #
2064
2037
  # @!attribute [rw] resource_arn
2065
2038
  # The Amazon Resource Name (ARN) of the resource to remove tags from.
2066
2039
  # @return [String]
@@ -2082,14 +2055,6 @@ module Aws::RedshiftServerless
2082
2055
  #
2083
2056
  class UntagResourceResponse < Aws::EmptyStructure; end
2084
2057
 
2085
- # @note When making an API call, you may pass UpdateEndpointAccessRequest
2086
- # data as a hash:
2087
- #
2088
- # {
2089
- # endpoint_name: "String", # required
2090
- # vpc_security_group_ids: ["VpcSecurityGroupId"],
2091
- # }
2092
- #
2093
2058
  # @!attribute [rw] endpoint_name
2094
2059
  # The name of the VPC endpoint to update.
2095
2060
  # @return [String]
@@ -2120,19 +2085,6 @@ module Aws::RedshiftServerless
2120
2085
  include Aws::Structure
2121
2086
  end
2122
2087
 
2123
- # @note When making an API call, you may pass UpdateNamespaceRequest
2124
- # data as a hash:
2125
- #
2126
- # {
2127
- # admin_user_password: "DbPassword",
2128
- # admin_username: "DbUser",
2129
- # default_iam_role_arn: "String",
2130
- # iam_roles: ["IamRoleArn"],
2131
- # kms_key_id: "String",
2132
- # log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
2133
- # namespace_name: "NamespaceName", # required
2134
- # }
2135
- #
2136
2088
  # @!attribute [rw] admin_user_password
2137
2089
  # The password of the administrator for the first database created in
2138
2090
  # the namespace.
@@ -2192,14 +2144,6 @@ module Aws::RedshiftServerless
2192
2144
  include Aws::Structure
2193
2145
  end
2194
2146
 
2195
- # @note When making an API call, you may pass UpdateSnapshotRequest
2196
- # data as a hash:
2197
- #
2198
- # {
2199
- # retention_period: 1,
2200
- # snapshot_name: "String", # required
2201
- # }
2202
- #
2203
2147
  # @!attribute [rw] retention_period
2204
2148
  # The new retention period of the snapshot.
2205
2149
  # @return [Integer]
@@ -2229,17 +2173,11 @@ module Aws::RedshiftServerless
2229
2173
  include Aws::Structure
2230
2174
  end
2231
2175
 
2232
- # @note When making an API call, you may pass UpdateUsageLimitRequest
2233
- # data as a hash:
2234
- #
2235
- # {
2236
- # amount: 1,
2237
- # breach_action: "log", # accepts log, emit-metric, deactivate
2238
- # usage_limit_id: "String", # required
2239
- # }
2240
- #
2241
2176
  # @!attribute [rw] amount
2242
- # The new limit amount. For more information about this parameter.
2177
+ # The new limit amount. If time-based, this amount is in Redshift
2178
+ # Processing Units (RPU) consumed per hour. If data-based, this amount
2179
+ # is in terabytes (TB) of data transferred between Regions in
2180
+ # cross-account sharing. The value must be a positive number.
2243
2181
  # @return [Integer]
2244
2182
  #
2245
2183
  # @!attribute [rw] breach_action
@@ -2273,24 +2211,6 @@ module Aws::RedshiftServerless
2273
2211
  include Aws::Structure
2274
2212
  end
2275
2213
 
2276
- # @note When making an API call, you may pass UpdateWorkgroupRequest
2277
- # data as a hash:
2278
- #
2279
- # {
2280
- # base_capacity: 1,
2281
- # config_parameters: [
2282
- # {
2283
- # parameter_key: "ParameterKey",
2284
- # parameter_value: "ParameterValue",
2285
- # },
2286
- # ],
2287
- # enhanced_vpc_routing: false,
2288
- # publicly_accessible: false,
2289
- # security_group_ids: ["SecurityGroupId"],
2290
- # subnet_ids: ["SubnetId"],
2291
- # workgroup_name: "WorkgroupName", # required
2292
- # }
2293
- #
2294
2214
  # @!attribute [rw] base_capacity
2295
2215
  # The new base data warehouse capacity in Redshift Processing Units
2296
2216
  # (RPUs).
@@ -2308,6 +2228,11 @@ module Aws::RedshiftServerless
2308
2228
  # route traffic through your VPC.
2309
2229
  # @return [Boolean]
2310
2230
  #
2231
+ # @!attribute [rw] port
2232
+ # The custom port to use when connecting to a workgroup. Valid port
2233
+ # ranges are 5431-5455 and 8191-8215. The default is 5439.
2234
+ # @return [Integer]
2235
+ #
2311
2236
  # @!attribute [rw] publicly_accessible
2312
2237
  # A value that specifies whether the workgroup can be accessible from
2313
2238
  # a public network.
@@ -2331,6 +2256,7 @@ module Aws::RedshiftServerless
2331
2256
  :base_capacity,
2332
2257
  :config_parameters,
2333
2258
  :enhanced_vpc_routing,
2259
+ :port,
2334
2260
  :publicly_accessible,
2335
2261
  :security_group_ids,
2336
2262
  :subnet_ids,
@@ -2493,6 +2419,11 @@ module Aws::RedshiftServerless
2493
2419
  # The namespace the workgroup is associated with.
2494
2420
  # @return [String]
2495
2421
  #
2422
+ # @!attribute [rw] port
2423
+ # The custom port to use when connecting to a workgroup. Valid port
2424
+ # ranges are 5431-5455 and 8191-8215. The default is 5439.
2425
+ # @return [Integer]
2426
+ #
2496
2427
  # @!attribute [rw] publicly_accessible
2497
2428
  # A value that specifies whether the workgroup can be accessible from
2498
2429
  # a public network
@@ -2531,6 +2462,7 @@ module Aws::RedshiftServerless
2531
2462
  :endpoint,
2532
2463
  :enhanced_vpc_routing,
2533
2464
  :namespace_name,
2465
+ :port,
2534
2466
  :publicly_accessible,
2535
2467
  :security_group_ids,
2536
2468
  :status,