aws-sdk-backup 1.98.0 → 1.104.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 +30 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +770 -3
- data/lib/aws-sdk-backup/client_api.rb +425 -0
- data/lib/aws-sdk-backup/types.rb +1486 -53
- data/lib/aws-sdk-backup.rb +1 -1
- data/sig/client.rbs +221 -10
- data/sig/types.rbs +289 -0
- metadata +3 -3
|
@@ -582,6 +582,7 @@ module Aws::Backup
|
|
|
582
582
|
# {
|
|
583
583
|
# rule_name: "BackupRuleName", # required
|
|
584
584
|
# target_backup_vault_name: "BackupVaultName", # required
|
|
585
|
+
# target_logically_air_gapped_backup_vault_arn: "ARN",
|
|
585
586
|
# schedule_expression: "CronExpression",
|
|
586
587
|
# start_window_minutes: 1,
|
|
587
588
|
# completion_window_minutes: 1,
|
|
@@ -589,6 +590,7 @@ module Aws::Backup
|
|
|
589
590
|
# move_to_cold_storage_after_days: 1,
|
|
590
591
|
# delete_after_days: 1,
|
|
591
592
|
# opt_in_to_archive_for_supported_resources: false,
|
|
593
|
+
# delete_after_event: "DELETE_AFTER_COPY", # accepts DELETE_AFTER_COPY
|
|
592
594
|
# },
|
|
593
595
|
# recovery_point_tags: {
|
|
594
596
|
# "TagKey" => "TagValue",
|
|
@@ -599,6 +601,7 @@ module Aws::Backup
|
|
|
599
601
|
# move_to_cold_storage_after_days: 1,
|
|
600
602
|
# delete_after_days: 1,
|
|
601
603
|
# opt_in_to_archive_for_supported_resources: false,
|
|
604
|
+
# delete_after_event: "DELETE_AFTER_COPY", # accepts DELETE_AFTER_COPY
|
|
602
605
|
# },
|
|
603
606
|
# destination_backup_vault_arn: "ARN", # required
|
|
604
607
|
# },
|
|
@@ -610,6 +613,12 @@ module Aws::Backup
|
|
|
610
613
|
# resource_types: ["ResourceType"],
|
|
611
614
|
# },
|
|
612
615
|
# ],
|
|
616
|
+
# scan_actions: [
|
|
617
|
+
# {
|
|
618
|
+
# malware_scanner: "GUARDDUTY", # accepts GUARDDUTY
|
|
619
|
+
# scan_mode: "FULL_SCAN", # accepts FULL_SCAN, INCREMENTAL_SCAN
|
|
620
|
+
# },
|
|
621
|
+
# ],
|
|
613
622
|
# },
|
|
614
623
|
# ],
|
|
615
624
|
# advanced_backup_settings: [
|
|
@@ -620,6 +629,13 @@ module Aws::Backup
|
|
|
620
629
|
# },
|
|
621
630
|
# },
|
|
622
631
|
# ],
|
|
632
|
+
# scan_settings: [
|
|
633
|
+
# {
|
|
634
|
+
# malware_scanner: "GUARDDUTY", # accepts GUARDDUTY
|
|
635
|
+
# resource_types: ["ResourceType"],
|
|
636
|
+
# scanner_role_arn: "IAMRoleArn",
|
|
637
|
+
# },
|
|
638
|
+
# ],
|
|
623
639
|
# },
|
|
624
640
|
# backup_plan_tags: {
|
|
625
641
|
# "TagKey" => "TagValue",
|
|
@@ -1005,6 +1021,12 @@ module Aws::Backup
|
|
|
1005
1021
|
# The maximum retention period that the vault retains its recovery
|
|
1006
1022
|
# points.
|
|
1007
1023
|
#
|
|
1024
|
+
# @option params [String] :encryption_key_arn
|
|
1025
|
+
# The ARN of the customer-managed KMS key to use for encrypting the
|
|
1026
|
+
# logically air-gapped backup vault. If not specified, the vault will be
|
|
1027
|
+
# encrypted with an Amazon Web Services-owned key managed by Amazon Web
|
|
1028
|
+
# Services Backup.
|
|
1029
|
+
#
|
|
1008
1030
|
# @return [Types::CreateLogicallyAirGappedBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1009
1031
|
#
|
|
1010
1032
|
# * {Types::CreateLogicallyAirGappedBackupVaultOutput#backup_vault_name #backup_vault_name} => String
|
|
@@ -1022,6 +1044,7 @@ module Aws::Backup
|
|
|
1022
1044
|
# creator_request_id: "string",
|
|
1023
1045
|
# min_retention_days: 1, # required
|
|
1024
1046
|
# max_retention_days: 1, # required
|
|
1047
|
+
# encryption_key_arn: "ARN",
|
|
1025
1048
|
# })
|
|
1026
1049
|
#
|
|
1027
1050
|
# @example Response structure
|
|
@@ -1066,7 +1089,8 @@ module Aws::Backup
|
|
|
1066
1089
|
# a report template. The report templates are:
|
|
1067
1090
|
#
|
|
1068
1091
|
# `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
|
|
1069
|
-
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
|
|
1092
|
+
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT |
|
|
1093
|
+
# SCAN_JOB_REPORT `
|
|
1070
1094
|
#
|
|
1071
1095
|
# If the report template is `RESOURCE_COMPLIANCE_REPORT` or
|
|
1072
1096
|
# `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the
|
|
@@ -1357,6 +1381,78 @@ module Aws::Backup
|
|
|
1357
1381
|
req.send_request(options)
|
|
1358
1382
|
end
|
|
1359
1383
|
|
|
1384
|
+
# Creates a tiering configuration.
|
|
1385
|
+
#
|
|
1386
|
+
# A tiering configuration enables automatic movement of backup data to a
|
|
1387
|
+
# lower-cost storage tier based on the age of backed-up objects in the
|
|
1388
|
+
# backup vault.
|
|
1389
|
+
#
|
|
1390
|
+
# Each vault can only have one vault-specific tiering configuration, in
|
|
1391
|
+
# addition to any global configuration that applies to all vaults.
|
|
1392
|
+
#
|
|
1393
|
+
# @option params [required, Types::TieringConfigurationInputForCreate] :tiering_configuration
|
|
1394
|
+
# A tiering configuration must contain a unique
|
|
1395
|
+
# `TieringConfigurationName` string you create and must contain a
|
|
1396
|
+
# `BackupVaultName` and `ResourceSelection`. You may optionally include
|
|
1397
|
+
# a `CreatorRequestId` string.
|
|
1398
|
+
#
|
|
1399
|
+
# The `TieringConfigurationName` is a unique string that is the name of
|
|
1400
|
+
# the tiering configuration. This cannot be changed after creation, and
|
|
1401
|
+
# it must consist of only alphanumeric characters and underscores.
|
|
1402
|
+
#
|
|
1403
|
+
# @option params [Hash<String,String>] :tiering_configuration_tags
|
|
1404
|
+
# The tags to assign to the tiering configuration.
|
|
1405
|
+
#
|
|
1406
|
+
# @option params [String] :creator_request_id
|
|
1407
|
+
# This is a unique string that identifies the request and allows failed
|
|
1408
|
+
# requests to be retried without the risk of running the operation
|
|
1409
|
+
# twice. This parameter is optional. If used, this parameter must
|
|
1410
|
+
# contain 1 to 50 alphanumeric or '-\_.' characters.
|
|
1411
|
+
#
|
|
1412
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1413
|
+
# not need to pass this option.**
|
|
1414
|
+
#
|
|
1415
|
+
# @return [Types::CreateTieringConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1416
|
+
#
|
|
1417
|
+
# * {Types::CreateTieringConfigurationOutput#tiering_configuration_arn #tiering_configuration_arn} => String
|
|
1418
|
+
# * {Types::CreateTieringConfigurationOutput#tiering_configuration_name #tiering_configuration_name} => String
|
|
1419
|
+
# * {Types::CreateTieringConfigurationOutput#creation_time #creation_time} => Time
|
|
1420
|
+
#
|
|
1421
|
+
# @example Request syntax with placeholder values
|
|
1422
|
+
#
|
|
1423
|
+
# resp = client.create_tiering_configuration({
|
|
1424
|
+
# tiering_configuration: { # required
|
|
1425
|
+
# tiering_configuration_name: "TieringConfigurationName", # required
|
|
1426
|
+
# backup_vault_name: "BackupVaultNameOrWildcard", # required
|
|
1427
|
+
# resource_selection: [ # required
|
|
1428
|
+
# {
|
|
1429
|
+
# resources: ["ARN"], # required
|
|
1430
|
+
# tiering_down_settings_in_days: 1, # required
|
|
1431
|
+
# resource_type: "ResourceType", # required
|
|
1432
|
+
# },
|
|
1433
|
+
# ],
|
|
1434
|
+
# },
|
|
1435
|
+
# tiering_configuration_tags: {
|
|
1436
|
+
# "TagKey" => "TagValue",
|
|
1437
|
+
# },
|
|
1438
|
+
# creator_request_id: "CreatorRequestId",
|
|
1439
|
+
# })
|
|
1440
|
+
#
|
|
1441
|
+
# @example Response structure
|
|
1442
|
+
#
|
|
1443
|
+
# resp.tiering_configuration_arn #=> String
|
|
1444
|
+
# resp.tiering_configuration_name #=> String
|
|
1445
|
+
# resp.creation_time #=> Time
|
|
1446
|
+
#
|
|
1447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateTieringConfiguration AWS API Documentation
|
|
1448
|
+
#
|
|
1449
|
+
# @overload create_tiering_configuration(params = {})
|
|
1450
|
+
# @param [Hash] params ({})
|
|
1451
|
+
def create_tiering_configuration(params = {}, options = {})
|
|
1452
|
+
req = build_request(:create_tiering_configuration, params)
|
|
1453
|
+
req.send_request(options)
|
|
1454
|
+
end
|
|
1455
|
+
|
|
1360
1456
|
# Deletes a backup plan. A backup plan can only be deleted after all
|
|
1361
1457
|
# associated selections of resources have been deleted. Deleting a
|
|
1362
1458
|
# backup plan deletes the current version of a backup plan. Previous
|
|
@@ -1681,6 +1777,29 @@ module Aws::Backup
|
|
|
1681
1777
|
req.send_request(options)
|
|
1682
1778
|
end
|
|
1683
1779
|
|
|
1780
|
+
# Deletes the tiering configuration specified by a tiering configuration
|
|
1781
|
+
# name.
|
|
1782
|
+
#
|
|
1783
|
+
# @option params [required, String] :tiering_configuration_name
|
|
1784
|
+
# The unique name of a tiering configuration.
|
|
1785
|
+
#
|
|
1786
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1787
|
+
#
|
|
1788
|
+
# @example Request syntax with placeholder values
|
|
1789
|
+
#
|
|
1790
|
+
# resp = client.delete_tiering_configuration({
|
|
1791
|
+
# tiering_configuration_name: "TieringConfigurationName", # required
|
|
1792
|
+
# })
|
|
1793
|
+
#
|
|
1794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteTieringConfiguration AWS API Documentation
|
|
1795
|
+
#
|
|
1796
|
+
# @overload delete_tiering_configuration(params = {})
|
|
1797
|
+
# @param [Hash] params ({})
|
|
1798
|
+
def delete_tiering_configuration(params = {}, options = {})
|
|
1799
|
+
req = build_request(:delete_tiering_configuration, params)
|
|
1800
|
+
req.send_request(options)
|
|
1801
|
+
end
|
|
1802
|
+
|
|
1684
1803
|
# Returns backup job details for the specified `BackupJobId`.
|
|
1685
1804
|
#
|
|
1686
1805
|
# @option params [required, String] :backup_job_id
|
|
@@ -1735,6 +1854,7 @@ module Aws::Backup
|
|
|
1735
1854
|
# resp.recovery_point_lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
1736
1855
|
# resp.recovery_point_lifecycle.delete_after_days #=> Integer
|
|
1737
1856
|
# resp.recovery_point_lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
1857
|
+
# resp.recovery_point_lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
1738
1858
|
# resp.backup_vault_arn #=> String
|
|
1739
1859
|
# resp.vault_type #=> String
|
|
1740
1860
|
# resp.vault_lock_state #=> String
|
|
@@ -1810,6 +1930,7 @@ module Aws::Backup
|
|
|
1810
1930
|
# * {Types::DescribeBackupVaultOutput#mpa_approval_team_arn #mpa_approval_team_arn} => String
|
|
1811
1931
|
# * {Types::DescribeBackupVaultOutput#mpa_session_arn #mpa_session_arn} => String
|
|
1812
1932
|
# * {Types::DescribeBackupVaultOutput#latest_mpa_approval_team_update #latest_mpa_approval_team_update} => Types::LatestMpaApprovalTeamUpdate
|
|
1933
|
+
# * {Types::DescribeBackupVaultOutput#encryption_key_type #encryption_key_type} => String
|
|
1813
1934
|
#
|
|
1814
1935
|
# @example Request syntax with placeholder values
|
|
1815
1936
|
#
|
|
@@ -1840,6 +1961,7 @@ module Aws::Backup
|
|
|
1840
1961
|
# resp.latest_mpa_approval_team_update.status_message #=> String
|
|
1841
1962
|
# resp.latest_mpa_approval_team_update.initiation_date #=> Time
|
|
1842
1963
|
# resp.latest_mpa_approval_team_update.expiry_date #=> Time
|
|
1964
|
+
# resp.encryption_key_type #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY"
|
|
1843
1965
|
#
|
|
1844
1966
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVault AWS API Documentation
|
|
1845
1967
|
#
|
|
@@ -1879,6 +2001,7 @@ module Aws::Backup
|
|
|
1879
2001
|
# resp.copy_job.destination_recovery_point_lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
1880
2002
|
# resp.copy_job.destination_recovery_point_lifecycle.delete_after_days #=> Integer
|
|
1881
2003
|
# resp.copy_job.destination_recovery_point_lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2004
|
+
# resp.copy_job.destination_recovery_point_lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
1882
2005
|
# resp.copy_job.resource_arn #=> String
|
|
1883
2006
|
# resp.copy_job.creation_date #=> Time
|
|
1884
2007
|
# resp.copy_job.completion_date #=> Time
|
|
@@ -1894,6 +2017,7 @@ module Aws::Backup
|
|
|
1894
2017
|
# resp.copy_job.created_by.backup_rule_name #=> String
|
|
1895
2018
|
# resp.copy_job.created_by.backup_rule_cron #=> String
|
|
1896
2019
|
# resp.copy_job.created_by.backup_rule_timezone #=> String
|
|
2020
|
+
# resp.copy_job.created_by_backup_job_id #=> String
|
|
1897
2021
|
# resp.copy_job.resource_type #=> String
|
|
1898
2022
|
# resp.copy_job.parent_job_id #=> String
|
|
1899
2023
|
# resp.copy_job.is_parent #=> Boolean
|
|
@@ -2082,6 +2206,8 @@ module Aws::Backup
|
|
|
2082
2206
|
# * {Types::DescribeRecoveryPointOutput#vault_type #vault_type} => String
|
|
2083
2207
|
# * {Types::DescribeRecoveryPointOutput#index_status #index_status} => String
|
|
2084
2208
|
# * {Types::DescribeRecoveryPointOutput#index_status_message #index_status_message} => String
|
|
2209
|
+
# * {Types::DescribeRecoveryPointOutput#encryption_key_type #encryption_key_type} => String
|
|
2210
|
+
# * {Types::DescribeRecoveryPointOutput#scan_results #scan_results} => Array<Types::ScanResult>
|
|
2085
2211
|
#
|
|
2086
2212
|
# @example Request syntax with placeholder values
|
|
2087
2213
|
#
|
|
@@ -2119,6 +2245,7 @@ module Aws::Backup
|
|
|
2119
2245
|
# resp.lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
2120
2246
|
# resp.lifecycle.delete_after_days #=> Integer
|
|
2121
2247
|
# resp.lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2248
|
+
# resp.lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
2122
2249
|
# resp.encryption_key_arn #=> String
|
|
2123
2250
|
# resp.is_encrypted #=> Boolean
|
|
2124
2251
|
# resp.storage_class #=> String, one of "WARM", "COLD", "DELETED"
|
|
@@ -2130,6 +2257,13 @@ module Aws::Backup
|
|
|
2130
2257
|
# resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
|
2131
2258
|
# resp.index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
|
|
2132
2259
|
# resp.index_status_message #=> String
|
|
2260
|
+
# resp.encryption_key_type #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY"
|
|
2261
|
+
# resp.scan_results #=> Array
|
|
2262
|
+
# resp.scan_results[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
2263
|
+
# resp.scan_results[0].scan_job_state #=> String, one of "COMPLETED", "COMPLETED_WITH_ISSUES", "FAILED", "CANCELED"
|
|
2264
|
+
# resp.scan_results[0].last_scan_timestamp #=> Time
|
|
2265
|
+
# resp.scan_results[0].findings #=> Array
|
|
2266
|
+
# resp.scan_results[0].findings[0] #=> String, one of "MALWARE"
|
|
2133
2267
|
#
|
|
2134
2268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPoint AWS API Documentation
|
|
2135
2269
|
#
|
|
@@ -2285,6 +2419,8 @@ module Aws::Backup
|
|
|
2285
2419
|
# * {Types::DescribeRestoreJobOutput#validation_status_message #validation_status_message} => String
|
|
2286
2420
|
# * {Types::DescribeRestoreJobOutput#deletion_status #deletion_status} => String
|
|
2287
2421
|
# * {Types::DescribeRestoreJobOutput#deletion_status_message #deletion_status_message} => String
|
|
2422
|
+
# * {Types::DescribeRestoreJobOutput#is_parent #is_parent} => Boolean
|
|
2423
|
+
# * {Types::DescribeRestoreJobOutput#parent_job_id #parent_job_id} => String
|
|
2288
2424
|
#
|
|
2289
2425
|
# @example Request syntax with placeholder values
|
|
2290
2426
|
#
|
|
@@ -2315,6 +2451,8 @@ module Aws::Backup
|
|
|
2315
2451
|
# resp.validation_status_message #=> String
|
|
2316
2452
|
# resp.deletion_status #=> String, one of "DELETING", "FAILED", "SUCCESSFUL"
|
|
2317
2453
|
# resp.deletion_status_message #=> String
|
|
2454
|
+
# resp.is_parent #=> Boolean
|
|
2455
|
+
# resp.parent_job_id #=> String
|
|
2318
2456
|
#
|
|
2319
2457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJob AWS API Documentation
|
|
2320
2458
|
#
|
|
@@ -2325,6 +2463,75 @@ module Aws::Backup
|
|
|
2325
2463
|
req.send_request(options)
|
|
2326
2464
|
end
|
|
2327
2465
|
|
|
2466
|
+
# Returns scan job details for the specified ScanJobID.
|
|
2467
|
+
#
|
|
2468
|
+
# @option params [required, String] :scan_job_id
|
|
2469
|
+
# Uniquely identifies a request to Backup to scan a resource.
|
|
2470
|
+
#
|
|
2471
|
+
# @return [Types::DescribeScanJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2472
|
+
#
|
|
2473
|
+
# * {Types::DescribeScanJobOutput#account_id #account_id} => String
|
|
2474
|
+
# * {Types::DescribeScanJobOutput#backup_vault_arn #backup_vault_arn} => String
|
|
2475
|
+
# * {Types::DescribeScanJobOutput#backup_vault_name #backup_vault_name} => String
|
|
2476
|
+
# * {Types::DescribeScanJobOutput#completion_date #completion_date} => Time
|
|
2477
|
+
# * {Types::DescribeScanJobOutput#created_by #created_by} => Types::ScanJobCreator
|
|
2478
|
+
# * {Types::DescribeScanJobOutput#creation_date #creation_date} => Time
|
|
2479
|
+
# * {Types::DescribeScanJobOutput#iam_role_arn #iam_role_arn} => String
|
|
2480
|
+
# * {Types::DescribeScanJobOutput#malware_scanner #malware_scanner} => String
|
|
2481
|
+
# * {Types::DescribeScanJobOutput#recovery_point_arn #recovery_point_arn} => String
|
|
2482
|
+
# * {Types::DescribeScanJobOutput#resource_arn #resource_arn} => String
|
|
2483
|
+
# * {Types::DescribeScanJobOutput#resource_name #resource_name} => String
|
|
2484
|
+
# * {Types::DescribeScanJobOutput#resource_type #resource_type} => String
|
|
2485
|
+
# * {Types::DescribeScanJobOutput#scan_base_recovery_point_arn #scan_base_recovery_point_arn} => String
|
|
2486
|
+
# * {Types::DescribeScanJobOutput#scan_id #scan_id} => String
|
|
2487
|
+
# * {Types::DescribeScanJobOutput#scan_job_id #scan_job_id} => String
|
|
2488
|
+
# * {Types::DescribeScanJobOutput#scan_mode #scan_mode} => String
|
|
2489
|
+
# * {Types::DescribeScanJobOutput#scan_result #scan_result} => Types::ScanResultInfo
|
|
2490
|
+
# * {Types::DescribeScanJobOutput#scanner_role_arn #scanner_role_arn} => String
|
|
2491
|
+
# * {Types::DescribeScanJobOutput#state #state} => String
|
|
2492
|
+
# * {Types::DescribeScanJobOutput#status_message #status_message} => String
|
|
2493
|
+
#
|
|
2494
|
+
# @example Request syntax with placeholder values
|
|
2495
|
+
#
|
|
2496
|
+
# resp = client.describe_scan_job({
|
|
2497
|
+
# scan_job_id: "String", # required
|
|
2498
|
+
# })
|
|
2499
|
+
#
|
|
2500
|
+
# @example Response structure
|
|
2501
|
+
#
|
|
2502
|
+
# resp.account_id #=> String
|
|
2503
|
+
# resp.backup_vault_arn #=> String
|
|
2504
|
+
# resp.backup_vault_name #=> String
|
|
2505
|
+
# resp.completion_date #=> Time
|
|
2506
|
+
# resp.created_by.backup_plan_arn #=> String
|
|
2507
|
+
# resp.created_by.backup_plan_id #=> String
|
|
2508
|
+
# resp.created_by.backup_plan_version #=> String
|
|
2509
|
+
# resp.created_by.backup_rule_id #=> String
|
|
2510
|
+
# resp.creation_date #=> Time
|
|
2511
|
+
# resp.iam_role_arn #=> String
|
|
2512
|
+
# resp.malware_scanner #=> String, one of "GUARDDUTY"
|
|
2513
|
+
# resp.recovery_point_arn #=> String
|
|
2514
|
+
# resp.resource_arn #=> String
|
|
2515
|
+
# resp.resource_name #=> String
|
|
2516
|
+
# resp.resource_type #=> String, one of "EBS", "EC2", "S3"
|
|
2517
|
+
# resp.scan_base_recovery_point_arn #=> String
|
|
2518
|
+
# resp.scan_id #=> String
|
|
2519
|
+
# resp.scan_job_id #=> String
|
|
2520
|
+
# resp.scan_mode #=> String, one of "FULL_SCAN", "INCREMENTAL_SCAN"
|
|
2521
|
+
# resp.scan_result.scan_result_status #=> String, one of "NO_THREATS_FOUND", "THREATS_FOUND"
|
|
2522
|
+
# resp.scanner_role_arn #=> String
|
|
2523
|
+
# resp.state #=> String, one of "CANCELED", "COMPLETED", "COMPLETED_WITH_ISSUES", "CREATED", "FAILED", "RUNNING"
|
|
2524
|
+
# resp.status_message #=> String
|
|
2525
|
+
#
|
|
2526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeScanJob AWS API Documentation
|
|
2527
|
+
#
|
|
2528
|
+
# @overload describe_scan_job(params = {})
|
|
2529
|
+
# @param [Hash] params ({})
|
|
2530
|
+
def describe_scan_job(params = {}, options = {})
|
|
2531
|
+
req = build_request(:describe_scan_job, params)
|
|
2532
|
+
req.send_request(options)
|
|
2533
|
+
end
|
|
2534
|
+
|
|
2328
2535
|
# Removes the association between an MPA approval team and a backup
|
|
2329
2536
|
# vault, disabling the MPA approval workflow for restore operations.
|
|
2330
2537
|
#
|
|
@@ -2492,12 +2699,14 @@ module Aws::Backup
|
|
|
2492
2699
|
# resp.backup_plan.rules #=> Array
|
|
2493
2700
|
# resp.backup_plan.rules[0].rule_name #=> String
|
|
2494
2701
|
# resp.backup_plan.rules[0].target_backup_vault_name #=> String
|
|
2702
|
+
# resp.backup_plan.rules[0].target_logically_air_gapped_backup_vault_arn #=> String
|
|
2495
2703
|
# resp.backup_plan.rules[0].schedule_expression #=> String
|
|
2496
2704
|
# resp.backup_plan.rules[0].start_window_minutes #=> Integer
|
|
2497
2705
|
# resp.backup_plan.rules[0].completion_window_minutes #=> Integer
|
|
2498
2706
|
# resp.backup_plan.rules[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
2499
2707
|
# resp.backup_plan.rules[0].lifecycle.delete_after_days #=> Integer
|
|
2500
2708
|
# resp.backup_plan.rules[0].lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2709
|
+
# resp.backup_plan.rules[0].lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
2501
2710
|
# resp.backup_plan.rules[0].recovery_point_tags #=> Hash
|
|
2502
2711
|
# resp.backup_plan.rules[0].recovery_point_tags["TagKey"] #=> String
|
|
2503
2712
|
# resp.backup_plan.rules[0].rule_id #=> String
|
|
@@ -2505,16 +2714,25 @@ module Aws::Backup
|
|
|
2505
2714
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
2506
2715
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
|
2507
2716
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2717
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
2508
2718
|
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
|
2509
2719
|
# resp.backup_plan.rules[0].enable_continuous_backup #=> Boolean
|
|
2510
2720
|
# resp.backup_plan.rules[0].schedule_expression_timezone #=> String
|
|
2511
2721
|
# resp.backup_plan.rules[0].index_actions #=> Array
|
|
2512
2722
|
# resp.backup_plan.rules[0].index_actions[0].resource_types #=> Array
|
|
2513
2723
|
# resp.backup_plan.rules[0].index_actions[0].resource_types[0] #=> String
|
|
2724
|
+
# resp.backup_plan.rules[0].scan_actions #=> Array
|
|
2725
|
+
# resp.backup_plan.rules[0].scan_actions[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
2726
|
+
# resp.backup_plan.rules[0].scan_actions[0].scan_mode #=> String, one of "FULL_SCAN", "INCREMENTAL_SCAN"
|
|
2514
2727
|
# resp.backup_plan.advanced_backup_settings #=> Array
|
|
2515
2728
|
# resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
|
|
2516
2729
|
# resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
|
|
2517
2730
|
# resp.backup_plan.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
|
2731
|
+
# resp.backup_plan.scan_settings #=> Array
|
|
2732
|
+
# resp.backup_plan.scan_settings[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
2733
|
+
# resp.backup_plan.scan_settings[0].resource_types #=> Array
|
|
2734
|
+
# resp.backup_plan.scan_settings[0].resource_types[0] #=> String
|
|
2735
|
+
# resp.backup_plan.scan_settings[0].scanner_role_arn #=> String
|
|
2518
2736
|
# resp.backup_plan_id #=> String
|
|
2519
2737
|
# resp.backup_plan_arn #=> String
|
|
2520
2738
|
# resp.version_id #=> String
|
|
@@ -2561,12 +2779,14 @@ module Aws::Backup
|
|
|
2561
2779
|
# resp.backup_plan.rules #=> Array
|
|
2562
2780
|
# resp.backup_plan.rules[0].rule_name #=> String
|
|
2563
2781
|
# resp.backup_plan.rules[0].target_backup_vault_name #=> String
|
|
2782
|
+
# resp.backup_plan.rules[0].target_logically_air_gapped_backup_vault_arn #=> String
|
|
2564
2783
|
# resp.backup_plan.rules[0].schedule_expression #=> String
|
|
2565
2784
|
# resp.backup_plan.rules[0].start_window_minutes #=> Integer
|
|
2566
2785
|
# resp.backup_plan.rules[0].completion_window_minutes #=> Integer
|
|
2567
2786
|
# resp.backup_plan.rules[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
2568
2787
|
# resp.backup_plan.rules[0].lifecycle.delete_after_days #=> Integer
|
|
2569
2788
|
# resp.backup_plan.rules[0].lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2789
|
+
# resp.backup_plan.rules[0].lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
2570
2790
|
# resp.backup_plan.rules[0].recovery_point_tags #=> Hash
|
|
2571
2791
|
# resp.backup_plan.rules[0].recovery_point_tags["TagKey"] #=> String
|
|
2572
2792
|
# resp.backup_plan.rules[0].rule_id #=> String
|
|
@@ -2574,16 +2794,25 @@ module Aws::Backup
|
|
|
2574
2794
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
2575
2795
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
|
2576
2796
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2797
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
2577
2798
|
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
|
2578
2799
|
# resp.backup_plan.rules[0].enable_continuous_backup #=> Boolean
|
|
2579
2800
|
# resp.backup_plan.rules[0].schedule_expression_timezone #=> String
|
|
2580
2801
|
# resp.backup_plan.rules[0].index_actions #=> Array
|
|
2581
2802
|
# resp.backup_plan.rules[0].index_actions[0].resource_types #=> Array
|
|
2582
2803
|
# resp.backup_plan.rules[0].index_actions[0].resource_types[0] #=> String
|
|
2804
|
+
# resp.backup_plan.rules[0].scan_actions #=> Array
|
|
2805
|
+
# resp.backup_plan.rules[0].scan_actions[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
2806
|
+
# resp.backup_plan.rules[0].scan_actions[0].scan_mode #=> String, one of "FULL_SCAN", "INCREMENTAL_SCAN"
|
|
2583
2807
|
# resp.backup_plan.advanced_backup_settings #=> Array
|
|
2584
2808
|
# resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
|
|
2585
2809
|
# resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
|
|
2586
2810
|
# resp.backup_plan.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
|
2811
|
+
# resp.backup_plan.scan_settings #=> Array
|
|
2812
|
+
# resp.backup_plan.scan_settings[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
2813
|
+
# resp.backup_plan.scan_settings[0].resource_types #=> Array
|
|
2814
|
+
# resp.backup_plan.scan_settings[0].resource_types[0] #=> String
|
|
2815
|
+
# resp.backup_plan.scan_settings[0].scanner_role_arn #=> String
|
|
2587
2816
|
#
|
|
2588
2817
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON AWS API Documentation
|
|
2589
2818
|
#
|
|
@@ -2615,12 +2844,14 @@ module Aws::Backup
|
|
|
2615
2844
|
# resp.backup_plan_document.rules #=> Array
|
|
2616
2845
|
# resp.backup_plan_document.rules[0].rule_name #=> String
|
|
2617
2846
|
# resp.backup_plan_document.rules[0].target_backup_vault_name #=> String
|
|
2847
|
+
# resp.backup_plan_document.rules[0].target_logically_air_gapped_backup_vault_arn #=> String
|
|
2618
2848
|
# resp.backup_plan_document.rules[0].schedule_expression #=> String
|
|
2619
2849
|
# resp.backup_plan_document.rules[0].start_window_minutes #=> Integer
|
|
2620
2850
|
# resp.backup_plan_document.rules[0].completion_window_minutes #=> Integer
|
|
2621
2851
|
# resp.backup_plan_document.rules[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
2622
2852
|
# resp.backup_plan_document.rules[0].lifecycle.delete_after_days #=> Integer
|
|
2623
2853
|
# resp.backup_plan_document.rules[0].lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2854
|
+
# resp.backup_plan_document.rules[0].lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
2624
2855
|
# resp.backup_plan_document.rules[0].recovery_point_tags #=> Hash
|
|
2625
2856
|
# resp.backup_plan_document.rules[0].recovery_point_tags["TagKey"] #=> String
|
|
2626
2857
|
# resp.backup_plan_document.rules[0].rule_id #=> String
|
|
@@ -2628,16 +2859,25 @@ module Aws::Backup
|
|
|
2628
2859
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
2629
2860
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
|
2630
2861
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
2862
|
+
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
2631
2863
|
# resp.backup_plan_document.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
|
2632
2864
|
# resp.backup_plan_document.rules[0].enable_continuous_backup #=> Boolean
|
|
2633
2865
|
# resp.backup_plan_document.rules[0].schedule_expression_timezone #=> String
|
|
2634
2866
|
# resp.backup_plan_document.rules[0].index_actions #=> Array
|
|
2635
2867
|
# resp.backup_plan_document.rules[0].index_actions[0].resource_types #=> Array
|
|
2636
2868
|
# resp.backup_plan_document.rules[0].index_actions[0].resource_types[0] #=> String
|
|
2869
|
+
# resp.backup_plan_document.rules[0].scan_actions #=> Array
|
|
2870
|
+
# resp.backup_plan_document.rules[0].scan_actions[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
2871
|
+
# resp.backup_plan_document.rules[0].scan_actions[0].scan_mode #=> String, one of "FULL_SCAN", "INCREMENTAL_SCAN"
|
|
2637
2872
|
# resp.backup_plan_document.advanced_backup_settings #=> Array
|
|
2638
2873
|
# resp.backup_plan_document.advanced_backup_settings[0].resource_type #=> String
|
|
2639
2874
|
# resp.backup_plan_document.advanced_backup_settings[0].backup_options #=> Hash
|
|
2640
2875
|
# resp.backup_plan_document.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
|
2876
|
+
# resp.backup_plan_document.scan_settings #=> Array
|
|
2877
|
+
# resp.backup_plan_document.scan_settings[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
2878
|
+
# resp.backup_plan_document.scan_settings[0].resource_types #=> Array
|
|
2879
|
+
# resp.backup_plan_document.scan_settings[0].resource_types[0] #=> String
|
|
2880
|
+
# resp.backup_plan_document.scan_settings[0].scanner_role_arn #=> String
|
|
2641
2881
|
#
|
|
2642
2882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate AWS API Documentation
|
|
2643
2883
|
#
|
|
@@ -3128,6 +3368,46 @@ module Aws::Backup
|
|
|
3128
3368
|
req.send_request(options)
|
|
3129
3369
|
end
|
|
3130
3370
|
|
|
3371
|
+
# Returns `TieringConfiguration` details for the specified
|
|
3372
|
+
# `TieringConfigurationName`. The details are the body of a tiering
|
|
3373
|
+
# configuration in JSON format, in addition to configuration metadata.
|
|
3374
|
+
#
|
|
3375
|
+
# @option params [required, String] :tiering_configuration_name
|
|
3376
|
+
# The unique name of a tiering configuration.
|
|
3377
|
+
#
|
|
3378
|
+
# @return [Types::GetTieringConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3379
|
+
#
|
|
3380
|
+
# * {Types::GetTieringConfigurationOutput#tiering_configuration #tiering_configuration} => Types::TieringConfiguration
|
|
3381
|
+
#
|
|
3382
|
+
# @example Request syntax with placeholder values
|
|
3383
|
+
#
|
|
3384
|
+
# resp = client.get_tiering_configuration({
|
|
3385
|
+
# tiering_configuration_name: "TieringConfigurationName", # required
|
|
3386
|
+
# })
|
|
3387
|
+
#
|
|
3388
|
+
# @example Response structure
|
|
3389
|
+
#
|
|
3390
|
+
# resp.tiering_configuration.tiering_configuration_name #=> String
|
|
3391
|
+
# resp.tiering_configuration.tiering_configuration_arn #=> String
|
|
3392
|
+
# resp.tiering_configuration.backup_vault_name #=> String
|
|
3393
|
+
# resp.tiering_configuration.resource_selection #=> Array
|
|
3394
|
+
# resp.tiering_configuration.resource_selection[0].resources #=> Array
|
|
3395
|
+
# resp.tiering_configuration.resource_selection[0].resources[0] #=> String
|
|
3396
|
+
# resp.tiering_configuration.resource_selection[0].tiering_down_settings_in_days #=> Integer
|
|
3397
|
+
# resp.tiering_configuration.resource_selection[0].resource_type #=> String
|
|
3398
|
+
# resp.tiering_configuration.creator_request_id #=> String
|
|
3399
|
+
# resp.tiering_configuration.creation_time #=> Time
|
|
3400
|
+
# resp.tiering_configuration.last_updated_time #=> Time
|
|
3401
|
+
#
|
|
3402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetTieringConfiguration AWS API Documentation
|
|
3403
|
+
#
|
|
3404
|
+
# @overload get_tiering_configuration(params = {})
|
|
3405
|
+
# @param [Hash] params ({})
|
|
3406
|
+
def get_tiering_configuration(params = {}, options = {})
|
|
3407
|
+
req = build_request(:get_tiering_configuration, params)
|
|
3408
|
+
req.send_request(options)
|
|
3409
|
+
end
|
|
3410
|
+
|
|
3131
3411
|
# This is a request for a summary of backup jobs created or running
|
|
3132
3412
|
# within the most recent 30 days. You can include parameters AccountID,
|
|
3133
3413
|
# State, ResourceType, MessageCategory, AggregationPeriod, MaxResults,
|
|
@@ -3424,6 +3704,7 @@ module Aws::Backup
|
|
|
3424
3704
|
# resp.backup_jobs[0].recovery_point_lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
3425
3705
|
# resp.backup_jobs[0].recovery_point_lifecycle.delete_after_days #=> Integer
|
|
3426
3706
|
# resp.backup_jobs[0].recovery_point_lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
3707
|
+
# resp.backup_jobs[0].recovery_point_lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
3427
3708
|
# resp.backup_jobs[0].encryption_key_arn #=> String
|
|
3428
3709
|
# resp.backup_jobs[0].is_encrypted #=> Boolean
|
|
3429
3710
|
# resp.backup_jobs[0].resource_arn #=> String
|
|
@@ -3718,6 +3999,7 @@ module Aws::Backup
|
|
|
3718
3999
|
# resp.backup_vault_list[0].min_retention_days #=> Integer
|
|
3719
4000
|
# resp.backup_vault_list[0].max_retention_days #=> Integer
|
|
3720
4001
|
# resp.backup_vault_list[0].lock_date #=> Time
|
|
4002
|
+
# resp.backup_vault_list[0].encryption_key_type #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY"
|
|
3721
4003
|
# resp.next_token #=> String
|
|
3722
4004
|
#
|
|
3723
4005
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupVaults AWS API Documentation
|
|
@@ -3952,6 +4234,9 @@ module Aws::Backup
|
|
|
3952
4234
|
#
|
|
3953
4235
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
|
3954
4236
|
#
|
|
4237
|
+
# @option params [String] :by_source_recovery_point_arn
|
|
4238
|
+
# Filters copy jobs by the specified source recovery point ARN.
|
|
4239
|
+
#
|
|
3955
4240
|
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3956
4241
|
#
|
|
3957
4242
|
# * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
|
|
@@ -3975,6 +4260,7 @@ module Aws::Backup
|
|
|
3975
4260
|
# by_complete_after: Time.now,
|
|
3976
4261
|
# by_parent_job_id: "string",
|
|
3977
4262
|
# by_message_category: "string",
|
|
4263
|
+
# by_source_recovery_point_arn: "string",
|
|
3978
4264
|
# })
|
|
3979
4265
|
#
|
|
3980
4266
|
# @example Response structure
|
|
@@ -3992,6 +4278,7 @@ module Aws::Backup
|
|
|
3992
4278
|
# resp.copy_jobs[0].destination_recovery_point_lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
3993
4279
|
# resp.copy_jobs[0].destination_recovery_point_lifecycle.delete_after_days #=> Integer
|
|
3994
4280
|
# resp.copy_jobs[0].destination_recovery_point_lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
4281
|
+
# resp.copy_jobs[0].destination_recovery_point_lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
3995
4282
|
# resp.copy_jobs[0].resource_arn #=> String
|
|
3996
4283
|
# resp.copy_jobs[0].creation_date #=> Time
|
|
3997
4284
|
# resp.copy_jobs[0].completion_date #=> Time
|
|
@@ -4007,6 +4294,7 @@ module Aws::Backup
|
|
|
4007
4294
|
# resp.copy_jobs[0].created_by.backup_rule_name #=> String
|
|
4008
4295
|
# resp.copy_jobs[0].created_by.backup_rule_cron #=> String
|
|
4009
4296
|
# resp.copy_jobs[0].created_by.backup_rule_timezone #=> String
|
|
4297
|
+
# resp.copy_jobs[0].created_by_backup_job_id #=> String
|
|
4010
4298
|
# resp.copy_jobs[0].resource_type #=> String
|
|
4011
4299
|
# resp.copy_jobs[0].parent_job_id #=> String
|
|
4012
4300
|
# resp.copy_jobs[0].is_parent #=> Boolean
|
|
@@ -4444,6 +4732,7 @@ module Aws::Backup
|
|
|
4444
4732
|
# resp.recovery_points[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
4445
4733
|
# resp.recovery_points[0].lifecycle.delete_after_days #=> Integer
|
|
4446
4734
|
# resp.recovery_points[0].lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
4735
|
+
# resp.recovery_points[0].lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
4447
4736
|
# resp.recovery_points[0].encryption_key_arn #=> String
|
|
4448
4737
|
# resp.recovery_points[0].is_encrypted #=> Boolean
|
|
4449
4738
|
# resp.recovery_points[0].last_restore_time #=> Time
|
|
@@ -4454,6 +4743,11 @@ module Aws::Backup
|
|
|
4454
4743
|
# resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
|
4455
4744
|
# resp.recovery_points[0].index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
|
|
4456
4745
|
# resp.recovery_points[0].index_status_message #=> String
|
|
4746
|
+
# resp.recovery_points[0].encryption_key_type #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY"
|
|
4747
|
+
# resp.recovery_points[0].aggregated_scan_result.failed_scan #=> Boolean
|
|
4748
|
+
# resp.recovery_points[0].aggregated_scan_result.findings #=> Array
|
|
4749
|
+
# resp.recovery_points[0].aggregated_scan_result.findings[0] #=> String, one of "MALWARE"
|
|
4750
|
+
# resp.recovery_points[0].aggregated_scan_result.last_computed #=> Time
|
|
4457
4751
|
#
|
|
4458
4752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByBackupVault AWS API Documentation
|
|
4459
4753
|
#
|
|
@@ -4581,6 +4875,11 @@ module Aws::Backup
|
|
|
4581
4875
|
# resp.recovery_points[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", "RESTORE_ACCESS_BACKUP_VAULT"
|
|
4582
4876
|
# resp.recovery_points[0].index_status #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING"
|
|
4583
4877
|
# resp.recovery_points[0].index_status_message #=> String
|
|
4878
|
+
# resp.recovery_points[0].encryption_key_type #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY"
|
|
4879
|
+
# resp.recovery_points[0].aggregated_scan_result.failed_scan #=> Boolean
|
|
4880
|
+
# resp.recovery_points[0].aggregated_scan_result.findings #=> Array
|
|
4881
|
+
# resp.recovery_points[0].aggregated_scan_result.findings[0] #=> String, one of "MALWARE"
|
|
4882
|
+
# resp.recovery_points[0].aggregated_scan_result.last_computed #=> Time
|
|
4584
4883
|
#
|
|
4585
4884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByResource AWS API Documentation
|
|
4586
4885
|
#
|
|
@@ -4612,7 +4911,11 @@ module Aws::Backup
|
|
|
4612
4911
|
# Returns only report jobs that are in the specified status. The
|
|
4613
4912
|
# statuses are:
|
|
4614
4913
|
#
|
|
4615
|
-
# `CREATED | RUNNING | COMPLETED | FAILED`
|
|
4914
|
+
# `CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES`
|
|
4915
|
+
#
|
|
4916
|
+
# Please note that only scanning jobs finish with state completed with
|
|
4917
|
+
# issues. For backup jobs this is a console interpretation of a job that
|
|
4918
|
+
# finishes in completed state and has a status message.
|
|
4616
4919
|
#
|
|
4617
4920
|
# @option params [Integer] :max_results
|
|
4618
4921
|
# The number of desired results from 1 to 1000. Optional. If
|
|
@@ -4958,6 +5261,10 @@ module Aws::Backup
|
|
|
4958
5261
|
# This returns only restore testing jobs that match the specified
|
|
4959
5262
|
# resource Amazon Resource Name (ARN).
|
|
4960
5263
|
#
|
|
5264
|
+
# @option params [String] :by_parent_job_id
|
|
5265
|
+
# This is a filter to list child (nested) restore jobs based on parent
|
|
5266
|
+
# restore job ID.
|
|
5267
|
+
#
|
|
4961
5268
|
# @return [Types::ListRestoreJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4962
5269
|
#
|
|
4963
5270
|
# * {Types::ListRestoreJobsOutput#restore_jobs #restore_jobs} => Array<Types::RestoreJobsListMember>
|
|
@@ -4978,6 +5285,7 @@ module Aws::Backup
|
|
|
4978
5285
|
# by_complete_before: Time.now,
|
|
4979
5286
|
# by_complete_after: Time.now,
|
|
4980
5287
|
# by_restore_testing_plan_arn: "ARN",
|
|
5288
|
+
# by_parent_job_id: "string",
|
|
4981
5289
|
# })
|
|
4982
5290
|
#
|
|
4983
5291
|
# @example Response structure
|
|
@@ -4999,6 +5307,8 @@ module Aws::Backup
|
|
|
4999
5307
|
# resp.restore_jobs[0].created_resource_arn #=> String
|
|
5000
5308
|
# resp.restore_jobs[0].resource_type #=> String
|
|
5001
5309
|
# resp.restore_jobs[0].recovery_point_creation_date #=> Time
|
|
5310
|
+
# resp.restore_jobs[0].is_parent #=> Boolean
|
|
5311
|
+
# resp.restore_jobs[0].parent_job_id #=> String
|
|
5002
5312
|
# resp.restore_jobs[0].created_by.restore_testing_plan_arn #=> String
|
|
5003
5313
|
# resp.restore_jobs[0].validation_status #=> String, one of "FAILED", "SUCCESSFUL", "TIMED_OUT", "VALIDATING"
|
|
5004
5314
|
# resp.restore_jobs[0].validation_status_message #=> String
|
|
@@ -5084,6 +5394,8 @@ module Aws::Backup
|
|
|
5084
5394
|
# resp.restore_jobs[0].created_resource_arn #=> String
|
|
5085
5395
|
# resp.restore_jobs[0].resource_type #=> String
|
|
5086
5396
|
# resp.restore_jobs[0].recovery_point_creation_date #=> Time
|
|
5397
|
+
# resp.restore_jobs[0].is_parent #=> Boolean
|
|
5398
|
+
# resp.restore_jobs[0].parent_job_id #=> String
|
|
5087
5399
|
# resp.restore_jobs[0].created_by.restore_testing_plan_arn #=> String
|
|
5088
5400
|
# resp.restore_jobs[0].validation_status #=> String, one of "FAILED", "SUCCESSFUL", "TIMED_OUT", "VALIDATING"
|
|
5089
5401
|
# resp.restore_jobs[0].validation_status_message #=> String
|
|
@@ -5198,6 +5510,242 @@ module Aws::Backup
|
|
|
5198
5510
|
req.send_request(options)
|
|
5199
5511
|
end
|
|
5200
5512
|
|
|
5513
|
+
# This is a request for a summary of scan jobs created or running within
|
|
5514
|
+
# the most recent 30 days.
|
|
5515
|
+
#
|
|
5516
|
+
# @option params [String] :account_id
|
|
5517
|
+
# Returns the job count for the specified account.
|
|
5518
|
+
#
|
|
5519
|
+
# If the request is sent from a member account or an account not part of
|
|
5520
|
+
# Amazon Web Services Organizations, jobs within requestor's account
|
|
5521
|
+
# will be returned.
|
|
5522
|
+
#
|
|
5523
|
+
# Root, admin, and delegated administrator accounts can use the value
|
|
5524
|
+
# `ANY` to return job counts from every account in the organization.
|
|
5525
|
+
#
|
|
5526
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
|
5527
|
+
# authenticated organization, then returns the sum.
|
|
5528
|
+
#
|
|
5529
|
+
# @option params [String] :resource_type
|
|
5530
|
+
# Returns the job count for the specified resource type. Use request
|
|
5531
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
|
5532
|
+
# types.
|
|
5533
|
+
#
|
|
5534
|
+
# The the value `ANY` returns count of all resource types.
|
|
5535
|
+
#
|
|
5536
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
|
5537
|
+
# returns the sum.
|
|
5538
|
+
#
|
|
5539
|
+
# @option params [String] :malware_scanner
|
|
5540
|
+
# Returns only the scan jobs for the specified malware scanner.
|
|
5541
|
+
# Currently the only MalwareScanner is `GUARDDUTY`. But the field also
|
|
5542
|
+
# supports `ANY`, and `AGGREGATE_ALL`.
|
|
5543
|
+
#
|
|
5544
|
+
# @option params [String] :scan_result_status
|
|
5545
|
+
# Returns only the scan jobs for the specified scan results.
|
|
5546
|
+
#
|
|
5547
|
+
# @option params [String] :state
|
|
5548
|
+
# Returns only the scan jobs for the specified scanning job state.
|
|
5549
|
+
#
|
|
5550
|
+
# @option params [String] :aggregation_period
|
|
5551
|
+
# The period for the returned results.
|
|
5552
|
+
#
|
|
5553
|
+
# * `ONE_DAY`The daily job count for the prior 1 day.
|
|
5554
|
+
#
|
|
5555
|
+
# * `SEVEN_DAYS`The daily job count for the prior 7 days.
|
|
5556
|
+
#
|
|
5557
|
+
# * `FOURTEEN_DAYS`The daily job count for the prior 14 days.
|
|
5558
|
+
#
|
|
5559
|
+
# @option params [Integer] :max_results
|
|
5560
|
+
# The maximum number of items to be returned.
|
|
5561
|
+
#
|
|
5562
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
|
5563
|
+
#
|
|
5564
|
+
# @option params [String] :next_token
|
|
5565
|
+
# The next item following a partial list of returned items. For example,
|
|
5566
|
+
# if a request is made to return `MaxResults` number of items,
|
|
5567
|
+
# `NextToken` allows you to return more items in your list starting at
|
|
5568
|
+
# the location pointed to by the next token.
|
|
5569
|
+
#
|
|
5570
|
+
# @return [Types::ListScanJobSummariesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5571
|
+
#
|
|
5572
|
+
# * {Types::ListScanJobSummariesOutput#scan_job_summaries #scan_job_summaries} => Array<Types::ScanJobSummary>
|
|
5573
|
+
# * {Types::ListScanJobSummariesOutput#aggregation_period #aggregation_period} => String
|
|
5574
|
+
# * {Types::ListScanJobSummariesOutput#next_token #next_token} => String
|
|
5575
|
+
#
|
|
5576
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5577
|
+
#
|
|
5578
|
+
# @example Request syntax with placeholder values
|
|
5579
|
+
#
|
|
5580
|
+
# resp = client.list_scan_job_summaries({
|
|
5581
|
+
# account_id: "AccountId",
|
|
5582
|
+
# resource_type: "ResourceType",
|
|
5583
|
+
# malware_scanner: "GUARDDUTY", # accepts GUARDDUTY
|
|
5584
|
+
# scan_result_status: "NO_THREATS_FOUND", # accepts NO_THREATS_FOUND, THREATS_FOUND
|
|
5585
|
+
# state: "CREATED", # accepts CREATED, COMPLETED, COMPLETED_WITH_ISSUES, RUNNING, FAILED, CANCELED, AGGREGATE_ALL, ANY
|
|
5586
|
+
# aggregation_period: "ONE_DAY", # accepts ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS
|
|
5587
|
+
# max_results: 1,
|
|
5588
|
+
# next_token: "string",
|
|
5589
|
+
# })
|
|
5590
|
+
#
|
|
5591
|
+
# @example Response structure
|
|
5592
|
+
#
|
|
5593
|
+
# resp.scan_job_summaries #=> Array
|
|
5594
|
+
# resp.scan_job_summaries[0].region #=> String
|
|
5595
|
+
# resp.scan_job_summaries[0].account_id #=> String
|
|
5596
|
+
# resp.scan_job_summaries[0].state #=> String, one of "CREATED", "COMPLETED", "COMPLETED_WITH_ISSUES", "RUNNING", "FAILED", "CANCELED", "AGGREGATE_ALL", "ANY"
|
|
5597
|
+
# resp.scan_job_summaries[0].resource_type #=> String
|
|
5598
|
+
# resp.scan_job_summaries[0].count #=> Integer
|
|
5599
|
+
# resp.scan_job_summaries[0].start_time #=> Time
|
|
5600
|
+
# resp.scan_job_summaries[0].end_time #=> Time
|
|
5601
|
+
# resp.scan_job_summaries[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
5602
|
+
# resp.scan_job_summaries[0].scan_result_status #=> String, one of "NO_THREATS_FOUND", "THREATS_FOUND"
|
|
5603
|
+
# resp.aggregation_period #=> String
|
|
5604
|
+
# resp.next_token #=> String
|
|
5605
|
+
#
|
|
5606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobSummaries AWS API Documentation
|
|
5607
|
+
#
|
|
5608
|
+
# @overload list_scan_job_summaries(params = {})
|
|
5609
|
+
# @param [Hash] params ({})
|
|
5610
|
+
def list_scan_job_summaries(params = {}, options = {})
|
|
5611
|
+
req = build_request(:list_scan_job_summaries, params)
|
|
5612
|
+
req.send_request(options)
|
|
5613
|
+
end
|
|
5614
|
+
|
|
5615
|
+
# Returns a list of existing scan jobs for an authenticated account for
|
|
5616
|
+
# the last 30 days.
|
|
5617
|
+
#
|
|
5618
|
+
# @option params [String] :by_account_id
|
|
5619
|
+
# The account ID to list the jobs from. Returns only backup jobs
|
|
5620
|
+
# associated with the specified account ID.
|
|
5621
|
+
#
|
|
5622
|
+
# If used from an Amazon Web Services Organizations management account,
|
|
5623
|
+
# passing `*` returns all jobs across the organization.
|
|
5624
|
+
#
|
|
5625
|
+
# Pattern: `^[0-9]{12}$`
|
|
5626
|
+
#
|
|
5627
|
+
# @option params [String] :by_backup_vault_name
|
|
5628
|
+
# Returns only scan jobs that will be stored in the specified backup
|
|
5629
|
+
# vault. Backup vaults are identified by names that are unique to the
|
|
5630
|
+
# account used to create them and the Amazon Web Services Region where
|
|
5631
|
+
# they are created.
|
|
5632
|
+
#
|
|
5633
|
+
# Pattern: `^[a-zA-Z0-9\-\_\.]{2,50}$`
|
|
5634
|
+
#
|
|
5635
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_complete_after
|
|
5636
|
+
# Returns only scan jobs completed after a date expressed in Unix format
|
|
5637
|
+
# and Coordinated Universal Time (UTC).
|
|
5638
|
+
#
|
|
5639
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_complete_before
|
|
5640
|
+
# Returns only backup jobs completed before a date expressed in Unix
|
|
5641
|
+
# format and Coordinated Universal Time (UTC).
|
|
5642
|
+
#
|
|
5643
|
+
# @option params [String] :by_malware_scanner
|
|
5644
|
+
# Returns only the scan jobs for the specified malware scanner.
|
|
5645
|
+
# Currently only supports `GUARDDUTY`.
|
|
5646
|
+
#
|
|
5647
|
+
# @option params [String] :by_recovery_point_arn
|
|
5648
|
+
# Returns only the scan jobs that are ran against the specified recovery
|
|
5649
|
+
# point.
|
|
5650
|
+
#
|
|
5651
|
+
# @option params [String] :by_resource_arn
|
|
5652
|
+
# Returns only scan jobs that match the specified resource Amazon
|
|
5653
|
+
# Resource Name (ARN).
|
|
5654
|
+
#
|
|
5655
|
+
# @option params [String] :by_resource_type
|
|
5656
|
+
# Returns restore testing selections by the specified restore testing
|
|
5657
|
+
# plan name.
|
|
5658
|
+
#
|
|
5659
|
+
# * `EBS`for Amazon Elastic Block Store
|
|
5660
|
+
#
|
|
5661
|
+
# * `EC2`for Amazon Elastic Compute Cloud
|
|
5662
|
+
#
|
|
5663
|
+
# * `S3`for Amazon Simple Storage Service (Amazon S3)
|
|
5664
|
+
#
|
|
5665
|
+
# Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
|
|
5666
|
+
#
|
|
5667
|
+
# @option params [String] :by_scan_result_status
|
|
5668
|
+
# Returns only the scan jobs for the specified scan results:
|
|
5669
|
+
#
|
|
5670
|
+
# * `THREATS_FOUND`
|
|
5671
|
+
#
|
|
5672
|
+
# * `NO_THREATS_FOUND`
|
|
5673
|
+
#
|
|
5674
|
+
# @option params [String] :by_state
|
|
5675
|
+
# Returns only the scan jobs for the specified scanning job state.
|
|
5676
|
+
#
|
|
5677
|
+
# @option params [Integer] :max_results
|
|
5678
|
+
# The maximum number of items to be returned.
|
|
5679
|
+
#
|
|
5680
|
+
# Valid Range: Minimum value of 1. Maximum value of 1000.
|
|
5681
|
+
#
|
|
5682
|
+
# @option params [String] :next_token
|
|
5683
|
+
# The next item following a partial list of returned items. For example,
|
|
5684
|
+
# if a request is made to return `MaxResults` number of items,
|
|
5685
|
+
# `NextToken` allows you to return more items in your list starting at
|
|
5686
|
+
# the location pointed to by the next token.
|
|
5687
|
+
#
|
|
5688
|
+
# @return [Types::ListScanJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5689
|
+
#
|
|
5690
|
+
# * {Types::ListScanJobsOutput#next_token #next_token} => String
|
|
5691
|
+
# * {Types::ListScanJobsOutput#scan_jobs #scan_jobs} => Array<Types::ScanJob>
|
|
5692
|
+
#
|
|
5693
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5694
|
+
#
|
|
5695
|
+
# @example Request syntax with placeholder values
|
|
5696
|
+
#
|
|
5697
|
+
# resp = client.list_scan_jobs({
|
|
5698
|
+
# by_account_id: "String",
|
|
5699
|
+
# by_backup_vault_name: "String",
|
|
5700
|
+
# by_complete_after: Time.now,
|
|
5701
|
+
# by_complete_before: Time.now,
|
|
5702
|
+
# by_malware_scanner: "GUARDDUTY", # accepts GUARDDUTY
|
|
5703
|
+
# by_recovery_point_arn: "String",
|
|
5704
|
+
# by_resource_arn: "String",
|
|
5705
|
+
# by_resource_type: "EBS", # accepts EBS, EC2, S3
|
|
5706
|
+
# by_scan_result_status: "NO_THREATS_FOUND", # accepts NO_THREATS_FOUND, THREATS_FOUND
|
|
5707
|
+
# by_state: "CANCELED", # accepts CANCELED, COMPLETED, COMPLETED_WITH_ISSUES, CREATED, FAILED, RUNNING
|
|
5708
|
+
# max_results: 1,
|
|
5709
|
+
# next_token: "String",
|
|
5710
|
+
# })
|
|
5711
|
+
#
|
|
5712
|
+
# @example Response structure
|
|
5713
|
+
#
|
|
5714
|
+
# resp.next_token #=> String
|
|
5715
|
+
# resp.scan_jobs #=> Array
|
|
5716
|
+
# resp.scan_jobs[0].account_id #=> String
|
|
5717
|
+
# resp.scan_jobs[0].backup_vault_arn #=> String
|
|
5718
|
+
# resp.scan_jobs[0].backup_vault_name #=> String
|
|
5719
|
+
# resp.scan_jobs[0].completion_date #=> Time
|
|
5720
|
+
# resp.scan_jobs[0].created_by.backup_plan_arn #=> String
|
|
5721
|
+
# resp.scan_jobs[0].created_by.backup_plan_id #=> String
|
|
5722
|
+
# resp.scan_jobs[0].created_by.backup_plan_version #=> String
|
|
5723
|
+
# resp.scan_jobs[0].created_by.backup_rule_id #=> String
|
|
5724
|
+
# resp.scan_jobs[0].creation_date #=> Time
|
|
5725
|
+
# resp.scan_jobs[0].iam_role_arn #=> String
|
|
5726
|
+
# resp.scan_jobs[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
5727
|
+
# resp.scan_jobs[0].recovery_point_arn #=> String
|
|
5728
|
+
# resp.scan_jobs[0].resource_arn #=> String
|
|
5729
|
+
# resp.scan_jobs[0].resource_name #=> String
|
|
5730
|
+
# resp.scan_jobs[0].resource_type #=> String, one of "EBS", "EC2", "S3"
|
|
5731
|
+
# resp.scan_jobs[0].scan_base_recovery_point_arn #=> String
|
|
5732
|
+
# resp.scan_jobs[0].scan_id #=> String
|
|
5733
|
+
# resp.scan_jobs[0].scan_job_id #=> String
|
|
5734
|
+
# resp.scan_jobs[0].scan_mode #=> String, one of "FULL_SCAN", "INCREMENTAL_SCAN"
|
|
5735
|
+
# resp.scan_jobs[0].scan_result.scan_result_status #=> String, one of "NO_THREATS_FOUND", "THREATS_FOUND"
|
|
5736
|
+
# resp.scan_jobs[0].scanner_role_arn #=> String
|
|
5737
|
+
# resp.scan_jobs[0].state #=> String, one of "CANCELED", "COMPLETED", "COMPLETED_WITH_ISSUES", "CREATED", "FAILED", "RUNNING"
|
|
5738
|
+
# resp.scan_jobs[0].status_message #=> String
|
|
5739
|
+
#
|
|
5740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobs AWS API Documentation
|
|
5741
|
+
#
|
|
5742
|
+
# @overload list_scan_jobs(params = {})
|
|
5743
|
+
# @param [Hash] params ({})
|
|
5744
|
+
def list_scan_jobs(params = {}, options = {})
|
|
5745
|
+
req = build_request(:list_scan_jobs, params)
|
|
5746
|
+
req.send_request(options)
|
|
5747
|
+
end
|
|
5748
|
+
|
|
5201
5749
|
# Returns the tags assigned to the resource, such as a target recovery
|
|
5202
5750
|
# point, backup plan, or backup vault.
|
|
5203
5751
|
#
|
|
@@ -5263,6 +5811,50 @@ module Aws::Backup
|
|
|
5263
5811
|
req.send_request(options)
|
|
5264
5812
|
end
|
|
5265
5813
|
|
|
5814
|
+
# Returns a list of tiering configurations.
|
|
5815
|
+
#
|
|
5816
|
+
# @option params [Integer] :max_results
|
|
5817
|
+
# The maximum number of items to be returned.
|
|
5818
|
+
#
|
|
5819
|
+
# @option params [String] :next_token
|
|
5820
|
+
# The next item following a partial list of returned items. For example,
|
|
5821
|
+
# if a request is made to return `MaxResults` number of items,
|
|
5822
|
+
# `NextToken` allows you to return more items in your list starting at
|
|
5823
|
+
# the location pointed to by the next token.
|
|
5824
|
+
#
|
|
5825
|
+
# @return [Types::ListTieringConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5826
|
+
#
|
|
5827
|
+
# * {Types::ListTieringConfigurationsOutput#tiering_configurations #tiering_configurations} => Array<Types::TieringConfigurationsListMember>
|
|
5828
|
+
# * {Types::ListTieringConfigurationsOutput#next_token #next_token} => String
|
|
5829
|
+
#
|
|
5830
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5831
|
+
#
|
|
5832
|
+
# @example Request syntax with placeholder values
|
|
5833
|
+
#
|
|
5834
|
+
# resp = client.list_tiering_configurations({
|
|
5835
|
+
# max_results: 1,
|
|
5836
|
+
# next_token: "string",
|
|
5837
|
+
# })
|
|
5838
|
+
#
|
|
5839
|
+
# @example Response structure
|
|
5840
|
+
#
|
|
5841
|
+
# resp.tiering_configurations #=> Array
|
|
5842
|
+
# resp.tiering_configurations[0].tiering_configuration_arn #=> String
|
|
5843
|
+
# resp.tiering_configurations[0].tiering_configuration_name #=> String
|
|
5844
|
+
# resp.tiering_configurations[0].backup_vault_name #=> String
|
|
5845
|
+
# resp.tiering_configurations[0].creation_time #=> Time
|
|
5846
|
+
# resp.tiering_configurations[0].last_updated_time #=> Time
|
|
5847
|
+
# resp.next_token #=> String
|
|
5848
|
+
#
|
|
5849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTieringConfigurations AWS API Documentation
|
|
5850
|
+
#
|
|
5851
|
+
# @overload list_tiering_configurations(params = {})
|
|
5852
|
+
# @param [Hash] params ({})
|
|
5853
|
+
def list_tiering_configurations(params = {}, options = {})
|
|
5854
|
+
req = build_request(:list_tiering_configurations, params)
|
|
5855
|
+
req.send_request(options)
|
|
5856
|
+
end
|
|
5857
|
+
|
|
5266
5858
|
# Sets a resource-based policy that is used to manage access permissions
|
|
5267
5859
|
# on the target backup vault. Requires a backup vault name and an access
|
|
5268
5860
|
# policy document in JSON format.
|
|
@@ -5520,6 +6112,14 @@ module Aws::Backup
|
|
|
5520
6112
|
# vaults are identified by names that are unique to the account used to
|
|
5521
6113
|
# create them and the Amazon Web Services Region where they are created.
|
|
5522
6114
|
#
|
|
6115
|
+
# @option params [String] :logically_air_gapped_backup_vault_arn
|
|
6116
|
+
# The ARN of a logically air-gapped vault. ARN must be in the same
|
|
6117
|
+
# account and Region. If provided, supported fully managed resources
|
|
6118
|
+
# back up directly to logically air-gapped vault, while other supported
|
|
6119
|
+
# resources create a temporary (billable) snapshot in backup vault, then
|
|
6120
|
+
# copy it to logically air-gapped vault. Unsupported resources only back
|
|
6121
|
+
# up to the specified backup vault.
|
|
6122
|
+
#
|
|
5523
6123
|
# @option params [required, String] :resource_arn
|
|
5524
6124
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
|
5525
6125
|
# format of the ARN depends on the resource type.
|
|
@@ -5625,6 +6225,7 @@ module Aws::Backup
|
|
|
5625
6225
|
#
|
|
5626
6226
|
# resp = client.start_backup_job({
|
|
5627
6227
|
# backup_vault_name: "BackupVaultName", # required
|
|
6228
|
+
# logically_air_gapped_backup_vault_arn: "ARN",
|
|
5628
6229
|
# resource_arn: "ARN", # required
|
|
5629
6230
|
# iam_role_arn: "IAMRoleArn", # required
|
|
5630
6231
|
# idempotency_token: "string",
|
|
@@ -5634,6 +6235,7 @@ module Aws::Backup
|
|
|
5634
6235
|
# move_to_cold_storage_after_days: 1,
|
|
5635
6236
|
# delete_after_days: 1,
|
|
5636
6237
|
# opt_in_to_archive_for_supported_resources: false,
|
|
6238
|
+
# delete_after_event: "DELETE_AFTER_COPY", # accepts DELETE_AFTER_COPY
|
|
5637
6239
|
# },
|
|
5638
6240
|
# recovery_point_tags: {
|
|
5639
6241
|
# "TagKey" => "TagValue",
|
|
@@ -5740,6 +6342,7 @@ module Aws::Backup
|
|
|
5740
6342
|
# move_to_cold_storage_after_days: 1,
|
|
5741
6343
|
# delete_after_days: 1,
|
|
5742
6344
|
# opt_in_to_archive_for_supported_resources: false,
|
|
6345
|
+
# delete_after_event: "DELETE_AFTER_COPY", # accepts DELETE_AFTER_COPY
|
|
5743
6346
|
# },
|
|
5744
6347
|
# })
|
|
5745
6348
|
#
|
|
@@ -5948,6 +6551,84 @@ module Aws::Backup
|
|
|
5948
6551
|
req.send_request(options)
|
|
5949
6552
|
end
|
|
5950
6553
|
|
|
6554
|
+
# Starts scanning jobs for specific resources.
|
|
6555
|
+
#
|
|
6556
|
+
# @option params [required, String] :backup_vault_name
|
|
6557
|
+
# The name of a logical container where backups are stored. Backup
|
|
6558
|
+
# vaults are identified by names that are unique to the account used to
|
|
6559
|
+
# create them and the Amazon Web Services Region where they are created.
|
|
6560
|
+
#
|
|
6561
|
+
# Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
|
|
6562
|
+
#
|
|
6563
|
+
# @option params [required, String] :iam_role_arn
|
|
6564
|
+
# Specifies the IAM role ARN used to create the target recovery point;
|
|
6565
|
+
# for example, `arn:aws:iam::123456789012:role/S3Access`.
|
|
6566
|
+
#
|
|
6567
|
+
# @option params [String] :idempotency_token
|
|
6568
|
+
# A customer-chosen string that you can use to distinguish between
|
|
6569
|
+
# otherwise identical calls to `StartScanJob`. Retrying a successful
|
|
6570
|
+
# request with the same idempotency token results in a success message
|
|
6571
|
+
# with no action taken.
|
|
6572
|
+
#
|
|
6573
|
+
# @option params [required, String] :malware_scanner
|
|
6574
|
+
# Specifies the malware scanner used during the scan job. Currently only
|
|
6575
|
+
# supports `GUARDDUTY`.
|
|
6576
|
+
#
|
|
6577
|
+
# @option params [required, String] :recovery_point_arn
|
|
6578
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
|
6579
|
+
# point. This is your target recovery point for a full scan. If you are
|
|
6580
|
+
# running an incremental scan, this will be your a recovery point which
|
|
6581
|
+
# has been created after your base recovery point selection.
|
|
6582
|
+
#
|
|
6583
|
+
# @option params [String] :scan_base_recovery_point_arn
|
|
6584
|
+
# An ARN that uniquely identifies the base recovery point to be used for
|
|
6585
|
+
# incremental scanning.
|
|
6586
|
+
#
|
|
6587
|
+
# @option params [required, String] :scan_mode
|
|
6588
|
+
# Specifies the scan type use for the scan job.
|
|
6589
|
+
#
|
|
6590
|
+
# Includes:
|
|
6591
|
+
#
|
|
6592
|
+
# * `FULL_SCAN` will scan the entire data lineage within the backup.
|
|
6593
|
+
#
|
|
6594
|
+
# * `INCREMENTAL_SCAN` will scan the data difference between the target
|
|
6595
|
+
# recovery point and base recovery point ARN.
|
|
6596
|
+
#
|
|
6597
|
+
# @option params [required, String] :scanner_role_arn
|
|
6598
|
+
# Specified the IAM scanner role ARN.
|
|
6599
|
+
#
|
|
6600
|
+
# @return [Types::StartScanJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6601
|
+
#
|
|
6602
|
+
# * {Types::StartScanJobOutput#creation_date #creation_date} => Time
|
|
6603
|
+
# * {Types::StartScanJobOutput#scan_job_id #scan_job_id} => String
|
|
6604
|
+
#
|
|
6605
|
+
# @example Request syntax with placeholder values
|
|
6606
|
+
#
|
|
6607
|
+
# resp = client.start_scan_job({
|
|
6608
|
+
# backup_vault_name: "String", # required
|
|
6609
|
+
# iam_role_arn: "String", # required
|
|
6610
|
+
# idempotency_token: "String",
|
|
6611
|
+
# malware_scanner: "GUARDDUTY", # required, accepts GUARDDUTY
|
|
6612
|
+
# recovery_point_arn: "String", # required
|
|
6613
|
+
# scan_base_recovery_point_arn: "String",
|
|
6614
|
+
# scan_mode: "FULL_SCAN", # required, accepts FULL_SCAN, INCREMENTAL_SCAN
|
|
6615
|
+
# scanner_role_arn: "String", # required
|
|
6616
|
+
# })
|
|
6617
|
+
#
|
|
6618
|
+
# @example Response structure
|
|
6619
|
+
#
|
|
6620
|
+
# resp.creation_date #=> Time
|
|
6621
|
+
# resp.scan_job_id #=> String
|
|
6622
|
+
#
|
|
6623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartScanJob AWS API Documentation
|
|
6624
|
+
#
|
|
6625
|
+
# @overload start_scan_job(params = {})
|
|
6626
|
+
# @param [Hash] params ({})
|
|
6627
|
+
def start_scan_job(params = {}, options = {})
|
|
6628
|
+
req = build_request(:start_scan_job, params)
|
|
6629
|
+
req.send_request(options)
|
|
6630
|
+
end
|
|
6631
|
+
|
|
5951
6632
|
# Attempts to cancel a job to create a one-time backup of a resource.
|
|
5952
6633
|
#
|
|
5953
6634
|
# This action is not supported for the following services:
|
|
@@ -6075,6 +6756,7 @@ module Aws::Backup
|
|
|
6075
6756
|
# * {Types::UpdateBackupPlanOutput#creation_date #creation_date} => Time
|
|
6076
6757
|
# * {Types::UpdateBackupPlanOutput#version_id #version_id} => String
|
|
6077
6758
|
# * {Types::UpdateBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array<Types::AdvancedBackupSetting>
|
|
6759
|
+
# * {Types::UpdateBackupPlanOutput#scan_settings #scan_settings} => Array<Types::ScanSetting>
|
|
6078
6760
|
#
|
|
6079
6761
|
# @example Request syntax with placeholder values
|
|
6080
6762
|
#
|
|
@@ -6086,6 +6768,7 @@ module Aws::Backup
|
|
|
6086
6768
|
# {
|
|
6087
6769
|
# rule_name: "BackupRuleName", # required
|
|
6088
6770
|
# target_backup_vault_name: "BackupVaultName", # required
|
|
6771
|
+
# target_logically_air_gapped_backup_vault_arn: "ARN",
|
|
6089
6772
|
# schedule_expression: "CronExpression",
|
|
6090
6773
|
# start_window_minutes: 1,
|
|
6091
6774
|
# completion_window_minutes: 1,
|
|
@@ -6093,6 +6776,7 @@ module Aws::Backup
|
|
|
6093
6776
|
# move_to_cold_storage_after_days: 1,
|
|
6094
6777
|
# delete_after_days: 1,
|
|
6095
6778
|
# opt_in_to_archive_for_supported_resources: false,
|
|
6779
|
+
# delete_after_event: "DELETE_AFTER_COPY", # accepts DELETE_AFTER_COPY
|
|
6096
6780
|
# },
|
|
6097
6781
|
# recovery_point_tags: {
|
|
6098
6782
|
# "TagKey" => "TagValue",
|
|
@@ -6103,6 +6787,7 @@ module Aws::Backup
|
|
|
6103
6787
|
# move_to_cold_storage_after_days: 1,
|
|
6104
6788
|
# delete_after_days: 1,
|
|
6105
6789
|
# opt_in_to_archive_for_supported_resources: false,
|
|
6790
|
+
# delete_after_event: "DELETE_AFTER_COPY", # accepts DELETE_AFTER_COPY
|
|
6106
6791
|
# },
|
|
6107
6792
|
# destination_backup_vault_arn: "ARN", # required
|
|
6108
6793
|
# },
|
|
@@ -6114,6 +6799,12 @@ module Aws::Backup
|
|
|
6114
6799
|
# resource_types: ["ResourceType"],
|
|
6115
6800
|
# },
|
|
6116
6801
|
# ],
|
|
6802
|
+
# scan_actions: [
|
|
6803
|
+
# {
|
|
6804
|
+
# malware_scanner: "GUARDDUTY", # accepts GUARDDUTY
|
|
6805
|
+
# scan_mode: "FULL_SCAN", # accepts FULL_SCAN, INCREMENTAL_SCAN
|
|
6806
|
+
# },
|
|
6807
|
+
# ],
|
|
6117
6808
|
# },
|
|
6118
6809
|
# ],
|
|
6119
6810
|
# advanced_backup_settings: [
|
|
@@ -6124,6 +6815,13 @@ module Aws::Backup
|
|
|
6124
6815
|
# },
|
|
6125
6816
|
# },
|
|
6126
6817
|
# ],
|
|
6818
|
+
# scan_settings: [
|
|
6819
|
+
# {
|
|
6820
|
+
# malware_scanner: "GUARDDUTY", # accepts GUARDDUTY
|
|
6821
|
+
# resource_types: ["ResourceType"],
|
|
6822
|
+
# scanner_role_arn: "IAMRoleArn",
|
|
6823
|
+
# },
|
|
6824
|
+
# ],
|
|
6127
6825
|
# },
|
|
6128
6826
|
# })
|
|
6129
6827
|
#
|
|
@@ -6137,6 +6835,11 @@ module Aws::Backup
|
|
|
6137
6835
|
# resp.advanced_backup_settings[0].resource_type #=> String
|
|
6138
6836
|
# resp.advanced_backup_settings[0].backup_options #=> Hash
|
|
6139
6837
|
# resp.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
|
6838
|
+
# resp.scan_settings #=> Array
|
|
6839
|
+
# resp.scan_settings[0].malware_scanner #=> String, one of "GUARDDUTY"
|
|
6840
|
+
# resp.scan_settings[0].resource_types #=> Array
|
|
6841
|
+
# resp.scan_settings[0].resource_types[0] #=> String
|
|
6842
|
+
# resp.scan_settings[0].scanner_role_arn #=> String
|
|
6140
6843
|
#
|
|
6141
6844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlan AWS API Documentation
|
|
6142
6845
|
#
|
|
@@ -6234,6 +6937,11 @@ module Aws::Backup
|
|
|
6234
6937
|
# Values can be true or false. Example: `update-global-settings
|
|
6235
6938
|
# --global-settings isMpaEnabled=false --region us-west-2`.
|
|
6236
6939
|
#
|
|
6940
|
+
# A value for Backup Service-Linked Role creation, styled
|
|
6941
|
+
# as`isDelegatedAdministratorEnabled`. Values can be true or false.
|
|
6942
|
+
# Example: `update-global-settings --global-settings
|
|
6943
|
+
# isDelegatedAdministratorEnabled=false --region us-west-2`.
|
|
6944
|
+
#
|
|
6237
6945
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6238
6946
|
#
|
|
6239
6947
|
# @example Request syntax with placeholder values
|
|
@@ -6377,6 +7085,7 @@ module Aws::Backup
|
|
|
6377
7085
|
# move_to_cold_storage_after_days: 1,
|
|
6378
7086
|
# delete_after_days: 1,
|
|
6379
7087
|
# opt_in_to_archive_for_supported_resources: false,
|
|
7088
|
+
# delete_after_event: "DELETE_AFTER_COPY", # accepts DELETE_AFTER_COPY
|
|
6380
7089
|
# },
|
|
6381
7090
|
# })
|
|
6382
7091
|
#
|
|
@@ -6387,6 +7096,7 @@ module Aws::Backup
|
|
|
6387
7096
|
# resp.lifecycle.move_to_cold_storage_after_days #=> Integer
|
|
6388
7097
|
# resp.lifecycle.delete_after_days #=> Integer
|
|
6389
7098
|
# resp.lifecycle.opt_in_to_archive_for_supported_resources #=> Boolean
|
|
7099
|
+
# resp.lifecycle.delete_after_event #=> String, one of "DELETE_AFTER_COPY"
|
|
6390
7100
|
# resp.calculated_lifecycle.move_to_cold_storage_at #=> Time
|
|
6391
7101
|
# resp.calculated_lifecycle.delete_at #=> Time
|
|
6392
7102
|
#
|
|
@@ -6665,6 +7375,63 @@ module Aws::Backup
|
|
|
6665
7375
|
req.send_request(options)
|
|
6666
7376
|
end
|
|
6667
7377
|
|
|
7378
|
+
# This request will send changes to your specified tiering
|
|
7379
|
+
# configuration. `TieringConfigurationName` cannot be updated after it
|
|
7380
|
+
# is created.
|
|
7381
|
+
#
|
|
7382
|
+
# `ResourceSelection` can contain:
|
|
7383
|
+
#
|
|
7384
|
+
# * `Resources`
|
|
7385
|
+
#
|
|
7386
|
+
# * `TieringDownSettingsInDays`
|
|
7387
|
+
#
|
|
7388
|
+
# * `ResourceType`
|
|
7389
|
+
#
|
|
7390
|
+
# @option params [required, String] :tiering_configuration_name
|
|
7391
|
+
# The name of a tiering configuration to update.
|
|
7392
|
+
#
|
|
7393
|
+
# @option params [required, Types::TieringConfigurationInputForUpdate] :tiering_configuration
|
|
7394
|
+
# Specifies the body of a tiering configuration.
|
|
7395
|
+
#
|
|
7396
|
+
# @return [Types::UpdateTieringConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7397
|
+
#
|
|
7398
|
+
# * {Types::UpdateTieringConfigurationOutput#tiering_configuration_arn #tiering_configuration_arn} => String
|
|
7399
|
+
# * {Types::UpdateTieringConfigurationOutput#tiering_configuration_name #tiering_configuration_name} => String
|
|
7400
|
+
# * {Types::UpdateTieringConfigurationOutput#creation_time #creation_time} => Time
|
|
7401
|
+
# * {Types::UpdateTieringConfigurationOutput#last_updated_time #last_updated_time} => Time
|
|
7402
|
+
#
|
|
7403
|
+
# @example Request syntax with placeholder values
|
|
7404
|
+
#
|
|
7405
|
+
# resp = client.update_tiering_configuration({
|
|
7406
|
+
# tiering_configuration_name: "TieringConfigurationName", # required
|
|
7407
|
+
# tiering_configuration: { # required
|
|
7408
|
+
# resource_selection: [ # required
|
|
7409
|
+
# {
|
|
7410
|
+
# resources: ["ARN"], # required
|
|
7411
|
+
# tiering_down_settings_in_days: 1, # required
|
|
7412
|
+
# resource_type: "ResourceType", # required
|
|
7413
|
+
# },
|
|
7414
|
+
# ],
|
|
7415
|
+
# backup_vault_name: "BackupVaultNameOrWildcard", # required
|
|
7416
|
+
# },
|
|
7417
|
+
# })
|
|
7418
|
+
#
|
|
7419
|
+
# @example Response structure
|
|
7420
|
+
#
|
|
7421
|
+
# resp.tiering_configuration_arn #=> String
|
|
7422
|
+
# resp.tiering_configuration_name #=> String
|
|
7423
|
+
# resp.creation_time #=> Time
|
|
7424
|
+
# resp.last_updated_time #=> Time
|
|
7425
|
+
#
|
|
7426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateTieringConfiguration AWS API Documentation
|
|
7427
|
+
#
|
|
7428
|
+
# @overload update_tiering_configuration(params = {})
|
|
7429
|
+
# @param [Hash] params ({})
|
|
7430
|
+
def update_tiering_configuration(params = {}, options = {})
|
|
7431
|
+
req = build_request(:update_tiering_configuration, params)
|
|
7432
|
+
req.send_request(options)
|
|
7433
|
+
end
|
|
7434
|
+
|
|
6668
7435
|
# @!endgroup
|
|
6669
7436
|
|
|
6670
7437
|
# @param params ({})
|
|
@@ -6683,7 +7450,7 @@ module Aws::Backup
|
|
|
6683
7450
|
tracer: tracer
|
|
6684
7451
|
)
|
|
6685
7452
|
context[:gem_name] = 'aws-sdk-backup'
|
|
6686
|
-
context[:gem_version] = '1.
|
|
7453
|
+
context[:gem_version] = '1.104.0'
|
|
6687
7454
|
Seahorse::Client::Request.new(handlers, context)
|
|
6688
7455
|
end
|
|
6689
7456
|
|