aws-sdk-backup 1.73.0 → 1.80.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.
@@ -32,11 +32,10 @@ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
32
32
  require 'aws-sdk-core/plugins/request_compression.rb'
33
33
  require 'aws-sdk-core/plugins/defaults_mode.rb'
34
34
  require 'aws-sdk-core/plugins/recursion_detection.rb'
35
+ require 'aws-sdk-core/plugins/telemetry.rb'
35
36
  require 'aws-sdk-core/plugins/sign.rb'
36
37
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
37
38
 
38
- Aws::Plugins::GlobalConfiguration.add_identifier(:backup)
39
-
40
39
  module Aws::Backup
41
40
  # An API client for Backup. To construct a client, you need to configure a `:region` and `:credentials`.
42
41
  #
@@ -83,6 +82,7 @@ module Aws::Backup
83
82
  add_plugin(Aws::Plugins::RequestCompression)
84
83
  add_plugin(Aws::Plugins::DefaultsMode)
85
84
  add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
86
  add_plugin(Aws::Plugins::Sign)
87
87
  add_plugin(Aws::Plugins::Protocols::RestJson)
88
88
  add_plugin(Aws::Backup::Plugins::Endpoints)
@@ -128,13 +128,15 @@ module Aws::Backup
128
128
  # locations will be searched for credentials:
129
129
  #
130
130
  # * `Aws.config[:credentials]`
131
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
132
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
+ # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
133
135
  # * `~/.aws/credentials`
134
136
  # * `~/.aws/config`
135
137
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
136
138
  # are very aggressive. Construct and pass an instance of
137
- # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
139
+ # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
138
140
  # enable retries and extended timeouts. Instance profile credential
139
141
  # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
140
142
  # to true.
@@ -153,6 +155,8 @@ module Aws::Backup
153
155
  #
154
156
  # @option options [String] :access_key_id
155
157
  #
158
+ # @option options [String] :account_id
159
+ #
156
160
  # @option options [Boolean] :active_endpoint_cache (false)
157
161
  # When set to `true`, a thread polling for endpoints will be running in
158
162
  # the background every 60 secs (default). Defaults to `false`.
@@ -330,6 +334,16 @@ module Aws::Backup
330
334
  # ** Please note ** When response stubbing is enabled, no HTTP
331
335
  # requests are made, and retries are disabled.
332
336
  #
337
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
338
+ # Allows you to provide a telemetry provider, which is used to
339
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
340
+ # will not record or emit any telemetry data. The SDK supports the
341
+ # following telemetry providers:
342
+ #
343
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
344
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
345
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
346
+ #
333
347
  # @option options [Aws::TokenProvider] :token_provider
334
348
  # A Bearer Token Provider. This can be an instance of any one of the
335
349
  # following classes:
@@ -357,7 +371,9 @@ module Aws::Backup
357
371
  # sending the request.
358
372
  #
359
373
  # @option options [Aws::Backup::EndpointProvider] :endpoint_provider
360
- # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Backup::EndpointParameters`
374
+ # The endpoint provider used to resolve endpoints. Any object that responds to
375
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
376
+ # `Aws::Backup::EndpointParameters`.
361
377
  #
362
378
  # @option options [Float] :http_continue_timeout (1)
363
379
  # The number of seconds to wait for a 100-continue response before sending the
@@ -413,6 +429,12 @@ module Aws::Backup
413
429
  # @option options [String] :ssl_ca_store
414
430
  # Sets the X509::Store to verify peer certificate.
415
431
  #
432
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
433
+ # Sets a client certificate when creating http connections.
434
+ #
435
+ # @option options [OpenSSL::PKey] :ssl_key
436
+ # Sets a client key when creating http connections.
437
+ #
416
438
  # @option options [Float] :ssl_timeout
417
439
  # Sets the SSL timeout in seconds
418
440
  #
@@ -425,19 +447,17 @@ module Aws::Backup
425
447
 
426
448
  # @!group API Operations
427
449
 
428
- # This action removes the specified legal hold on a recovery point. This
429
- # action can only be performed by a user with sufficient permissions.
450
+ # Removes the specified legal hold on a recovery point. This action can
451
+ # only be performed by a user with sufficient permissions.
430
452
  #
431
453
  # @option params [required, String] :legal_hold_id
432
- # Legal hold ID required to remove the specified legal hold on a
433
- # recovery point.
454
+ # The ID of the legal hold.
434
455
  #
435
456
  # @option params [required, String] :cancel_description
436
- # String describing the reason for removing the legal hold.
457
+ # A string the describes the reason for removing the legal hold.
437
458
  #
438
459
  # @option params [Integer] :retain_record_in_days
439
- # The integer amount in days specifying amount of days after this API
440
- # operation to remove legal hold.
460
+ # The integer amount, in days, after which to remove legal hold.
441
461
  #
442
462
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
443
463
  #
@@ -466,13 +486,11 @@ module Aws::Backup
466
486
  # receive an `AlreadyExistsException` exception.
467
487
  #
468
488
  # @option params [required, Types::BackupPlanInput] :backup_plan
469
- # Specifies the body of a backup plan. Includes a `BackupPlanName` and
470
- # one or more sets of `Rules`.
489
+ # The body of a backup plan. Includes a `BackupPlanName` and one or more
490
+ # sets of `Rules`.
471
491
  #
472
492
  # @option params [Hash<String,String>] :backup_plan_tags
473
- # To help organize your resources, you can assign your own metadata to
474
- # the resources that you create. Each tag is a key-value pair. The
475
- # specified tags are assigned to all backups created with this plan.
493
+ # The tags to assign to the backup plan.
476
494
  #
477
495
  # @option params [String] :creator_request_id
478
496
  # Identifies the request and allows failed requests to be retried
@@ -569,12 +587,10 @@ module Aws::Backup
569
587
  # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json
570
588
  #
571
589
  # @option params [required, String] :backup_plan_id
572
- # Uniquely identifies the backup plan to be associated with the
573
- # selection of resources.
590
+ # The ID of the backup plan.
574
591
  #
575
592
  # @option params [required, Types::BackupSelection] :backup_selection
576
- # Specifies the body of a request to assign a set of resources to a
577
- # backup plan.
593
+ # The body of a request to assign a set of resources to a backup plan.
578
594
  #
579
595
  # @option params [String] :creator_request_id
580
596
  # A unique string that identifies the request and allows failed requests
@@ -667,8 +683,7 @@ module Aws::Backup
667
683
  # They consist of letters, numbers, and hyphens.
668
684
  #
669
685
  # @option params [Hash<String,String>] :backup_vault_tags
670
- # Metadata that you can assign to help organize the resources that you
671
- # create. Each tag is a key-value pair.
686
+ # The tags to assign to the backup vault.
672
687
  #
673
688
  # @option params [String] :encryption_key_arn
674
689
  # The server-side encryption key that is used to protect your backups;
@@ -731,8 +746,8 @@ module Aws::Backup
731
746
  # characters.
732
747
  #
733
748
  # @option params [required, Array<Types::FrameworkControl>] :framework_controls
734
- # A list of the controls that make up the framework. Each control in the
735
- # list has a name, input parameters, and scope.
749
+ # The controls that make up the framework. Each control in the list has
750
+ # a name, input parameters, and scope.
736
751
  #
737
752
  # @option params [String] :idempotency_token
738
753
  # A customer-chosen string that you can use to distinguish between
@@ -744,8 +759,7 @@ module Aws::Backup
744
759
  # not need to pass this option.**
745
760
  #
746
761
  # @option params [Hash<String,String>] :framework_tags
747
- # Metadata that you can assign to help organize the frameworks that you
748
- # create. Each tag is a key-value pair.
762
+ # The tags to assign to the framework.
749
763
  #
750
764
  # @return [Types::CreateFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
751
765
  #
@@ -795,17 +809,17 @@ module Aws::Backup
795
809
  req.send_request(options)
796
810
  end
797
811
 
798
- # This action creates a legal hold on a recovery point (backup). A legal
799
- # hold is a restraint on altering or deleting a backup until an
800
- # authorized user cancels the legal hold. Any actions to delete or
801
- # disassociate a recovery point will fail with an error if one or more
802
- # active legal holds are on the recovery point.
812
+ # Creates a legal hold on a recovery point (backup). A legal hold is a
813
+ # restraint on altering or deleting a backup until an authorized user
814
+ # cancels the legal hold. Any actions to delete or disassociate a
815
+ # recovery point will fail with an error if one or more active legal
816
+ # holds are on the recovery point.
803
817
  #
804
818
  # @option params [required, String] :title
805
- # This is the string title of the legal hold.
819
+ # The title of the legal hold.
806
820
  #
807
821
  # @option params [required, String] :description
808
- # This is the string description of the legal hold.
822
+ # The description of the legal hold.
809
823
  #
810
824
  # @option params [String] :idempotency_token
811
825
  # This is a user-chosen string used to distinguish between otherwise
@@ -813,8 +827,8 @@ module Aws::Backup
813
827
  # idempotency token results in a success message with no action taken.
814
828
  #
815
829
  # @option params [Types::RecoveryPointSelection] :recovery_point_selection
816
- # This specifies criteria to assign a set of resources, such as resource
817
- # types or backup vaults.
830
+ # The criteria to assign a set of resources, such as resource types or
831
+ # backup vaults.
818
832
  #
819
833
  # @option params [Hash<String,String>] :tags
820
834
  # Optional tags to include. A tag is a key-value pair you can use to
@@ -875,8 +889,7 @@ module Aws::Backup
875
889
  req.send_request(options)
876
890
  end
877
891
 
878
- # This request creates a logical container to where backups may be
879
- # copied.
892
+ # Creates a logical container to where backups may be copied.
880
893
  #
881
894
  # This request includes a name, the Region, the maximum number of
882
895
  # retention days, the minimum number of retention days, and optionally
@@ -888,41 +901,28 @@ module Aws::Backup
888
901
  # </note>
889
902
  #
890
903
  # @option params [required, String] :backup_vault_name
891
- # This is the name of the vault that is being created.
904
+ # The name of a logical container where backups are stored. Logically
905
+ # air-gapped backup vaults are identified by names that are unique to
906
+ # the account used to create them and the Region where they are created.
892
907
  #
893
908
  # @option params [Hash<String,String>] :backup_vault_tags
894
- # These are the tags that will be included in the newly-created vault.
909
+ # The tags to assign to the vault.
895
910
  #
896
911
  # @option params [String] :creator_request_id
897
- # This is the ID of the creation request.
912
+ # The ID of the creation request.
898
913
  #
899
914
  # This parameter is optional. If used, this parameter must contain 1 to
900
915
  # 50 alphanumeric or '-\_.' characters.
901
916
  #
902
917
  # @option params [required, Integer] :min_retention_days
903
918
  # This setting specifies the minimum retention period that the vault
904
- # retains its recovery points. If this parameter is not specified, no
905
- # minimum retention period is enforced.
919
+ # retains its recovery points.
906
920
  #
907
- # If specified, any backup or copy job to the vault must have a
908
- # lifecycle policy with a retention period equal to or longer than the
909
- # minimum retention period. If a job retention period is shorter than
910
- # that minimum retention period, then the vault fails the backup or copy
911
- # job, and you should either modify your lifecycle settings or use a
912
- # different vault.
921
+ # The minimum value accepted is 7 days.
913
922
  #
914
923
  # @option params [required, Integer] :max_retention_days
915
- # This is the setting that specifies the maximum retention period that
916
- # the vault retains its recovery points. If this parameter is not
917
- # specified, Backup does not enforce a maximum retention period on the
918
- # recovery points in the vault (allowing indefinite storage).
919
- #
920
- # If specified, any backup or copy job to the vault must have a
921
- # lifecycle policy with a retention period equal to or shorter than the
922
- # maximum retention period. If the job retention period is longer than
923
- # that maximum retention period, then the vault fails the backup or copy
924
- # job, and you should either modify your lifecycle settings or use a
925
- # different vault.
924
+ # The maximum retention period that the vault retains its recovery
925
+ # points.
926
926
  #
927
927
  # @return [Types::CreateLogicallyAirGappedBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
928
928
  #
@@ -992,8 +992,7 @@ module Aws::Backup
992
992
  # report coverage by Amazon Web Services Regions and frameworks.
993
993
  #
994
994
  # @option params [Hash<String,String>] :report_plan_tags
995
- # Metadata that you can assign to help organize the report plans that
996
- # you create. Each tag is a key-value pair.
995
+ # The tags to assign to the report plan.
997
996
  #
998
997
  # @option params [String] :idempotency_token
999
998
  # A customer-chosen string that you can use to distinguish between
@@ -1049,12 +1048,11 @@ module Aws::Backup
1049
1048
  req.send_request(options)
1050
1049
  end
1051
1050
 
1052
- # This is the first of two steps to create a restore testing plan; once
1053
- # this request is successful, finish the procedure with request
1054
- # CreateRestoreTestingSelection.
1051
+ # Creates a restore testing plan.
1055
1052
  #
1056
- # You must include the parameter RestoreTestingPlan. You may optionally
1057
- # include CreatorRequestId and Tags.
1053
+ # The first of two steps to create a restore testing plan. After this
1054
+ # request is successful, finish the procedure using
1055
+ # CreateRestoreTestingSelection.
1058
1056
  #
1059
1057
  # @option params [String] :creator_request_id
1060
1058
  # This is a unique string that identifies the request and allows failed
@@ -1073,10 +1071,7 @@ module Aws::Backup
1073
1071
  # it must consist of only alphanumeric characters and underscores.
1074
1072
  #
1075
1073
  # @option params [Hash<String,String>] :tags
1076
- # Optional tags to include. A tag is a key-value pair you can use to
1077
- # manage, filter, and search for your resources. Allowed characters
1078
- # include UTF-8 letters,numbers, spaces, and the following characters: +
1079
- # - = . \_ : /.
1074
+ # The tags to assign to the restore testing plan.
1080
1075
  #
1081
1076
  # @return [Types::CreateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1082
1077
  #
@@ -1293,7 +1288,6 @@ module Aws::Backup
1293
1288
  # The name of a logical container where backups are stored. Backup
1294
1289
  # vaults are identified by names that are unique to the account used to
1295
1290
  # create them and the Amazon Web Services Region where they are created.
1296
- # They consist of lowercase letters, numbers, and hyphens.
1297
1291
  #
1298
1292
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1299
1293
  #
@@ -1375,8 +1369,7 @@ module Aws::Backup
1375
1369
  # @option params [required, String] :backup_vault_name
1376
1370
  # The name of a logical container where backups are stored. Backup
1377
1371
  # vaults are identified by names that are unique to the account used to
1378
- # create them and the Region where they are created. They consist of
1379
- # lowercase letters, numbers, and hyphens.
1372
+ # create them and the Region where they are created.
1380
1373
  #
1381
1374
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1382
1375
  #
@@ -1444,7 +1437,6 @@ module Aws::Backup
1444
1437
  # The name of a logical container where backups are stored. Backup
1445
1438
  # vaults are identified by names that are unique to the account used to
1446
1439
  # create them and the Amazon Web Services Region where they are created.
1447
- # They consist of lowercase letters, numbers, and hyphens.
1448
1440
  #
1449
1441
  # @option params [required, String] :recovery_point_arn
1450
1442
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -1639,16 +1631,16 @@ module Aws::Backup
1639
1631
  # The name of a logical container where backups are stored. Backup
1640
1632
  # vaults are identified by names that are unique to the account used to
1641
1633
  # create them and the Amazon Web Services Region where they are created.
1642
- # They consist of lowercase letters, numbers, and hyphens.
1643
1634
  #
1644
1635
  # @option params [String] :backup_vault_account_id
1645
- # This is the account ID of the specified backup vault.
1636
+ # The account ID of the specified backup vault.
1646
1637
  #
1647
1638
  # @return [Types::DescribeBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1648
1639
  #
1649
1640
  # * {Types::DescribeBackupVaultOutput#backup_vault_name #backup_vault_name} => String
1650
1641
  # * {Types::DescribeBackupVaultOutput#backup_vault_arn #backup_vault_arn} => String
1651
1642
  # * {Types::DescribeBackupVaultOutput#vault_type #vault_type} => String
1643
+ # * {Types::DescribeBackupVaultOutput#vault_state #vault_state} => String
1652
1644
  # * {Types::DescribeBackupVaultOutput#encryption_key_arn #encryption_key_arn} => String
1653
1645
  # * {Types::DescribeBackupVaultOutput#creation_date #creation_date} => Time
1654
1646
  # * {Types::DescribeBackupVaultOutput#creator_request_id #creator_request_id} => String
@@ -1670,6 +1662,7 @@ module Aws::Backup
1670
1662
  # resp.backup_vault_name #=> String
1671
1663
  # resp.backup_vault_arn #=> String
1672
1664
  # resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
1665
+ # resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
1673
1666
  # resp.encryption_key_arn #=> String
1674
1667
  # resp.creation_date #=> Time
1675
1668
  # resp.creator_request_id #=> String
@@ -1872,7 +1865,6 @@ module Aws::Backup
1872
1865
  # The name of a logical container where backups are stored. Backup
1873
1866
  # vaults are identified by names that are unique to the account used to
1874
1867
  # create them and the Amazon Web Services Region where they are created.
1875
- # They consist of lowercase letters, numbers, and hyphens.
1876
1868
  #
1877
1869
  # @option params [required, String] :recovery_point_arn
1878
1870
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -1880,7 +1872,7 @@ module Aws::Backup
1880
1872
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
1881
1873
  #
1882
1874
  # @option params [String] :backup_vault_account_id
1883
- # This is the account ID of the specified backup vault.
1875
+ # The account ID of the specified backup vault.
1884
1876
  #
1885
1877
  # @return [Types::DescribeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1886
1878
  #
@@ -2178,15 +2170,14 @@ module Aws::Backup
2178
2170
  # (composite) recovery point.
2179
2171
  #
2180
2172
  # @option params [required, String] :backup_vault_name
2181
- # This is the name of a logical container where the child (nested)
2182
- # recovery point is stored. Backup vaults are identified by names that
2183
- # are unique to the account used to create them and the Amazon Web
2184
- # Services Region where they are created. They consist of lowercase
2185
- # letters, numbers, and hyphens.
2173
+ # The name of a logical container where the child (nested) recovery
2174
+ # point is stored. Backup vaults are identified by names that are unique
2175
+ # to the account used to create them and the Amazon Web Services Region
2176
+ # where they are created.
2186
2177
  #
2187
2178
  # @option params [required, String] :recovery_point_arn
2188
- # This is the Amazon Resource Name (ARN) that uniquely identifies the
2189
- # child (nested) recovery point; for example,
2179
+ # The Amazon Resource Name (ARN) that uniquely identifies the child
2180
+ # (nested) recovery point; for example,
2190
2181
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`
2191
2182
  #
2192
2183
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -2485,7 +2476,6 @@ module Aws::Backup
2485
2476
  # The name of a logical container where backups are stored. Backup
2486
2477
  # vaults are identified by names that are unique to the account used to
2487
2478
  # create them and the Amazon Web Services Region where they are created.
2488
- # They consist of lowercase letters, numbers, and hyphens.
2489
2479
  #
2490
2480
  # @return [Types::GetBackupVaultAccessPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2491
2481
  #
@@ -2520,7 +2510,6 @@ module Aws::Backup
2520
2510
  # The name of a logical container where backups are stored. Backup
2521
2511
  # vaults are identified by names that are unique to the account used to
2522
2512
  # create them and the Amazon Web Services Region where they are created.
2523
- # They consist of lowercase letters, numbers, and hyphens.
2524
2513
  #
2525
2514
  # @return [Types::GetBackupVaultNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2526
2515
  #
@@ -2556,8 +2545,7 @@ module Aws::Backup
2556
2545
  # are the body of a legal hold in JSON format, in addition to metadata.
2557
2546
  #
2558
2547
  # @option params [required, String] :legal_hold_id
2559
- # This is the ID required to use `GetLegalHold`. This unique ID is
2560
- # associated with a specific legal hold.
2548
+ # The ID of the legal hold.
2561
2549
  #
2562
2550
  # @return [Types::GetLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2563
2551
  #
@@ -2612,7 +2600,6 @@ module Aws::Backup
2612
2600
  # The name of a logical container where backups are stored. Backup
2613
2601
  # vaults are identified by names that are unique to the account used to
2614
2602
  # create them and the Amazon Web Services Region where they are created.
2615
- # They consist of lowercase letters, numbers, and hyphens.
2616
2603
  #
2617
2604
  # @option params [required, String] :recovery_point_arn
2618
2605
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -2620,7 +2607,7 @@ module Aws::Backup
2620
2607
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
2621
2608
  #
2622
2609
  # @option params [String] :backup_vault_account_id
2623
- # This is the account ID of the specified backup vault.
2610
+ # The account ID of the specified backup vault.
2624
2611
  #
2625
2612
  # @return [Types::GetRecoveryPointRestoreMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2626
2613
  #
@@ -2691,7 +2678,7 @@ module Aws::Backup
2691
2678
  # is an optional parameter.
2692
2679
  #
2693
2680
  # @option params [String] :backup_vault_account_id
2694
- # This is the account ID of the specified backup vault.
2681
+ # The account ID of the specified backup vault.
2695
2682
  #
2696
2683
  # @option params [required, String] :backup_vault_name
2697
2684
  # The name of a logical container where backups are stored. Backup
@@ -2921,18 +2908,16 @@ module Aws::Backup
2921
2908
  # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
2922
2909
  #
2923
2910
  # @option params [String] :aggregation_period
2924
- # This is the period that sets the boundaries for returned results.
2925
- #
2926
- # Acceptable values include
2911
+ # The period for the returned results.
2927
2912
  #
2928
- # * `ONE_DAY` for daily job count for the prior 14 days.
2913
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
2929
2914
  #
2930
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
2915
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
2931
2916
  #
2932
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
2917
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
2933
2918
  #
2934
2919
  # @option params [Integer] :max_results
2935
- # This parameter sets the maximum number of items to be returned.
2920
+ # The maximum number of items to be returned.
2936
2921
  #
2937
2922
  # The value is an integer. Range of accepted values is from 1 to 500.
2938
2923
  #
@@ -3025,8 +3010,7 @@ module Aws::Backup
3025
3010
  # Returns only backup jobs that will be stored in the specified backup
3026
3011
  # vault. Backup vaults are identified by names that are unique to the
3027
3012
  # account used to create them and the Amazon Web Services Region where
3028
- # they are created. They consist of lowercase letters, numbers, and
3029
- # hyphens.
3013
+ # they are created.
3030
3014
  #
3031
3015
  # @option params [Time,DateTime,Date,Integer,String] :by_created_before
3032
3016
  # Returns only backup jobs that were created before the specified date.
@@ -3055,19 +3039,20 @@ module Aws::Backup
3055
3039
  #
3056
3040
  # * `Neptune` for Amazon Neptune
3057
3041
  #
3042
+ # * `RDS` for Amazon Relational Database Service
3043
+ #
3058
3044
  # * `Redshift` for Amazon Redshift
3059
3045
  #
3060
- # * `RDS` for Amazon Relational Database Service
3046
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
3061
3047
  #
3062
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
3048
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
3049
+ # Compute Cloud instances
3063
3050
  #
3064
3051
  # * `Storage Gateway` for Storage Gateway
3065
3052
  #
3066
- # * `S3` for Amazon S3
3067
- #
3068
3053
  # * `Timestream` for Amazon Timestream
3069
3054
  #
3070
- # * `VirtualMachine` for virtual machines
3055
+ # * `VirtualMachine` for VMware virtual machines
3071
3056
  #
3072
3057
  # @option params [String] :by_account_id
3073
3058
  # The account ID to list the jobs from. Returns only backup jobs
@@ -3173,8 +3158,7 @@ module Aws::Backup
3173
3158
  req.send_request(options)
3174
3159
  end
3175
3160
 
3176
- # Returns metadata of your saved backup plan templates, including the
3177
- # template ID, name, and the creation and deletion dates.
3161
+ # Lists the backup plan templates.
3178
3162
  #
3179
3163
  # @option params [String] :next_token
3180
3164
  # The next item following a partial list of returned items. For example,
@@ -3183,7 +3167,7 @@ module Aws::Backup
3183
3167
  # the location pointed to by the next token.
3184
3168
  #
3185
3169
  # @option params [Integer] :max_results
3186
- # The maximum number of items to be returned.
3170
+ # The maximum number of items to return.
3187
3171
  #
3188
3172
  # @return [Types::ListBackupPlanTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3189
3173
  #
@@ -3272,10 +3256,7 @@ module Aws::Backup
3272
3256
  req.send_request(options)
3273
3257
  end
3274
3258
 
3275
- # Returns a list of all active backup plans for an authenticated
3276
- # account. The list contains information such as Amazon Resource Names
3277
- # (ARNs), plan IDs, creation and deletion dates, version IDs, plan
3278
- # names, and creator request IDs.
3259
+ # Lists the active backup plans for the account.
3279
3260
  #
3280
3261
  # @option params [String] :next_token
3281
3262
  # The next item following a partial list of returned items. For example,
@@ -3420,6 +3401,8 @@ module Aws::Backup
3420
3401
  # resp.backup_vault_list #=> Array
3421
3402
  # resp.backup_vault_list[0].backup_vault_name #=> String
3422
3403
  # resp.backup_vault_list[0].backup_vault_arn #=> String
3404
+ # resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
3405
+ # resp.backup_vault_list[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
3423
3406
  # resp.backup_vault_list[0].creation_date #=> Time
3424
3407
  # resp.backup_vault_list[0].encryption_key_arn #=> String
3425
3408
  # resp.backup_vault_list[0].creator_request_id #=> String
@@ -3502,13 +3485,13 @@ module Aws::Backup
3502
3485
  # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
3503
3486
  #
3504
3487
  # @option params [String] :aggregation_period
3505
- # This is the period that sets the boundaries for returned results.
3488
+ # The period for the returned results.
3506
3489
  #
3507
- # * `ONE_DAY` for daily job count for the prior 14 days.
3490
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
3508
3491
  #
3509
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
3492
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
3510
3493
  #
3511
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
3494
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
3512
3495
  #
3513
3496
  # @option params [Integer] :max_results
3514
3497
  # This parameter sets the maximum number of items to be returned.
@@ -3609,24 +3592,25 @@ module Aws::Backup
3609
3592
  #
3610
3593
  # * `Neptune` for Amazon Neptune
3611
3594
  #
3595
+ # * `RDS` for Amazon Relational Database Service
3596
+ #
3612
3597
  # * `Redshift` for Amazon Redshift
3613
3598
  #
3614
- # * `RDS` for Amazon Relational Database Service
3599
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
3615
3600
  #
3616
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
3601
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
3602
+ # Compute Cloud instances
3617
3603
  #
3618
3604
  # * `Storage Gateway` for Storage Gateway
3619
3605
  #
3620
- # * `S3` for Amazon S3
3621
- #
3622
3606
  # * `Timestream` for Amazon Timestream
3623
3607
  #
3624
- # * `VirtualMachine` for virtual machines
3608
+ # * `VirtualMachine` for VMware virtual machines
3625
3609
  #
3626
3610
  # @option params [String] :by_destination_vault_arn
3627
3611
  # An Amazon Resource Name (ARN) that uniquely identifies a source backup
3628
3612
  # vault to copy from; for example,
3629
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
3613
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
3630
3614
  #
3631
3615
  # @option params [String] :by_account_id
3632
3616
  # The account ID to list the jobs from. Returns only copy jobs
@@ -3869,12 +3853,12 @@ module Aws::Backup
3869
3853
  # backup vault.
3870
3854
  #
3871
3855
  # @option params [required, String] :backup_vault_name
3872
- # This is the list of protected resources by backup vault within the
3873
- # vault(s) you specify by name.
3856
+ # The list of protected resources by backup vault within the vault(s)
3857
+ # you specify by name.
3874
3858
  #
3875
3859
  # @option params [String] :backup_vault_account_id
3876
- # This is the list of protected resources by backup vault within the
3877
- # vault(s) you specify by account ID.
3860
+ # The list of protected resources by backup vault within the vault(s)
3861
+ # you specify by account ID.
3878
3862
  #
3879
3863
  # @option params [String] :next_token
3880
3864
  # The next item following a partial list of returned items. For example,
@@ -3928,7 +3912,6 @@ module Aws::Backup
3928
3912
  # The name of a logical container where backups are stored. Backup
3929
3913
  # vaults are identified by names that are unique to the account used to
3930
3914
  # create them and the Amazon Web Services Region where they are created.
3931
- # They consist of lowercase letters, numbers, and hyphens.
3932
3915
  #
3933
3916
  # <note markdown="1"> Backup vault name might not be available when a supported service
3934
3917
  # creates the backup.
@@ -3973,19 +3956,20 @@ module Aws::Backup
3973
3956
  #
3974
3957
  # * `Neptune` for Amazon Neptune
3975
3958
  #
3959
+ # * `RDS` for Amazon Relational Database Service
3960
+ #
3976
3961
  # * `Redshift` for Amazon Redshift
3977
3962
  #
3978
- # * `RDS` for Amazon Relational Database Service
3963
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
3979
3964
  #
3980
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
3965
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
3966
+ # Compute Cloud instances
3981
3967
  #
3982
3968
  # * `Storage Gateway` for Storage Gateway
3983
3969
  #
3984
- # * `S3` for Amazon S3
3985
- #
3986
3970
  # * `Timestream` for Amazon Timestream
3987
3971
  #
3988
- # * `VirtualMachine` for virtual machines
3972
+ # * `VirtualMachine` for VMware virtual machines
3989
3973
  #
3990
3974
  # @option params [String] :by_backup_plan_id
3991
3975
  # Returns only recovery points that match the specified backup plan ID.
@@ -4071,16 +4055,16 @@ module Aws::Backup
4071
4055
  # specified legal hold.
4072
4056
  #
4073
4057
  # @option params [required, String] :legal_hold_id
4074
- # This is the ID of the legal hold.
4058
+ # The ID of the legal hold.
4075
4059
  #
4076
4060
  # @option params [String] :next_token
4077
- # This is the next item following a partial list of returned resources.
4078
- # For example, if a request is made to return `MaxResults` number of
4061
+ # The next item following a partial list of returned resources. For
4062
+ # example, if a request is made to return `MaxResults` number of
4079
4063
  # resources, `NextToken` allows you to return more items in your list
4080
4064
  # starting at the location pointed to by the next token.
4081
4065
  #
4082
4066
  # @option params [Integer] :max_results
4083
- # This is the maximum number of resource list items to be returned.
4067
+ # The maximum number of resource list items to be returned.
4084
4068
  #
4085
4069
  # @return [Types::ListRecoveryPointsByLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4086
4070
  #
@@ -4115,8 +4099,8 @@ module Aws::Backup
4115
4099
  req.send_request(options)
4116
4100
  end
4117
4101
 
4118
- # Returns detailed information about all the recovery points of the type
4119
- # specified by a resource Amazon Resource Name (ARN).
4102
+ # The information about the recovery points of the type specified by a
4103
+ # resource Amazon Resource Name (ARN).
4120
4104
  #
4121
4105
  # <note markdown="1"> For Amazon EFS and Amazon EC2, this action only lists recovery points
4122
4106
  # created by Backup.
@@ -4373,15 +4357,13 @@ module Aws::Backup
4373
4357
  # Relational Database Service (Amazon RDS) database.
4374
4358
  #
4375
4359
  # @option params [String] :aggregation_period
4376
- # This is the period that sets the boundaries for returned results.
4377
- #
4378
- # Acceptable values include
4360
+ # The period for the returned results.
4379
4361
  #
4380
- # * `ONE_DAY` for daily job count for the prior 14 days.
4362
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
4381
4363
  #
4382
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
4364
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
4383
4365
  #
4384
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
4366
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
4385
4367
  #
4386
4368
  # @option params [Integer] :max_results
4387
4369
  # This parameter sets the maximum number of items to be returned.
@@ -4473,19 +4455,20 @@ module Aws::Backup
4473
4455
  #
4474
4456
  # * `Neptune` for Amazon Neptune
4475
4457
  #
4458
+ # * `RDS` for Amazon Relational Database Service
4459
+ #
4476
4460
  # * `Redshift` for Amazon Redshift
4477
4461
  #
4478
- # * `RDS` for Amazon Relational Database Service
4462
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
4479
4463
  #
4480
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
4464
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
4465
+ # Compute Cloud instances
4481
4466
  #
4482
4467
  # * `Storage Gateway` for Storage Gateway
4483
4468
  #
4484
- # * `S3` for Amazon S3
4485
- #
4486
4469
  # * `Timestream` for Amazon Timestream
4487
4470
  #
4488
- # * `VirtualMachine` for virtual machines
4471
+ # * `VirtualMachine` for VMware virtual machines
4489
4472
  #
4490
4473
  # @option params [Time,DateTime,Date,Integer,String] :by_created_before
4491
4474
  # Returns only restore jobs that were created before the specified date.
@@ -4744,17 +4727,8 @@ module Aws::Backup
4744
4727
  req.send_request(options)
4745
4728
  end
4746
4729
 
4747
- # Returns a list of key-value pairs assigned to a target recovery point,
4748
- # backup plan, or backup vault.
4749
- #
4750
- # `ListTags` only works for resource types that support full Backup
4751
- # management of their backups. Those resource types are listed in the
4752
- # "Full Backup management" section of the [ Feature availability by
4753
- # resource][1] table.
4754
- #
4755
- #
4756
- #
4757
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
4730
+ # Returns the tags assigned to the resource, such as a target recovery
4731
+ # point, backup plan, or backup vault.
4758
4732
  #
4759
4733
  # @option params [required, String] :resource_arn
4760
4734
  # An Amazon Resource Name (ARN) that uniquely identifies a resource. The
@@ -4808,7 +4782,6 @@ module Aws::Backup
4808
4782
  # The name of a logical container where backups are stored. Backup
4809
4783
  # vaults are identified by names that are unique to the account used to
4810
4784
  # create them and the Amazon Web Services Region where they are created.
4811
- # They consist of lowercase letters, numbers, and hyphens.
4812
4785
  #
4813
4786
  # @option params [String] :policy
4814
4787
  # The backup vault access policy document in JSON format.
@@ -4843,10 +4816,17 @@ module Aws::Backup
4843
4816
  # environments that are subject to SEC 17a-4, CFTC, and FINRA
4844
4817
  # regulations. For more information about how Backup Vault Lock relates
4845
4818
  # to these regulations, see the [Cohasset Associates Compliance
4846
- # Assessment.](samples/cohassetreport.zip)
4819
+ # Assessment.][1]
4847
4820
  #
4848
4821
  # </note>
4849
4822
  #
4823
+ # For more information, see [Backup Vault Lock][2].
4824
+ #
4825
+ #
4826
+ #
4827
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip
4828
+ # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html
4829
+ #
4850
4830
  # @option params [required, String] :backup_vault_name
4851
4831
  # The Backup Vault Lock configuration that specifies the name of the
4852
4832
  # backup vault it protects.
@@ -4858,8 +4838,10 @@ module Aws::Backup
4858
4838
  # require you to retain certain data for at least seven years (2555
4859
4839
  # days).
4860
4840
  #
4861
- # If this parameter is not specified, Vault Lock will not enforce a
4862
- # minimum retention period.
4841
+ # This parameter is required when a vault lock is created through
4842
+ # CloudFormation; otherwise, this parameter is optional. If this
4843
+ # parameter is not specified, Vault Lock will not enforce a minimum
4844
+ # retention period.
4863
4845
  #
4864
4846
  # If this parameter is specified, any backup or copy job to the vault
4865
4847
  # must have a lifecycle policy with a retention period equal to or
@@ -4940,7 +4922,6 @@ module Aws::Backup
4940
4922
  # The name of a logical container where backups are stored. Backup
4941
4923
  # vaults are identified by names that are unique to the account used to
4942
4924
  # create them and the Amazon Web Services Region where they are created.
4943
- # They consist of lowercase letters, numbers, and hyphens.
4944
4925
  #
4945
4926
  # @option params [required, String] :sns_topic_arn
4946
4927
  # The Amazon Resource Name (ARN) that specifies the topic for a backup
@@ -4965,9 +4946,9 @@ module Aws::Backup
4965
4946
  #
4966
4947
  # * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
4967
4948
  #
4968
- # <note markdown="1"> The list below shows items that are deprecated events (for reference)
4969
- # and are no longer in use. They are no longer supported and will not
4970
- # return statuses or notifications. Refer to the list above for current
4949
+ # <note markdown="1"> The list below includes both supported events and deprecated events
4950
+ # that are no longer in use (for reference). Deprecated events do not
4951
+ # return statuses or notifications. Refer to the list above for the
4971
4952
  # supported events.
4972
4953
  #
4973
4954
  # </note>
@@ -5003,7 +4984,7 @@ module Aws::Backup
5003
4984
  # This is a unique identifier of a restore job within Backup.
5004
4985
  #
5005
4986
  # @option params [required, String] :validation_status
5006
- # This is the status of your restore validation.
4987
+ # The status of your restore validation.
5007
4988
  #
5008
4989
  # @option params [String] :validation_status_message
5009
4990
  # This is an optional message string you can input to describe the
@@ -5034,7 +5015,6 @@ module Aws::Backup
5034
5015
  # The name of a logical container where backups are stored. Backup
5035
5016
  # vaults are identified by names that are unique to the account used to
5036
5017
  # create them and the Amazon Web Services Region where they are created.
5037
- # They consist of lowercase letters, numbers, and hyphens.
5038
5018
  #
5039
5019
  # @option params [required, String] :resource_arn
5040
5020
  # An Amazon Resource Name (ARN) that uniquely identifies a resource. The
@@ -5088,25 +5068,22 @@ module Aws::Backup
5088
5068
  # “transition to cold after days” setting cannot be changed after a
5089
5069
  # backup has been transitioned to cold.
5090
5070
  #
5091
- # Resource types that are able to be transitioned to cold storage are
5092
- # listed in the "Lifecycle to cold storage" section of the [ Feature
5093
- # availability by resource][1] table. Backup ignores this expression for
5094
- # other resource types.
5071
+ # Resource types that can transition to cold storage are listed in the
5072
+ # [Feature availability by resource][1] table. Backup ignores this
5073
+ # expression for other resource types.
5095
5074
  #
5096
5075
  # This parameter has a maximum value of 100 years (36,500 days).
5097
5076
  #
5098
5077
  #
5099
5078
  #
5100
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
5079
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
5101
5080
  #
5102
5081
  # @option params [Hash<String,String>] :recovery_point_tags
5103
- # To help organize your resources, you can assign your own metadata to
5104
- # the resources that you create. Each tag is a key-value pair.
5082
+ # The tags to assign to the resources.
5105
5083
  #
5106
5084
  # @option params [Hash<String,String>] :backup_options
5107
- # Specifies the backup option for a selected resource. This option is
5108
- # only available for Windows Volume Shadow Copy Service (VSS) backup
5109
- # jobs.
5085
+ # The backup option for a selected resource. This option is only
5086
+ # available for Windows Volume Shadow Copy Service (VSS) backup jobs.
5110
5087
  #
5111
5088
  # Valid values: Set to `"WindowsVSS":"enabled"` to enable the
5112
5089
  # `WindowsVSS` backup option and create a Windows VSS backup. Set to
@@ -5171,12 +5148,12 @@ module Aws::Backup
5171
5148
  # The name of a logical source container where backups are stored.
5172
5149
  # Backup vaults are identified by names that are unique to the account
5173
5150
  # used to create them and the Amazon Web Services Region where they are
5174
- # created. They consist of lowercase letters, numbers, and hyphens.
5151
+ # created.
5175
5152
  #
5176
5153
  # @option params [required, String] :destination_backup_vault_arn
5177
5154
  # An Amazon Resource Name (ARN) that uniquely identifies a destination
5178
5155
  # backup vault to copy to; for example,
5179
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
5156
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
5180
5157
  #
5181
5158
  # @option params [required, String] :iam_role_arn
5182
5159
  # Specifies the IAM role ARN used to copy the target recovery point; for
@@ -5189,23 +5166,26 @@ module Aws::Backup
5189
5166
  # with no action taken.
5190
5167
  #
5191
5168
  # @option params [Types::Lifecycle] :lifecycle
5192
- # Contains an array of `Transition` objects specifying how long in days
5193
- # before a recovery point transitions to cold storage or is deleted.
5169
+ # Specifies the time period, in days, before a recovery point
5170
+ # transitions to cold storage or is deleted.
5194
5171
  #
5195
5172
  # Backups transitioned to cold storage must be stored in cold storage
5196
- # for a minimum of 90 days. Therefore, on the console, the retention
5197
- # setting must be 90 days greater than the transition to cold after
5198
- # days” setting. The transition to cold after days setting cannot be
5199
- # changed after a backup has been transitioned to cold.
5173
+ # for a minimum of 90 days. Therefore, on the console, the retention
5174
+ # setting must be 90 days greater than the transition to cold after days
5175
+ # setting. The transition to cold after days setting can't be changed
5176
+ # after a backup has been transitioned to cold.
5177
+ #
5178
+ # Resource types that can transition to cold storage are listed in the
5179
+ # [Feature availability by resource][1] table. Backup ignores this
5180
+ # expression for other resource types.
5200
5181
  #
5201
- # Resource types that are able to be transitioned to cold storage are
5202
- # listed in the "Lifecycle to cold storage" section of the [ Feature
5203
- # availability by resource][1] table. Backup ignores this expression for
5204
- # other resource types.
5182
+ # To remove the existing lifecycle and retention periods and keep your
5183
+ # recovery points indefinitely, specify -1 for
5184
+ # `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
5205
5185
  #
5206
5186
  #
5207
5187
  #
5208
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
5188
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
5209
5189
  #
5210
5190
  # @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5211
5191
  #
@@ -5289,8 +5269,7 @@ module Aws::Backup
5289
5269
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
5290
5270
  #
5291
5271
  # @option params [required, Hash<String,String>] :metadata
5292
- # A set of metadata key-value pairs. Contains information, such as a
5293
- # resource name, required to restore a recovery point.
5272
+ # A set of metadata key-value pairs.
5294
5273
  #
5295
5274
  # You can get configuration metadata about a resource at the time it was
5296
5275
  # backed up by calling `GetRecoveryPointRestoreMetadata`. However,
@@ -5299,33 +5278,56 @@ module Aws::Backup
5299
5278
  # resource. For example, you might need to provide a new resource name
5300
5279
  # if the original already exists.
5301
5280
  #
5302
- # You need to specify specific metadata to restore an Amazon Elastic
5303
- # File System (Amazon EFS) instance:
5281
+ # For more information about the metadata for each resource, see the
5282
+ # following:
5283
+ #
5284
+ # * [Metadata for Amazon Aurora][1]
5304
5285
  #
5305
- # * `file-system-id`: The ID of the Amazon EFS file system that is
5306
- # backed up by Backup. Returned in `GetRecoveryPointRestoreMetadata`.
5286
+ # * [Metadata for Amazon DocumentDB][2]
5307
5287
  #
5308
- # * `Encrypted`: A Boolean value that, if true, specifies that the file
5309
- # system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
5310
- # set to `true`.
5288
+ # * [Metadata for CloudFormation][3]
5311
5289
  #
5312
- # * `KmsKeyId`: Specifies the Amazon Web Services KMS key that is used
5313
- # to encrypt the restored file system. You can specify a key from
5314
- # another Amazon Web Services account provided that key it is properly
5315
- # shared with your account via Amazon Web Services KMS.
5290
+ # * [Metadata for Amazon DynamoDB][4]
5316
5291
  #
5317
- # * `PerformanceMode`: Specifies the throughput mode of the file system.
5292
+ # * [ Metadata for Amazon EBS][5]
5318
5293
  #
5319
- # * `CreationToken`: A user-supplied value that ensures the uniqueness
5320
- # (idempotency) of the request.
5294
+ # * [Metadata for Amazon EC2][6]
5321
5295
  #
5322
- # * `newFileSystem`: A Boolean value that, if true, specifies that the
5323
- # recovery point is restored to a new Amazon EFS file system.
5296
+ # * [Metadata for Amazon EFS][7]
5324
5297
  #
5325
- # * `ItemsToRestore`: An array of one to five strings where each string
5326
- # is a file path. Use `ItemsToRestore` to restore specific files or
5327
- # directories rather than the entire file system. This parameter is
5328
- # optional. For example, `"itemsToRestore":"["/my.test"]"`.
5298
+ # * [Metadata for Amazon FSx][8]
5299
+ #
5300
+ # * [Metadata for Amazon Neptune][9]
5301
+ #
5302
+ # * [Metadata for Amazon RDS][10]
5303
+ #
5304
+ # * [Metadata for Amazon Redshift][11]
5305
+ #
5306
+ # * [Metadata for Storage Gateway][12]
5307
+ #
5308
+ # * [Metadata for Amazon S3][13]
5309
+ #
5310
+ # * [Metadata for Amazon Timestream][14]
5311
+ #
5312
+ # * [Metadata for virtual machines][15]
5313
+ #
5314
+ #
5315
+ #
5316
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli
5317
+ # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli
5318
+ # [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli
5319
+ # [4]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli
5320
+ # [5]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli
5321
+ # [6]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli
5322
+ # [7]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli
5323
+ # [8]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli
5324
+ # [9]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli
5325
+ # [10]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli
5326
+ # [11]: https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api
5327
+ # [12]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli
5328
+ # [13]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli
5329
+ # [14]: https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api
5330
+ # [15]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli
5329
5331
  #
5330
5332
  # @option params [String] :iam_role_arn
5331
5333
  # The Amazon Resource Name (ARN) of the IAM role that Backup uses to
@@ -5342,35 +5344,35 @@ module Aws::Backup
5342
5344
  # Starts a job to restore a recovery point for one of the following
5343
5345
  # resources:
5344
5346
  #
5345
- # * `Aurora` for Amazon Aurora
5347
+ # * `Aurora` - Amazon Aurora
5346
5348
  #
5347
- # * `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
5349
+ # * `DocumentDB` - Amazon DocumentDB
5348
5350
  #
5349
- # * `CloudFormation` for CloudFormation
5351
+ # * `CloudFormation` - CloudFormation
5350
5352
  #
5351
- # * `DynamoDB` for Amazon DynamoDB
5353
+ # * `DynamoDB` - Amazon DynamoDB
5352
5354
  #
5353
- # * `EBS` for Amazon Elastic Block Store
5355
+ # * `EBS` - Amazon Elastic Block Store
5354
5356
  #
5355
- # * `EC2` for Amazon Elastic Compute Cloud
5357
+ # * `EC2` - Amazon Elastic Compute Cloud
5356
5358
  #
5357
- # * `EFS` for Amazon Elastic File System
5359
+ # * `EFS` - Amazon Elastic File System
5358
5360
  #
5359
- # * `FSx` for Amazon FSx
5361
+ # * `FSx` - Amazon FSx
5360
5362
  #
5361
- # * `Neptune` for Amazon Neptune
5363
+ # * `Neptune` - Amazon Neptune
5362
5364
  #
5363
- # * `RDS` for Amazon Relational Database Service
5365
+ # * `RDS` - Amazon Relational Database Service
5364
5366
  #
5365
- # * `Redshift` for Amazon Redshift
5367
+ # * `Redshift` - Amazon Redshift
5366
5368
  #
5367
- # * `Storage Gateway` for Storage Gateway
5369
+ # * `Storage Gateway` - Storage Gateway
5368
5370
  #
5369
- # * `S3` for Amazon S3
5371
+ # * `S3` - Amazon Simple Storage Service
5370
5372
  #
5371
- # * `Timestream` for Amazon Timestream
5373
+ # * `Timestream` - Amazon Timestream
5372
5374
  #
5373
- # * `VirtualMachine` for virtual machines
5375
+ # * `VirtualMachine` - Virtual machines
5374
5376
  #
5375
5377
  # @option params [Boolean] :copy_source_tags_to_restored_resource
5376
5378
  # This is an optional parameter. If this equals `True`, tags included in
@@ -5412,7 +5414,7 @@ module Aws::Backup
5412
5414
  #
5413
5415
  # This action is not supported for the following services: Amazon FSx
5414
5416
  # for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp
5415
- # ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB
5417
+ # ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB
5416
5418
  # compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
5417
5419
  #
5418
5420
  # @option params [required, String] :backup_job_id
@@ -5438,10 +5440,19 @@ module Aws::Backup
5438
5440
  # Assigns a set of key-value pairs to a recovery point, backup plan, or
5439
5441
  # backup vault identified by an Amazon Resource Name (ARN).
5440
5442
  #
5443
+ # This API is supported for recovery points for resource types including
5444
+ # Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon
5445
+ # RDS.
5446
+ #
5441
5447
  # @option params [required, String] :resource_arn
5442
5448
  # An ARN that uniquely identifies a resource. The format of the ARN
5443
5449
  # depends on the type of the tagged resource.
5444
5450
  #
5451
+ # ARNs that do not include `backup` are incompatible with tagging.
5452
+ # `TagResource` and `UntagResource` with invalid ARNs will result in an
5453
+ # error. Acceptable ARN content can include `arn:aws:backup:us-east`.
5454
+ # Invalid ARN content may look like `arn:aws:ec2:us-east`.
5455
+ #
5445
5456
  # @option params [required, Hash<String,String>] :tags
5446
5457
  # Key-value pairs that are used to help organize your resources. You can
5447
5458
  # assign your own metadata to the resources you create. For clarity,
@@ -5471,13 +5482,21 @@ module Aws::Backup
5471
5482
  # Removes a set of key-value pairs from a recovery point, backup plan,
5472
5483
  # or backup vault identified by an Amazon Resource Name (ARN)
5473
5484
  #
5485
+ # This API is not supported for recovery points for resource types
5486
+ # including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune,
5487
+ # and Amazon RDS.
5488
+ #
5474
5489
  # @option params [required, String] :resource_arn
5475
5490
  # An ARN that uniquely identifies a resource. The format of the ARN
5476
5491
  # depends on the type of the tagged resource.
5477
5492
  #
5493
+ # ARNs that do not include `backup` are incompatible with tagging.
5494
+ # `TagResource` and `UntagResource` with invalid ARNs will result in an
5495
+ # error. Acceptable ARN content can include `arn:aws:backup:us-east`.
5496
+ # Invalid ARN content may look like `arn:aws:ec2:us-east`.
5497
+ #
5478
5498
  # @option params [required, Array<String>] :tag_key_list
5479
- # A list of keys to identify which key-value tags to remove from a
5480
- # resource.
5499
+ # The keys to identify which key-value tags to remove from a resource.
5481
5500
  #
5482
5501
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5483
5502
  #
@@ -5497,16 +5516,15 @@ module Aws::Backup
5497
5516
  req.send_request(options)
5498
5517
  end
5499
5518
 
5500
- # Updates an existing backup plan identified by its `backupPlanId` with
5501
- # the input document in JSON format. The new version is uniquely
5502
- # identified by a `VersionId`.
5519
+ # Updates the specified backup plan. The new version is uniquely
5520
+ # identified by its ID.
5503
5521
  #
5504
5522
  # @option params [required, String] :backup_plan_id
5505
- # Uniquely identifies a backup plan.
5523
+ # The ID of the backup plan.
5506
5524
  #
5507
5525
  # @option params [required, Types::BackupPlanInput] :backup_plan
5508
- # Specifies the body of a backup plan. Includes a `BackupPlanName` and
5509
- # one or more sets of `Rules`.
5526
+ # The body of a backup plan. Includes a `BackupPlanName` and one or more
5527
+ # sets of `Rules`.
5510
5528
  #
5511
5529
  # @return [Types::UpdateBackupPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5512
5530
  #
@@ -5582,8 +5600,7 @@ module Aws::Backup
5582
5600
  req.send_request(options)
5583
5601
  end
5584
5602
 
5585
- # Updates an existing framework identified by its `FrameworkName` with
5586
- # the input document in JSON format.
5603
+ # Updates the specified framework.
5587
5604
  #
5588
5605
  # @option params [required, String] :framework_name
5589
5606
  # The unique name of a framework. This name is between 1 and 256
@@ -5595,8 +5612,8 @@ module Aws::Backup
5595
5612
  # characters.
5596
5613
  #
5597
5614
  # @option params [Array<Types::FrameworkControl>] :framework_controls
5598
- # A list of the controls that make up the framework. Each control in the
5599
- # list has a name, input parameters, and scope.
5615
+ # The controls that make up the framework. Each control in the list has
5616
+ # a name, input parameters, and scope.
5600
5617
  #
5601
5618
  # @option params [String] :idempotency_token
5602
5619
  # A customer-chosen string that you can use to distinguish between
@@ -5689,28 +5706,31 @@ module Aws::Backup
5689
5706
  # cold storage and when it expires. Backup transitions and expires
5690
5707
  # backups automatically according to the lifecycle that you define.
5691
5708
  #
5709
+ # Resource types that can transition to cold storage are listed in the
5710
+ # [Feature availability by resource][1] table. Backup ignores this
5711
+ # expression for other resource types.
5712
+ #
5692
5713
  # Backups transitioned to cold storage must be stored in cold storage
5693
5714
  # for a minimum of 90 days. Therefore, the “retention” setting must be
5694
5715
  # 90 days greater than the “transition to cold after days” setting. The
5695
5716
  # “transition to cold after days” setting cannot be changed after a
5696
5717
  # backup has been transitioned to cold.
5697
5718
  #
5698
- # Resource types that are able to be transitioned to cold storage are
5699
- # listed in the "Lifecycle to cold storage" section of the [ Feature
5700
- # availability by resource][1] table. Backup ignores this expression for
5701
- # other resource types.
5719
+ # If your lifecycle currently uses the parameters `DeleteAfterDays` and
5720
+ # `MoveToColdStorageAfterDays`, include these parameters and their
5721
+ # values when you call this operation. Not including them may result in
5722
+ # your plan updating with null values.
5702
5723
  #
5703
5724
  # This operation does not support continuous backups.
5704
5725
  #
5705
5726
  #
5706
5727
  #
5707
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
5728
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
5708
5729
  #
5709
5730
  # @option params [required, String] :backup_vault_name
5710
5731
  # The name of a logical container where backups are stored. Backup
5711
5732
  # vaults are identified by names that are unique to the account used to
5712
5733
  # create them and the Amazon Web Services Region where they are created.
5713
- # They consist of lowercase letters, numbers, and hyphens.
5714
5734
  #
5715
5735
  # @option params [required, String] :recovery_point_arn
5716
5736
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -5817,8 +5837,7 @@ module Aws::Backup
5817
5837
  req.send_request(options)
5818
5838
  end
5819
5839
 
5820
- # Updates an existing report plan identified by its `ReportPlanName`
5821
- # with the input document in JSON format.
5840
+ # Updates the specified report plan.
5822
5841
  #
5823
5842
  # @option params [required, String] :report_plan_name
5824
5843
  # The unique name of the report plan. This name is between 1 and 256
@@ -5830,13 +5849,12 @@ module Aws::Backup
5830
5849
  # characters.
5831
5850
  #
5832
5851
  # @option params [Types::ReportDeliveryChannel] :report_delivery_channel
5833
- # A structure that contains information about where to deliver your
5834
- # reports, specifically your Amazon S3 bucket name, S3 key prefix, and
5835
- # the formats of your reports.
5852
+ # The information about where to deliver your reports, specifically your
5853
+ # Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
5836
5854
  #
5837
5855
  # @option params [Types::ReportSetting] :report_setting
5838
- # Identifies the report template for the report. Reports are built using
5839
- # a report template. The report templates are:
5856
+ # The report template for the report. Reports are built using a report
5857
+ # template. The report templates are:
5840
5858
  #
5841
5859
  # `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
5842
5860
  # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
@@ -5915,7 +5933,7 @@ module Aws::Backup
5915
5933
  # Specifies the body of a restore testing plan.
5916
5934
  #
5917
5935
  # @option params [required, String] :restore_testing_plan_name
5918
- # This is the restore testing plan name you wish to update.
5936
+ # The name of the restore testing plan name.
5919
5937
  #
5920
5938
  # @return [Types::UpdateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5921
5939
  #
@@ -5958,13 +5976,13 @@ module Aws::Backup
5958
5976
  req.send_request(options)
5959
5977
  end
5960
5978
 
5979
+ # Updates the specified restore testing selection.
5980
+ #
5961
5981
  # Most elements except the `RestoreTestingSelectionName` can be updated
5962
5982
  # with this request.
5963
5983
  #
5964
- # `RestoreTestingSelection` can use either protected resource ARNs or
5965
- # conditions, but not both. That is, if your selection has
5966
- # `ProtectedResourceArns`, requesting an update with the parameter
5967
- # `ProtectedResourceConditions` will be unsuccessful.
5984
+ # You can use either protected resource ARNs or conditions, but not
5985
+ # both.
5968
5986
  #
5969
5987
  # @option params [required, String] :restore_testing_plan_name
5970
5988
  # The restore testing plan name is required to update the indicated
@@ -5977,8 +5995,8 @@ module Aws::Backup
5977
5995
  # `ProtectedResourceConditions` will be unsuccessful.
5978
5996
  #
5979
5997
  # @option params [required, String] :restore_testing_selection_name
5980
- # This is the required restore testing selection name of the restore
5981
- # testing selection you wish to update.
5998
+ # The required restore testing selection name of the restore testing
5999
+ # selection you wish to update.
5982
6000
  #
5983
6001
  # @return [Types::UpdateRestoreTestingSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5984
6002
  #
@@ -6040,14 +6058,19 @@ module Aws::Backup
6040
6058
  # @api private
6041
6059
  def build_request(operation_name, params = {})
6042
6060
  handlers = @handlers.for(operation_name)
6061
+ tracer = config.telemetry_provider.tracer_provider.tracer(
6062
+ Aws::Telemetry.module_to_tracer_name('Aws::Backup')
6063
+ )
6043
6064
  context = Seahorse::Client::RequestContext.new(
6044
6065
  operation_name: operation_name,
6045
6066
  operation: config.api.operation(operation_name),
6046
6067
  client: self,
6047
6068
  params: params,
6048
- config: config)
6069
+ config: config,
6070
+ tracer: tracer
6071
+ )
6049
6072
  context[:gem_name] = 'aws-sdk-backup'
6050
- context[:gem_version] = '1.73.0'
6073
+ context[:gem_version] = '1.80.0'
6051
6074
  Seahorse::Client::Request.new(handlers, context)
6052
6075
  end
6053
6076