aws-sdk-backup 1.88.0 → 1.92.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.
@@ -95,7 +95,7 @@ module Aws::Backup
95
95
  # class name or an instance of a plugin class.
96
96
  #
97
97
  # @option options [required, Aws::CredentialProvider] :credentials
98
- # Your AWS credentials. This can be an instance of any one of the
98
+ # Your AWS credentials used for authentication. This can be an instance of any one of the
99
99
  # following classes:
100
100
  #
101
101
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -128,18 +128,23 @@ module Aws::Backup
128
128
  # locations will be searched for credentials:
129
129
  #
130
130
  # * `Aws.config[:credentials]`
131
+ #
131
132
  # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
133
  # `:account_id` options.
133
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
- # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
134
+ #
135
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
136
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
137
+ #
135
138
  # * `~/.aws/credentials`
139
+ #
136
140
  # * `~/.aws/config`
141
+ #
137
142
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
143
  # are very aggressive. Construct and pass an instance of
139
144
  # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
145
  # enable retries and extended timeouts. Instance profile credential
141
- # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
- # to true.
146
+ # fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
147
+ # to `true`.
143
148
  #
144
149
  # @option options [required, String] :region
145
150
  # The AWS region to connect to. The configured `:region` is
@@ -167,6 +172,11 @@ module Aws::Backup
167
172
  # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
173
  # not retry instead of sleeping.
169
174
  #
175
+ # @option options [Array<String>] :auth_scheme_preference
176
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
177
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
178
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
179
+ #
170
180
  # @option options [Boolean] :client_side_monitoring (false)
171
181
  # When `true`, client-side metrics will be collected for all API requests from
172
182
  # this client.
@@ -253,8 +263,8 @@ module Aws::Backup
253
263
  # 4 times. Used in `standard` and `adaptive` retry modes.
254
264
  #
255
265
  # @option options [String] :profile ("default")
256
- # Used when loading credentials from the shared credentials file
257
- # at HOME/.aws/credentials. When not specified, 'default' is used.
266
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
267
+ # When not specified, 'default' is used.
258
268
  #
259
269
  # @option options [String] :request_checksum_calculation ("when_supported")
260
270
  # Determines when a checksum will be calculated for request payloads. Values are:
@@ -367,7 +377,7 @@ module Aws::Backup
367
377
  # `Aws::Telemetry::OTelProvider` for telemetry provider.
368
378
  #
369
379
  # @option options [Aws::TokenProvider] :token_provider
370
- # A Bearer Token Provider. This can be an instance of any one of the
380
+ # Your Bearer token used for authentication. This can be an instance of any one of the
371
381
  # following classes:
372
382
  #
373
383
  # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
@@ -469,6 +479,38 @@ module Aws::Backup
469
479
 
470
480
  # @!group API Operations
471
481
 
482
+ # Associates an MPA approval team with a backup vault.
483
+ #
484
+ # @option params [required, String] :backup_vault_name
485
+ # The name of the backup vault to associate with the MPA approval team.
486
+ #
487
+ # @option params [required, String] :mpa_approval_team_arn
488
+ # The Amazon Resource Name (ARN) of the MPA approval team to associate
489
+ # with the backup vault.
490
+ #
491
+ # @option params [String] :requester_comment
492
+ # A comment provided by the requester explaining the association
493
+ # request.
494
+ #
495
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
496
+ #
497
+ # @example Request syntax with placeholder values
498
+ #
499
+ # resp = client.associate_backup_vault_mpa_approval_team({
500
+ # backup_vault_name: "BackupVaultName", # required
501
+ # mpa_approval_team_arn: "ARN", # required
502
+ # requester_comment: "RequesterComment",
503
+ # })
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam AWS API Documentation
506
+ #
507
+ # @overload associate_backup_vault_mpa_approval_team(params = {})
508
+ # @param [Hash] params ({})
509
+ def associate_backup_vault_mpa_approval_team(params = {}, options = {})
510
+ req = build_request(:associate_backup_vault_mpa_approval_team, params)
511
+ req.send_request(options)
512
+ end
513
+
472
514
  # Removes the specified legal hold on a recovery point. This action can
473
515
  # only be performed by a user with sufficient permissions.
474
516
  #
@@ -523,6 +565,9 @@ module Aws::Backup
523
565
  # If used, this parameter must contain 1 to 50 alphanumeric or '-\_.'
524
566
  # characters.
525
567
  #
568
+ # **A suitable default value is auto-generated.** You should normally
569
+ # not need to pass this option.**
570
+ #
526
571
  # @return [Types::CreateBackupPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
527
572
  #
528
573
  # * {Types::CreateBackupPlanOutput#backup_plan_id #backup_plan_id} => String
@@ -627,6 +672,9 @@ module Aws::Backup
627
672
  # If used, this parameter must contain 1 to 50 alphanumeric or '-\_.'
628
673
  # characters.
629
674
  #
675
+ # **A suitable default value is auto-generated.** You should normally
676
+ # not need to pass this option.**
677
+ #
630
678
  # @return [Types::CreateBackupSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
631
679
  #
632
680
  # * {Types::CreateBackupSelectionOutput#selection_id #selection_id} => String
@@ -725,6 +773,9 @@ module Aws::Backup
725
773
  # If used, this parameter must contain 1 to 50 alphanumeric or '-\_.'
726
774
  # characters.
727
775
  #
776
+ # **A suitable default value is auto-generated.** You should normally
777
+ # not need to pass this option.**
778
+ #
728
779
  # @return [Types::CreateBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
729
780
  #
730
781
  # * {Types::CreateBackupVaultOutput#backup_vault_name #backup_vault_name} => String
@@ -853,6 +904,9 @@ module Aws::Backup
853
904
  # identical calls. Retrying a successful request with the same
854
905
  # idempotency token results in a success message with no action taken.
855
906
  #
907
+ # **A suitable default value is auto-generated.** You should normally
908
+ # not need to pass this option.**
909
+ #
856
910
  # @option params [Types::RecoveryPointSelection] :recovery_point_selection
857
911
  # The criteria to assign a set of resources, such as resource types or
858
912
  # backup vaults.
@@ -941,6 +995,9 @@ module Aws::Backup
941
995
  # This parameter is optional. If used, this parameter must contain 1 to
942
996
  # 50 alphanumeric or '-\_.' characters.
943
997
  #
998
+ # **A suitable default value is auto-generated.** You should normally
999
+ # not need to pass this option.**
1000
+ #
944
1001
  # @option params [required, Integer] :min_retention_days
945
1002
  # This setting specifies the minimum retention period that the vault
946
1003
  # retains its recovery points.
@@ -1075,6 +1132,66 @@ module Aws::Backup
1075
1132
  req.send_request(options)
1076
1133
  end
1077
1134
 
1135
+ # Creates a restore access backup vault that provides temporary access
1136
+ # to recovery points in a logically air-gapped backup vault, subject to
1137
+ # MPA approval.
1138
+ #
1139
+ # @option params [required, String] :source_backup_vault_arn
1140
+ # The ARN of the source backup vault containing the recovery points to
1141
+ # which temporary access is requested.
1142
+ #
1143
+ # @option params [String] :backup_vault_name
1144
+ # The name of the backup vault to associate with an MPA approval team.
1145
+ #
1146
+ # @option params [Hash<String,String>] :backup_vault_tags
1147
+ # Optional tags to assign to the restore access backup vault.
1148
+ #
1149
+ # @option params [String] :creator_request_id
1150
+ # A unique string that identifies the request and allows failed requests
1151
+ # to be retried without the risk of executing the operation twice.
1152
+ #
1153
+ # **A suitable default value is auto-generated.** You should normally
1154
+ # not need to pass this option.**
1155
+ #
1156
+ # @option params [String] :requester_comment
1157
+ # A comment explaining the reason for requesting restore access to the
1158
+ # backup vault.
1159
+ #
1160
+ # @return [Types::CreateRestoreAccessBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1161
+ #
1162
+ # * {Types::CreateRestoreAccessBackupVaultOutput#restore_access_backup_vault_arn #restore_access_backup_vault_arn} => String
1163
+ # * {Types::CreateRestoreAccessBackupVaultOutput#vault_state #vault_state} => String
1164
+ # * {Types::CreateRestoreAccessBackupVaultOutput#restore_access_backup_vault_name #restore_access_backup_vault_name} => String
1165
+ # * {Types::CreateRestoreAccessBackupVaultOutput#creation_date #creation_date} => Time
1166
+ #
1167
+ # @example Request syntax with placeholder values
1168
+ #
1169
+ # resp = client.create_restore_access_backup_vault({
1170
+ # source_backup_vault_arn: "ARN", # required
1171
+ # backup_vault_name: "BackupVaultName",
1172
+ # backup_vault_tags: {
1173
+ # "TagKey" => "TagValue",
1174
+ # },
1175
+ # creator_request_id: "string",
1176
+ # requester_comment: "RequesterComment",
1177
+ # })
1178
+ #
1179
+ # @example Response structure
1180
+ #
1181
+ # resp.restore_access_backup_vault_arn #=> String
1182
+ # resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
1183
+ # resp.restore_access_backup_vault_name #=> String
1184
+ # resp.creation_date #=> Time
1185
+ #
1186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreAccessBackupVault AWS API Documentation
1187
+ #
1188
+ # @overload create_restore_access_backup_vault(params = {})
1189
+ # @param [Hash] params ({})
1190
+ def create_restore_access_backup_vault(params = {}, options = {})
1191
+ req = build_request(:create_restore_access_backup_vault, params)
1192
+ req.send_request(options)
1193
+ end
1194
+
1078
1195
  # Creates a restore testing plan.
1079
1196
  #
1080
1197
  # The first of two steps to create a restore testing plan. After this
@@ -1676,6 +1793,10 @@ module Aws::Backup
1676
1793
  # * {Types::DescribeBackupVaultOutput#min_retention_days #min_retention_days} => Integer
1677
1794
  # * {Types::DescribeBackupVaultOutput#max_retention_days #max_retention_days} => Integer
1678
1795
  # * {Types::DescribeBackupVaultOutput#lock_date #lock_date} => Time
1796
+ # * {Types::DescribeBackupVaultOutput#source_backup_vault_arn #source_backup_vault_arn} => String
1797
+ # * {Types::DescribeBackupVaultOutput#mpa_approval_team_arn #mpa_approval_team_arn} => String
1798
+ # * {Types::DescribeBackupVaultOutput#mpa_session_arn #mpa_session_arn} => String
1799
+ # * {Types::DescribeBackupVaultOutput#latest_mpa_approval_team_update #latest_mpa_approval_team_update} => Types::LatestMpaApprovalTeamUpdate
1679
1800
  #
1680
1801
  # @example Request syntax with placeholder values
1681
1802
  #
@@ -1688,7 +1809,7 @@ module Aws::Backup
1688
1809
  #
1689
1810
  # resp.backup_vault_name #=> String
1690
1811
  # resp.backup_vault_arn #=> String
1691
- # resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
1812
+ # resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
1692
1813
  # resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
1693
1814
  # resp.encryption_key_arn #=> String
1694
1815
  # resp.creation_date #=> Time
@@ -1698,6 +1819,14 @@ module Aws::Backup
1698
1819
  # resp.min_retention_days #=> Integer
1699
1820
  # resp.max_retention_days #=> Integer
1700
1821
  # resp.lock_date #=> Time
1822
+ # resp.source_backup_vault_arn #=> String
1823
+ # resp.mpa_approval_team_arn #=> String
1824
+ # resp.mpa_session_arn #=> String
1825
+ # resp.latest_mpa_approval_team_update.mpa_session_arn #=> String
1826
+ # resp.latest_mpa_approval_team_update.status #=> String, one of "PENDING", "APPROVED", "FAILED"
1827
+ # resp.latest_mpa_approval_team_update.status_message #=> String
1828
+ # resp.latest_mpa_approval_team_update.initiation_date #=> Time
1829
+ # resp.latest_mpa_approval_team_update.expiry_date #=> Time
1701
1830
  #
1702
1831
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVault AWS API Documentation
1703
1832
  #
@@ -1914,6 +2043,7 @@ module Aws::Backup
1914
2043
  # * {Types::DescribeRecoveryPointOutput#status #status} => String
1915
2044
  # * {Types::DescribeRecoveryPointOutput#status_message #status_message} => String
1916
2045
  # * {Types::DescribeRecoveryPointOutput#creation_date #creation_date} => Time
2046
+ # * {Types::DescribeRecoveryPointOutput#initiation_date #initiation_date} => Time
1917
2047
  # * {Types::DescribeRecoveryPointOutput#completion_date #completion_date} => Time
1918
2048
  # * {Types::DescribeRecoveryPointOutput#backup_size_in_bytes #backup_size_in_bytes} => Integer
1919
2049
  # * {Types::DescribeRecoveryPointOutput#calculated_lifecycle #calculated_lifecycle} => Types::CalculatedLifecycle
@@ -1951,9 +2081,10 @@ module Aws::Backup
1951
2081
  # resp.created_by.backup_plan_version #=> String
1952
2082
  # resp.created_by.backup_rule_id #=> String
1953
2083
  # resp.iam_role_arn #=> String
1954
- # resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
2084
+ # resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
1955
2085
  # resp.status_message #=> String
1956
2086
  # resp.creation_date #=> Time
2087
+ # resp.initiation_date #=> Time
1957
2088
  # resp.completion_date #=> Time
1958
2089
  # resp.backup_size_in_bytes #=> Integer
1959
2090
  # resp.calculated_lifecycle.move_to_cold_storage_at #=> Time
@@ -1969,7 +2100,7 @@ module Aws::Backup
1969
2100
  # resp.composite_member_identifier #=> String
1970
2101
  # resp.is_parent #=> Boolean
1971
2102
  # resp.resource_name #=> String
1972
- # resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
2103
+ # resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
1973
2104
  # resp.index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
1974
2105
  # resp.index_status_message #=> String
1975
2106
  #
@@ -2163,6 +2294,35 @@ module Aws::Backup
2163
2294
  req.send_request(options)
2164
2295
  end
2165
2296
 
2297
+ # Removes the association between an MPA approval team and a backup
2298
+ # vault, disabling the MPA approval workflow for restore operations.
2299
+ #
2300
+ # @option params [required, String] :backup_vault_name
2301
+ # The name of the backup vault from which to disassociate the MPA
2302
+ # approval team.
2303
+ #
2304
+ # @option params [String] :requester_comment
2305
+ # An optional comment explaining the reason for disassociating the MPA
2306
+ # approval team from the backup vault.
2307
+ #
2308
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2309
+ #
2310
+ # @example Request syntax with placeholder values
2311
+ #
2312
+ # resp = client.disassociate_backup_vault_mpa_approval_team({
2313
+ # backup_vault_name: "BackupVaultName", # required
2314
+ # requester_comment: "RequesterComment",
2315
+ # })
2316
+ #
2317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam AWS API Documentation
2318
+ #
2319
+ # @overload disassociate_backup_vault_mpa_approval_team(params = {})
2320
+ # @param [Hash] params ({})
2321
+ def disassociate_backup_vault_mpa_approval_team(params = {}, options = {})
2322
+ req = build_request(:disassociate_backup_vault_mpa_approval_team, params)
2323
+ req.send_request(options)
2324
+ end
2325
+
2166
2326
  # Deletes the specified continuous backup recovery point from Backup and
2167
2327
  # releases control of that continuous backup to the source service, such
2168
2328
  # as Amazon RDS. The source service will continue to create and retain
@@ -2570,7 +2730,7 @@ module Aws::Backup
2570
2730
  # resp.backup_vault_arn #=> String
2571
2731
  # resp.sns_topic_arn #=> String
2572
2732
  # resp.backup_vault_events #=> Array
2573
- # resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED"
2733
+ # resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED", "CONTINUOUS_BACKUP_INTERRUPTED", "RECOVERY_POINT_INDEX_COMPLETED", "RECOVERY_POINT_INDEX_DELETED", "RECOVERY_POINT_INDEXING_FAILED"
2574
2734
  #
2575
2735
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotifications AWS API Documentation
2576
2736
  #
@@ -3484,7 +3644,7 @@ module Aws::Backup
3484
3644
  # @example Request syntax with placeholder values
3485
3645
  #
3486
3646
  # resp = client.list_backup_vaults({
3487
- # by_vault_type: "BACKUP_VAULT", # accepts BACKUP_VAULT, LOGICALLY_AIR_GAPPED_BACKUP_VAULT
3647
+ # by_vault_type: "BACKUP_VAULT", # accepts BACKUP_VAULT, LOGICALLY_AIR_GAPPED_BACKUP_VAULT, RESTORE_ACCESS_BACKUP_VAULT
3488
3648
  # by_shared: false,
3489
3649
  # next_token: "string",
3490
3650
  # max_results: 1,
@@ -3495,7 +3655,7 @@ module Aws::Backup
3495
3655
  # resp.backup_vault_list #=> Array
3496
3656
  # resp.backup_vault_list[0].backup_vault_name #=> String
3497
3657
  # resp.backup_vault_list[0].backup_vault_arn #=> String
3498
- # resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
3658
+ # resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
3499
3659
  # resp.backup_vault_list[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
3500
3660
  # resp.backup_vault_list[0].creation_date #=> Time
3501
3661
  # resp.backup_vault_list[0].encryption_key_arn #=> String
@@ -4206,9 +4366,10 @@ module Aws::Backup
4206
4366
  # resp.recovery_points[0].created_by.backup_plan_version #=> String
4207
4367
  # resp.recovery_points[0].created_by.backup_rule_id #=> String
4208
4368
  # resp.recovery_points[0].iam_role_arn #=> String
4209
- # resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
4369
+ # resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
4210
4370
  # resp.recovery_points[0].status_message #=> String
4211
4371
  # resp.recovery_points[0].creation_date #=> Time
4372
+ # resp.recovery_points[0].initiation_date #=> Time
4212
4373
  # resp.recovery_points[0].completion_date #=> Time
4213
4374
  # resp.recovery_points[0].backup_size_in_bytes #=> Integer
4214
4375
  # resp.recovery_points[0].calculated_lifecycle.move_to_cold_storage_at #=> Time
@@ -4223,7 +4384,7 @@ module Aws::Backup
4223
4384
  # resp.recovery_points[0].composite_member_identifier #=> String
4224
4385
  # resp.recovery_points[0].is_parent #=> Boolean
4225
4386
  # resp.recovery_points[0].resource_name #=> String
4226
- # resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
4387
+ # resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
4227
4388
  # resp.recovery_points[0].index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
4228
4389
  # resp.recovery_points[0].index_status_message #=> String
4229
4390
  #
@@ -4342,7 +4503,7 @@ module Aws::Backup
4342
4503
  # resp.recovery_points #=> Array
4343
4504
  # resp.recovery_points[0].recovery_point_arn #=> String
4344
4505
  # resp.recovery_points[0].creation_date #=> Time
4345
- # resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
4506
+ # resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
4346
4507
  # resp.recovery_points[0].status_message #=> String
4347
4508
  # resp.recovery_points[0].encryption_key_arn #=> String
4348
4509
  # resp.recovery_points[0].backup_size_bytes #=> Integer
@@ -4350,7 +4511,7 @@ module Aws::Backup
4350
4511
  # resp.recovery_points[0].is_parent #=> Boolean
4351
4512
  # resp.recovery_points[0].parent_recovery_point_arn #=> String
4352
4513
  # resp.recovery_points[0].resource_name #=> String
4353
- # resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
4514
+ # resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
4354
4515
  # resp.recovery_points[0].index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
4355
4516
  # resp.recovery_points[0].index_status_message #=> String
4356
4517
  #
@@ -4498,6 +4659,58 @@ module Aws::Backup
4498
4659
  req.send_request(options)
4499
4660
  end
4500
4661
 
4662
+ # Returns a list of restore access backup vaults associated with a
4663
+ # specified backup vault.
4664
+ #
4665
+ # @option params [required, String] :backup_vault_name
4666
+ # The name of the backup vault for which to list associated restore
4667
+ # access backup vaults.
4668
+ #
4669
+ # @option params [String] :next_token
4670
+ # The pagination token from a previous request to retrieve the next set
4671
+ # of results.
4672
+ #
4673
+ # @option params [Integer] :max_results
4674
+ # The maximum number of items to return in the response.
4675
+ #
4676
+ # @return [Types::ListRestoreAccessBackupVaultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4677
+ #
4678
+ # * {Types::ListRestoreAccessBackupVaultsOutput#next_token #next_token} => String
4679
+ # * {Types::ListRestoreAccessBackupVaultsOutput#restore_access_backup_vaults #restore_access_backup_vaults} => Array&lt;Types::RestoreAccessBackupVaultListMember&gt;
4680
+ #
4681
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4682
+ #
4683
+ # @example Request syntax with placeholder values
4684
+ #
4685
+ # resp = client.list_restore_access_backup_vaults({
4686
+ # backup_vault_name: "BackupVaultName", # required
4687
+ # next_token: "string",
4688
+ # max_results: 1,
4689
+ # })
4690
+ #
4691
+ # @example Response structure
4692
+ #
4693
+ # resp.next_token #=> String
4694
+ # resp.restore_access_backup_vaults #=> Array
4695
+ # resp.restore_access_backup_vaults[0].restore_access_backup_vault_arn #=> String
4696
+ # resp.restore_access_backup_vaults[0].creation_date #=> Time
4697
+ # resp.restore_access_backup_vaults[0].approval_date #=> Time
4698
+ # resp.restore_access_backup_vaults[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
4699
+ # resp.restore_access_backup_vaults[0].latest_revoke_request.mpa_session_arn #=> String
4700
+ # resp.restore_access_backup_vaults[0].latest_revoke_request.status #=> String, one of "PENDING", "FAILED"
4701
+ # resp.restore_access_backup_vaults[0].latest_revoke_request.status_message #=> String
4702
+ # resp.restore_access_backup_vaults[0].latest_revoke_request.initiation_date #=> Time
4703
+ # resp.restore_access_backup_vaults[0].latest_revoke_request.expiry_date #=> Time
4704
+ #
4705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreAccessBackupVaults AWS API Documentation
4706
+ #
4707
+ # @overload list_restore_access_backup_vaults(params = {})
4708
+ # @param [Hash] params ({})
4709
+ def list_restore_access_backup_vaults(params = {}, options = {})
4710
+ req = build_request(:list_restore_access_backup_vaults, params)
4711
+ req.send_request(options)
4712
+ end
4713
+
4501
4714
  # This request obtains a summary of restore jobs created or running
4502
4715
  # within the the most recent 30 days. You can include parameters
4503
4716
  # AccountID, State, ResourceType, AggregationPeriod, MaxResults, or
@@ -4917,6 +5130,24 @@ module Aws::Backup
4917
5130
  # Returns the tags assigned to the resource, such as a target recovery
4918
5131
  # point, backup plan, or backup vault.
4919
5132
  #
5133
+ # This operation returns results depending on the resource type used in
5134
+ # the value for `resourceArn`. For example, recovery points of Amazon
5135
+ # DynamoDB with Advanced Settings have an ARN (Amazon Resource Name)
5136
+ # that begins with `arn:aws:backup`. Recovery points (backups) of
5137
+ # DynamoDB without Advanced Settings enabled have an ARN that begins
5138
+ # with `arn:aws:dynamodb`.
5139
+ #
5140
+ # When this operation is called and when you include values of
5141
+ # `resourceArn` that have an ARN other than `arn:aws:backup`, it may
5142
+ # return one of the exceptions listed below. To prevent this exception,
5143
+ # include only values representing resource types that are fully managed
5144
+ # by Backup. These have an ARN that begins `arn:aws:backup` and they are
5145
+ # noted in the [Feature availability by resource][1] table.
5146
+ #
5147
+ #
5148
+ #
5149
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
5150
+ #
4920
5151
  # @option params [required, String] :resource_arn
4921
5152
  # An Amazon Resource Name (ARN) that uniquely identifies a resource. The
4922
5153
  # format of the ARN depends on the type of resource. Valid targets for
@@ -5117,32 +5348,13 @@ module Aws::Backup
5117
5348
  #
5118
5349
  # @option params [required, Array<String>] :backup_vault_events
5119
5350
  # An array of events that indicate the status of jobs to back up
5120
- # resources to the backup vault.
5351
+ # resources to the backup vault. For the list of supported events,
5352
+ # common use cases, and code samples, see [Notification options with
5353
+ # Backup][1].
5121
5354
  #
5122
- # For common use cases and code samples, see [Using Amazon SNS to track
5123
- # Backup events][1].
5124
5355
  #
5125
- # The following events are supported:
5126
5356
  #
5127
- # * `BACKUP_JOB_STARTED` \| `BACKUP_JOB_COMPLETED`
5128
- #
5129
- # * `COPY_JOB_STARTED` \| `COPY_JOB_SUCCESSFUL` \| `COPY_JOB_FAILED`
5130
- #
5131
- # * `RESTORE_JOB_STARTED` \| `RESTORE_JOB_COMPLETED` \|
5132
- # `RECOVERY_POINT_MODIFIED`
5133
- #
5134
- # * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
5135
- #
5136
- # <note markdown="1"> The list below includes both supported events and deprecated events
5137
- # that are no longer in use (for reference). Deprecated events do not
5138
- # return statuses or notifications. Refer to the list above for the
5139
- # supported events.
5140
- #
5141
- # </note>
5142
- #
5143
- #
5144
- #
5145
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html
5357
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-notifications.html
5146
5358
  #
5147
5359
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5148
5360
  #
@@ -5151,7 +5363,7 @@ module Aws::Backup
5151
5363
  # resp = client.put_backup_vault_notifications({
5152
5364
  # backup_vault_name: "BackupVaultName", # required
5153
5365
  # sns_topic_arn: "ARN", # required
5154
- # backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED, S3_BACKUP_OBJECT_FAILED, S3_RESTORE_OBJECT_FAILED
5366
+ # backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED, S3_BACKUP_OBJECT_FAILED, S3_RESTORE_OBJECT_FAILED, CONTINUOUS_BACKUP_INTERRUPTED, RECOVERY_POINT_INDEX_COMPLETED, RECOVERY_POINT_INDEX_DELETED, RECOVERY_POINT_INDEXING_FAILED
5155
5367
  # })
5156
5368
  #
5157
5369
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotifications AWS API Documentation
@@ -5196,6 +5408,40 @@ module Aws::Backup
5196
5408
  req.send_request(options)
5197
5409
  end
5198
5410
 
5411
+ # Revokes access to a restore access backup vault, removing the ability
5412
+ # to restore from its recovery points and permanently deleting the
5413
+ # vault.
5414
+ #
5415
+ # @option params [required, String] :backup_vault_name
5416
+ # The name of the source backup vault associated with the restore access
5417
+ # backup vault to be revoked.
5418
+ #
5419
+ # @option params [required, String] :restore_access_backup_vault_arn
5420
+ # The ARN of the restore access backup vault to revoke.
5421
+ #
5422
+ # @option params [String] :requester_comment
5423
+ # A comment explaining the reason for revoking access to the restore
5424
+ # access backup vault.
5425
+ #
5426
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5427
+ #
5428
+ # @example Request syntax with placeholder values
5429
+ #
5430
+ # resp = client.revoke_restore_access_backup_vault({
5431
+ # backup_vault_name: "BackupVaultName", # required
5432
+ # restore_access_backup_vault_arn: "ARN", # required
5433
+ # requester_comment: "RequesterComment",
5434
+ # })
5435
+ #
5436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RevokeRestoreAccessBackupVault AWS API Documentation
5437
+ #
5438
+ # @overload revoke_restore_access_backup_vault(params = {})
5439
+ # @param [Hash] params ({})
5440
+ def revoke_restore_access_backup_vault(params = {}, options = {})
5441
+ req = build_request(:revoke_restore_access_backup_vault, params)
5442
+ req.send_request(options)
5443
+ end
5444
+
5199
5445
  # Starts an on-demand backup job for the specified resource.
5200
5446
  #
5201
5447
  # @option params [required, String] :backup_vault_name
@@ -5217,6 +5463,9 @@ module Aws::Backup
5217
5463
  # request with the same idempotency token results in a success message
5218
5464
  # with no action taken.
5219
5465
  #
5466
+ # **A suitable default value is auto-generated.** You should normally
5467
+ # not need to pass this option.**
5468
+ #
5220
5469
  # @option params [Integer] :start_window_minutes
5221
5470
  # A value in minutes after a backup is scheduled before a job will be
5222
5471
  # canceled if it doesn't start successfully. This value is optional,
@@ -5370,6 +5619,9 @@ module Aws::Backup
5370
5619
  # request with the same idempotency token results in a success message
5371
5620
  # with no action taken.
5372
5621
  #
5622
+ # **A suitable default value is auto-generated.** You should normally
5623
+ # not need to pass this option.**
5624
+ #
5373
5625
  # @option params [Types::Lifecycle] :lifecycle
5374
5626
  # Specifies the time period, in days, before a recovery point
5375
5627
  # transitions to cold storage or is deleted.
@@ -5545,6 +5797,9 @@ module Aws::Backup
5545
5797
  # request with the same idempotency token results in a success message
5546
5798
  # with no action taken.
5547
5799
  #
5800
+ # **A suitable default value is auto-generated.** You should normally
5801
+ # not need to pass this option.**
5802
+ #
5548
5803
  # @option params [String] :resource_type
5549
5804
  # Starts a job to restore a recovery point for one of the following
5550
5805
  # resources:
@@ -5617,10 +5872,25 @@ module Aws::Backup
5617
5872
 
5618
5873
  # Attempts to cancel a job to create a one-time backup of a resource.
5619
5874
  #
5620
- # This action is not supported for the following services: Amazon FSx
5621
- # for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp
5622
- # ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB
5623
- # compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
5875
+ # This action is not supported for the following services:
5876
+ #
5877
+ # * Amazon Aurora
5878
+ #
5879
+ # * Amazon DocumentDB (with MongoDB compatibility)
5880
+ #
5881
+ # * Amazon FSx for Lustre
5882
+ #
5883
+ # * Amazon FSx for NetApp ONTAP
5884
+ #
5885
+ # * Amazon FSx for OpenZFS
5886
+ #
5887
+ # * Amazon FSx for Windows File Server
5888
+ #
5889
+ # * Amazon Neptune
5890
+ #
5891
+ # * SAP HANA databases on Amazon EC2 instances
5892
+ #
5893
+ # * Amazon RDS
5624
5894
  #
5625
5895
  # @option params [required, String] :backup_job_id
5626
5896
  # Uniquely identifies a request to Backup to back up a resource.
@@ -5642,21 +5912,10 @@ module Aws::Backup
5642
5912
  req.send_request(options)
5643
5913
  end
5644
5914
 
5645
- # Assigns a set of key-value pairs to a recovery point, backup plan, or
5646
- # backup vault identified by an Amazon Resource Name (ARN).
5647
- #
5648
- # This API is supported for recovery points for resource types including
5649
- # Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon
5650
- # RDS.
5915
+ # Assigns a set of key-value pairs to a resource.
5651
5916
  #
5652
5917
  # @option params [required, String] :resource_arn
5653
- # An ARN that uniquely identifies a resource. The format of the ARN
5654
- # depends on the type of the tagged resource.
5655
- #
5656
- # ARNs that do not include `backup` are incompatible with tagging.
5657
- # `TagResource` and `UntagResource` with invalid ARNs will result in an
5658
- # error. Acceptable ARN content can include `arn:aws:backup:us-east`.
5659
- # Invalid ARN content may look like `arn:aws:ec2:us-east`.
5918
+ # The ARN that uniquely identifies the resource.
5660
5919
  #
5661
5920
  # @option params [required, Hash<String,String>] :tags
5662
5921
  # Key-value pairs that are used to help organize your resources. You can
@@ -6340,7 +6599,7 @@ module Aws::Backup
6340
6599
  tracer: tracer
6341
6600
  )
6342
6601
  context[:gem_name] = 'aws-sdk-backup'
6343
- context[:gem_version] = '1.88.0'
6602
+ context[:gem_version] = '1.92.0'
6344
6603
  Seahorse::Client::Request.new(handlers, context)
6345
6604
  end
6346
6605