aws-sdk-backup 1.88.0 → 1.90.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +301 -52
- data/lib/aws-sdk-backup/client_api.rb +159 -8
- data/lib/aws-sdk-backup/types.rb +492 -84
- data/lib/aws-sdk-backup.rb +2 -2
- data/sig/client.rbs +64 -6
- data/sig/types.rbs +94 -11
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 160d988d88549dd265802f9200c5c3cf9ca24b09ccbe802d201d3df10aa66355
|
4
|
+
data.tar.gz: a8ad7727e529b4bdb2ef0c293ccb9371668f80027551961c8aba05cad4b8881d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e10c9908ae17e3d77d14ff97475c083b63df16b41a6f7bc1914659c80994035e6d17a1eff9405c27619c9025f419af1da410a679cb3f4c56d9d83b4008e3891b
|
7
|
+
data.tar.gz: 96aa453cd2f1e05e8eb7c622ac4f5f7b8a0fcc57308e3934c394c62309fac08bb7937a49df49b16f2796aa86f0dd28a2f507c5cf75e31f29ac9ea54ab78b91bd
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.90.0 (2025-06-17)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS Backup is adding support for integration of its logically air-gapped vaults with the AWS Organizations Multi-party approval capability.
|
8
|
+
|
9
|
+
1.89.0 (2025-06-02)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - You can now subscribe to Amazon SNS notifications and Amazon EventBridge events for backup indexing. You can now receive notifications when a backup index is created, deleted, or fails to create, enhancing your ability to monitor and track your backup operations.
|
13
|
+
|
4
14
|
1.88.0 (2025-05-12)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.90.0
|
@@ -469,6 +469,38 @@ module Aws::Backup
|
|
469
469
|
|
470
470
|
# @!group API Operations
|
471
471
|
|
472
|
+
# Associates an MPA approval team with a backup vault.
|
473
|
+
#
|
474
|
+
# @option params [required, String] :backup_vault_name
|
475
|
+
# The name of the backup vault to associate with the MPA approval team.
|
476
|
+
#
|
477
|
+
# @option params [required, String] :mpa_approval_team_arn
|
478
|
+
# The Amazon Resource Name (ARN) of the MPA approval team to associate
|
479
|
+
# with the backup vault.
|
480
|
+
#
|
481
|
+
# @option params [String] :requester_comment
|
482
|
+
# A comment provided by the requester explaining the association
|
483
|
+
# request.
|
484
|
+
#
|
485
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
486
|
+
#
|
487
|
+
# @example Request syntax with placeholder values
|
488
|
+
#
|
489
|
+
# resp = client.associate_backup_vault_mpa_approval_team({
|
490
|
+
# backup_vault_name: "BackupVaultName", # required
|
491
|
+
# mpa_approval_team_arn: "ARN", # required
|
492
|
+
# requester_comment: "RequesterComment",
|
493
|
+
# })
|
494
|
+
#
|
495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam AWS API Documentation
|
496
|
+
#
|
497
|
+
# @overload associate_backup_vault_mpa_approval_team(params = {})
|
498
|
+
# @param [Hash] params ({})
|
499
|
+
def associate_backup_vault_mpa_approval_team(params = {}, options = {})
|
500
|
+
req = build_request(:associate_backup_vault_mpa_approval_team, params)
|
501
|
+
req.send_request(options)
|
502
|
+
end
|
503
|
+
|
472
504
|
# Removes the specified legal hold on a recovery point. This action can
|
473
505
|
# only be performed by a user with sufficient permissions.
|
474
506
|
#
|
@@ -523,6 +555,9 @@ module Aws::Backup
|
|
523
555
|
# If used, this parameter must contain 1 to 50 alphanumeric or '-\_.'
|
524
556
|
# characters.
|
525
557
|
#
|
558
|
+
# **A suitable default value is auto-generated.** You should normally
|
559
|
+
# not need to pass this option.**
|
560
|
+
#
|
526
561
|
# @return [Types::CreateBackupPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
527
562
|
#
|
528
563
|
# * {Types::CreateBackupPlanOutput#backup_plan_id #backup_plan_id} => String
|
@@ -627,6 +662,9 @@ module Aws::Backup
|
|
627
662
|
# If used, this parameter must contain 1 to 50 alphanumeric or '-\_.'
|
628
663
|
# characters.
|
629
664
|
#
|
665
|
+
# **A suitable default value is auto-generated.** You should normally
|
666
|
+
# not need to pass this option.**
|
667
|
+
#
|
630
668
|
# @return [Types::CreateBackupSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
631
669
|
#
|
632
670
|
# * {Types::CreateBackupSelectionOutput#selection_id #selection_id} => String
|
@@ -725,6 +763,9 @@ module Aws::Backup
|
|
725
763
|
# If used, this parameter must contain 1 to 50 alphanumeric or '-\_.'
|
726
764
|
# characters.
|
727
765
|
#
|
766
|
+
# **A suitable default value is auto-generated.** You should normally
|
767
|
+
# not need to pass this option.**
|
768
|
+
#
|
728
769
|
# @return [Types::CreateBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
729
770
|
#
|
730
771
|
# * {Types::CreateBackupVaultOutput#backup_vault_name #backup_vault_name} => String
|
@@ -853,6 +894,9 @@ module Aws::Backup
|
|
853
894
|
# identical calls. Retrying a successful request with the same
|
854
895
|
# idempotency token results in a success message with no action taken.
|
855
896
|
#
|
897
|
+
# **A suitable default value is auto-generated.** You should normally
|
898
|
+
# not need to pass this option.**
|
899
|
+
#
|
856
900
|
# @option params [Types::RecoveryPointSelection] :recovery_point_selection
|
857
901
|
# The criteria to assign a set of resources, such as resource types or
|
858
902
|
# backup vaults.
|
@@ -941,6 +985,9 @@ module Aws::Backup
|
|
941
985
|
# This parameter is optional. If used, this parameter must contain 1 to
|
942
986
|
# 50 alphanumeric or '-\_.' characters.
|
943
987
|
#
|
988
|
+
# **A suitable default value is auto-generated.** You should normally
|
989
|
+
# not need to pass this option.**
|
990
|
+
#
|
944
991
|
# @option params [required, Integer] :min_retention_days
|
945
992
|
# This setting specifies the minimum retention period that the vault
|
946
993
|
# retains its recovery points.
|
@@ -1075,6 +1122,66 @@ module Aws::Backup
|
|
1075
1122
|
req.send_request(options)
|
1076
1123
|
end
|
1077
1124
|
|
1125
|
+
# Creates a restore access backup vault that provides temporary access
|
1126
|
+
# to recovery points in a logically air-gapped backup vault, subject to
|
1127
|
+
# MPA approval.
|
1128
|
+
#
|
1129
|
+
# @option params [required, String] :source_backup_vault_arn
|
1130
|
+
# The ARN of the source backup vault containing the recovery points to
|
1131
|
+
# which temporary access is requested.
|
1132
|
+
#
|
1133
|
+
# @option params [String] :backup_vault_name
|
1134
|
+
# The name of the backup vault to associate with an MPA approval team.
|
1135
|
+
#
|
1136
|
+
# @option params [Hash<String,String>] :backup_vault_tags
|
1137
|
+
# Optional tags to assign to the restore access backup vault.
|
1138
|
+
#
|
1139
|
+
# @option params [String] :creator_request_id
|
1140
|
+
# A unique string that identifies the request and allows failed requests
|
1141
|
+
# to be retried without the risk of executing the operation twice.
|
1142
|
+
#
|
1143
|
+
# **A suitable default value is auto-generated.** You should normally
|
1144
|
+
# not need to pass this option.**
|
1145
|
+
#
|
1146
|
+
# @option params [String] :requester_comment
|
1147
|
+
# A comment explaining the reason for requesting restore access to the
|
1148
|
+
# backup vault.
|
1149
|
+
#
|
1150
|
+
# @return [Types::CreateRestoreAccessBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1151
|
+
#
|
1152
|
+
# * {Types::CreateRestoreAccessBackupVaultOutput#restore_access_backup_vault_arn #restore_access_backup_vault_arn} => String
|
1153
|
+
# * {Types::CreateRestoreAccessBackupVaultOutput#vault_state #vault_state} => String
|
1154
|
+
# * {Types::CreateRestoreAccessBackupVaultOutput#restore_access_backup_vault_name #restore_access_backup_vault_name} => String
|
1155
|
+
# * {Types::CreateRestoreAccessBackupVaultOutput#creation_date #creation_date} => Time
|
1156
|
+
#
|
1157
|
+
# @example Request syntax with placeholder values
|
1158
|
+
#
|
1159
|
+
# resp = client.create_restore_access_backup_vault({
|
1160
|
+
# source_backup_vault_arn: "ARN", # required
|
1161
|
+
# backup_vault_name: "BackupVaultName",
|
1162
|
+
# backup_vault_tags: {
|
1163
|
+
# "TagKey" => "TagValue",
|
1164
|
+
# },
|
1165
|
+
# creator_request_id: "string",
|
1166
|
+
# requester_comment: "RequesterComment",
|
1167
|
+
# })
|
1168
|
+
#
|
1169
|
+
# @example Response structure
|
1170
|
+
#
|
1171
|
+
# resp.restore_access_backup_vault_arn #=> String
|
1172
|
+
# resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
|
1173
|
+
# resp.restore_access_backup_vault_name #=> String
|
1174
|
+
# resp.creation_date #=> Time
|
1175
|
+
#
|
1176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreAccessBackupVault AWS API Documentation
|
1177
|
+
#
|
1178
|
+
# @overload create_restore_access_backup_vault(params = {})
|
1179
|
+
# @param [Hash] params ({})
|
1180
|
+
def create_restore_access_backup_vault(params = {}, options = {})
|
1181
|
+
req = build_request(:create_restore_access_backup_vault, params)
|
1182
|
+
req.send_request(options)
|
1183
|
+
end
|
1184
|
+
|
1078
1185
|
# Creates a restore testing plan.
|
1079
1186
|
#
|
1080
1187
|
# The first of two steps to create a restore testing plan. After this
|
@@ -1676,6 +1783,10 @@ module Aws::Backup
|
|
1676
1783
|
# * {Types::DescribeBackupVaultOutput#min_retention_days #min_retention_days} => Integer
|
1677
1784
|
# * {Types::DescribeBackupVaultOutput#max_retention_days #max_retention_days} => Integer
|
1678
1785
|
# * {Types::DescribeBackupVaultOutput#lock_date #lock_date} => Time
|
1786
|
+
# * {Types::DescribeBackupVaultOutput#source_backup_vault_arn #source_backup_vault_arn} => String
|
1787
|
+
# * {Types::DescribeBackupVaultOutput#mpa_approval_team_arn #mpa_approval_team_arn} => String
|
1788
|
+
# * {Types::DescribeBackupVaultOutput#mpa_session_arn #mpa_session_arn} => String
|
1789
|
+
# * {Types::DescribeBackupVaultOutput#latest_mpa_approval_team_update #latest_mpa_approval_team_update} => Types::LatestMpaApprovalTeamUpdate
|
1679
1790
|
#
|
1680
1791
|
# @example Request syntax with placeholder values
|
1681
1792
|
#
|
@@ -1688,7 +1799,7 @@ module Aws::Backup
|
|
1688
1799
|
#
|
1689
1800
|
# resp.backup_vault_name #=> String
|
1690
1801
|
# resp.backup_vault_arn #=> String
|
1691
|
-
# resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
1802
|
+
# resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
1692
1803
|
# resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
|
1693
1804
|
# resp.encryption_key_arn #=> String
|
1694
1805
|
# resp.creation_date #=> Time
|
@@ -1698,6 +1809,14 @@ module Aws::Backup
|
|
1698
1809
|
# resp.min_retention_days #=> Integer
|
1699
1810
|
# resp.max_retention_days #=> Integer
|
1700
1811
|
# resp.lock_date #=> Time
|
1812
|
+
# resp.source_backup_vault_arn #=> String
|
1813
|
+
# resp.mpa_approval_team_arn #=> String
|
1814
|
+
# resp.mpa_session_arn #=> String
|
1815
|
+
# resp.latest_mpa_approval_team_update.mpa_session_arn #=> String
|
1816
|
+
# resp.latest_mpa_approval_team_update.status #=> String, one of "PENDING", "APPROVED", "FAILED"
|
1817
|
+
# resp.latest_mpa_approval_team_update.status_message #=> String
|
1818
|
+
# resp.latest_mpa_approval_team_update.initiation_date #=> Time
|
1819
|
+
# resp.latest_mpa_approval_team_update.expiry_date #=> Time
|
1701
1820
|
#
|
1702
1821
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVault AWS API Documentation
|
1703
1822
|
#
|
@@ -1914,6 +2033,7 @@ module Aws::Backup
|
|
1914
2033
|
# * {Types::DescribeRecoveryPointOutput#status #status} => String
|
1915
2034
|
# * {Types::DescribeRecoveryPointOutput#status_message #status_message} => String
|
1916
2035
|
# * {Types::DescribeRecoveryPointOutput#creation_date #creation_date} => Time
|
2036
|
+
# * {Types::DescribeRecoveryPointOutput#initiation_date #initiation_date} => Time
|
1917
2037
|
# * {Types::DescribeRecoveryPointOutput#completion_date #completion_date} => Time
|
1918
2038
|
# * {Types::DescribeRecoveryPointOutput#backup_size_in_bytes #backup_size_in_bytes} => Integer
|
1919
2039
|
# * {Types::DescribeRecoveryPointOutput#calculated_lifecycle #calculated_lifecycle} => Types::CalculatedLifecycle
|
@@ -1951,9 +2071,10 @@ module Aws::Backup
|
|
1951
2071
|
# resp.created_by.backup_plan_version #=> String
|
1952
2072
|
# resp.created_by.backup_rule_id #=> String
|
1953
2073
|
# resp.iam_role_arn #=> String
|
1954
|
-
# resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
2074
|
+
# resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
|
1955
2075
|
# resp.status_message #=> String
|
1956
2076
|
# resp.creation_date #=> Time
|
2077
|
+
# resp.initiation_date #=> Time
|
1957
2078
|
# resp.completion_date #=> Time
|
1958
2079
|
# resp.backup_size_in_bytes #=> Integer
|
1959
2080
|
# resp.calculated_lifecycle.move_to_cold_storage_at #=> Time
|
@@ -1969,7 +2090,7 @@ module Aws::Backup
|
|
1969
2090
|
# resp.composite_member_identifier #=> String
|
1970
2091
|
# resp.is_parent #=> Boolean
|
1971
2092
|
# resp.resource_name #=> String
|
1972
|
-
# resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
2093
|
+
# resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
1973
2094
|
# resp.index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
|
1974
2095
|
# resp.index_status_message #=> String
|
1975
2096
|
#
|
@@ -2163,6 +2284,35 @@ module Aws::Backup
|
|
2163
2284
|
req.send_request(options)
|
2164
2285
|
end
|
2165
2286
|
|
2287
|
+
# Removes the association between an MPA approval team and a backup
|
2288
|
+
# vault, disabling the MPA approval workflow for restore operations.
|
2289
|
+
#
|
2290
|
+
# @option params [required, String] :backup_vault_name
|
2291
|
+
# The name of the backup vault from which to disassociate the MPA
|
2292
|
+
# approval team.
|
2293
|
+
#
|
2294
|
+
# @option params [String] :requester_comment
|
2295
|
+
# An optional comment explaining the reason for disassociating the MPA
|
2296
|
+
# approval team from the backup vault.
|
2297
|
+
#
|
2298
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2299
|
+
#
|
2300
|
+
# @example Request syntax with placeholder values
|
2301
|
+
#
|
2302
|
+
# resp = client.disassociate_backup_vault_mpa_approval_team({
|
2303
|
+
# backup_vault_name: "BackupVaultName", # required
|
2304
|
+
# requester_comment: "RequesterComment",
|
2305
|
+
# })
|
2306
|
+
#
|
2307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam AWS API Documentation
|
2308
|
+
#
|
2309
|
+
# @overload disassociate_backup_vault_mpa_approval_team(params = {})
|
2310
|
+
# @param [Hash] params ({})
|
2311
|
+
def disassociate_backup_vault_mpa_approval_team(params = {}, options = {})
|
2312
|
+
req = build_request(:disassociate_backup_vault_mpa_approval_team, params)
|
2313
|
+
req.send_request(options)
|
2314
|
+
end
|
2315
|
+
|
2166
2316
|
# Deletes the specified continuous backup recovery point from Backup and
|
2167
2317
|
# releases control of that continuous backup to the source service, such
|
2168
2318
|
# as Amazon RDS. The source service will continue to create and retain
|
@@ -2570,7 +2720,7 @@ module Aws::Backup
|
|
2570
2720
|
# resp.backup_vault_arn #=> String
|
2571
2721
|
# resp.sns_topic_arn #=> String
|
2572
2722
|
# resp.backup_vault_events #=> Array
|
2573
|
-
# resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED"
|
2723
|
+
# resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED", "CONTINUOUS_BACKUP_INTERRUPTED", "RECOVERY_POINT_INDEX_COMPLETED", "RECOVERY_POINT_INDEX_DELETED", "RECOVERY_POINT_INDEXING_FAILED"
|
2574
2724
|
#
|
2575
2725
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotifications AWS API Documentation
|
2576
2726
|
#
|
@@ -3484,7 +3634,7 @@ module Aws::Backup
|
|
3484
3634
|
# @example Request syntax with placeholder values
|
3485
3635
|
#
|
3486
3636
|
# resp = client.list_backup_vaults({
|
3487
|
-
# by_vault_type: "BACKUP_VAULT", # accepts BACKUP_VAULT, LOGICALLY_AIR_GAPPED_BACKUP_VAULT
|
3637
|
+
# by_vault_type: "BACKUP_VAULT", # accepts BACKUP_VAULT, LOGICALLY_AIR_GAPPED_BACKUP_VAULT, RESTORE_ACCESS_BACKUP_VAULT
|
3488
3638
|
# by_shared: false,
|
3489
3639
|
# next_token: "string",
|
3490
3640
|
# max_results: 1,
|
@@ -3495,7 +3645,7 @@ module Aws::Backup
|
|
3495
3645
|
# resp.backup_vault_list #=> Array
|
3496
3646
|
# resp.backup_vault_list[0].backup_vault_name #=> String
|
3497
3647
|
# resp.backup_vault_list[0].backup_vault_arn #=> String
|
3498
|
-
# resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
3648
|
+
# resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
3499
3649
|
# resp.backup_vault_list[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
|
3500
3650
|
# resp.backup_vault_list[0].creation_date #=> Time
|
3501
3651
|
# resp.backup_vault_list[0].encryption_key_arn #=> String
|
@@ -4206,9 +4356,10 @@ module Aws::Backup
|
|
4206
4356
|
# resp.recovery_points[0].created_by.backup_plan_version #=> String
|
4207
4357
|
# resp.recovery_points[0].created_by.backup_rule_id #=> String
|
4208
4358
|
# resp.recovery_points[0].iam_role_arn #=> String
|
4209
|
-
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
4359
|
+
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
|
4210
4360
|
# resp.recovery_points[0].status_message #=> String
|
4211
4361
|
# resp.recovery_points[0].creation_date #=> Time
|
4362
|
+
# resp.recovery_points[0].initiation_date #=> Time
|
4212
4363
|
# resp.recovery_points[0].completion_date #=> Time
|
4213
4364
|
# resp.recovery_points[0].backup_size_in_bytes #=> Integer
|
4214
4365
|
# resp.recovery_points[0].calculated_lifecycle.move_to_cold_storage_at #=> Time
|
@@ -4223,7 +4374,7 @@ module Aws::Backup
|
|
4223
4374
|
# resp.recovery_points[0].composite_member_identifier #=> String
|
4224
4375
|
# resp.recovery_points[0].is_parent #=> Boolean
|
4225
4376
|
# resp.recovery_points[0].resource_name #=> String
|
4226
|
-
# resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
4377
|
+
# resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
4227
4378
|
# resp.recovery_points[0].index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
|
4228
4379
|
# resp.recovery_points[0].index_status_message #=> String
|
4229
4380
|
#
|
@@ -4342,7 +4493,7 @@ module Aws::Backup
|
|
4342
4493
|
# resp.recovery_points #=> Array
|
4343
4494
|
# resp.recovery_points[0].recovery_point_arn #=> String
|
4344
4495
|
# resp.recovery_points[0].creation_date #=> Time
|
4345
|
-
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
4496
|
+
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
|
4346
4497
|
# resp.recovery_points[0].status_message #=> String
|
4347
4498
|
# resp.recovery_points[0].encryption_key_arn #=> String
|
4348
4499
|
# resp.recovery_points[0].backup_size_bytes #=> Integer
|
@@ -4350,7 +4501,7 @@ module Aws::Backup
|
|
4350
4501
|
# resp.recovery_points[0].is_parent #=> Boolean
|
4351
4502
|
# resp.recovery_points[0].parent_recovery_point_arn #=> String
|
4352
4503
|
# resp.recovery_points[0].resource_name #=> String
|
4353
|
-
# resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
4504
|
+
# resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
4354
4505
|
# resp.recovery_points[0].index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
|
4355
4506
|
# resp.recovery_points[0].index_status_message #=> String
|
4356
4507
|
#
|
@@ -4498,6 +4649,58 @@ module Aws::Backup
|
|
4498
4649
|
req.send_request(options)
|
4499
4650
|
end
|
4500
4651
|
|
4652
|
+
# Returns a list of restore access backup vaults associated with a
|
4653
|
+
# specified backup vault.
|
4654
|
+
#
|
4655
|
+
# @option params [required, String] :backup_vault_name
|
4656
|
+
# The name of the backup vault for which to list associated restore
|
4657
|
+
# access backup vaults.
|
4658
|
+
#
|
4659
|
+
# @option params [String] :next_token
|
4660
|
+
# The pagination token from a previous request to retrieve the next set
|
4661
|
+
# of results.
|
4662
|
+
#
|
4663
|
+
# @option params [Integer] :max_results
|
4664
|
+
# The maximum number of items to return in the response.
|
4665
|
+
#
|
4666
|
+
# @return [Types::ListRestoreAccessBackupVaultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4667
|
+
#
|
4668
|
+
# * {Types::ListRestoreAccessBackupVaultsOutput#next_token #next_token} => String
|
4669
|
+
# * {Types::ListRestoreAccessBackupVaultsOutput#restore_access_backup_vaults #restore_access_backup_vaults} => Array<Types::RestoreAccessBackupVaultListMember>
|
4670
|
+
#
|
4671
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4672
|
+
#
|
4673
|
+
# @example Request syntax with placeholder values
|
4674
|
+
#
|
4675
|
+
# resp = client.list_restore_access_backup_vaults({
|
4676
|
+
# backup_vault_name: "BackupVaultName", # required
|
4677
|
+
# next_token: "string",
|
4678
|
+
# max_results: 1,
|
4679
|
+
# })
|
4680
|
+
#
|
4681
|
+
# @example Response structure
|
4682
|
+
#
|
4683
|
+
# resp.next_token #=> String
|
4684
|
+
# resp.restore_access_backup_vaults #=> Array
|
4685
|
+
# resp.restore_access_backup_vaults[0].restore_access_backup_vault_arn #=> String
|
4686
|
+
# resp.restore_access_backup_vaults[0].creation_date #=> Time
|
4687
|
+
# resp.restore_access_backup_vaults[0].approval_date #=> Time
|
4688
|
+
# resp.restore_access_backup_vaults[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
|
4689
|
+
# resp.restore_access_backup_vaults[0].latest_revoke_request.mpa_session_arn #=> String
|
4690
|
+
# resp.restore_access_backup_vaults[0].latest_revoke_request.status #=> String, one of "PENDING", "FAILED"
|
4691
|
+
# resp.restore_access_backup_vaults[0].latest_revoke_request.status_message #=> String
|
4692
|
+
# resp.restore_access_backup_vaults[0].latest_revoke_request.initiation_date #=> Time
|
4693
|
+
# resp.restore_access_backup_vaults[0].latest_revoke_request.expiry_date #=> Time
|
4694
|
+
#
|
4695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreAccessBackupVaults AWS API Documentation
|
4696
|
+
#
|
4697
|
+
# @overload list_restore_access_backup_vaults(params = {})
|
4698
|
+
# @param [Hash] params ({})
|
4699
|
+
def list_restore_access_backup_vaults(params = {}, options = {})
|
4700
|
+
req = build_request(:list_restore_access_backup_vaults, params)
|
4701
|
+
req.send_request(options)
|
4702
|
+
end
|
4703
|
+
|
4501
4704
|
# This request obtains a summary of restore jobs created or running
|
4502
4705
|
# within the the most recent 30 days. You can include parameters
|
4503
4706
|
# AccountID, State, ResourceType, AggregationPeriod, MaxResults, or
|
@@ -4917,6 +5120,24 @@ module Aws::Backup
|
|
4917
5120
|
# Returns the tags assigned to the resource, such as a target recovery
|
4918
5121
|
# point, backup plan, or backup vault.
|
4919
5122
|
#
|
5123
|
+
# This operation returns results depending on the resource type used in
|
5124
|
+
# the value for `resourceArn`. For example, recovery points of Amazon
|
5125
|
+
# DynamoDB with Advanced Settings have an ARN (Amazon Resource Name)
|
5126
|
+
# that begins with `arn:aws:backup`. Recovery points (backups) of
|
5127
|
+
# DynamoDB without Advanced Settings enabled have an ARN that begins
|
5128
|
+
# with `arn:aws:dynamodb`.
|
5129
|
+
#
|
5130
|
+
# When this operation is called and when you include values of
|
5131
|
+
# `resourceArn` that have an ARN other than `arn:aws:backup`, it may
|
5132
|
+
# return one of the exceptions listed below. To prevent this exception,
|
5133
|
+
# include only values representing resource types that are fully managed
|
5134
|
+
# by Backup. These have an ARN that begins `arn:aws:backup` and they are
|
5135
|
+
# noted in the [Feature availability by resource][1] table.
|
5136
|
+
#
|
5137
|
+
#
|
5138
|
+
#
|
5139
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
|
5140
|
+
#
|
4920
5141
|
# @option params [required, String] :resource_arn
|
4921
5142
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
4922
5143
|
# format of the ARN depends on the type of resource. Valid targets for
|
@@ -5117,32 +5338,13 @@ module Aws::Backup
|
|
5117
5338
|
#
|
5118
5339
|
# @option params [required, Array<String>] :backup_vault_events
|
5119
5340
|
# An array of events that indicate the status of jobs to back up
|
5120
|
-
# resources to the backup vault.
|
5121
|
-
#
|
5122
|
-
#
|
5123
|
-
# Backup events][1].
|
5124
|
-
#
|
5125
|
-
# The following events are supported:
|
5341
|
+
# resources to the backup vault. For the list of supported events,
|
5342
|
+
# common use cases, and code samples, see [Notification options with
|
5343
|
+
# Backup][1].
|
5126
5344
|
#
|
5127
|
-
# * `BACKUP_JOB_STARTED` \| `BACKUP_JOB_COMPLETED`
|
5128
5345
|
#
|
5129
|
-
# * `COPY_JOB_STARTED` \| `COPY_JOB_SUCCESSFUL` \| `COPY_JOB_FAILED`
|
5130
5346
|
#
|
5131
|
-
#
|
5132
|
-
# `RECOVERY_POINT_MODIFIED`
|
5133
|
-
#
|
5134
|
-
# * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
|
5135
|
-
#
|
5136
|
-
# <note markdown="1"> The list below includes both supported events and deprecated events
|
5137
|
-
# that are no longer in use (for reference). Deprecated events do not
|
5138
|
-
# return statuses or notifications. Refer to the list above for the
|
5139
|
-
# supported events.
|
5140
|
-
#
|
5141
|
-
# </note>
|
5142
|
-
#
|
5143
|
-
#
|
5144
|
-
#
|
5145
|
-
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html
|
5347
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-notifications.html
|
5146
5348
|
#
|
5147
5349
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5148
5350
|
#
|
@@ -5151,7 +5353,7 @@ module Aws::Backup
|
|
5151
5353
|
# resp = client.put_backup_vault_notifications({
|
5152
5354
|
# backup_vault_name: "BackupVaultName", # required
|
5153
5355
|
# sns_topic_arn: "ARN", # required
|
5154
|
-
# backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED, S3_BACKUP_OBJECT_FAILED, S3_RESTORE_OBJECT_FAILED
|
5356
|
+
# backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED, S3_BACKUP_OBJECT_FAILED, S3_RESTORE_OBJECT_FAILED, CONTINUOUS_BACKUP_INTERRUPTED, RECOVERY_POINT_INDEX_COMPLETED, RECOVERY_POINT_INDEX_DELETED, RECOVERY_POINT_INDEXING_FAILED
|
5155
5357
|
# })
|
5156
5358
|
#
|
5157
5359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotifications AWS API Documentation
|
@@ -5196,6 +5398,40 @@ module Aws::Backup
|
|
5196
5398
|
req.send_request(options)
|
5197
5399
|
end
|
5198
5400
|
|
5401
|
+
# Revokes access to a restore access backup vault, removing the ability
|
5402
|
+
# to restore from its recovery points and permanently deleting the
|
5403
|
+
# vault.
|
5404
|
+
#
|
5405
|
+
# @option params [required, String] :backup_vault_name
|
5406
|
+
# The name of the source backup vault associated with the restore access
|
5407
|
+
# backup vault to be revoked.
|
5408
|
+
#
|
5409
|
+
# @option params [required, String] :restore_access_backup_vault_arn
|
5410
|
+
# The ARN of the restore access backup vault to revoke.
|
5411
|
+
#
|
5412
|
+
# @option params [String] :requester_comment
|
5413
|
+
# A comment explaining the reason for revoking access to the restore
|
5414
|
+
# access backup vault.
|
5415
|
+
#
|
5416
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5417
|
+
#
|
5418
|
+
# @example Request syntax with placeholder values
|
5419
|
+
#
|
5420
|
+
# resp = client.revoke_restore_access_backup_vault({
|
5421
|
+
# backup_vault_name: "BackupVaultName", # required
|
5422
|
+
# restore_access_backup_vault_arn: "ARN", # required
|
5423
|
+
# requester_comment: "RequesterComment",
|
5424
|
+
# })
|
5425
|
+
#
|
5426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RevokeRestoreAccessBackupVault AWS API Documentation
|
5427
|
+
#
|
5428
|
+
# @overload revoke_restore_access_backup_vault(params = {})
|
5429
|
+
# @param [Hash] params ({})
|
5430
|
+
def revoke_restore_access_backup_vault(params = {}, options = {})
|
5431
|
+
req = build_request(:revoke_restore_access_backup_vault, params)
|
5432
|
+
req.send_request(options)
|
5433
|
+
end
|
5434
|
+
|
5199
5435
|
# Starts an on-demand backup job for the specified resource.
|
5200
5436
|
#
|
5201
5437
|
# @option params [required, String] :backup_vault_name
|
@@ -5217,6 +5453,9 @@ module Aws::Backup
|
|
5217
5453
|
# request with the same idempotency token results in a success message
|
5218
5454
|
# with no action taken.
|
5219
5455
|
#
|
5456
|
+
# **A suitable default value is auto-generated.** You should normally
|
5457
|
+
# not need to pass this option.**
|
5458
|
+
#
|
5220
5459
|
# @option params [Integer] :start_window_minutes
|
5221
5460
|
# A value in minutes after a backup is scheduled before a job will be
|
5222
5461
|
# canceled if it doesn't start successfully. This value is optional,
|
@@ -5370,6 +5609,9 @@ module Aws::Backup
|
|
5370
5609
|
# request with the same idempotency token results in a success message
|
5371
5610
|
# with no action taken.
|
5372
5611
|
#
|
5612
|
+
# **A suitable default value is auto-generated.** You should normally
|
5613
|
+
# not need to pass this option.**
|
5614
|
+
#
|
5373
5615
|
# @option params [Types::Lifecycle] :lifecycle
|
5374
5616
|
# Specifies the time period, in days, before a recovery point
|
5375
5617
|
# transitions to cold storage or is deleted.
|
@@ -5545,6 +5787,9 @@ module Aws::Backup
|
|
5545
5787
|
# request with the same idempotency token results in a success message
|
5546
5788
|
# with no action taken.
|
5547
5789
|
#
|
5790
|
+
# **A suitable default value is auto-generated.** You should normally
|
5791
|
+
# not need to pass this option.**
|
5792
|
+
#
|
5548
5793
|
# @option params [String] :resource_type
|
5549
5794
|
# Starts a job to restore a recovery point for one of the following
|
5550
5795
|
# resources:
|
@@ -5617,10 +5862,25 @@ module Aws::Backup
|
|
5617
5862
|
|
5618
5863
|
# Attempts to cancel a job to create a one-time backup of a resource.
|
5619
5864
|
#
|
5620
|
-
# This action is not supported for the following services:
|
5621
|
-
#
|
5622
|
-
#
|
5623
|
-
#
|
5865
|
+
# This action is not supported for the following services:
|
5866
|
+
#
|
5867
|
+
# * Amazon Aurora
|
5868
|
+
#
|
5869
|
+
# * Amazon DocumentDB (with MongoDB compatibility)
|
5870
|
+
#
|
5871
|
+
# * Amazon FSx for Lustre
|
5872
|
+
#
|
5873
|
+
# * Amazon FSx for NetApp ONTAP
|
5874
|
+
#
|
5875
|
+
# * Amazon FSx for OpenZFS
|
5876
|
+
#
|
5877
|
+
# * Amazon FSx for Windows File Server
|
5878
|
+
#
|
5879
|
+
# * Amazon Neptune
|
5880
|
+
#
|
5881
|
+
# * SAP HANA databases on Amazon EC2 instances
|
5882
|
+
#
|
5883
|
+
# * Amazon RDS
|
5624
5884
|
#
|
5625
5885
|
# @option params [required, String] :backup_job_id
|
5626
5886
|
# Uniquely identifies a request to Backup to back up a resource.
|
@@ -5642,21 +5902,10 @@ module Aws::Backup
|
|
5642
5902
|
req.send_request(options)
|
5643
5903
|
end
|
5644
5904
|
|
5645
|
-
# Assigns a set of key-value pairs to a
|
5646
|
-
# backup vault identified by an Amazon Resource Name (ARN).
|
5647
|
-
#
|
5648
|
-
# This API is supported for recovery points for resource types including
|
5649
|
-
# Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon
|
5650
|
-
# RDS.
|
5905
|
+
# Assigns a set of key-value pairs to a resource.
|
5651
5906
|
#
|
5652
5907
|
# @option params [required, String] :resource_arn
|
5653
|
-
#
|
5654
|
-
# depends on the type of the tagged resource.
|
5655
|
-
#
|
5656
|
-
# ARNs that do not include `backup` are incompatible with tagging.
|
5657
|
-
# `TagResource` and `UntagResource` with invalid ARNs will result in an
|
5658
|
-
# error. Acceptable ARN content can include `arn:aws:backup:us-east`.
|
5659
|
-
# Invalid ARN content may look like `arn:aws:ec2:us-east`.
|
5908
|
+
# The ARN that uniquely identifies the resource.
|
5660
5909
|
#
|
5661
5910
|
# @option params [required, Hash<String,String>] :tags
|
5662
5911
|
# Key-value pairs that are used to help organize your resources. You can
|
@@ -6340,7 +6589,7 @@ module Aws::Backup
|
|
6340
6589
|
tracer: tracer
|
6341
6590
|
)
|
6342
6591
|
context[:gem_name] = 'aws-sdk-backup'
|
6343
|
-
context[:gem_version] = '1.
|
6592
|
+
context[:gem_version] = '1.90.0'
|
6344
6593
|
Seahorse::Client::Request.new(handlers, context)
|
6345
6594
|
end
|
6346
6595
|
|