aws-sdk-backup 1.30.0 → 1.31.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 770705d074a6e01db73029028b66ae3dfee1ec25067f3bc4af821a7677bda728
4
- data.tar.gz: 0a822ee4e9c31861fc2f7f289a5da7b42a26f968c383f7c9fd63725f3cf46461
3
+ metadata.gz: c54a3897810f6e5b879b41f62f35b26fac46a157b92b17c3e651af0078182db8
4
+ data.tar.gz: de39094a7a90e2b1cb05840e88a054bb0ea7f24d995c89a11243270ac29b54ee
5
5
  SHA512:
6
- metadata.gz: c0d181442f4518702e92d84ad44d7045d942881b943a4445b64fe182ab3b16cd536c9d74548817ab0dbb307bad047dc424febb4ebbb23a83729ff622b8faa1ee
7
- data.tar.gz: 4a4600365df5300fd713bb127831624b1b3ec5643b2a15dfb075605eca5914370e5fbb8544009ae49ffc583a5d33a6c1f377b82445118d301274545c53d7173d
6
+ metadata.gz: e7ad9467a8f03ed8914b3788988db52bdc0cb6d6233c6623306316416aadc303618b039cdeff97787afe1e4d18eed6108f5129e0b55bd0db6eb11ff31025e230
7
+ data.tar.gz: fad5a6f8bd253e526689150ce9af4af476f9a7cf7219d7a47ca84d7e0a0ba71c6da10ca9fabbc61f55e6d4b0413132bf28a67c80dc8d37576521fff4ffce67d3
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.31.0 (2021-08-23)
5
+ ------------------
6
+
7
+ * Feature - AWS Backup - Features: Evaluate your backup activity and generate audit reports.
8
+
4
9
  1.30.0 (2021-07-30)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.30.0
1
+ 1.31.0
@@ -328,11 +328,11 @@ module Aws::Backup
328
328
  # @!group API Operations
329
329
 
330
330
  # Creates a backup plan using a backup plan name and backup rules. A
331
- # backup plan is a document that contains information that AWS Backup
332
- # uses to schedule tasks that create recovery points for resources.
331
+ # backup plan is a document that contains information that Backup uses
332
+ # to schedule tasks that create recovery points for resources.
333
333
  #
334
- # If you call `CreateBackupPlan` with a plan that already exists, an
335
- # `AlreadyExistsException` is returned.
334
+ # If you call `CreateBackupPlan` with a plan that already exists, you
335
+ # receive an `AlreadyExistsException` exception.
336
336
  #
337
337
  # @option params [required, Types::BackupPlanInput] :backup_plan
338
338
  # Specifies the body of a backup plan. Includes a `BackupPlanName` and
@@ -510,16 +510,16 @@ module Aws::Backup
510
510
  # `CreateBackupVault` request includes a name, optionally one or more
511
511
  # resource tags, an encryption key, and a request ID.
512
512
  #
513
- # <note markdown="1"> Sensitive data, such as passport numbers, should not be included the
514
- # name of a backup vault.
513
+ # <note markdown="1"> Do not include sensitive data, such as passport numbers, in the name
514
+ # of a backup vault.
515
515
  #
516
516
  # </note>
517
517
  #
518
518
  # @option params [required, String] :backup_vault_name
519
519
  # The name of a logical container where backups are stored. Backup
520
520
  # vaults are identified by names that are unique to the account used to
521
- # create them and the AWS Region where they are created. They consist of
522
- # letters, numbers, and hyphens.
521
+ # create them and the Amazon Web Services Region where they are created.
522
+ # They consist of letters, numbers, and hyphens.
523
523
  #
524
524
  # @option params [Hash<String,String>] :backup_vault_tags
525
525
  # Metadata that you can assign to help organize the resources that you
@@ -566,6 +566,165 @@ module Aws::Backup
566
566
  req.send_request(options)
567
567
  end
568
568
 
569
+ # Creates a framework with one or more controls. A framework is a
570
+ # collection of controls that you can use to evaluate your backup
571
+ # practices. By using pre-built customizable controls to define your
572
+ # policies, you can evaluate whether your backup practices comply with
573
+ # your policies. To get insights into the compliance status of your
574
+ # frameworks, you can set up automatic daily reports.
575
+ #
576
+ # @option params [required, String] :framework_name
577
+ # The unique name of the framework. The name must be between 1 and 256
578
+ # characters, starting with a letter, and consisting of letters (a-z,
579
+ # A-Z), numbers (0-9), and underscores (\_).
580
+ #
581
+ # @option params [String] :framework_description
582
+ # An optional description of the framework with a maximum of 1,024
583
+ # characters.
584
+ #
585
+ # @option params [required, Array<Types::FrameworkControl>] :framework_controls
586
+ # A list of the controls that make up the framework. Each control in the
587
+ # list has a name, input parameters, and scope.
588
+ #
589
+ # @option params [String] :idempotency_token
590
+ # A customer-chosen string that you can use to distinguish between
591
+ # otherwise identical calls to `CreateFrameworkInput`. Retrying a
592
+ # successful request with the same idempotency token results in a
593
+ # success message with no action taken.
594
+ #
595
+ # **A suitable default value is auto-generated.** You should normally
596
+ # not need to pass this option.**
597
+ #
598
+ # @option params [Hash<String,String>] :framework_tags
599
+ # Metadata that you can assign to help organize the frameworks that you
600
+ # create. Each tag is a key-value pair.
601
+ #
602
+ # @return [Types::CreateFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
603
+ #
604
+ # * {Types::CreateFrameworkOutput#framework_name #framework_name} => String
605
+ # * {Types::CreateFrameworkOutput#framework_arn #framework_arn} => String
606
+ #
607
+ # @example Request syntax with placeholder values
608
+ #
609
+ # resp = client.create_framework({
610
+ # framework_name: "FrameworkName", # required
611
+ # framework_description: "FrameworkDescription",
612
+ # framework_controls: [ # required
613
+ # {
614
+ # control_name: "ControlName", # required
615
+ # control_input_parameters: [
616
+ # {
617
+ # parameter_name: "ParameterName",
618
+ # parameter_value: "ParameterValue",
619
+ # },
620
+ # ],
621
+ # control_scope: {
622
+ # compliance_resource_ids: ["string"],
623
+ # compliance_resource_types: ["ARN"],
624
+ # tags: {
625
+ # "string" => "string",
626
+ # },
627
+ # },
628
+ # },
629
+ # ],
630
+ # idempotency_token: "string",
631
+ # framework_tags: {
632
+ # "string" => "string",
633
+ # },
634
+ # })
635
+ #
636
+ # @example Response structure
637
+ #
638
+ # resp.framework_name #=> String
639
+ # resp.framework_arn #=> String
640
+ #
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateFramework AWS API Documentation
642
+ #
643
+ # @overload create_framework(params = {})
644
+ # @param [Hash] params ({})
645
+ def create_framework(params = {}, options = {})
646
+ req = build_request(:create_framework, params)
647
+ req.send_request(options)
648
+ end
649
+
650
+ # Creates a report plan. A report plan is a document that contains
651
+ # information about the contents of the report and where Backup will
652
+ # deliver it.
653
+ #
654
+ # If you call `CreateReportPlan` with a plan that already exists, you
655
+ # receive an `AlreadyExistsException` exception.
656
+ #
657
+ # @option params [required, String] :report_plan_name
658
+ # The unique name of the report plan. The name must be between 1 and 256
659
+ # characters, starting with a letter, and consisting of letters (a-z,
660
+ # A-Z), numbers (0-9), and underscores (\_).
661
+ #
662
+ # @option params [String] :report_plan_description
663
+ # An optional description of the report plan with a maximum of 1,024
664
+ # characters.
665
+ #
666
+ # @option params [required, Types::ReportDeliveryChannel] :report_delivery_channel
667
+ # A structure that contains information about where and how to deliver
668
+ # your reports, specifically your Amazon S3 bucket name, S3 key prefix,
669
+ # and the formats of your reports.
670
+ #
671
+ # @option params [required, Types::ReportSetting] :report_setting
672
+ # Identifies the report template for the report. Reports are built using
673
+ # a report template. The report templates are:
674
+ #
675
+ # `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
676
+ #
677
+ # @option params [Hash<String,String>] :report_plan_tags
678
+ # Metadata that you can assign to help organize the frameworks that you
679
+ # create. Each tag is a key-value pair.
680
+ #
681
+ # @option params [String] :idempotency_token
682
+ # A customer-chosen string that you can use to distinguish between
683
+ # otherwise identical calls to `CreateReportPlanInput`. Retrying a
684
+ # successful request with the same idempotency token results in a
685
+ # success message with no action taken.
686
+ #
687
+ # **A suitable default value is auto-generated.** You should normally
688
+ # not need to pass this option.**
689
+ #
690
+ # @return [Types::CreateReportPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
691
+ #
692
+ # * {Types::CreateReportPlanOutput#report_plan_name #report_plan_name} => String
693
+ # * {Types::CreateReportPlanOutput#report_plan_arn #report_plan_arn} => String
694
+ #
695
+ # @example Request syntax with placeholder values
696
+ #
697
+ # resp = client.create_report_plan({
698
+ # report_plan_name: "ReportPlanName", # required
699
+ # report_plan_description: "ReportPlanDescription",
700
+ # report_delivery_channel: { # required
701
+ # s3_bucket_name: "string", # required
702
+ # s3_key_prefix: "string",
703
+ # formats: ["string"],
704
+ # },
705
+ # report_setting: { # required
706
+ # report_template: "string", # required
707
+ # },
708
+ # report_plan_tags: {
709
+ # "string" => "string",
710
+ # },
711
+ # idempotency_token: "string",
712
+ # })
713
+ #
714
+ # @example Response structure
715
+ #
716
+ # resp.report_plan_name #=> String
717
+ # resp.report_plan_arn #=> String
718
+ #
719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateReportPlan AWS API Documentation
720
+ #
721
+ # @overload create_report_plan(params = {})
722
+ # @param [Hash] params ({})
723
+ def create_report_plan(params = {}, options = {})
724
+ req = build_request(:create_report_plan, params)
725
+ req.send_request(options)
726
+ end
727
+
569
728
  # Deletes a backup plan. A backup plan can only be deleted after all
570
729
  # associated selections of resources have been deleted. Deleting a
571
730
  # backup plan deletes the current version of a backup plan. Previous
@@ -637,8 +796,8 @@ module Aws::Backup
637
796
  # @option params [required, String] :backup_vault_name
638
797
  # The name of a logical container where backups are stored. Backup
639
798
  # vaults are identified by names that are unique to the account used to
640
- # create them and the AWS Region where they are created. They consist of
641
- # lowercase letters, numbers, and hyphens.
799
+ # create them and the Amazon Web Services Region where they are created.
800
+ # They consist of lowercase letters, numbers, and hyphens.
642
801
  #
643
802
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
644
803
  #
@@ -663,8 +822,8 @@ module Aws::Backup
663
822
  # @option params [required, String] :backup_vault_name
664
823
  # The name of a logical container where backups are stored. Backup
665
824
  # vaults are identified by names that are unique to the account used to
666
- # create them and the AWS Region where they are created. They consist of
667
- # lowercase letters, numbers, and hyphens.
825
+ # create them and the Amazon Web Services Region where they are created.
826
+ # They consist of lowercase letters, numbers, and hyphens.
668
827
  #
669
828
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
670
829
  #
@@ -708,6 +867,28 @@ module Aws::Backup
708
867
  req.send_request(options)
709
868
  end
710
869
 
870
+ # Deletes the framework specified by a framework name.
871
+ #
872
+ # @option params [required, String] :framework_name
873
+ # The unique name of a framework.
874
+ #
875
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
876
+ #
877
+ # @example Request syntax with placeholder values
878
+ #
879
+ # resp = client.delete_framework({
880
+ # framework_name: "FrameworkName", # required
881
+ # })
882
+ #
883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteFramework AWS API Documentation
884
+ #
885
+ # @overload delete_framework(params = {})
886
+ # @param [Hash] params ({})
887
+ def delete_framework(params = {}, options = {})
888
+ req = build_request(:delete_framework, params)
889
+ req.send_request(options)
890
+ end
891
+
711
892
  # Deletes the recovery point specified by a recovery point ID.
712
893
  #
713
894
  # If the recovery point ID belongs to a continuous backup, calling this
@@ -717,8 +898,8 @@ module Aws::Backup
717
898
  # @option params [required, String] :backup_vault_name
718
899
  # The name of a logical container where backups are stored. Backup
719
900
  # vaults are identified by names that are unique to the account used to
720
- # create them and the AWS Region where they are created. They consist of
721
- # lowercase letters, numbers, and hyphens.
901
+ # create them and the Amazon Web Services Region where they are created.
902
+ # They consist of lowercase letters, numbers, and hyphens.
722
903
  #
723
904
  # @option params [required, String] :recovery_point_arn
724
905
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -743,10 +924,32 @@ module Aws::Backup
743
924
  req.send_request(options)
744
925
  end
745
926
 
927
+ # Deletes the report plan specified by a report plan name.
928
+ #
929
+ # @option params [required, String] :report_plan_name
930
+ # The unique name of a report plan.
931
+ #
932
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
933
+ #
934
+ # @example Request syntax with placeholder values
935
+ #
936
+ # resp = client.delete_report_plan({
937
+ # report_plan_name: "ReportPlanName", # required
938
+ # })
939
+ #
940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteReportPlan AWS API Documentation
941
+ #
942
+ # @overload delete_report_plan(params = {})
943
+ # @param [Hash] params ({})
944
+ def delete_report_plan(params = {}, options = {})
945
+ req = build_request(:delete_report_plan, params)
946
+ req.send_request(options)
947
+ end
948
+
746
949
  # Returns backup job details for the specified `BackupJobId`.
747
950
  #
748
951
  # @option params [required, String] :backup_job_id
749
- # Uniquely identifies a request to AWS Backup to back up a resource.
952
+ # Uniquely identifies a request to Backup to back up a resource.
750
953
  #
751
954
  # @return [Types::DescribeBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
752
955
  #
@@ -818,8 +1021,8 @@ module Aws::Backup
818
1021
  # @option params [required, String] :backup_vault_name
819
1022
  # The name of a logical container where backups are stored. Backup
820
1023
  # vaults are identified by names that are unique to the account used to
821
- # create them and the AWS Region where they are created. They consist of
822
- # lowercase letters, numbers, and hyphens.
1024
+ # create them and the Amazon Web Services Region where they are created.
1025
+ # They consist of lowercase letters, numbers, and hyphens.
823
1026
  #
824
1027
  # @return [Types::DescribeBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
825
1028
  #
@@ -899,8 +1102,62 @@ module Aws::Backup
899
1102
  req.send_request(options)
900
1103
  end
901
1104
 
902
- # Describes the global settings of the AWS account, including whether it
903
- # is opted in to cross-account backup.
1105
+ # Returns the framework details for the specified `FrameworkName`.
1106
+ #
1107
+ # @option params [required, String] :framework_name
1108
+ # The unique name of a framework.
1109
+ #
1110
+ # @return [Types::DescribeFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1111
+ #
1112
+ # * {Types::DescribeFrameworkOutput#framework_name #framework_name} => String
1113
+ # * {Types::DescribeFrameworkOutput#framework_arn #framework_arn} => String
1114
+ # * {Types::DescribeFrameworkOutput#framework_description #framework_description} => String
1115
+ # * {Types::DescribeFrameworkOutput#framework_controls #framework_controls} => Array&lt;Types::FrameworkControl&gt;
1116
+ # * {Types::DescribeFrameworkOutput#creation_time #creation_time} => Time
1117
+ # * {Types::DescribeFrameworkOutput#deployment_status #deployment_status} => String
1118
+ # * {Types::DescribeFrameworkOutput#framework_status #framework_status} => String
1119
+ # * {Types::DescribeFrameworkOutput#idempotency_token #idempotency_token} => String
1120
+ #
1121
+ # @example Request syntax with placeholder values
1122
+ #
1123
+ # resp = client.describe_framework({
1124
+ # framework_name: "FrameworkName", # required
1125
+ # })
1126
+ #
1127
+ # @example Response structure
1128
+ #
1129
+ # resp.framework_name #=> String
1130
+ # resp.framework_arn #=> String
1131
+ # resp.framework_description #=> String
1132
+ # resp.framework_controls #=> Array
1133
+ # resp.framework_controls[0].control_name #=> String
1134
+ # resp.framework_controls[0].control_input_parameters #=> Array
1135
+ # resp.framework_controls[0].control_input_parameters[0].parameter_name #=> String
1136
+ # resp.framework_controls[0].control_input_parameters[0].parameter_value #=> String
1137
+ # resp.framework_controls[0].control_scope.compliance_resource_ids #=> Array
1138
+ # resp.framework_controls[0].control_scope.compliance_resource_ids[0] #=> String
1139
+ # resp.framework_controls[0].control_scope.compliance_resource_types #=> Array
1140
+ # resp.framework_controls[0].control_scope.compliance_resource_types[0] #=> String
1141
+ # resp.framework_controls[0].control_scope.tags #=> Hash
1142
+ # resp.framework_controls[0].control_scope.tags["string"] #=> String
1143
+ # resp.creation_time #=> Time
1144
+ # resp.deployment_status #=> String
1145
+ # resp.framework_status #=> String
1146
+ # resp.idempotency_token #=> String
1147
+ #
1148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeFramework AWS API Documentation
1149
+ #
1150
+ # @overload describe_framework(params = {})
1151
+ # @param [Hash] params ({})
1152
+ def describe_framework(params = {}, options = {})
1153
+ req = build_request(:describe_framework, params)
1154
+ req.send_request(options)
1155
+ end
1156
+
1157
+ # Describes whether the Amazon Web Services account is opted in to
1158
+ # cross-account backup. Returns an error if the account is not a member
1159
+ # of an Organizations organization. Example: `describe-global-settings
1160
+ # --region us-west-2`
904
1161
  #
905
1162
  # @return [Types::DescribeGlobalSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
906
1163
  #
@@ -923,8 +1180,8 @@ module Aws::Backup
923
1180
  end
924
1181
 
925
1182
  # Returns information about a saved resource, including the last time it
926
- # was backed up, its Amazon Resource Name (ARN), and the AWS service
927
- # type of the saved resource.
1183
+ # was backed up, its Amazon Resource Name (ARN), and the Amazon Web
1184
+ # Services service type of the saved resource.
928
1185
  #
929
1186
  # @option params [required, String] :resource_arn
930
1187
  # An Amazon Resource Name (ARN) that uniquely identifies a resource. The
@@ -963,8 +1220,8 @@ module Aws::Backup
963
1220
  # @option params [required, String] :backup_vault_name
964
1221
  # The name of a logical container where backups are stored. Backup
965
1222
  # vaults are identified by names that are unique to the account used to
966
- # create them and the AWS Region where they are created. They consist of
967
- # lowercase letters, numbers, and hyphens.
1223
+ # create them and the Amazon Web Services Region where they are created.
1224
+ # They consist of lowercase letters, numbers, and hyphens.
968
1225
  #
969
1226
  # @option params [required, String] :recovery_point_arn
970
1227
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -982,6 +1239,7 @@ module Aws::Backup
982
1239
  # * {Types::DescribeRecoveryPointOutput#created_by #created_by} => Types::RecoveryPointCreator
983
1240
  # * {Types::DescribeRecoveryPointOutput#iam_role_arn #iam_role_arn} => String
984
1241
  # * {Types::DescribeRecoveryPointOutput#status #status} => String
1242
+ # * {Types::DescribeRecoveryPointOutput#status_message #status_message} => String
985
1243
  # * {Types::DescribeRecoveryPointOutput#creation_date #creation_date} => Time
986
1244
  # * {Types::DescribeRecoveryPointOutput#completion_date #completion_date} => Time
987
1245
  # * {Types::DescribeRecoveryPointOutput#backup_size_in_bytes #backup_size_in_bytes} => Integer
@@ -1013,6 +1271,7 @@ module Aws::Backup
1013
1271
  # resp.created_by.backup_rule_id #=> String
1014
1272
  # resp.iam_role_arn #=> String
1015
1273
  # resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
1274
+ # resp.status_message #=> String
1016
1275
  # resp.creation_date #=> Time
1017
1276
  # resp.completion_date #=> Time
1018
1277
  # resp.backup_size_in_bytes #=> Integer
@@ -1034,13 +1293,11 @@ module Aws::Backup
1034
1293
  req.send_request(options)
1035
1294
  end
1036
1295
 
1037
- # Returns the current service opt-in settings for the Region. If
1038
- # service-opt-in is enabled for a service, AWS Backup tries to protect
1039
- # that service's resources in this Region, when the resource is
1040
- # included in an on-demand backup or scheduled backup plan. Otherwise,
1041
- # AWS Backup does not try to protect that service's resources in this
1042
- # Region, AWS Backup does not try to protect that service's resources
1043
- # in this Region.
1296
+ # Returns the current service opt-in settings for the Region. If service
1297
+ # opt-in is enabled for a service, Backup tries to protect that
1298
+ # service's resources in this Region, when the resource is included in
1299
+ # an on-demand backup or scheduled backup plan. Otherwise, Backup does
1300
+ # not try to protect that service's resources in this Region.
1044
1301
  #
1045
1302
  # @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1046
1303
  #
@@ -1060,6 +1317,86 @@ module Aws::Backup
1060
1317
  req.send_request(options)
1061
1318
  end
1062
1319
 
1320
+ # Returns the details associated with creating a report as specified by
1321
+ # its `ReportJobId`.
1322
+ #
1323
+ # @option params [required, String] :report_job_id
1324
+ # The identifier of the report job. A unique, randomly generated,
1325
+ # Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The
1326
+ # report job ID cannot be edited.
1327
+ #
1328
+ # @return [Types::DescribeReportJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1329
+ #
1330
+ # * {Types::DescribeReportJobOutput#report_job #report_job} => Types::ReportJob
1331
+ #
1332
+ # @example Request syntax with placeholder values
1333
+ #
1334
+ # resp = client.describe_report_job({
1335
+ # report_job_id: "ReportJobId", # required
1336
+ # })
1337
+ #
1338
+ # @example Response structure
1339
+ #
1340
+ # resp.report_job.report_job_id #=> String
1341
+ # resp.report_job.report_plan_arn #=> String
1342
+ # resp.report_job.report_template #=> String
1343
+ # resp.report_job.creation_time #=> Time
1344
+ # resp.report_job.completion_time #=> Time
1345
+ # resp.report_job.status #=> String
1346
+ # resp.report_job.status_message #=> String
1347
+ # resp.report_job.report_destination.s3_bucket_name #=> String
1348
+ # resp.report_job.report_destination.s3_keys #=> Array
1349
+ # resp.report_job.report_destination.s3_keys[0] #=> String
1350
+ #
1351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeReportJob AWS API Documentation
1352
+ #
1353
+ # @overload describe_report_job(params = {})
1354
+ # @param [Hash] params ({})
1355
+ def describe_report_job(params = {}, options = {})
1356
+ req = build_request(:describe_report_job, params)
1357
+ req.send_request(options)
1358
+ end
1359
+
1360
+ # Returns a list of all report plans for an Amazon Web Services account
1361
+ # and Amazon Web Services Region.
1362
+ #
1363
+ # @option params [required, String] :report_plan_name
1364
+ # The unique name of a report plan.
1365
+ #
1366
+ # @return [Types::DescribeReportPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1367
+ #
1368
+ # * {Types::DescribeReportPlanOutput#report_plan #report_plan} => Types::ReportPlan
1369
+ #
1370
+ # @example Request syntax with placeholder values
1371
+ #
1372
+ # resp = client.describe_report_plan({
1373
+ # report_plan_name: "ReportPlanName", # required
1374
+ # })
1375
+ #
1376
+ # @example Response structure
1377
+ #
1378
+ # resp.report_plan.report_plan_arn #=> String
1379
+ # resp.report_plan.report_plan_name #=> String
1380
+ # resp.report_plan.report_plan_description #=> String
1381
+ # resp.report_plan.report_setting.report_template #=> String
1382
+ # resp.report_plan.report_delivery_channel.s3_bucket_name #=> String
1383
+ # resp.report_plan.report_delivery_channel.s3_key_prefix #=> String
1384
+ # resp.report_plan.report_delivery_channel.formats #=> Array
1385
+ # resp.report_plan.report_delivery_channel.formats[0] #=> String
1386
+ # resp.report_plan.deployment_status #=> String
1387
+ # resp.report_plan.creation_time #=> Time
1388
+ # resp.report_plan.last_attempted_execution_time #=> Time
1389
+ # resp.report_plan.last_successful_execution_time #=> Time
1390
+ #
1391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeReportPlan AWS API Documentation
1392
+ #
1393
+ # @overload describe_report_plan(params = {})
1394
+ # @param [Hash] params ({})
1395
+ def describe_report_plan(params = {}, options = {})
1396
+ req = build_request(:describe_report_plan, params)
1397
+ req.send_request(options)
1398
+ end
1399
+
1063
1400
  # Returns metadata associated with a restore job that is specified by a
1064
1401
  # job ID.
1065
1402
  #
@@ -1113,20 +1450,20 @@ module Aws::Backup
1113
1450
  req.send_request(options)
1114
1451
  end
1115
1452
 
1116
- # Deletes the specified continuous backup recovery point from AWS Backup
1117
- # and releases control of that continuous backup to the source service,
1118
- # such as Amazon RDS. The source service will continue to create and
1119
- # retain continuous backups using the lifecycle that you specified in
1120
- # your original backup plan.
1453
+ # Deletes the specified continuous backup recovery point from Backup and
1454
+ # releases control of that continuous backup to the source service, such
1455
+ # as Amazon RDS. The source service will continue to create and retain
1456
+ # continuous backups using the lifecycle that you specified in your
1457
+ # original backup plan.
1121
1458
  #
1122
1459
  # Does not support snapshot backup recovery points.
1123
1460
  #
1124
1461
  # @option params [required, String] :backup_vault_name
1125
- # The unique name of an AWS Backup vault. Required.
1462
+ # The unique name of an Backup vault.
1126
1463
  #
1127
1464
  # @option params [required, String] :recovery_point_arn
1128
- # An Amazon Resource Name (ARN) that uniquely identifies an AWS Backup
1129
- # recovery point. Required.
1465
+ # An Amazon Resource Name (ARN) that uniquely identifies an Backup
1466
+ # recovery point.
1130
1467
  #
1131
1468
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1132
1469
  #
@@ -1400,8 +1737,8 @@ module Aws::Backup
1400
1737
  # @option params [required, String] :backup_vault_name
1401
1738
  # The name of a logical container where backups are stored. Backup
1402
1739
  # vaults are identified by names that are unique to the account used to
1403
- # create them and the AWS Region where they are created. They consist of
1404
- # lowercase letters, numbers, and hyphens.
1740
+ # create them and the Amazon Web Services Region where they are created.
1741
+ # They consist of lowercase letters, numbers, and hyphens.
1405
1742
  #
1406
1743
  # @return [Types::GetBackupVaultAccessPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1407
1744
  #
@@ -1435,8 +1772,8 @@ module Aws::Backup
1435
1772
  # @option params [required, String] :backup_vault_name
1436
1773
  # The name of a logical container where backups are stored. Backup
1437
1774
  # vaults are identified by names that are unique to the account used to
1438
- # create them and the AWS Region where they are created. They consist of
1439
- # lowercase letters, numbers, and hyphens.
1775
+ # create them and the Amazon Web Services Region where they are created.
1776
+ # They consist of lowercase letters, numbers, and hyphens.
1440
1777
  #
1441
1778
  # @return [Types::GetBackupVaultNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1442
1779
  #
@@ -1474,8 +1811,8 @@ module Aws::Backup
1474
1811
  # @option params [required, String] :backup_vault_name
1475
1812
  # The name of a logical container where backups are stored. Backup
1476
1813
  # vaults are identified by names that are unique to the account used to
1477
- # create them and the AWS Region where they are created. They consist of
1478
- # lowercase letters, numbers, and hyphens.
1814
+ # create them and the Amazon Web Services Region where they are created.
1815
+ # They consist of lowercase letters, numbers, and hyphens.
1479
1816
  #
1480
1817
  # @option params [required, String] :recovery_point_arn
1481
1818
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -1511,7 +1848,7 @@ module Aws::Backup
1511
1848
  req.send_request(options)
1512
1849
  end
1513
1850
 
1514
- # Returns the AWS resource types supported by AWS Backup.
1851
+ # Returns the Amazon Web Services resource types supported by Backup.
1515
1852
  #
1516
1853
  # @return [Types::GetSupportedResourceTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1517
1854
  #
@@ -1558,8 +1895,9 @@ module Aws::Backup
1558
1895
  # @option params [String] :by_backup_vault_name
1559
1896
  # Returns only backup jobs that will be stored in the specified backup
1560
1897
  # vault. Backup vaults are identified by names that are unique to the
1561
- # account used to create them and the AWS Region where they are created.
1562
- # They consist of lowercase letters, numbers, and hyphens.
1898
+ # account used to create them and the Amazon Web Services Region where
1899
+ # they are created. They consist of lowercase letters, numbers, and
1900
+ # hyphens.
1563
1901
  #
1564
1902
  # @option params [Time,DateTime,Date,Integer,String] :by_created_before
1565
1903
  # Returns only backup jobs that were created before the specified date.
@@ -1582,14 +1920,14 @@ module Aws::Backup
1582
1920
  #
1583
1921
  # * `Aurora` for Amazon Aurora
1584
1922
  #
1585
- # * `Storage Gateway` for AWS Storage Gateway
1923
+ # * `Storage Gateway` for Storage Gateway
1586
1924
  #
1587
1925
  # @option params [String] :by_account_id
1588
1926
  # The account ID to list the jobs from. Returns only backup jobs
1589
1927
  # associated with the specified account ID.
1590
1928
  #
1591
- # If used from an AWS Organizations management account, passing `*`
1592
- # returns all jobs across the organization.
1929
+ # If used from an Organizations management account, passing `*` returns
1930
+ # all jobs across the organization.
1593
1931
  #
1594
1932
  # @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1595
1933
  #
@@ -1749,10 +2087,9 @@ module Aws::Backup
1749
2087
  req.send_request(options)
1750
2088
  end
1751
2089
 
1752
- # Returns a list of existing backup plans for an authenticated account.
1753
- # The list is populated only if the advanced option is set for the
1754
- # backup plan. The list contains information such as Amazon Resource
1755
- # Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan
2090
+ # Returns a list of all active backup plans for an authenticated
2091
+ # account. The list contains information such as Amazon Resource Names
2092
+ # (ARNs), plan IDs, creation and deletion dates, version IDs, plan
1756
2093
  # names, and creator request IDs.
1757
2094
  #
1758
2095
  # @option params [String] :next_token
@@ -1944,7 +2281,7 @@ module Aws::Backup
1944
2281
  #
1945
2282
  # * `Aurora` for Amazon Aurora
1946
2283
  #
1947
- # * `Storage Gateway` for AWS Storage Gateway
2284
+ # * `Storage Gateway` for Storage Gateway
1948
2285
  #
1949
2286
  # @option params [String] :by_destination_vault_arn
1950
2287
  # An Amazon Resource Name (ARN) that uniquely identifies a source backup
@@ -2008,7 +2345,53 @@ module Aws::Backup
2008
2345
  req.send_request(options)
2009
2346
  end
2010
2347
 
2011
- # Returns an array of resources successfully backed up by AWS Backup,
2348
+ # Returns a list of all frameworks for an Amazon Web Services account
2349
+ # and Amazon Web Services Region.
2350
+ #
2351
+ # @option params [Integer] :max_results
2352
+ # The number of desired results from 1 to 1000. Optional. If
2353
+ # unspecified, the query will return 1 MB of data.
2354
+ #
2355
+ # @option params [String] :next_token
2356
+ # An identifier that was returned from the previous call to this
2357
+ # operation, which can be used to return the next set of items in the
2358
+ # list.
2359
+ #
2360
+ # @return [Types::ListFrameworksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2361
+ #
2362
+ # * {Types::ListFrameworksOutput#frameworks #frameworks} => Array&lt;Types::Framework&gt;
2363
+ # * {Types::ListFrameworksOutput#next_token #next_token} => String
2364
+ #
2365
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2366
+ #
2367
+ # @example Request syntax with placeholder values
2368
+ #
2369
+ # resp = client.list_frameworks({
2370
+ # max_results: 1,
2371
+ # next_token: "string",
2372
+ # })
2373
+ #
2374
+ # @example Response structure
2375
+ #
2376
+ # resp.frameworks #=> Array
2377
+ # resp.frameworks[0].framework_name #=> String
2378
+ # resp.frameworks[0].framework_arn #=> String
2379
+ # resp.frameworks[0].framework_description #=> String
2380
+ # resp.frameworks[0].number_of_controls #=> Integer
2381
+ # resp.frameworks[0].creation_time #=> Time
2382
+ # resp.frameworks[0].deployment_status #=> String
2383
+ # resp.next_token #=> String
2384
+ #
2385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListFrameworks AWS API Documentation
2386
+ #
2387
+ # @overload list_frameworks(params = {})
2388
+ # @param [Hash] params ({})
2389
+ def list_frameworks(params = {}, options = {})
2390
+ req = build_request(:list_frameworks, params)
2391
+ req.send_request(options)
2392
+ end
2393
+
2394
+ # Returns an array of resources successfully backed up by Backup,
2012
2395
  # including the time the resource was saved, an Amazon Resource Name
2013
2396
  # (ARN) of the resource, and a resource type.
2014
2397
  #
@@ -2058,8 +2441,13 @@ module Aws::Backup
2058
2441
  # @option params [required, String] :backup_vault_name
2059
2442
  # The name of a logical container where backups are stored. Backup
2060
2443
  # vaults are identified by names that are unique to the account used to
2061
- # create them and the AWS Region where they are created. They consist of
2062
- # lowercase letters, numbers, and hyphens.
2444
+ # create them and the Amazon Web Services Region where they are created.
2445
+ # They consist of lowercase letters, numbers, and hyphens.
2446
+ #
2447
+ # <note markdown="1"> Backup vault name might not be available when a supported service
2448
+ # creates the backup.
2449
+ #
2450
+ # </note>
2063
2451
  #
2064
2452
  # @option params [String] :next_token
2065
2453
  # The next item following a partial list of returned items. For example,
@@ -2124,6 +2512,7 @@ module Aws::Backup
2124
2512
  # resp.recovery_points[0].created_by.backup_rule_id #=> String
2125
2513
  # resp.recovery_points[0].iam_role_arn #=> String
2126
2514
  # resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
2515
+ # resp.recovery_points[0].status_message #=> String
2127
2516
  # resp.recovery_points[0].creation_date #=> Time
2128
2517
  # resp.recovery_points[0].completion_date #=> Time
2129
2518
  # resp.recovery_points[0].backup_size_in_bytes #=> Integer
@@ -2144,9 +2533,14 @@ module Aws::Backup
2144
2533
  req.send_request(options)
2145
2534
  end
2146
2535
 
2147
- # Returns detailed information about recovery points of the type
2536
+ # Returns detailed information about all the recovery points of the type
2148
2537
  # specified by a resource Amazon Resource Name (ARN).
2149
2538
  #
2539
+ # <note markdown="1"> For Amazon EFS and Amazon EC2, this action only lists recovery points
2540
+ # created by Backup.
2541
+ #
2542
+ # </note>
2543
+ #
2150
2544
  # @option params [required, String] :resource_arn
2151
2545
  # An ARN that uniquely identifies a resource. The format of the ARN
2152
2546
  # depends on the resource type.
@@ -2160,6 +2554,10 @@ module Aws::Backup
2160
2554
  # @option params [Integer] :max_results
2161
2555
  # The maximum number of items to be returned.
2162
2556
  #
2557
+ # <note markdown="1"> Amazon RDS requires a value of at least 20.
2558
+ #
2559
+ # </note>
2560
+ #
2163
2561
  # @return [Types::ListRecoveryPointsByResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2164
2562
  #
2165
2563
  # * {Types::ListRecoveryPointsByResourceOutput#next_token #next_token} => String
@@ -2182,6 +2580,7 @@ module Aws::Backup
2182
2580
  # resp.recovery_points[0].recovery_point_arn #=> String
2183
2581
  # resp.recovery_points[0].creation_date #=> Time
2184
2582
  # resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
2583
+ # resp.recovery_points[0].status_message #=> String
2185
2584
  # resp.recovery_points[0].encryption_key_arn #=> String
2186
2585
  # resp.recovery_points[0].backup_size_bytes #=> Integer
2187
2586
  # resp.recovery_points[0].backup_vault_name #=> String
@@ -2195,8 +2594,134 @@ module Aws::Backup
2195
2594
  req.send_request(options)
2196
2595
  end
2197
2596
 
2198
- # Returns a list of jobs that AWS Backup initiated to restore a saved
2199
- # resource, including metadata about the recovery process.
2597
+ # Returns details about your report jobs.
2598
+ #
2599
+ # @option params [String] :by_report_plan_name
2600
+ # Returns only report jobs with the specified report plan name.
2601
+ #
2602
+ # @option params [Time,DateTime,Date,Integer,String] :by_creation_before
2603
+ # Returns only report jobs that were created before the date and time
2604
+ # specified in Unix format and Coordinated Universal Time (UTC). For
2605
+ # example, the value 1516925490 represents Friday, January 26, 2018
2606
+ # 12:11:30 AM.
2607
+ #
2608
+ # @option params [Time,DateTime,Date,Integer,String] :by_creation_after
2609
+ # Returns only report jobs that were created after the date and time
2610
+ # specified in Unix format and Coordinated Universal Time (UTC). For
2611
+ # example, the value 1516925490 represents Friday, January 26, 2018
2612
+ # 12:11:30 AM.
2613
+ #
2614
+ # @option params [String] :by_status
2615
+ # Returns only report jobs that are in the specified status. The
2616
+ # statuses are:
2617
+ #
2618
+ # `CREATED | RUNNING | COMPLETED | FAILED`
2619
+ #
2620
+ # @option params [Integer] :max_results
2621
+ # The number of desired results from 1 to 1000. Optional. If
2622
+ # unspecified, the query will return 1 MB of data.
2623
+ #
2624
+ # @option params [String] :next_token
2625
+ # An identifier that was returned from the previous call to this
2626
+ # operation, which can be used to return the next set of items in the
2627
+ # list.
2628
+ #
2629
+ # @return [Types::ListReportJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2630
+ #
2631
+ # * {Types::ListReportJobsOutput#report_jobs #report_jobs} => Array&lt;Types::ReportJob&gt;
2632
+ # * {Types::ListReportJobsOutput#next_token #next_token} => String
2633
+ #
2634
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2635
+ #
2636
+ # @example Request syntax with placeholder values
2637
+ #
2638
+ # resp = client.list_report_jobs({
2639
+ # by_report_plan_name: "ReportPlanName",
2640
+ # by_creation_before: Time.now,
2641
+ # by_creation_after: Time.now,
2642
+ # by_status: "string",
2643
+ # max_results: 1,
2644
+ # next_token: "string",
2645
+ # })
2646
+ #
2647
+ # @example Response structure
2648
+ #
2649
+ # resp.report_jobs #=> Array
2650
+ # resp.report_jobs[0].report_job_id #=> String
2651
+ # resp.report_jobs[0].report_plan_arn #=> String
2652
+ # resp.report_jobs[0].report_template #=> String
2653
+ # resp.report_jobs[0].creation_time #=> Time
2654
+ # resp.report_jobs[0].completion_time #=> Time
2655
+ # resp.report_jobs[0].status #=> String
2656
+ # resp.report_jobs[0].status_message #=> String
2657
+ # resp.report_jobs[0].report_destination.s3_bucket_name #=> String
2658
+ # resp.report_jobs[0].report_destination.s3_keys #=> Array
2659
+ # resp.report_jobs[0].report_destination.s3_keys[0] #=> String
2660
+ # resp.next_token #=> String
2661
+ #
2662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListReportJobs AWS API Documentation
2663
+ #
2664
+ # @overload list_report_jobs(params = {})
2665
+ # @param [Hash] params ({})
2666
+ def list_report_jobs(params = {}, options = {})
2667
+ req = build_request(:list_report_jobs, params)
2668
+ req.send_request(options)
2669
+ end
2670
+
2671
+ # Returns a list of your report plans. For detailed information about a
2672
+ # single report plan, use `DescribeReportPlan`.
2673
+ #
2674
+ # @option params [Integer] :max_results
2675
+ # The number of desired results from 1 to 1000. Optional. If
2676
+ # unspecified, the query will return 1 MB of data.
2677
+ #
2678
+ # @option params [String] :next_token
2679
+ # An identifier that was returned from the previous call to this
2680
+ # operation, which can be used to return the next set of items in the
2681
+ # list.
2682
+ #
2683
+ # @return [Types::ListReportPlansOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2684
+ #
2685
+ # * {Types::ListReportPlansOutput#report_plans #report_plans} => Array&lt;Types::ReportPlan&gt;
2686
+ # * {Types::ListReportPlansOutput#next_token #next_token} => String
2687
+ #
2688
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2689
+ #
2690
+ # @example Request syntax with placeholder values
2691
+ #
2692
+ # resp = client.list_report_plans({
2693
+ # max_results: 1,
2694
+ # next_token: "string",
2695
+ # })
2696
+ #
2697
+ # @example Response structure
2698
+ #
2699
+ # resp.report_plans #=> Array
2700
+ # resp.report_plans[0].report_plan_arn #=> String
2701
+ # resp.report_plans[0].report_plan_name #=> String
2702
+ # resp.report_plans[0].report_plan_description #=> String
2703
+ # resp.report_plans[0].report_setting.report_template #=> String
2704
+ # resp.report_plans[0].report_delivery_channel.s3_bucket_name #=> String
2705
+ # resp.report_plans[0].report_delivery_channel.s3_key_prefix #=> String
2706
+ # resp.report_plans[0].report_delivery_channel.formats #=> Array
2707
+ # resp.report_plans[0].report_delivery_channel.formats[0] #=> String
2708
+ # resp.report_plans[0].deployment_status #=> String
2709
+ # resp.report_plans[0].creation_time #=> Time
2710
+ # resp.report_plans[0].last_attempted_execution_time #=> Time
2711
+ # resp.report_plans[0].last_successful_execution_time #=> Time
2712
+ # resp.next_token #=> String
2713
+ #
2714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListReportPlans AWS API Documentation
2715
+ #
2716
+ # @overload list_report_plans(params = {})
2717
+ # @param [Hash] params ({})
2718
+ def list_report_plans(params = {}, options = {})
2719
+ req = build_request(:list_report_plans, params)
2720
+ req.send_request(options)
2721
+ end
2722
+
2723
+ # Returns a list of jobs that Backup initiated to restore a saved
2724
+ # resource, including details about the recovery process.
2200
2725
  #
2201
2726
  # @option params [String] :next_token
2202
2727
  # The next item following a partial list of returned items. For example,
@@ -2323,8 +2848,8 @@ module Aws::Backup
2323
2848
  # @option params [required, String] :backup_vault_name
2324
2849
  # The name of a logical container where backups are stored. Backup
2325
2850
  # vaults are identified by names that are unique to the account used to
2326
- # create them and the AWS Region where they are created. They consist of
2327
- # lowercase letters, numbers, and hyphens.
2851
+ # create them and the Amazon Web Services Region where they are created.
2852
+ # They consist of lowercase letters, numbers, and hyphens.
2328
2853
  #
2329
2854
  # @option params [String] :policy
2330
2855
  # The backup vault access policy document in JSON format.
@@ -2353,8 +2878,8 @@ module Aws::Backup
2353
2878
  # @option params [required, String] :backup_vault_name
2354
2879
  # The name of a logical container where backups are stored. Backup
2355
2880
  # vaults are identified by names that are unique to the account used to
2356
- # create them and the AWS Region where they are created. They consist of
2357
- # lowercase letters, numbers, and hyphens.
2881
+ # create them and the Amazon Web Services Region where they are created.
2882
+ # They consist of lowercase letters, numbers, and hyphens.
2358
2883
  #
2359
2884
  # @option params [required, String] :sns_topic_arn
2360
2885
  # The Amazon Resource Name (ARN) that specifies the topic for a backup
@@ -2365,6 +2890,22 @@ module Aws::Backup
2365
2890
  # An array of events that indicate the status of jobs to back up
2366
2891
  # resources to the backup vault.
2367
2892
  #
2893
+ # <note markdown="1"> The following events are supported:
2894
+ #
2895
+ # `BACKUP_JOB_STARTED`, `BACKUP_JOB_COMPLETED`,
2896
+ #
2897
+ # `COPY_JOB_STARTED`, `COPY_JOB_SUCCESSFUL`, `COPY_JOB_FAILED`,
2898
+ #
2899
+ # `RESTORE_JOB_STARTED`, `RESTORE_JOB_COMPLETED`, and
2900
+ # `RECOVERY_POINT_MODIFIED`.
2901
+ #
2902
+ # To find failed backup jobs, use `BACKUP_JOB_COMPLETED` and filter
2903
+ # using event metadata.
2904
+ #
2905
+ # Other events in the following list are deprecated.
2906
+ #
2907
+ # </note>
2908
+ #
2368
2909
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2369
2910
  #
2370
2911
  # @example Request syntax with placeholder values
@@ -2389,8 +2930,8 @@ module Aws::Backup
2389
2930
  # @option params [required, String] :backup_vault_name
2390
2931
  # The name of a logical container where backups are stored. Backup
2391
2932
  # vaults are identified by names that are unique to the account used to
2392
- # create them and the AWS Region where they are created. They consist of
2393
- # lowercase letters, numbers, and hyphens.
2933
+ # create them and the Amazon Web Services Region where they are created.
2934
+ # They consist of lowercase letters, numbers, and hyphens.
2394
2935
  #
2395
2936
  # @option params [required, String] :resource_arn
2396
2937
  # An Amazon Resource Name (ARN) that uniquely identifies a resource. The
@@ -2401,8 +2942,10 @@ module Aws::Backup
2401
2942
  # for example, `arn:aws:iam::123456789012:role/S3Access`.
2402
2943
  #
2403
2944
  # @option params [String] :idempotency_token
2404
- # A customer chosen string that can be used to distinguish between calls
2405
- # to `StartBackupJob`.
2945
+ # A customer-chosen string that you can use to distinguish between
2946
+ # otherwise identical calls to `StartBackupJob`. Retrying a successful
2947
+ # request with the same idempotency token results in a success message
2948
+ # with no action taken.
2406
2949
  #
2407
2950
  # @option params [Integer] :start_window_minutes
2408
2951
  # A value in minutes after a backup is scheduled before a job will be
@@ -2418,9 +2961,8 @@ module Aws::Backup
2418
2961
  #
2419
2962
  # @option params [Types::Lifecycle] :lifecycle
2420
2963
  # The lifecycle defines when a protected resource is transitioned to
2421
- # cold storage and when it expires. AWS Backup will transition and
2422
- # expire backups automatically according to the lifecycle that you
2423
- # define.
2964
+ # cold storage and when it expires. Backup will transition and expire
2965
+ # backups automatically according to the lifecycle that you define.
2424
2966
  #
2425
2967
  # Backups transitioned to cold storage must be stored in cold storage
2426
2968
  # for a minimum of 90 days. Therefore, the “expire after days” setting
@@ -2437,11 +2979,12 @@ module Aws::Backup
2437
2979
  #
2438
2980
  # @option params [Hash<String,String>] :backup_options
2439
2981
  # Specifies the backup option for a selected resource. This option is
2440
- # only available for Windows VSS backup jobs.
2982
+ # only available for Windows Volume Shadow Copy Service (VSS) backup
2983
+ # jobs.
2441
2984
  #
2442
- # Valid values: Set to `"WindowsVSS”:“enabled"` to enable WindowsVSS
2443
- # backup option and create a VSS Windows backup. Set to
2444
- # WindowsVSS”:”disabled to create a regular backup. The WindowsVSS
2985
+ # Valid values: Set to `"WindowsVSS":"enabled"` to enable the
2986
+ # `WindowsVSS` backup option and create a Windows VSS backup. Set to
2987
+ # `"WindowsVSS""disabled"` to create a regular backup. The `WindowsVSS`
2445
2988
  # option is not enabled by default.
2446
2989
  #
2447
2990
  # @return [Types::StartBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2498,8 +3041,8 @@ module Aws::Backup
2498
3041
  # @option params [required, String] :source_backup_vault_name
2499
3042
  # The name of a logical source container where backups are stored.
2500
3043
  # Backup vaults are identified by names that are unique to the account
2501
- # used to create them and the AWS Region where they are created. They
2502
- # consist of lowercase letters, numbers, and hyphens.
3044
+ # used to create them and the Amazon Web Services Region where they are
3045
+ # created. They consist of lowercase letters, numbers, and hyphens.
2503
3046
  #
2504
3047
  # @option params [required, String] :destination_backup_vault_arn
2505
3048
  # An Amazon Resource Name (ARN) that uniquely identifies a destination
@@ -2511,8 +3054,10 @@ module Aws::Backup
2511
3054
  # example, `arn:aws:iam::123456789012:role/S3Access`.
2512
3055
  #
2513
3056
  # @option params [String] :idempotency_token
2514
- # A customer chosen string that can be used to distinguish between calls
2515
- # to `StartCopyJob`.
3057
+ # A customer-chosen string that you can use to distinguish between
3058
+ # otherwise identical calls to `StartCopyJob`. Retrying a successful
3059
+ # request with the same idempotency token results in a success message
3060
+ # with no action taken.
2516
3061
  #
2517
3062
  # @option params [Types::Lifecycle] :lifecycle
2518
3063
  # Contains an array of `Transition` objects specifying how long in days
@@ -2560,6 +3105,44 @@ module Aws::Backup
2560
3105
  req.send_request(options)
2561
3106
  end
2562
3107
 
3108
+ # Starts an on-demand report job for the specified report plan.
3109
+ #
3110
+ # @option params [required, String] :report_plan_name
3111
+ # The unique name of a report plan.
3112
+ #
3113
+ # @option params [String] :idempotency_token
3114
+ # A customer-chosen string that you can use to distinguish between
3115
+ # otherwise identical calls to `StartReportJobInput`. Retrying a
3116
+ # successful request with the same idempotency token results in a
3117
+ # success message with no action taken.
3118
+ #
3119
+ # **A suitable default value is auto-generated.** You should normally
3120
+ # not need to pass this option.**
3121
+ #
3122
+ # @return [Types::StartReportJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3123
+ #
3124
+ # * {Types::StartReportJobOutput#report_job_id #report_job_id} => String
3125
+ #
3126
+ # @example Request syntax with placeholder values
3127
+ #
3128
+ # resp = client.start_report_job({
3129
+ # report_plan_name: "ReportPlanName", # required
3130
+ # idempotency_token: "string",
3131
+ # })
3132
+ #
3133
+ # @example Response structure
3134
+ #
3135
+ # resp.report_job_id #=> String
3136
+ #
3137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartReportJob AWS API Documentation
3138
+ #
3139
+ # @overload start_report_job(params = {})
3140
+ # @param [Hash] params ({})
3141
+ def start_report_job(params = {}, options = {})
3142
+ req = build_request(:start_report_job, params)
3143
+ req.send_request(options)
3144
+ end
3145
+
2563
3146
  # Recovers the saved resource identified by an Amazon Resource Name
2564
3147
  # (ARN).
2565
3148
  #
@@ -2582,17 +3165,16 @@ module Aws::Backup
2582
3165
  # File System (Amazon EFS) instance:
2583
3166
  #
2584
3167
  # * `file-system-id`\: The ID of the Amazon EFS file system that is
2585
- # backed up by AWS Backup. Returned in
2586
- # `GetRecoveryPointRestoreMetadata`.
3168
+ # backed up by Backup. Returned in `GetRecoveryPointRestoreMetadata`.
2587
3169
  #
2588
3170
  # * `Encrypted`\: A Boolean value that, if true, specifies that the file
2589
3171
  # system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
2590
3172
  # set to `true`.
2591
3173
  #
2592
- # * `KmsKeyId`\: Specifies the AWS KMS key that is used to encrypt the
2593
- # restored file system. You can specify a key from another AWS account
2594
- # provided that key it is properly shared with your account via AWS
2595
- # KMS.
3174
+ # * `KmsKeyId`\: Specifies the Amazon Web Services KMS key that is used
3175
+ # to encrypt the restored file system. You can specify a key from
3176
+ # another Amazon Web Services account provided that key it is properly
3177
+ # shared with your account via Amazon Web Services KMS.
2596
3178
  #
2597
3179
  # * `PerformanceMode`\: Specifies the throughput mode of the file
2598
3180
  # system.
@@ -2603,20 +3185,21 @@ module Aws::Backup
2603
3185
  # * `newFileSystem`\: A Boolean value that, if true, specifies that the
2604
3186
  # recovery point is restored to a new Amazon EFS file system.
2605
3187
  #
2606
- # * `ItemsToRestore `\: An array of one to five strings where each
2607
- # string is a file path. Use `ItemsToRestore` to restore specific
2608
- # files or directories rather than the entire file system. This
2609
- # parameter is optional. For example,
2610
- # `"itemsToRestore":"["/my.test"]"`.
3188
+ # * `ItemsToRestore`\: An array of one to five strings where each string
3189
+ # is a file path. Use `ItemsToRestore` to restore specific files or
3190
+ # directories rather than the entire file system. This parameter is
3191
+ # optional. For example, `"itemsToRestore":"["/my.test"]"`.
2611
3192
  #
2612
3193
  # @option params [required, String] :iam_role_arn
2613
- # The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to
3194
+ # The Amazon Resource Name (ARN) of the IAM role that Backup uses to
2614
3195
  # create the target recovery point; for example,
2615
3196
  # `arn:aws:iam::123456789012:role/S3Access`.
2616
3197
  #
2617
3198
  # @option params [String] :idempotency_token
2618
- # A customer chosen string that can be used to distinguish between calls
2619
- # to `StartRestoreJob`.
3199
+ # A customer-chosen string that you can use to distinguish between
3200
+ # otherwise identical calls to `StartRestoreJob`. Retrying a successful
3201
+ # request with the same idempotency token results in a success message
3202
+ # with no action taken.
2620
3203
  #
2621
3204
  # @option params [String] :resource_type
2622
3205
  # Starts a job to restore a recovery point for one of the following
@@ -2634,7 +3217,7 @@ module Aws::Backup
2634
3217
  #
2635
3218
  # * `Aurora` for Amazon Aurora
2636
3219
  #
2637
- # * `Storage Gateway` for AWS Storage Gateway
3220
+ # * `Storage Gateway` for Storage Gateway
2638
3221
  #
2639
3222
  # @return [Types::StartRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2640
3223
  #
@@ -2668,7 +3251,7 @@ module Aws::Backup
2668
3251
  # Attempts to cancel a job to create a one-time backup of a resource.
2669
3252
  #
2670
3253
  # @option params [required, String] :backup_job_id
2671
- # Uniquely identifies a request to AWS Backup to back up a resource.
3254
+ # Uniquely identifies a request to Backup to back up a resource.
2672
3255
  #
2673
3256
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2674
3257
  #
@@ -2829,11 +3412,87 @@ module Aws::Backup
2829
3412
  req.send_request(options)
2830
3413
  end
2831
3414
 
2832
- # Updates the current global settings for the AWS account. Use the
2833
- # `DescribeGlobalSettings` API to determine the current settings.
3415
+ # Updates an existing framework identified by its `FrameworkName` with
3416
+ # the input document in JSON format.
3417
+ #
3418
+ # @option params [required, String] :framework_name
3419
+ # The unique name of a framework. This name is between 1 and 256
3420
+ # characters, starting with a letter, and consisting of letters (a-z,
3421
+ # A-Z), numbers (0-9), and underscores (\_).
3422
+ #
3423
+ # @option params [String] :framework_description
3424
+ # An optional description of the framework with a maximum 1,024
3425
+ # characters.
3426
+ #
3427
+ # @option params [Array<Types::FrameworkControl>] :framework_controls
3428
+ # A list of the controls that make up the framework. Each control in the
3429
+ # list has a name, input parameters, and scope.
3430
+ #
3431
+ # @option params [String] :idempotency_token
3432
+ # A customer-chosen string that you can use to distinguish between
3433
+ # otherwise identical calls to `UpdateFrameworkInput`. Retrying a
3434
+ # successful request with the same idempotency token results in a
3435
+ # success message with no action taken.
3436
+ #
3437
+ # **A suitable default value is auto-generated.** You should normally
3438
+ # not need to pass this option.**
3439
+ #
3440
+ # @return [Types::UpdateFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3441
+ #
3442
+ # * {Types::UpdateFrameworkOutput#framework_name #framework_name} => String
3443
+ # * {Types::UpdateFrameworkOutput#framework_arn #framework_arn} => String
3444
+ # * {Types::UpdateFrameworkOutput#creation_time #creation_time} => Time
3445
+ #
3446
+ # @example Request syntax with placeholder values
3447
+ #
3448
+ # resp = client.update_framework({
3449
+ # framework_name: "FrameworkName", # required
3450
+ # framework_description: "FrameworkDescription",
3451
+ # framework_controls: [
3452
+ # {
3453
+ # control_name: "ControlName", # required
3454
+ # control_input_parameters: [
3455
+ # {
3456
+ # parameter_name: "ParameterName",
3457
+ # parameter_value: "ParameterValue",
3458
+ # },
3459
+ # ],
3460
+ # control_scope: {
3461
+ # compliance_resource_ids: ["string"],
3462
+ # compliance_resource_types: ["ARN"],
3463
+ # tags: {
3464
+ # "string" => "string",
3465
+ # },
3466
+ # },
3467
+ # },
3468
+ # ],
3469
+ # idempotency_token: "string",
3470
+ # })
3471
+ #
3472
+ # @example Response structure
3473
+ #
3474
+ # resp.framework_name #=> String
3475
+ # resp.framework_arn #=> String
3476
+ # resp.creation_time #=> Time
3477
+ #
3478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateFramework AWS API Documentation
3479
+ #
3480
+ # @overload update_framework(params = {})
3481
+ # @param [Hash] params ({})
3482
+ def update_framework(params = {}, options = {})
3483
+ req = build_request(:update_framework, params)
3484
+ req.send_request(options)
3485
+ end
3486
+
3487
+ # Updates whether the Amazon Web Services account is opted in to
3488
+ # cross-account backup. Returns an error if the account is not an
3489
+ # Organizations management account. Use the `DescribeGlobalSettings` API
3490
+ # to determine the current settings.
2834
3491
  #
2835
3492
  # @option params [Hash<String,String>] :global_settings
2836
- # A list of resources along with the opt-in preferences for the account.
3493
+ # A value for `isCrossAccountBackupEnabled` and a Region. Example:
3494
+ # `update-global-settings --global-settings
3495
+ # isCrossAccountBackupEnabled=false --region us-west-2`.
2837
3496
  #
2838
3497
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2839
3498
  #
@@ -2857,7 +3516,7 @@ module Aws::Backup
2857
3516
  # Sets the transition lifecycle of a recovery point.
2858
3517
  #
2859
3518
  # The lifecycle defines when a protected resource is transitioned to
2860
- # cold storage and when it expires. AWS Backup transitions and expires
3519
+ # cold storage and when it expires. Backup transitions and expires
2861
3520
  # backups automatically according to the lifecycle that you define.
2862
3521
  #
2863
3522
  # Backups transitioned to cold storage must be stored in cold storage
@@ -2874,8 +3533,8 @@ module Aws::Backup
2874
3533
  # @option params [required, String] :backup_vault_name
2875
3534
  # The name of a logical container where backups are stored. Backup
2876
3535
  # vaults are identified by names that are unique to the account used to
2877
- # create them and the AWS Region where they are created. They consist of
2878
- # lowercase letters, numbers, and hyphens.
3536
+ # create them and the Amazon Web Services Region where they are created.
3537
+ # They consist of lowercase letters, numbers, and hyphens.
2879
3538
  #
2880
3539
  # @option params [required, String] :recovery_point_arn
2881
3540
  # An Amazon Resource Name (ARN) that uniquely identifies a recovery
@@ -2884,7 +3543,7 @@ module Aws::Backup
2884
3543
  #
2885
3544
  # @option params [Types::Lifecycle] :lifecycle
2886
3545
  # The lifecycle defines when a protected resource is transitioned to
2887
- # cold storage and when it expires. AWS Backup transitions and expires
3546
+ # cold storage and when it expires. Backup transitions and expires
2888
3547
  # backups automatically according to the lifecycle that you define.
2889
3548
  #
2890
3549
  # Backups transitioned to cold storage must be stored in cold storage
@@ -2930,12 +3589,12 @@ module Aws::Backup
2930
3589
  end
2931
3590
 
2932
3591
  # Updates the current service opt-in settings for the Region. If
2933
- # service-opt-in is enabled for a service, AWS Backup tries to protect
2934
- # that service's resources in this Region, when the resource is
2935
- # included in an on-demand backup or scheduled backup plan. Otherwise,
2936
- # AWS Backup does not try to protect that service's resources in this
2937
- # Region. Use the `DescribeRegionSettings` API to determine the resource
2938
- # types that are supported.
3592
+ # service-opt-in is enabled for a service, Backup tries to protect that
3593
+ # service's resources in this Region, when the resource is included in
3594
+ # an on-demand backup or scheduled backup plan. Otherwise, Backup does
3595
+ # not try to protect that service's resources in this Region. Use the
3596
+ # `DescribeRegionSettings` API to determine the resource types that are
3597
+ # supported.
2939
3598
  #
2940
3599
  # @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
2941
3600
  # Updates the list of services along with the opt-in preferences for the
@@ -2960,6 +3619,75 @@ module Aws::Backup
2960
3619
  req.send_request(options)
2961
3620
  end
2962
3621
 
3622
+ # Updates an existing report plan identified by its `ReportPlanName`
3623
+ # with the input document in JSON format.
3624
+ #
3625
+ # @option params [required, String] :report_plan_name
3626
+ # The unique name of the report plan. This name is between 1 and 256
3627
+ # characters, starting with a letter, and consisting of letters (a-z,
3628
+ # A-Z), numbers (0-9), and underscores (\_).
3629
+ #
3630
+ # @option params [String] :report_plan_description
3631
+ # An optional description of the report plan with a maximum 1,024
3632
+ # characters.
3633
+ #
3634
+ # @option params [Types::ReportDeliveryChannel] :report_delivery_channel
3635
+ # A structure that contains information about where to deliver your
3636
+ # reports, specifically your Amazon S3 bucket name, S3 key prefix, and
3637
+ # the formats of your reports.
3638
+ #
3639
+ # @option params [Types::ReportSetting] :report_setting
3640
+ # Identifies the report template for the report. Reports are built using
3641
+ # a report template. The report templates are:
3642
+ #
3643
+ # `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
3644
+ #
3645
+ # @option params [String] :idempotency_token
3646
+ # A customer-chosen string that you can use to distinguish between
3647
+ # otherwise identical calls to `UpdateReportPlanInput`. Retrying a
3648
+ # successful request with the same idempotency token results in a
3649
+ # success message with no action taken.
3650
+ #
3651
+ # **A suitable default value is auto-generated.** You should normally
3652
+ # not need to pass this option.**
3653
+ #
3654
+ # @return [Types::UpdateReportPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3655
+ #
3656
+ # * {Types::UpdateReportPlanOutput#report_plan_name #report_plan_name} => String
3657
+ # * {Types::UpdateReportPlanOutput#report_plan_arn #report_plan_arn} => String
3658
+ # * {Types::UpdateReportPlanOutput#creation_time #creation_time} => Time
3659
+ #
3660
+ # @example Request syntax with placeholder values
3661
+ #
3662
+ # resp = client.update_report_plan({
3663
+ # report_plan_name: "ReportPlanName", # required
3664
+ # report_plan_description: "ReportPlanDescription",
3665
+ # report_delivery_channel: {
3666
+ # s3_bucket_name: "string", # required
3667
+ # s3_key_prefix: "string",
3668
+ # formats: ["string"],
3669
+ # },
3670
+ # report_setting: {
3671
+ # report_template: "string", # required
3672
+ # },
3673
+ # idempotency_token: "string",
3674
+ # })
3675
+ #
3676
+ # @example Response structure
3677
+ #
3678
+ # resp.report_plan_name #=> String
3679
+ # resp.report_plan_arn #=> String
3680
+ # resp.creation_time #=> Time
3681
+ #
3682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateReportPlan AWS API Documentation
3683
+ #
3684
+ # @overload update_report_plan(params = {})
3685
+ # @param [Hash] params ({})
3686
+ def update_report_plan(params = {}, options = {})
3687
+ req = build_request(:update_report_plan, params)
3688
+ req.send_request(options)
3689
+ end
3690
+
2963
3691
  # @!endgroup
2964
3692
 
2965
3693
  # @param params ({})
@@ -2973,7 +3701,7 @@ module Aws::Backup
2973
3701
  params: params,
2974
3702
  config: config)
2975
3703
  context[:gem_name] = 'aws-sdk-backup'
2976
- context[:gem_version] = '1.30.0'
3704
+ context[:gem_version] = '1.31.0'
2977
3705
  Seahorse::Client::Request.new(handlers, context)
2978
3706
  end
2979
3707