aws-sdk-backup 1.73.0 → 1.75.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,6 +32,7 @@ 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
 
@@ -83,6 +84,7 @@ module Aws::Backup
83
84
  add_plugin(Aws::Plugins::RequestCompression)
84
85
  add_plugin(Aws::Plugins::DefaultsMode)
85
86
  add_plugin(Aws::Plugins::RecursionDetection)
87
+ add_plugin(Aws::Plugins::Telemetry)
86
88
  add_plugin(Aws::Plugins::Sign)
87
89
  add_plugin(Aws::Plugins::Protocols::RestJson)
88
90
  add_plugin(Aws::Backup::Plugins::Endpoints)
@@ -330,6 +332,16 @@ module Aws::Backup
330
332
  # ** Please note ** When response stubbing is enabled, no HTTP
331
333
  # requests are made, and retries are disabled.
332
334
  #
335
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
336
+ # Allows you to provide a telemetry provider, which is used to
337
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
338
+ # will not record or emit any telemetry data. The SDK supports the
339
+ # following telemetry providers:
340
+ #
341
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
342
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
343
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
344
+ #
333
345
  # @option options [Aws::TokenProvider] :token_provider
334
346
  # A Bearer Token Provider. This can be an instance of any one of the
335
347
  # following classes:
@@ -425,19 +437,17 @@ module Aws::Backup
425
437
 
426
438
  # @!group API Operations
427
439
 
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.
440
+ # Removes the specified legal hold on a recovery point. This action can
441
+ # only be performed by a user with sufficient permissions.
430
442
  #
431
443
  # @option params [required, String] :legal_hold_id
432
- # Legal hold ID required to remove the specified legal hold on a
433
- # recovery point.
444
+ # The ID of the legal hold.
434
445
  #
435
446
  # @option params [required, String] :cancel_description
436
- # String describing the reason for removing the legal hold.
447
+ # A string the describes the reason for removing the legal hold.
437
448
  #
438
449
  # @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.
450
+ # The integer amount, in days, after which to remove legal hold.
441
451
  #
442
452
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
443
453
  #
@@ -466,13 +476,11 @@ module Aws::Backup
466
476
  # receive an `AlreadyExistsException` exception.
467
477
  #
468
478
  # @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`.
479
+ # The body of a backup plan. Includes a `BackupPlanName` and one or more
480
+ # sets of `Rules`.
471
481
  #
472
482
  # @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.
483
+ # The tags to assign to the backup plan.
476
484
  #
477
485
  # @option params [String] :creator_request_id
478
486
  # Identifies the request and allows failed requests to be retried
@@ -569,12 +577,10 @@ module Aws::Backup
569
577
  # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json
570
578
  #
571
579
  # @option params [required, String] :backup_plan_id
572
- # Uniquely identifies the backup plan to be associated with the
573
- # selection of resources.
580
+ # The ID of the backup plan.
574
581
  #
575
582
  # @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.
583
+ # The body of a request to assign a set of resources to a backup plan.
578
584
  #
579
585
  # @option params [String] :creator_request_id
580
586
  # A unique string that identifies the request and allows failed requests
@@ -667,8 +673,7 @@ module Aws::Backup
667
673
  # They consist of letters, numbers, and hyphens.
668
674
  #
669
675
  # @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.
676
+ # The tags to assign to the backup vault.
672
677
  #
673
678
  # @option params [String] :encryption_key_arn
674
679
  # The server-side encryption key that is used to protect your backups;
@@ -731,8 +736,8 @@ module Aws::Backup
731
736
  # characters.
732
737
  #
733
738
  # @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.
739
+ # The controls that make up the framework. Each control in the list has
740
+ # a name, input parameters, and scope.
736
741
  #
737
742
  # @option params [String] :idempotency_token
738
743
  # A customer-chosen string that you can use to distinguish between
@@ -744,8 +749,7 @@ module Aws::Backup
744
749
  # not need to pass this option.**
745
750
  #
746
751
  # @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.
752
+ # The tags to assign to the framework.
749
753
  #
750
754
  # @return [Types::CreateFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
751
755
  #
@@ -795,17 +799,17 @@ module Aws::Backup
795
799
  req.send_request(options)
796
800
  end
797
801
 
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.
802
+ # Creates a legal hold on a recovery point (backup). A legal hold is a
803
+ # restraint on altering or deleting a backup until an authorized user
804
+ # cancels the legal hold. Any actions to delete or disassociate a
805
+ # recovery point will fail with an error if one or more active legal
806
+ # holds are on the recovery point.
803
807
  #
804
808
  # @option params [required, String] :title
805
- # This is the string title of the legal hold.
809
+ # The title of the legal hold.
806
810
  #
807
811
  # @option params [required, String] :description
808
- # This is the string description of the legal hold.
812
+ # The description of the legal hold.
809
813
  #
810
814
  # @option params [String] :idempotency_token
811
815
  # This is a user-chosen string used to distinguish between otherwise
@@ -813,8 +817,8 @@ module Aws::Backup
813
817
  # idempotency token results in a success message with no action taken.
814
818
  #
815
819
  # @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.
820
+ # The criteria to assign a set of resources, such as resource types or
821
+ # backup vaults.
818
822
  #
819
823
  # @option params [Hash<String,String>] :tags
820
824
  # Optional tags to include. A tag is a key-value pair you can use to
@@ -875,8 +879,7 @@ module Aws::Backup
875
879
  req.send_request(options)
876
880
  end
877
881
 
878
- # This request creates a logical container to where backups may be
879
- # copied.
882
+ # Creates a logical container to where backups may be copied.
880
883
  #
881
884
  # This request includes a name, the Region, the maximum number of
882
885
  # retention days, the minimum number of retention days, and optionally
@@ -888,41 +891,28 @@ module Aws::Backup
888
891
  # </note>
889
892
  #
890
893
  # @option params [required, String] :backup_vault_name
891
- # This is the name of the vault that is being created.
894
+ # The name of a logical container where backups are stored. Logically
895
+ # air-gapped backup vaults are identified by names that are unique to
896
+ # the account used to create them and the Region where they are created.
892
897
  #
893
898
  # @option params [Hash<String,String>] :backup_vault_tags
894
- # These are the tags that will be included in the newly-created vault.
899
+ # The tags to assign to the vault.
895
900
  #
896
901
  # @option params [String] :creator_request_id
897
- # This is the ID of the creation request.
902
+ # The ID of the creation request.
898
903
  #
899
904
  # This parameter is optional. If used, this parameter must contain 1 to
900
905
  # 50 alphanumeric or '-\_.' characters.
901
906
  #
902
907
  # @option params [required, Integer] :min_retention_days
903
908
  # 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.
909
+ # retains its recovery points.
906
910
  #
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.
911
+ # The minimum value accepted is 7 days.
913
912
  #
914
913
  # @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.
914
+ # The maximum retention period that the vault retains its recovery
915
+ # points.
926
916
  #
927
917
  # @return [Types::CreateLogicallyAirGappedBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
928
918
  #
@@ -992,8 +982,7 @@ module Aws::Backup
992
982
  # report coverage by Amazon Web Services Regions and frameworks.
993
983
  #
994
984
  # @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.
985
+ # The tags to assign to the report plan.
997
986
  #
998
987
  # @option params [String] :idempotency_token
999
988
  # A customer-chosen string that you can use to distinguish between
@@ -1049,12 +1038,11 @@ module Aws::Backup
1049
1038
  req.send_request(options)
1050
1039
  end
1051
1040
 
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.
1041
+ # Creates a restore testing plan.
1055
1042
  #
1056
- # You must include the parameter RestoreTestingPlan. You may optionally
1057
- # include CreatorRequestId and Tags.
1043
+ # The first of two steps to create a restore testing plan. After this
1044
+ # request is successful, finish the procedure using
1045
+ # CreateRestoreTestingSelection.
1058
1046
  #
1059
1047
  # @option params [String] :creator_request_id
1060
1048
  # This is a unique string that identifies the request and allows failed
@@ -1073,10 +1061,7 @@ module Aws::Backup
1073
1061
  # it must consist of only alphanumeric characters and underscores.
1074
1062
  #
1075
1063
  # @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
- # - = . \_ : /.
1064
+ # The tags to assign to the restore testing plan.
1080
1065
  #
1081
1066
  # @return [Types::CreateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1082
1067
  #
@@ -1293,7 +1278,6 @@ module Aws::Backup
1293
1278
  # The name of a logical container where backups are stored. Backup
1294
1279
  # vaults are identified by names that are unique to the account used to
1295
1280
  # create them and the Amazon Web Services Region where they are created.
1296
- # They consist of lowercase letters, numbers, and hyphens.
1297
1281
  #
1298
1282
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1299
1283
  #
@@ -1375,8 +1359,7 @@ module Aws::Backup
1375
1359
  # @option params [required, String] :backup_vault_name
1376
1360
  # The name of a logical container where backups are stored. Backup
1377
1361
  # 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.
1362
+ # create them and the Region where they are created.
1380
1363
  #
1381
1364
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1382
1365
  #
@@ -1444,7 +1427,6 @@ module Aws::Backup
1444
1427
  # The name of a logical container where backups are stored. Backup
1445
1428
  # vaults are identified by names that are unique to the account used to
1446
1429
  # create them and the Amazon Web Services Region where they are created.
1447
- # They consist of lowercase letters, numbers, and hyphens.
1448
1430
  #
1449
1431
  # @option params [required, String] :recovery_point_arn
1450
1432
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -1639,16 +1621,16 @@ module Aws::Backup
1639
1621
  # The name of a logical container where backups are stored. Backup
1640
1622
  # vaults are identified by names that are unique to the account used to
1641
1623
  # create them and the Amazon Web Services Region where they are created.
1642
- # They consist of lowercase letters, numbers, and hyphens.
1643
1624
  #
1644
1625
  # @option params [String] :backup_vault_account_id
1645
- # This is the account ID of the specified backup vault.
1626
+ # The account ID of the specified backup vault.
1646
1627
  #
1647
1628
  # @return [Types::DescribeBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1648
1629
  #
1649
1630
  # * {Types::DescribeBackupVaultOutput#backup_vault_name #backup_vault_name} => String
1650
1631
  # * {Types::DescribeBackupVaultOutput#backup_vault_arn #backup_vault_arn} => String
1651
1632
  # * {Types::DescribeBackupVaultOutput#vault_type #vault_type} => String
1633
+ # * {Types::DescribeBackupVaultOutput#vault_state #vault_state} => String
1652
1634
  # * {Types::DescribeBackupVaultOutput#encryption_key_arn #encryption_key_arn} => String
1653
1635
  # * {Types::DescribeBackupVaultOutput#creation_date #creation_date} => Time
1654
1636
  # * {Types::DescribeBackupVaultOutput#creator_request_id #creator_request_id} => String
@@ -1670,6 +1652,7 @@ module Aws::Backup
1670
1652
  # resp.backup_vault_name #=> String
1671
1653
  # resp.backup_vault_arn #=> String
1672
1654
  # resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
1655
+ # resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
1673
1656
  # resp.encryption_key_arn #=> String
1674
1657
  # resp.creation_date #=> Time
1675
1658
  # resp.creator_request_id #=> String
@@ -1872,7 +1855,6 @@ module Aws::Backup
1872
1855
  # The name of a logical container where backups are stored. Backup
1873
1856
  # vaults are identified by names that are unique to the account used to
1874
1857
  # create them and the Amazon Web Services Region where they are created.
1875
- # They consist of lowercase letters, numbers, and hyphens.
1876
1858
  #
1877
1859
  # @option params [required, String] :recovery_point_arn
1878
1860
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -1880,7 +1862,7 @@ module Aws::Backup
1880
1862
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
1881
1863
  #
1882
1864
  # @option params [String] :backup_vault_account_id
1883
- # This is the account ID of the specified backup vault.
1865
+ # The account ID of the specified backup vault.
1884
1866
  #
1885
1867
  # @return [Types::DescribeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1886
1868
  #
@@ -2178,15 +2160,14 @@ module Aws::Backup
2178
2160
  # (composite) recovery point.
2179
2161
  #
2180
2162
  # @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.
2163
+ # The name of a logical container where the child (nested) recovery
2164
+ # point is stored. Backup vaults are identified by names that are unique
2165
+ # to the account used to create them and the Amazon Web Services Region
2166
+ # where they are created.
2186
2167
  #
2187
2168
  # @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,
2169
+ # The Amazon Resource Name (ARN) that uniquely identifies the child
2170
+ # (nested) recovery point; for example,
2190
2171
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`
2191
2172
  #
2192
2173
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -2485,7 +2466,6 @@ module Aws::Backup
2485
2466
  # The name of a logical container where backups are stored. Backup
2486
2467
  # vaults are identified by names that are unique to the account used to
2487
2468
  # create them and the Amazon Web Services Region where they are created.
2488
- # They consist of lowercase letters, numbers, and hyphens.
2489
2469
  #
2490
2470
  # @return [Types::GetBackupVaultAccessPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2491
2471
  #
@@ -2520,7 +2500,6 @@ module Aws::Backup
2520
2500
  # The name of a logical container where backups are stored. Backup
2521
2501
  # vaults are identified by names that are unique to the account used to
2522
2502
  # create them and the Amazon Web Services Region where they are created.
2523
- # They consist of lowercase letters, numbers, and hyphens.
2524
2503
  #
2525
2504
  # @return [Types::GetBackupVaultNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2526
2505
  #
@@ -2556,8 +2535,7 @@ module Aws::Backup
2556
2535
  # are the body of a legal hold in JSON format, in addition to metadata.
2557
2536
  #
2558
2537
  # @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.
2538
+ # The ID of the legal hold.
2561
2539
  #
2562
2540
  # @return [Types::GetLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2563
2541
  #
@@ -2612,7 +2590,6 @@ module Aws::Backup
2612
2590
  # The name of a logical container where backups are stored. Backup
2613
2591
  # vaults are identified by names that are unique to the account used to
2614
2592
  # create them and the Amazon Web Services Region where they are created.
2615
- # They consist of lowercase letters, numbers, and hyphens.
2616
2593
  #
2617
2594
  # @option params [required, String] :recovery_point_arn
2618
2595
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -2620,7 +2597,7 @@ module Aws::Backup
2620
2597
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
2621
2598
  #
2622
2599
  # @option params [String] :backup_vault_account_id
2623
- # This is the account ID of the specified backup vault.
2600
+ # The account ID of the specified backup vault.
2624
2601
  #
2625
2602
  # @return [Types::GetRecoveryPointRestoreMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2626
2603
  #
@@ -2691,7 +2668,7 @@ module Aws::Backup
2691
2668
  # is an optional parameter.
2692
2669
  #
2693
2670
  # @option params [String] :backup_vault_account_id
2694
- # This is the account ID of the specified backup vault.
2671
+ # The account ID of the specified backup vault.
2695
2672
  #
2696
2673
  # @option params [required, String] :backup_vault_name
2697
2674
  # The name of a logical container where backups are stored. Backup
@@ -2921,18 +2898,16 @@ module Aws::Backup
2921
2898
  # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
2922
2899
  #
2923
2900
  # @option params [String] :aggregation_period
2924
- # This is the period that sets the boundaries for returned results.
2925
- #
2926
- # Acceptable values include
2901
+ # The period for the returned results.
2927
2902
  #
2928
- # * `ONE_DAY` for daily job count for the prior 14 days.
2903
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
2929
2904
  #
2930
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
2905
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
2931
2906
  #
2932
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
2907
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
2933
2908
  #
2934
2909
  # @option params [Integer] :max_results
2935
- # This parameter sets the maximum number of items to be returned.
2910
+ # The maximum number of items to be returned.
2936
2911
  #
2937
2912
  # The value is an integer. Range of accepted values is from 1 to 500.
2938
2913
  #
@@ -3025,8 +3000,7 @@ module Aws::Backup
3025
3000
  # Returns only backup jobs that will be stored in the specified backup
3026
3001
  # vault. Backup vaults are identified by names that are unique to the
3027
3002
  # 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.
3003
+ # they are created.
3030
3004
  #
3031
3005
  # @option params [Time,DateTime,Date,Integer,String] :by_created_before
3032
3006
  # Returns only backup jobs that were created before the specified date.
@@ -3055,19 +3029,20 @@ module Aws::Backup
3055
3029
  #
3056
3030
  # * `Neptune` for Amazon Neptune
3057
3031
  #
3032
+ # * `RDS` for Amazon Relational Database Service
3033
+ #
3058
3034
  # * `Redshift` for Amazon Redshift
3059
3035
  #
3060
- # * `RDS` for Amazon Relational Database Service
3036
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
3061
3037
  #
3062
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
3038
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
3039
+ # Compute Cloud instances
3063
3040
  #
3064
3041
  # * `Storage Gateway` for Storage Gateway
3065
3042
  #
3066
- # * `S3` for Amazon S3
3067
- #
3068
3043
  # * `Timestream` for Amazon Timestream
3069
3044
  #
3070
- # * `VirtualMachine` for virtual machines
3045
+ # * `VirtualMachine` for VMware virtual machines
3071
3046
  #
3072
3047
  # @option params [String] :by_account_id
3073
3048
  # The account ID to list the jobs from. Returns only backup jobs
@@ -3173,8 +3148,7 @@ module Aws::Backup
3173
3148
  req.send_request(options)
3174
3149
  end
3175
3150
 
3176
- # Returns metadata of your saved backup plan templates, including the
3177
- # template ID, name, and the creation and deletion dates.
3151
+ # Lists the backup plan templates.
3178
3152
  #
3179
3153
  # @option params [String] :next_token
3180
3154
  # The next item following a partial list of returned items. For example,
@@ -3183,7 +3157,7 @@ module Aws::Backup
3183
3157
  # the location pointed to by the next token.
3184
3158
  #
3185
3159
  # @option params [Integer] :max_results
3186
- # The maximum number of items to be returned.
3160
+ # The maximum number of items to return.
3187
3161
  #
3188
3162
  # @return [Types::ListBackupPlanTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3189
3163
  #
@@ -3272,10 +3246,7 @@ module Aws::Backup
3272
3246
  req.send_request(options)
3273
3247
  end
3274
3248
 
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.
3249
+ # Lists the active backup plans for the account.
3279
3250
  #
3280
3251
  # @option params [String] :next_token
3281
3252
  # The next item following a partial list of returned items. For example,
@@ -3420,6 +3391,8 @@ module Aws::Backup
3420
3391
  # resp.backup_vault_list #=> Array
3421
3392
  # resp.backup_vault_list[0].backup_vault_name #=> String
3422
3393
  # resp.backup_vault_list[0].backup_vault_arn #=> String
3394
+ # resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
3395
+ # resp.backup_vault_list[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
3423
3396
  # resp.backup_vault_list[0].creation_date #=> Time
3424
3397
  # resp.backup_vault_list[0].encryption_key_arn #=> String
3425
3398
  # resp.backup_vault_list[0].creator_request_id #=> String
@@ -3502,13 +3475,13 @@ module Aws::Backup
3502
3475
  # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
3503
3476
  #
3504
3477
  # @option params [String] :aggregation_period
3505
- # This is the period that sets the boundaries for returned results.
3478
+ # The period for the returned results.
3506
3479
  #
3507
- # * `ONE_DAY` for daily job count for the prior 14 days.
3480
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
3508
3481
  #
3509
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
3482
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
3510
3483
  #
3511
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
3484
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
3512
3485
  #
3513
3486
  # @option params [Integer] :max_results
3514
3487
  # This parameter sets the maximum number of items to be returned.
@@ -3609,24 +3582,25 @@ module Aws::Backup
3609
3582
  #
3610
3583
  # * `Neptune` for Amazon Neptune
3611
3584
  #
3585
+ # * `RDS` for Amazon Relational Database Service
3586
+ #
3612
3587
  # * `Redshift` for Amazon Redshift
3613
3588
  #
3614
- # * `RDS` for Amazon Relational Database Service
3589
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
3615
3590
  #
3616
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
3591
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
3592
+ # Compute Cloud instances
3617
3593
  #
3618
3594
  # * `Storage Gateway` for Storage Gateway
3619
3595
  #
3620
- # * `S3` for Amazon S3
3621
- #
3622
3596
  # * `Timestream` for Amazon Timestream
3623
3597
  #
3624
- # * `VirtualMachine` for virtual machines
3598
+ # * `VirtualMachine` for VMware virtual machines
3625
3599
  #
3626
3600
  # @option params [String] :by_destination_vault_arn
3627
3601
  # An Amazon Resource Name (ARN) that uniquely identifies a source backup
3628
3602
  # vault to copy from; for example,
3629
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
3603
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
3630
3604
  #
3631
3605
  # @option params [String] :by_account_id
3632
3606
  # The account ID to list the jobs from. Returns only copy jobs
@@ -3869,12 +3843,12 @@ module Aws::Backup
3869
3843
  # backup vault.
3870
3844
  #
3871
3845
  # @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.
3846
+ # The list of protected resources by backup vault within the vault(s)
3847
+ # you specify by name.
3874
3848
  #
3875
3849
  # @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.
3850
+ # The list of protected resources by backup vault within the vault(s)
3851
+ # you specify by account ID.
3878
3852
  #
3879
3853
  # @option params [String] :next_token
3880
3854
  # The next item following a partial list of returned items. For example,
@@ -3928,7 +3902,6 @@ module Aws::Backup
3928
3902
  # The name of a logical container where backups are stored. Backup
3929
3903
  # vaults are identified by names that are unique to the account used to
3930
3904
  # create them and the Amazon Web Services Region where they are created.
3931
- # They consist of lowercase letters, numbers, and hyphens.
3932
3905
  #
3933
3906
  # <note markdown="1"> Backup vault name might not be available when a supported service
3934
3907
  # creates the backup.
@@ -3973,19 +3946,20 @@ module Aws::Backup
3973
3946
  #
3974
3947
  # * `Neptune` for Amazon Neptune
3975
3948
  #
3949
+ # * `RDS` for Amazon Relational Database Service
3950
+ #
3976
3951
  # * `Redshift` for Amazon Redshift
3977
3952
  #
3978
- # * `RDS` for Amazon Relational Database Service
3953
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
3979
3954
  #
3980
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
3955
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
3956
+ # Compute Cloud instances
3981
3957
  #
3982
3958
  # * `Storage Gateway` for Storage Gateway
3983
3959
  #
3984
- # * `S3` for Amazon S3
3985
- #
3986
3960
  # * `Timestream` for Amazon Timestream
3987
3961
  #
3988
- # * `VirtualMachine` for virtual machines
3962
+ # * `VirtualMachine` for VMware virtual machines
3989
3963
  #
3990
3964
  # @option params [String] :by_backup_plan_id
3991
3965
  # Returns only recovery points that match the specified backup plan ID.
@@ -4071,16 +4045,16 @@ module Aws::Backup
4071
4045
  # specified legal hold.
4072
4046
  #
4073
4047
  # @option params [required, String] :legal_hold_id
4074
- # This is the ID of the legal hold.
4048
+ # The ID of the legal hold.
4075
4049
  #
4076
4050
  # @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
4051
+ # The next item following a partial list of returned resources. For
4052
+ # example, if a request is made to return `MaxResults` number of
4079
4053
  # resources, `NextToken` allows you to return more items in your list
4080
4054
  # starting at the location pointed to by the next token.
4081
4055
  #
4082
4056
  # @option params [Integer] :max_results
4083
- # This is the maximum number of resource list items to be returned.
4057
+ # The maximum number of resource list items to be returned.
4084
4058
  #
4085
4059
  # @return [Types::ListRecoveryPointsByLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4086
4060
  #
@@ -4115,8 +4089,8 @@ module Aws::Backup
4115
4089
  req.send_request(options)
4116
4090
  end
4117
4091
 
4118
- # Returns detailed information about all the recovery points of the type
4119
- # specified by a resource Amazon Resource Name (ARN).
4092
+ # The information about the recovery points of the type specified by a
4093
+ # resource Amazon Resource Name (ARN).
4120
4094
  #
4121
4095
  # <note markdown="1"> For Amazon EFS and Amazon EC2, this action only lists recovery points
4122
4096
  # created by Backup.
@@ -4373,15 +4347,13 @@ module Aws::Backup
4373
4347
  # Relational Database Service (Amazon RDS) database.
4374
4348
  #
4375
4349
  # @option params [String] :aggregation_period
4376
- # This is the period that sets the boundaries for returned results.
4377
- #
4378
- # Acceptable values include
4350
+ # The period for the returned results.
4379
4351
  #
4380
- # * `ONE_DAY` for daily job count for the prior 14 days.
4352
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
4381
4353
  #
4382
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
4354
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
4383
4355
  #
4384
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
4356
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
4385
4357
  #
4386
4358
  # @option params [Integer] :max_results
4387
4359
  # This parameter sets the maximum number of items to be returned.
@@ -4473,19 +4445,20 @@ module Aws::Backup
4473
4445
  #
4474
4446
  # * `Neptune` for Amazon Neptune
4475
4447
  #
4448
+ # * `RDS` for Amazon Relational Database Service
4449
+ #
4476
4450
  # * `Redshift` for Amazon Redshift
4477
4451
  #
4478
- # * `RDS` for Amazon Relational Database Service
4452
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
4479
4453
  #
4480
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
4454
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
4455
+ # Compute Cloud instances
4481
4456
  #
4482
4457
  # * `Storage Gateway` for Storage Gateway
4483
4458
  #
4484
- # * `S3` for Amazon S3
4485
- #
4486
4459
  # * `Timestream` for Amazon Timestream
4487
4460
  #
4488
- # * `VirtualMachine` for virtual machines
4461
+ # * `VirtualMachine` for VMware virtual machines
4489
4462
  #
4490
4463
  # @option params [Time,DateTime,Date,Integer,String] :by_created_before
4491
4464
  # Returns only restore jobs that were created before the specified date.
@@ -4744,17 +4717,8 @@ module Aws::Backup
4744
4717
  req.send_request(options)
4745
4718
  end
4746
4719
 
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
4720
+ # Returns the tags assigned to the resource, such as a target recovery
4721
+ # point, backup plan, or backup vault.
4758
4722
  #
4759
4723
  # @option params [required, String] :resource_arn
4760
4724
  # An Amazon Resource Name (ARN) that uniquely identifies a resource. The
@@ -4808,7 +4772,6 @@ module Aws::Backup
4808
4772
  # The name of a logical container where backups are stored. Backup
4809
4773
  # vaults are identified by names that are unique to the account used to
4810
4774
  # create them and the Amazon Web Services Region where they are created.
4811
- # They consist of lowercase letters, numbers, and hyphens.
4812
4775
  #
4813
4776
  # @option params [String] :policy
4814
4777
  # The backup vault access policy document in JSON format.
@@ -4843,10 +4806,17 @@ module Aws::Backup
4843
4806
  # environments that are subject to SEC 17a-4, CFTC, and FINRA
4844
4807
  # regulations. For more information about how Backup Vault Lock relates
4845
4808
  # to these regulations, see the [Cohasset Associates Compliance
4846
- # Assessment.](samples/cohassetreport.zip)
4809
+ # Assessment.][1]
4847
4810
  #
4848
4811
  # </note>
4849
4812
  #
4813
+ # For more information, see [Backup Vault Lock][2].
4814
+ #
4815
+ #
4816
+ #
4817
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip
4818
+ # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html
4819
+ #
4850
4820
  # @option params [required, String] :backup_vault_name
4851
4821
  # The Backup Vault Lock configuration that specifies the name of the
4852
4822
  # backup vault it protects.
@@ -4858,8 +4828,10 @@ module Aws::Backup
4858
4828
  # require you to retain certain data for at least seven years (2555
4859
4829
  # days).
4860
4830
  #
4861
- # If this parameter is not specified, Vault Lock will not enforce a
4862
- # minimum retention period.
4831
+ # This parameter is required when a vault lock is created through
4832
+ # CloudFormation; otherwise, this parameter is optional. If this
4833
+ # parameter is not specified, Vault Lock will not enforce a minimum
4834
+ # retention period.
4863
4835
  #
4864
4836
  # If this parameter is specified, any backup or copy job to the vault
4865
4837
  # must have a lifecycle policy with a retention period equal to or
@@ -4940,7 +4912,6 @@ module Aws::Backup
4940
4912
  # The name of a logical container where backups are stored. Backup
4941
4913
  # vaults are identified by names that are unique to the account used to
4942
4914
  # create them and the Amazon Web Services Region where they are created.
4943
- # They consist of lowercase letters, numbers, and hyphens.
4944
4915
  #
4945
4916
  # @option params [required, String] :sns_topic_arn
4946
4917
  # The Amazon Resource Name (ARN) that specifies the topic for a backup
@@ -4965,9 +4936,9 @@ module Aws::Backup
4965
4936
  #
4966
4937
  # * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
4967
4938
  #
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
4939
+ # <note markdown="1"> The list below includes both supported events and deprecated events
4940
+ # that are no longer in use (for reference). Deprecated events do not
4941
+ # return statuses or notifications. Refer to the list above for the
4971
4942
  # supported events.
4972
4943
  #
4973
4944
  # </note>
@@ -5003,7 +4974,7 @@ module Aws::Backup
5003
4974
  # This is a unique identifier of a restore job within Backup.
5004
4975
  #
5005
4976
  # @option params [required, String] :validation_status
5006
- # This is the status of your restore validation.
4977
+ # The status of your restore validation.
5007
4978
  #
5008
4979
  # @option params [String] :validation_status_message
5009
4980
  # This is an optional message string you can input to describe the
@@ -5034,7 +5005,6 @@ module Aws::Backup
5034
5005
  # The name of a logical container where backups are stored. Backup
5035
5006
  # vaults are identified by names that are unique to the account used to
5036
5007
  # create them and the Amazon Web Services Region where they are created.
5037
- # They consist of lowercase letters, numbers, and hyphens.
5038
5008
  #
5039
5009
  # @option params [required, String] :resource_arn
5040
5010
  # An Amazon Resource Name (ARN) that uniquely identifies a resource. The
@@ -5088,25 +5058,22 @@ module Aws::Backup
5088
5058
  # “transition to cold after days” setting cannot be changed after a
5089
5059
  # backup has been transitioned to cold.
5090
5060
  #
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.
5061
+ # Resource types that can transition to cold storage are listed in the
5062
+ # [Feature availability by resource][1] table. Backup ignores this
5063
+ # expression for other resource types.
5095
5064
  #
5096
5065
  # This parameter has a maximum value of 100 years (36,500 days).
5097
5066
  #
5098
5067
  #
5099
5068
  #
5100
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
5069
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
5101
5070
  #
5102
5071
  # @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.
5072
+ # The tags to assign to the resources.
5105
5073
  #
5106
5074
  # @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.
5075
+ # The backup option for a selected resource. This option is only
5076
+ # available for Windows Volume Shadow Copy Service (VSS) backup jobs.
5110
5077
  #
5111
5078
  # Valid values: Set to `"WindowsVSS":"enabled"` to enable the
5112
5079
  # `WindowsVSS` backup option and create a Windows VSS backup. Set to
@@ -5171,12 +5138,12 @@ module Aws::Backup
5171
5138
  # The name of a logical source container where backups are stored.
5172
5139
  # Backup vaults are identified by names that are unique to the account
5173
5140
  # used to create them and the Amazon Web Services Region where they are
5174
- # created. They consist of lowercase letters, numbers, and hyphens.
5141
+ # created.
5175
5142
  #
5176
5143
  # @option params [required, String] :destination_backup_vault_arn
5177
5144
  # An Amazon Resource Name (ARN) that uniquely identifies a destination
5178
5145
  # backup vault to copy to; for example,
5179
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
5146
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
5180
5147
  #
5181
5148
  # @option params [required, String] :iam_role_arn
5182
5149
  # Specifies the IAM role ARN used to copy the target recovery point; for
@@ -5189,23 +5156,26 @@ module Aws::Backup
5189
5156
  # with no action taken.
5190
5157
  #
5191
5158
  # @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.
5159
+ # Specifies the time period, in days, before a recovery point
5160
+ # transitions to cold storage or is deleted.
5194
5161
  #
5195
5162
  # 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.
5163
+ # for a minimum of 90 days. Therefore, on the console, the retention
5164
+ # setting must be 90 days greater than the transition to cold after days
5165
+ # setting. The transition to cold after days setting can't be changed
5166
+ # after a backup has been transitioned to cold.
5167
+ #
5168
+ # Resource types that can transition to cold storage are listed in the
5169
+ # [Feature availability by resource][1] table. Backup ignores this
5170
+ # expression for other resource types.
5200
5171
  #
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.
5172
+ # To remove the existing lifecycle and retention periods and keep your
5173
+ # recovery points indefinitely, specify -1 for
5174
+ # `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
5205
5175
  #
5206
5176
  #
5207
5177
  #
5208
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
5178
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
5209
5179
  #
5210
5180
  # @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5211
5181
  #
@@ -5289,8 +5259,7 @@ module Aws::Backup
5289
5259
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
5290
5260
  #
5291
5261
  # @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.
5262
+ # A set of metadata key-value pairs.
5294
5263
  #
5295
5264
  # You can get configuration metadata about a resource at the time it was
5296
5265
  # backed up by calling `GetRecoveryPointRestoreMetadata`. However,
@@ -5299,33 +5268,56 @@ module Aws::Backup
5299
5268
  # resource. For example, you might need to provide a new resource name
5300
5269
  # if the original already exists.
5301
5270
  #
5302
- # You need to specify specific metadata to restore an Amazon Elastic
5303
- # File System (Amazon EFS) instance:
5271
+ # For more information about the metadata for each resource, see the
5272
+ # following:
5273
+ #
5274
+ # * [Metadata for Amazon Aurora][1]
5275
+ #
5276
+ # * [Metadata for Amazon DocumentDB][2]
5304
5277
  #
5305
- # * `file-system-id`: The ID of the Amazon EFS file system that is
5306
- # backed up by Backup. Returned in `GetRecoveryPointRestoreMetadata`.
5278
+ # * [Metadata for CloudFormation][3]
5307
5279
  #
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`.
5280
+ # * [Metadata for Amazon DynamoDB][4]
5311
5281
  #
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.
5282
+ # * [ Metadata for Amazon EBS][5]
5316
5283
  #
5317
- # * `PerformanceMode`: Specifies the throughput mode of the file system.
5284
+ # * [Metadata for Amazon EC2][6]
5318
5285
  #
5319
- # * `CreationToken`: A user-supplied value that ensures the uniqueness
5320
- # (idempotency) of the request.
5286
+ # * [Metadata for Amazon EFS][7]
5321
5287
  #
5322
- # * `newFileSystem`: A Boolean value that, if true, specifies that the
5323
- # recovery point is restored to a new Amazon EFS file system.
5288
+ # * [Metadata for Amazon FSx][8]
5324
5289
  #
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"]"`.
5290
+ # * [Metadata for Amazon Neptune][9]
5291
+ #
5292
+ # * [Metadata for Amazon RDS][10]
5293
+ #
5294
+ # * [Metadata for Amazon Redshift][11]
5295
+ #
5296
+ # * [Metadata for Storage Gateway][12]
5297
+ #
5298
+ # * [Metadata for Amazon S3][13]
5299
+ #
5300
+ # * [Metadata for Amazon Timestream][14]
5301
+ #
5302
+ # * [Metadata for virtual machines][15]
5303
+ #
5304
+ #
5305
+ #
5306
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli
5307
+ # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli
5308
+ # [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli
5309
+ # [4]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli
5310
+ # [5]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli
5311
+ # [6]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli
5312
+ # [7]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli
5313
+ # [8]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli
5314
+ # [9]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli
5315
+ # [10]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli
5316
+ # [11]: https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api
5317
+ # [12]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli
5318
+ # [13]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli
5319
+ # [14]: https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api
5320
+ # [15]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli
5329
5321
  #
5330
5322
  # @option params [String] :iam_role_arn
5331
5323
  # The Amazon Resource Name (ARN) of the IAM role that Backup uses to
@@ -5342,35 +5334,35 @@ module Aws::Backup
5342
5334
  # Starts a job to restore a recovery point for one of the following
5343
5335
  # resources:
5344
5336
  #
5345
- # * `Aurora` for Amazon Aurora
5337
+ # * `Aurora` - Amazon Aurora
5346
5338
  #
5347
- # * `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
5339
+ # * `DocumentDB` - Amazon DocumentDB
5348
5340
  #
5349
- # * `CloudFormation` for CloudFormation
5341
+ # * `CloudFormation` - CloudFormation
5350
5342
  #
5351
- # * `DynamoDB` for Amazon DynamoDB
5343
+ # * `DynamoDB` - Amazon DynamoDB
5352
5344
  #
5353
- # * `EBS` for Amazon Elastic Block Store
5345
+ # * `EBS` - Amazon Elastic Block Store
5354
5346
  #
5355
- # * `EC2` for Amazon Elastic Compute Cloud
5347
+ # * `EC2` - Amazon Elastic Compute Cloud
5356
5348
  #
5357
- # * `EFS` for Amazon Elastic File System
5349
+ # * `EFS` - Amazon Elastic File System
5358
5350
  #
5359
- # * `FSx` for Amazon FSx
5351
+ # * `FSx` - Amazon FSx
5360
5352
  #
5361
- # * `Neptune` for Amazon Neptune
5353
+ # * `Neptune` - Amazon Neptune
5362
5354
  #
5363
- # * `RDS` for Amazon Relational Database Service
5355
+ # * `RDS` - Amazon Relational Database Service
5364
5356
  #
5365
- # * `Redshift` for Amazon Redshift
5357
+ # * `Redshift` - Amazon Redshift
5366
5358
  #
5367
- # * `Storage Gateway` for Storage Gateway
5359
+ # * `Storage Gateway` - Storage Gateway
5368
5360
  #
5369
- # * `S3` for Amazon S3
5361
+ # * `S3` - Amazon Simple Storage Service
5370
5362
  #
5371
- # * `Timestream` for Amazon Timestream
5363
+ # * `Timestream` - Amazon Timestream
5372
5364
  #
5373
- # * `VirtualMachine` for virtual machines
5365
+ # * `VirtualMachine` - Virtual machines
5374
5366
  #
5375
5367
  # @option params [Boolean] :copy_source_tags_to_restored_resource
5376
5368
  # This is an optional parameter. If this equals `True`, tags included in
@@ -5412,7 +5404,7 @@ module Aws::Backup
5412
5404
  #
5413
5405
  # This action is not supported for the following services: Amazon FSx
5414
5406
  # for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp
5415
- # ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB
5407
+ # ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB
5416
5408
  # compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
5417
5409
  #
5418
5410
  # @option params [required, String] :backup_job_id
@@ -5438,10 +5430,19 @@ module Aws::Backup
5438
5430
  # Assigns a set of key-value pairs to a recovery point, backup plan, or
5439
5431
  # backup vault identified by an Amazon Resource Name (ARN).
5440
5432
  #
5433
+ # This API is supported for recovery points for resource types including
5434
+ # Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon
5435
+ # RDS.
5436
+ #
5441
5437
  # @option params [required, String] :resource_arn
5442
5438
  # An ARN that uniquely identifies a resource. The format of the ARN
5443
5439
  # depends on the type of the tagged resource.
5444
5440
  #
5441
+ # ARNs that do not include `backup` are incompatible with tagging.
5442
+ # `TagResource` and `UntagResource` with invalid ARNs will result in an
5443
+ # error. Acceptable ARN content can include `arn:aws:backup:us-east`.
5444
+ # Invalid ARN content may look like `arn:aws:ec2:us-east`.
5445
+ #
5445
5446
  # @option params [required, Hash<String,String>] :tags
5446
5447
  # Key-value pairs that are used to help organize your resources. You can
5447
5448
  # assign your own metadata to the resources you create. For clarity,
@@ -5471,13 +5472,21 @@ module Aws::Backup
5471
5472
  # Removes a set of key-value pairs from a recovery point, backup plan,
5472
5473
  # or backup vault identified by an Amazon Resource Name (ARN)
5473
5474
  #
5475
+ # This API is not supported for recovery points for resource types
5476
+ # including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune,
5477
+ # and Amazon RDS.
5478
+ #
5474
5479
  # @option params [required, String] :resource_arn
5475
5480
  # An ARN that uniquely identifies a resource. The format of the ARN
5476
5481
  # depends on the type of the tagged resource.
5477
5482
  #
5483
+ # ARNs that do not include `backup` are incompatible with tagging.
5484
+ # `TagResource` and `UntagResource` with invalid ARNs will result in an
5485
+ # error. Acceptable ARN content can include `arn:aws:backup:us-east`.
5486
+ # Invalid ARN content may look like `arn:aws:ec2:us-east`.
5487
+ #
5478
5488
  # @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.
5489
+ # The keys to identify which key-value tags to remove from a resource.
5481
5490
  #
5482
5491
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5483
5492
  #
@@ -5497,16 +5506,15 @@ module Aws::Backup
5497
5506
  req.send_request(options)
5498
5507
  end
5499
5508
 
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`.
5509
+ # Updates the specified backup plan. The new version is uniquely
5510
+ # identified by its ID.
5503
5511
  #
5504
5512
  # @option params [required, String] :backup_plan_id
5505
- # Uniquely identifies a backup plan.
5513
+ # The ID of the backup plan.
5506
5514
  #
5507
5515
  # @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`.
5516
+ # The body of a backup plan. Includes a `BackupPlanName` and one or more
5517
+ # sets of `Rules`.
5510
5518
  #
5511
5519
  # @return [Types::UpdateBackupPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5512
5520
  #
@@ -5582,8 +5590,7 @@ module Aws::Backup
5582
5590
  req.send_request(options)
5583
5591
  end
5584
5592
 
5585
- # Updates an existing framework identified by its `FrameworkName` with
5586
- # the input document in JSON format.
5593
+ # Updates the specified framework.
5587
5594
  #
5588
5595
  # @option params [required, String] :framework_name
5589
5596
  # The unique name of a framework. This name is between 1 and 256
@@ -5595,8 +5602,8 @@ module Aws::Backup
5595
5602
  # characters.
5596
5603
  #
5597
5604
  # @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.
5605
+ # The controls that make up the framework. Each control in the list has
5606
+ # a name, input parameters, and scope.
5600
5607
  #
5601
5608
  # @option params [String] :idempotency_token
5602
5609
  # A customer-chosen string that you can use to distinguish between
@@ -5689,28 +5696,31 @@ module Aws::Backup
5689
5696
  # cold storage and when it expires. Backup transitions and expires
5690
5697
  # backups automatically according to the lifecycle that you define.
5691
5698
  #
5699
+ # Resource types that can transition to cold storage are listed in the
5700
+ # [Feature availability by resource][1] table. Backup ignores this
5701
+ # expression for other resource types.
5702
+ #
5692
5703
  # Backups transitioned to cold storage must be stored in cold storage
5693
5704
  # for a minimum of 90 days. Therefore, the “retention” setting must be
5694
5705
  # 90 days greater than the “transition to cold after days” setting. The
5695
5706
  # “transition to cold after days” setting cannot be changed after a
5696
5707
  # backup has been transitioned to cold.
5697
5708
  #
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.
5709
+ # If your lifecycle currently uses the parameters `DeleteAfterDays` and
5710
+ # `MoveToColdStorageAfterDays`, include these parameters and their
5711
+ # values when you call this operation. Not including them may result in
5712
+ # your plan updating with null values.
5702
5713
  #
5703
5714
  # This operation does not support continuous backups.
5704
5715
  #
5705
5716
  #
5706
5717
  #
5707
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
5718
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
5708
5719
  #
5709
5720
  # @option params [required, String] :backup_vault_name
5710
5721
  # The name of a logical container where backups are stored. Backup
5711
5722
  # vaults are identified by names that are unique to the account used to
5712
5723
  # create them and the Amazon Web Services Region where they are created.
5713
- # They consist of lowercase letters, numbers, and hyphens.
5714
5724
  #
5715
5725
  # @option params [required, String] :recovery_point_arn
5716
5726
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -5817,8 +5827,7 @@ module Aws::Backup
5817
5827
  req.send_request(options)
5818
5828
  end
5819
5829
 
5820
- # Updates an existing report plan identified by its `ReportPlanName`
5821
- # with the input document in JSON format.
5830
+ # Updates the specified report plan.
5822
5831
  #
5823
5832
  # @option params [required, String] :report_plan_name
5824
5833
  # The unique name of the report plan. This name is between 1 and 256
@@ -5830,13 +5839,12 @@ module Aws::Backup
5830
5839
  # characters.
5831
5840
  #
5832
5841
  # @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.
5842
+ # The information about where to deliver your reports, specifically your
5843
+ # Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
5836
5844
  #
5837
5845
  # @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:
5846
+ # The report template for the report. Reports are built using a report
5847
+ # template. The report templates are:
5840
5848
  #
5841
5849
  # `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
5842
5850
  # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
@@ -5915,7 +5923,7 @@ module Aws::Backup
5915
5923
  # Specifies the body of a restore testing plan.
5916
5924
  #
5917
5925
  # @option params [required, String] :restore_testing_plan_name
5918
- # This is the restore testing plan name you wish to update.
5926
+ # The name of the restore testing plan name.
5919
5927
  #
5920
5928
  # @return [Types::UpdateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5921
5929
  #
@@ -5958,13 +5966,13 @@ module Aws::Backup
5958
5966
  req.send_request(options)
5959
5967
  end
5960
5968
 
5969
+ # Updates the specified restore testing selection.
5970
+ #
5961
5971
  # Most elements except the `RestoreTestingSelectionName` can be updated
5962
5972
  # with this request.
5963
5973
  #
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.
5974
+ # You can use either protected resource ARNs or conditions, but not
5975
+ # both.
5968
5976
  #
5969
5977
  # @option params [required, String] :restore_testing_plan_name
5970
5978
  # The restore testing plan name is required to update the indicated
@@ -5977,8 +5985,8 @@ module Aws::Backup
5977
5985
  # `ProtectedResourceConditions` will be unsuccessful.
5978
5986
  #
5979
5987
  # @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.
5988
+ # The required restore testing selection name of the restore testing
5989
+ # selection you wish to update.
5982
5990
  #
5983
5991
  # @return [Types::UpdateRestoreTestingSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5984
5992
  #
@@ -6040,14 +6048,19 @@ module Aws::Backup
6040
6048
  # @api private
6041
6049
  def build_request(operation_name, params = {})
6042
6050
  handlers = @handlers.for(operation_name)
6051
+ tracer = config.telemetry_provider.tracer_provider.tracer(
6052
+ Aws::Telemetry.module_to_tracer_name('Aws::Backup')
6053
+ )
6043
6054
  context = Seahorse::Client::RequestContext.new(
6044
6055
  operation_name: operation_name,
6045
6056
  operation: config.api.operation(operation_name),
6046
6057
  client: self,
6047
6058
  params: params,
6048
- config: config)
6059
+ config: config,
6060
+ tracer: tracer
6061
+ )
6049
6062
  context[:gem_name] = 'aws-sdk-backup'
6050
- context[:gem_version] = '1.73.0'
6063
+ context[:gem_version] = '1.75.0'
6051
6064
  Seahorse::Client::Request.new(handlers, context)
6052
6065
  end
6053
6066