aws-sdk-backup 1.27.0 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +168 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-backup/client.rb +887 -107
- data/lib/aws-sdk-backup/client_api.rb +457 -1
- data/lib/aws-sdk-backup/errors.rb +63 -1
- data/lib/aws-sdk-backup/resource.rb +1 -1
- data/lib/aws-sdk-backup/types.rb +1561 -188
- data/lib/aws-sdk-backup.rb +2 -2
- metadata +11 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c54a3897810f6e5b879b41f62f35b26fac46a157b92b17c3e651af0078182db8
|
4
|
+
data.tar.gz: de39094a7a90e2b1cb05840e88a054bb0ea7f24d995c89a11243270ac29b54ee
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e7ad9467a8f03ed8914b3788988db52bdc0cb6d6233c6623306316416aadc303618b039cdeff97787afe1e4d18eed6108f5129e0b55bd0db6eb11ff31025e230
|
7
|
+
data.tar.gz: fad5a6f8bd253e526689150ce9af4af476f9a7cf7219d7a47ca84d7e0a0ba71c6da10ca9fabbc61f55e6d4b0413132bf28a67c80dc8d37576521fff4ffce67d3
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,168 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.31.0 (2021-08-23)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS Backup - Features: Evaluate your backup activity and generate audit reports.
|
8
|
+
|
9
|
+
1.30.0 (2021-07-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.29.0 (2021-07-28)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.28.0 (2021-03-10)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Added support for enabling continuous backups.
|
23
|
+
|
24
|
+
1.27.0 (2021-02-02)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
28
|
+
|
29
|
+
1.26.0 (2021-01-26)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Documentation updates for AWS Backup
|
33
|
+
|
34
|
+
1.25.0 (2020-11-18)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - AWS Backup now supports cross-account backup, enabling AWS customers to securely copy their backups across their AWS accounts within their AWS organizations.
|
38
|
+
|
39
|
+
1.24.0 (2020-10-19)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Documentation updates for Cryo
|
43
|
+
|
44
|
+
1.23.0 (2020-09-30)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
48
|
+
|
49
|
+
1.22.0 (2020-09-23)
|
50
|
+
------------------
|
51
|
+
|
52
|
+
* Feature - This release allows customers to enable or disable advanced backup settings in backup plan. As part of this feature AWS Backup added support for Windows VSS backup option for EC2 resources.
|
53
|
+
|
54
|
+
1.21.0 (2020-09-15)
|
55
|
+
------------------
|
56
|
+
|
57
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
58
|
+
|
59
|
+
1.20.0 (2020-08-31)
|
60
|
+
------------------
|
61
|
+
|
62
|
+
* Feature - Documentation updates for Cryo
|
63
|
+
|
64
|
+
1.19.0 (2020-08-25)
|
65
|
+
------------------
|
66
|
+
|
67
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
68
|
+
|
69
|
+
1.18.0 (2020-06-24)
|
70
|
+
------------------
|
71
|
+
|
72
|
+
* Feature - Customers can now manage and monitor their backups in a policied manner across their AWS accounts, via an integration between AWS Backup and AWS Organizations
|
73
|
+
|
74
|
+
1.17.0 (2020-06-23)
|
75
|
+
------------------
|
76
|
+
|
77
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
78
|
+
|
79
|
+
1.16.1 (2020-06-11)
|
80
|
+
------------------
|
81
|
+
|
82
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
83
|
+
|
84
|
+
1.16.0 (2020-06-10)
|
85
|
+
------------------
|
86
|
+
|
87
|
+
* Issue - This version has been yanked. (#2327).
|
88
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
89
|
+
|
90
|
+
1.15.0 (2020-05-28)
|
91
|
+
------------------
|
92
|
+
|
93
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
94
|
+
|
95
|
+
1.14.0 (2020-05-20)
|
96
|
+
------------------
|
97
|
+
|
98
|
+
* Feature - This release allows customers to enable or disable AWS Backup support for an AWS resource type. This release also includes new APIs, update-region-settings and describe-region-settings, which can be used to opt in to a specific resource type. For all current AWS Backup customers, the default settings enable support for EBS, EC2, StorageGateway, EFS, DDB and RDS resource types.
|
99
|
+
|
100
|
+
1.13.0 (2020-05-07)
|
101
|
+
------------------
|
102
|
+
|
103
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
104
|
+
|
105
|
+
1.12.0 (2020-03-09)
|
106
|
+
------------------
|
107
|
+
|
108
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
109
|
+
|
110
|
+
1.11.0 (2020-01-13)
|
111
|
+
------------------
|
112
|
+
|
113
|
+
* Feature - Cross-region backup is a new AWS Backup feature that allows enterprises to copy backups across multiple AWS services to different regions.
|
114
|
+
|
115
|
+
1.10.0 (2019-10-23)
|
116
|
+
------------------
|
117
|
+
|
118
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
119
|
+
|
120
|
+
1.9.0 (2019-07-25)
|
121
|
+
------------------
|
122
|
+
|
123
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
124
|
+
|
125
|
+
1.8.0 (2019-07-01)
|
126
|
+
------------------
|
127
|
+
|
128
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
129
|
+
|
130
|
+
1.7.0 (2019-06-17)
|
131
|
+
------------------
|
132
|
+
|
133
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
134
|
+
|
135
|
+
1.6.0 (2019-05-21)
|
136
|
+
------------------
|
137
|
+
|
138
|
+
* Feature - API update.
|
139
|
+
|
140
|
+
1.5.0 (2019-05-15)
|
141
|
+
------------------
|
142
|
+
|
143
|
+
* Feature - API update.
|
144
|
+
|
145
|
+
1.4.0 (2019-05-14)
|
146
|
+
------------------
|
147
|
+
|
148
|
+
* Feature - API update.
|
149
|
+
|
150
|
+
1.3.0 (2019-03-21)
|
151
|
+
------------------
|
152
|
+
|
153
|
+
* Feature - API update.
|
154
|
+
|
155
|
+
1.2.0 (2019-03-18)
|
156
|
+
------------------
|
157
|
+
|
158
|
+
* Feature - API update.
|
159
|
+
|
160
|
+
1.1.0 (2019-03-14)
|
161
|
+
------------------
|
162
|
+
|
163
|
+
* Feature - API update.
|
164
|
+
|
165
|
+
1.0.0 (2019-01-16)
|
166
|
+
------------------
|
167
|
+
|
168
|
+
* Feature - Initial release of `aws-sdk-backup`.
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.31.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -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
|
332
|
-
#
|
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,
|
335
|
-
# `AlreadyExistsException`
|
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
|
@@ -385,6 +385,7 @@ module Aws::Backup
|
|
385
385
|
# destination_backup_vault_arn: "ARN", # required
|
386
386
|
# },
|
387
387
|
# ],
|
388
|
+
# enable_continuous_backup: false,
|
388
389
|
# },
|
389
390
|
# ],
|
390
391
|
# advanced_backup_settings: [
|
@@ -509,16 +510,16 @@ module Aws::Backup
|
|
509
510
|
# `CreateBackupVault` request includes a name, optionally one or more
|
510
511
|
# resource tags, an encryption key, and a request ID.
|
511
512
|
#
|
512
|
-
# <note markdown="1">
|
513
|
-
#
|
513
|
+
# <note markdown="1"> Do not include sensitive data, such as passport numbers, in the name
|
514
|
+
# of a backup vault.
|
514
515
|
#
|
515
516
|
# </note>
|
516
517
|
#
|
517
518
|
# @option params [required, String] :backup_vault_name
|
518
519
|
# The name of a logical container where backups are stored. Backup
|
519
520
|
# vaults are identified by names that are unique to the account used to
|
520
|
-
# create them and the
|
521
|
-
# 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.
|
522
523
|
#
|
523
524
|
# @option params [Hash<String,String>] :backup_vault_tags
|
524
525
|
# Metadata that you can assign to help organize the resources that you
|
@@ -565,6 +566,165 @@ module Aws::Backup
|
|
565
566
|
req.send_request(options)
|
566
567
|
end
|
567
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
|
+
|
568
728
|
# Deletes a backup plan. A backup plan can only be deleted after all
|
569
729
|
# associated selections of resources have been deleted. Deleting a
|
570
730
|
# backup plan deletes the current version of a backup plan. Previous
|
@@ -636,8 +796,8 @@ module Aws::Backup
|
|
636
796
|
# @option params [required, String] :backup_vault_name
|
637
797
|
# The name of a logical container where backups are stored. Backup
|
638
798
|
# vaults are identified by names that are unique to the account used to
|
639
|
-
# create them and the
|
640
|
-
# 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.
|
641
801
|
#
|
642
802
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
643
803
|
#
|
@@ -662,8 +822,8 @@ module Aws::Backup
|
|
662
822
|
# @option params [required, String] :backup_vault_name
|
663
823
|
# The name of a logical container where backups are stored. Backup
|
664
824
|
# vaults are identified by names that are unique to the account used to
|
665
|
-
# create them and the
|
666
|
-
# 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.
|
667
827
|
#
|
668
828
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
669
829
|
#
|
@@ -707,13 +867,39 @@ module Aws::Backup
|
|
707
867
|
req.send_request(options)
|
708
868
|
end
|
709
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
|
+
|
710
892
|
# Deletes the recovery point specified by a recovery point ID.
|
711
893
|
#
|
894
|
+
# If the recovery point ID belongs to a continuous backup, calling this
|
895
|
+
# endpoint deletes the existing continuous backup and stops future
|
896
|
+
# continuous backup.
|
897
|
+
#
|
712
898
|
# @option params [required, String] :backup_vault_name
|
713
899
|
# The name of a logical container where backups are stored. Backup
|
714
900
|
# vaults are identified by names that are unique to the account used to
|
715
|
-
# create them and the
|
716
|
-
# 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.
|
717
903
|
#
|
718
904
|
# @option params [required, String] :recovery_point_arn
|
719
905
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -738,10 +924,32 @@ module Aws::Backup
|
|
738
924
|
req.send_request(options)
|
739
925
|
end
|
740
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
|
+
|
741
949
|
# Returns backup job details for the specified `BackupJobId`.
|
742
950
|
#
|
743
951
|
# @option params [required, String] :backup_job_id
|
744
|
-
# Uniquely identifies a request to
|
952
|
+
# Uniquely identifies a request to Backup to back up a resource.
|
745
953
|
#
|
746
954
|
# @return [Types::DescribeBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
747
955
|
#
|
@@ -813,8 +1021,8 @@ module Aws::Backup
|
|
813
1021
|
# @option params [required, String] :backup_vault_name
|
814
1022
|
# The name of a logical container where backups are stored. Backup
|
815
1023
|
# vaults are identified by names that are unique to the account used to
|
816
|
-
# create them and the
|
817
|
-
# 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.
|
818
1026
|
#
|
819
1027
|
# @return [Types::DescribeBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
820
1028
|
#
|
@@ -894,8 +1102,62 @@ module Aws::Backup
|
|
894
1102
|
req.send_request(options)
|
895
1103
|
end
|
896
1104
|
|
897
|
-
#
|
898
|
-
#
|
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<Types::FrameworkControl>
|
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`
|
899
1161
|
#
|
900
1162
|
# @return [Types::DescribeGlobalSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
901
1163
|
#
|
@@ -918,8 +1180,8 @@ module Aws::Backup
|
|
918
1180
|
end
|
919
1181
|
|
920
1182
|
# Returns information about a saved resource, including the last time it
|
921
|
-
# was backed up, its Amazon Resource Name (ARN), and the
|
922
|
-
# 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.
|
923
1185
|
#
|
924
1186
|
# @option params [required, String] :resource_arn
|
925
1187
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
@@ -958,8 +1220,8 @@ module Aws::Backup
|
|
958
1220
|
# @option params [required, String] :backup_vault_name
|
959
1221
|
# The name of a logical container where backups are stored. Backup
|
960
1222
|
# vaults are identified by names that are unique to the account used to
|
961
|
-
# create them and the
|
962
|
-
# 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.
|
963
1225
|
#
|
964
1226
|
# @option params [required, String] :recovery_point_arn
|
965
1227
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -977,6 +1239,7 @@ module Aws::Backup
|
|
977
1239
|
# * {Types::DescribeRecoveryPointOutput#created_by #created_by} => Types::RecoveryPointCreator
|
978
1240
|
# * {Types::DescribeRecoveryPointOutput#iam_role_arn #iam_role_arn} => String
|
979
1241
|
# * {Types::DescribeRecoveryPointOutput#status #status} => String
|
1242
|
+
# * {Types::DescribeRecoveryPointOutput#status_message #status_message} => String
|
980
1243
|
# * {Types::DescribeRecoveryPointOutput#creation_date #creation_date} => Time
|
981
1244
|
# * {Types::DescribeRecoveryPointOutput#completion_date #completion_date} => Time
|
982
1245
|
# * {Types::DescribeRecoveryPointOutput#backup_size_in_bytes #backup_size_in_bytes} => Integer
|
@@ -1008,6 +1271,7 @@ module Aws::Backup
|
|
1008
1271
|
# resp.created_by.backup_rule_id #=> String
|
1009
1272
|
# resp.iam_role_arn #=> String
|
1010
1273
|
# resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
1274
|
+
# resp.status_message #=> String
|
1011
1275
|
# resp.creation_date #=> Time
|
1012
1276
|
# resp.completion_date #=> Time
|
1013
1277
|
# resp.backup_size_in_bytes #=> Integer
|
@@ -1029,13 +1293,11 @@ module Aws::Backup
|
|
1029
1293
|
req.send_request(options)
|
1030
1294
|
end
|
1031
1295
|
|
1032
|
-
# Returns the current service opt-in settings for the Region. If
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
-
#
|
1037
|
-
# Region, AWS Backup does not try to protect that service's resources
|
1038
|
-
# 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.
|
1039
1301
|
#
|
1040
1302
|
# @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1041
1303
|
#
|
@@ -1055,6 +1317,86 @@ module Aws::Backup
|
|
1055
1317
|
req.send_request(options)
|
1056
1318
|
end
|
1057
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
|
+
|
1058
1400
|
# Returns metadata associated with a restore job that is specified by a
|
1059
1401
|
# job ID.
|
1060
1402
|
#
|
@@ -1108,6 +1450,39 @@ module Aws::Backup
|
|
1108
1450
|
req.send_request(options)
|
1109
1451
|
end
|
1110
1452
|
|
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.
|
1458
|
+
#
|
1459
|
+
# Does not support snapshot backup recovery points.
|
1460
|
+
#
|
1461
|
+
# @option params [required, String] :backup_vault_name
|
1462
|
+
# The unique name of an Backup vault.
|
1463
|
+
#
|
1464
|
+
# @option params [required, String] :recovery_point_arn
|
1465
|
+
# An Amazon Resource Name (ARN) that uniquely identifies an Backup
|
1466
|
+
# recovery point.
|
1467
|
+
#
|
1468
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1469
|
+
#
|
1470
|
+
# @example Request syntax with placeholder values
|
1471
|
+
#
|
1472
|
+
# resp = client.disassociate_recovery_point({
|
1473
|
+
# backup_vault_name: "BackupVaultName", # required
|
1474
|
+
# recovery_point_arn: "ARN", # required
|
1475
|
+
# })
|
1476
|
+
#
|
1477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DisassociateRecoveryPoint AWS API Documentation
|
1478
|
+
#
|
1479
|
+
# @overload disassociate_recovery_point(params = {})
|
1480
|
+
# @param [Hash] params ({})
|
1481
|
+
def disassociate_recovery_point(params = {}, options = {})
|
1482
|
+
req = build_request(:disassociate_recovery_point, params)
|
1483
|
+
req.send_request(options)
|
1484
|
+
end
|
1485
|
+
|
1111
1486
|
# Returns the backup plan that is specified by the plan ID as a backup
|
1112
1487
|
# template.
|
1113
1488
|
#
|
@@ -1137,9 +1512,9 @@ module Aws::Backup
|
|
1137
1512
|
req.send_request(options)
|
1138
1513
|
end
|
1139
1514
|
|
1140
|
-
# Returns `BackupPlan` details for the specified `BackupPlanId`.
|
1141
|
-
# the body of a backup plan in JSON format, in addition to
|
1142
|
-
# metadata.
|
1515
|
+
# Returns `BackupPlan` details for the specified `BackupPlanId`. The
|
1516
|
+
# details are the body of a backup plan in JSON format, in addition to
|
1517
|
+
# plan metadata.
|
1143
1518
|
#
|
1144
1519
|
# @option params [required, String] :backup_plan_id
|
1145
1520
|
# Uniquely identifies a backup plan.
|
@@ -1185,6 +1560,7 @@ module Aws::Backup
|
|
1185
1560
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1186
1561
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1187
1562
|
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1563
|
+
# resp.backup_plan.rules[0].enable_continuous_backup #=> Boolean
|
1188
1564
|
# resp.backup_plan.advanced_backup_settings #=> Array
|
1189
1565
|
# resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
|
1190
1566
|
# resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
|
@@ -1243,6 +1619,7 @@ module Aws::Backup
|
|
1243
1619
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1244
1620
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1245
1621
|
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1622
|
+
# resp.backup_plan.rules[0].enable_continuous_backup #=> Boolean
|
1246
1623
|
# resp.backup_plan.advanced_backup_settings #=> Array
|
1247
1624
|
# resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
|
1248
1625
|
# resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
|
@@ -1290,6 +1667,7 @@ module Aws::Backup
|
|
1290
1667
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1291
1668
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1292
1669
|
# resp.backup_plan_document.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1670
|
+
# resp.backup_plan_document.rules[0].enable_continuous_backup #=> Boolean
|
1293
1671
|
# resp.backup_plan_document.advanced_backup_settings #=> Array
|
1294
1672
|
# resp.backup_plan_document.advanced_backup_settings[0].resource_type #=> String
|
1295
1673
|
# resp.backup_plan_document.advanced_backup_settings[0].backup_options #=> Hash
|
@@ -1359,8 +1737,8 @@ module Aws::Backup
|
|
1359
1737
|
# @option params [required, String] :backup_vault_name
|
1360
1738
|
# The name of a logical container where backups are stored. Backup
|
1361
1739
|
# vaults are identified by names that are unique to the account used to
|
1362
|
-
# create them and the
|
1363
|
-
# 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.
|
1364
1742
|
#
|
1365
1743
|
# @return [Types::GetBackupVaultAccessPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1366
1744
|
#
|
@@ -1394,8 +1772,8 @@ module Aws::Backup
|
|
1394
1772
|
# @option params [required, String] :backup_vault_name
|
1395
1773
|
# The name of a logical container where backups are stored. Backup
|
1396
1774
|
# vaults are identified by names that are unique to the account used to
|
1397
|
-
# create them and the
|
1398
|
-
# 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.
|
1399
1777
|
#
|
1400
1778
|
# @return [Types::GetBackupVaultNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1401
1779
|
#
|
@@ -1433,8 +1811,8 @@ module Aws::Backup
|
|
1433
1811
|
# @option params [required, String] :backup_vault_name
|
1434
1812
|
# The name of a logical container where backups are stored. Backup
|
1435
1813
|
# vaults are identified by names that are unique to the account used to
|
1436
|
-
# create them and the
|
1437
|
-
# 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.
|
1438
1816
|
#
|
1439
1817
|
# @option params [required, String] :recovery_point_arn
|
1440
1818
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -1470,7 +1848,7 @@ module Aws::Backup
|
|
1470
1848
|
req.send_request(options)
|
1471
1849
|
end
|
1472
1850
|
|
1473
|
-
# Returns the
|
1851
|
+
# Returns the Amazon Web Services resource types supported by Backup.
|
1474
1852
|
#
|
1475
1853
|
# @return [Types::GetSupportedResourceTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1476
1854
|
#
|
@@ -1490,7 +1868,13 @@ module Aws::Backup
|
|
1490
1868
|
req.send_request(options)
|
1491
1869
|
end
|
1492
1870
|
|
1493
|
-
# Returns a list of existing backup jobs for an authenticated account
|
1871
|
+
# Returns a list of existing backup jobs for an authenticated account
|
1872
|
+
# for the last 30 days. For a longer period of time, consider using
|
1873
|
+
# these [monitoring tools][1].
|
1874
|
+
#
|
1875
|
+
#
|
1876
|
+
#
|
1877
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
1494
1878
|
#
|
1495
1879
|
# @option params [String] :next_token
|
1496
1880
|
# The next item following a partial list of returned items. For example,
|
@@ -1511,8 +1895,9 @@ module Aws::Backup
|
|
1511
1895
|
# @option params [String] :by_backup_vault_name
|
1512
1896
|
# Returns only backup jobs that will be stored in the specified backup
|
1513
1897
|
# vault. Backup vaults are identified by names that are unique to the
|
1514
|
-
# account used to create them and the
|
1515
|
-
# They consist of lowercase letters, numbers, and
|
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.
|
1516
1901
|
#
|
1517
1902
|
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
1518
1903
|
# Returns only backup jobs that were created before the specified date.
|
@@ -1535,14 +1920,14 @@ module Aws::Backup
|
|
1535
1920
|
#
|
1536
1921
|
# * `Aurora` for Amazon Aurora
|
1537
1922
|
#
|
1538
|
-
# * `Storage Gateway` for
|
1923
|
+
# * `Storage Gateway` for Storage Gateway
|
1539
1924
|
#
|
1540
1925
|
# @option params [String] :by_account_id
|
1541
1926
|
# The account ID to list the jobs from. Returns only backup jobs
|
1542
1927
|
# associated with the specified account ID.
|
1543
1928
|
#
|
1544
|
-
# If used from an
|
1545
|
-
#
|
1929
|
+
# If used from an Organizations management account, passing `*` returns
|
1930
|
+
# all jobs across the organization.
|
1546
1931
|
#
|
1547
1932
|
# @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1548
1933
|
#
|
@@ -1702,10 +2087,9 @@ module Aws::Backup
|
|
1702
2087
|
req.send_request(options)
|
1703
2088
|
end
|
1704
2089
|
|
1705
|
-
# Returns a list of
|
1706
|
-
# The list
|
1707
|
-
#
|
1708
|
-
# 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
|
1709
2093
|
# names, and creator request IDs.
|
1710
2094
|
#
|
1711
2095
|
# @option params [String] :next_token
|
@@ -1897,7 +2281,7 @@ module Aws::Backup
|
|
1897
2281
|
#
|
1898
2282
|
# * `Aurora` for Amazon Aurora
|
1899
2283
|
#
|
1900
|
-
# * `Storage Gateway` for
|
2284
|
+
# * `Storage Gateway` for Storage Gateway
|
1901
2285
|
#
|
1902
2286
|
# @option params [String] :by_destination_vault_arn
|
1903
2287
|
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
@@ -1961,7 +2345,53 @@ module Aws::Backup
|
|
1961
2345
|
req.send_request(options)
|
1962
2346
|
end
|
1963
2347
|
|
1964
|
-
# Returns
|
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<Types::Framework>
|
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,
|
1965
2395
|
# including the time the resource was saved, an Amazon Resource Name
|
1966
2396
|
# (ARN) of the resource, and a resource type.
|
1967
2397
|
#
|
@@ -2011,8 +2441,13 @@ module Aws::Backup
|
|
2011
2441
|
# @option params [required, String] :backup_vault_name
|
2012
2442
|
# The name of a logical container where backups are stored. Backup
|
2013
2443
|
# vaults are identified by names that are unique to the account used to
|
2014
|
-
# create them and the
|
2015
|
-
# 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>
|
2016
2451
|
#
|
2017
2452
|
# @option params [String] :next_token
|
2018
2453
|
# The next item following a partial list of returned items. For example,
|
@@ -2077,6 +2512,7 @@ module Aws::Backup
|
|
2077
2512
|
# resp.recovery_points[0].created_by.backup_rule_id #=> String
|
2078
2513
|
# resp.recovery_points[0].iam_role_arn #=> String
|
2079
2514
|
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
2515
|
+
# resp.recovery_points[0].status_message #=> String
|
2080
2516
|
# resp.recovery_points[0].creation_date #=> Time
|
2081
2517
|
# resp.recovery_points[0].completion_date #=> Time
|
2082
2518
|
# resp.recovery_points[0].backup_size_in_bytes #=> Integer
|
@@ -2097,9 +2533,14 @@ module Aws::Backup
|
|
2097
2533
|
req.send_request(options)
|
2098
2534
|
end
|
2099
2535
|
|
2100
|
-
# Returns detailed information about recovery points of the type
|
2536
|
+
# Returns detailed information about all the recovery points of the type
|
2101
2537
|
# specified by a resource Amazon Resource Name (ARN).
|
2102
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
|
+
#
|
2103
2544
|
# @option params [required, String] :resource_arn
|
2104
2545
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
2105
2546
|
# depends on the resource type.
|
@@ -2113,6 +2554,10 @@ module Aws::Backup
|
|
2113
2554
|
# @option params [Integer] :max_results
|
2114
2555
|
# The maximum number of items to be returned.
|
2115
2556
|
#
|
2557
|
+
# <note markdown="1"> Amazon RDS requires a value of at least 20.
|
2558
|
+
#
|
2559
|
+
# </note>
|
2560
|
+
#
|
2116
2561
|
# @return [Types::ListRecoveryPointsByResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2117
2562
|
#
|
2118
2563
|
# * {Types::ListRecoveryPointsByResourceOutput#next_token #next_token} => String
|
@@ -2135,6 +2580,7 @@ module Aws::Backup
|
|
2135
2580
|
# resp.recovery_points[0].recovery_point_arn #=> String
|
2136
2581
|
# resp.recovery_points[0].creation_date #=> Time
|
2137
2582
|
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
2583
|
+
# resp.recovery_points[0].status_message #=> String
|
2138
2584
|
# resp.recovery_points[0].encryption_key_arn #=> String
|
2139
2585
|
# resp.recovery_points[0].backup_size_bytes #=> Integer
|
2140
2586
|
# resp.recovery_points[0].backup_vault_name #=> String
|
@@ -2148,8 +2594,134 @@ module Aws::Backup
|
|
2148
2594
|
req.send_request(options)
|
2149
2595
|
end
|
2150
2596
|
|
2151
|
-
# Returns
|
2152
|
-
#
|
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<Types::ReportJob>
|
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<Types::ReportPlan>
|
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.
|
2153
2725
|
#
|
2154
2726
|
# @option params [String] :next_token
|
2155
2727
|
# The next item following a partial list of returned items. For example,
|
@@ -2276,8 +2848,8 @@ module Aws::Backup
|
|
2276
2848
|
# @option params [required, String] :backup_vault_name
|
2277
2849
|
# The name of a logical container where backups are stored. Backup
|
2278
2850
|
# vaults are identified by names that are unique to the account used to
|
2279
|
-
# create them and the
|
2280
|
-
# 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.
|
2281
2853
|
#
|
2282
2854
|
# @option params [String] :policy
|
2283
2855
|
# The backup vault access policy document in JSON format.
|
@@ -2306,8 +2878,8 @@ module Aws::Backup
|
|
2306
2878
|
# @option params [required, String] :backup_vault_name
|
2307
2879
|
# The name of a logical container where backups are stored. Backup
|
2308
2880
|
# vaults are identified by names that are unique to the account used to
|
2309
|
-
# create them and the
|
2310
|
-
# 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.
|
2311
2883
|
#
|
2312
2884
|
# @option params [required, String] :sns_topic_arn
|
2313
2885
|
# The Amazon Resource Name (ARN) that specifies the topic for a backup
|
@@ -2318,6 +2890,22 @@ module Aws::Backup
|
|
2318
2890
|
# An array of events that indicate the status of jobs to back up
|
2319
2891
|
# resources to the backup vault.
|
2320
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
|
+
#
|
2321
2909
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2322
2910
|
#
|
2323
2911
|
# @example Request syntax with placeholder values
|
@@ -2342,8 +2930,8 @@ module Aws::Backup
|
|
2342
2930
|
# @option params [required, String] :backup_vault_name
|
2343
2931
|
# The name of a logical container where backups are stored. Backup
|
2344
2932
|
# vaults are identified by names that are unique to the account used to
|
2345
|
-
# create them and the
|
2346
|
-
# 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.
|
2347
2935
|
#
|
2348
2936
|
# @option params [required, String] :resource_arn
|
2349
2937
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
@@ -2354,8 +2942,10 @@ module Aws::Backup
|
|
2354
2942
|
# for example, `arn:aws:iam::123456789012:role/S3Access`.
|
2355
2943
|
#
|
2356
2944
|
# @option params [String] :idempotency_token
|
2357
|
-
# A customer
|
2358
|
-
# 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.
|
2359
2949
|
#
|
2360
2950
|
# @option params [Integer] :start_window_minutes
|
2361
2951
|
# A value in minutes after a backup is scheduled before a job will be
|
@@ -2371,9 +2961,8 @@ module Aws::Backup
|
|
2371
2961
|
#
|
2372
2962
|
# @option params [Types::Lifecycle] :lifecycle
|
2373
2963
|
# The lifecycle defines when a protected resource is transitioned to
|
2374
|
-
# cold storage and when it expires.
|
2375
|
-
#
|
2376
|
-
# define.
|
2964
|
+
# cold storage and when it expires. Backup will transition and expire
|
2965
|
+
# backups automatically according to the lifecycle that you define.
|
2377
2966
|
#
|
2378
2967
|
# Backups transitioned to cold storage must be stored in cold storage
|
2379
2968
|
# for a minimum of 90 days. Therefore, the “expire after days” setting
|
@@ -2390,11 +2979,12 @@ module Aws::Backup
|
|
2390
2979
|
#
|
2391
2980
|
# @option params [Hash<String,String>] :backup_options
|
2392
2981
|
# Specifies the backup option for a selected resource. This option is
|
2393
|
-
# only available for Windows VSS backup
|
2982
|
+
# only available for Windows Volume Shadow Copy Service (VSS) backup
|
2983
|
+
# jobs.
|
2394
2984
|
#
|
2395
|
-
# Valid values: Set to `"WindowsVSS
|
2396
|
-
# backup option and create a VSS
|
2397
|
-
#
|
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`
|
2398
2988
|
# option is not enabled by default.
|
2399
2989
|
#
|
2400
2990
|
# @return [Types::StartBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2441,6 +3031,8 @@ module Aws::Backup
|
|
2441
3031
|
|
2442
3032
|
# Starts a job to create a one-time copy of the specified resource.
|
2443
3033
|
#
|
3034
|
+
# Does not support continuous backups.
|
3035
|
+
#
|
2444
3036
|
# @option params [required, String] :recovery_point_arn
|
2445
3037
|
# An ARN that uniquely identifies a recovery point to use for the copy
|
2446
3038
|
# job; for example,
|
@@ -2449,8 +3041,8 @@ module Aws::Backup
|
|
2449
3041
|
# @option params [required, String] :source_backup_vault_name
|
2450
3042
|
# The name of a logical source container where backups are stored.
|
2451
3043
|
# Backup vaults are identified by names that are unique to the account
|
2452
|
-
# used to create them and the
|
2453
|
-
# 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.
|
2454
3046
|
#
|
2455
3047
|
# @option params [required, String] :destination_backup_vault_arn
|
2456
3048
|
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
@@ -2462,8 +3054,10 @@ module Aws::Backup
|
|
2462
3054
|
# example, `arn:aws:iam::123456789012:role/S3Access`.
|
2463
3055
|
#
|
2464
3056
|
# @option params [String] :idempotency_token
|
2465
|
-
# A customer
|
2466
|
-
# 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.
|
2467
3061
|
#
|
2468
3062
|
# @option params [Types::Lifecycle] :lifecycle
|
2469
3063
|
# Contains an array of `Transition` objects specifying how long in days
|
@@ -2511,6 +3105,44 @@ module Aws::Backup
|
|
2511
3105
|
req.send_request(options)
|
2512
3106
|
end
|
2513
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
|
+
|
2514
3146
|
# Recovers the saved resource identified by an Amazon Resource Name
|
2515
3147
|
# (ARN).
|
2516
3148
|
#
|
@@ -2533,17 +3165,16 @@ module Aws::Backup
|
|
2533
3165
|
# File System (Amazon EFS) instance:
|
2534
3166
|
#
|
2535
3167
|
# * `file-system-id`\: The ID of the Amazon EFS file system that is
|
2536
|
-
# backed up by
|
2537
|
-
# `GetRecoveryPointRestoreMetadata`.
|
3168
|
+
# backed up by Backup. Returned in `GetRecoveryPointRestoreMetadata`.
|
2538
3169
|
#
|
2539
3170
|
# * `Encrypted`\: A Boolean value that, if true, specifies that the file
|
2540
3171
|
# system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
|
2541
3172
|
# set to `true`.
|
2542
3173
|
#
|
2543
|
-
# * `KmsKeyId`\: Specifies the
|
2544
|
-
# restored file system. You can specify a key from
|
2545
|
-
# provided that key it is properly
|
2546
|
-
# 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.
|
2547
3178
|
#
|
2548
3179
|
# * `PerformanceMode`\: Specifies the throughput mode of the file
|
2549
3180
|
# system.
|
@@ -2554,20 +3185,21 @@ module Aws::Backup
|
|
2554
3185
|
# * `newFileSystem`\: A Boolean value that, if true, specifies that the
|
2555
3186
|
# recovery point is restored to a new Amazon EFS file system.
|
2556
3187
|
#
|
2557
|
-
# * `ItemsToRestore
|
2558
|
-
#
|
2559
|
-
#
|
2560
|
-
#
|
2561
|
-
# `"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"]"`.
|
2562
3192
|
#
|
2563
3193
|
# @option params [required, String] :iam_role_arn
|
2564
|
-
# The Amazon Resource Name (ARN) of the IAM role that
|
3194
|
+
# The Amazon Resource Name (ARN) of the IAM role that Backup uses to
|
2565
3195
|
# create the target recovery point; for example,
|
2566
3196
|
# `arn:aws:iam::123456789012:role/S3Access`.
|
2567
3197
|
#
|
2568
3198
|
# @option params [String] :idempotency_token
|
2569
|
-
# A customer
|
2570
|
-
# 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.
|
2571
3203
|
#
|
2572
3204
|
# @option params [String] :resource_type
|
2573
3205
|
# Starts a job to restore a recovery point for one of the following
|
@@ -2585,7 +3217,7 @@ module Aws::Backup
|
|
2585
3217
|
#
|
2586
3218
|
# * `Aurora` for Amazon Aurora
|
2587
3219
|
#
|
2588
|
-
# * `Storage Gateway` for
|
3220
|
+
# * `Storage Gateway` for Storage Gateway
|
2589
3221
|
#
|
2590
3222
|
# @return [Types::StartRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2591
3223
|
#
|
@@ -2619,7 +3251,7 @@ module Aws::Backup
|
|
2619
3251
|
# Attempts to cancel a job to create a one-time backup of a resource.
|
2620
3252
|
#
|
2621
3253
|
# @option params [required, String] :backup_job_id
|
2622
|
-
# Uniquely identifies a request to
|
3254
|
+
# Uniquely identifies a request to Backup to back up a resource.
|
2623
3255
|
#
|
2624
3256
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2625
3257
|
#
|
@@ -2746,6 +3378,7 @@ module Aws::Backup
|
|
2746
3378
|
# destination_backup_vault_arn: "ARN", # required
|
2747
3379
|
# },
|
2748
3380
|
# ],
|
3381
|
+
# enable_continuous_backup: false,
|
2749
3382
|
# },
|
2750
3383
|
# ],
|
2751
3384
|
# advanced_backup_settings: [
|
@@ -2779,11 +3412,87 @@ module Aws::Backup
|
|
2779
3412
|
req.send_request(options)
|
2780
3413
|
end
|
2781
3414
|
|
2782
|
-
# Updates
|
2783
|
-
#
|
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.
|
2784
3491
|
#
|
2785
3492
|
# @option params [Hash<String,String>] :global_settings
|
2786
|
-
# A
|
3493
|
+
# A value for `isCrossAccountBackupEnabled` and a Region. Example:
|
3494
|
+
# `update-global-settings --global-settings
|
3495
|
+
# isCrossAccountBackupEnabled=false --region us-west-2`.
|
2787
3496
|
#
|
2788
3497
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2789
3498
|
#
|
@@ -2807,7 +3516,7 @@ module Aws::Backup
|
|
2807
3516
|
# Sets the transition lifecycle of a recovery point.
|
2808
3517
|
#
|
2809
3518
|
# The lifecycle defines when a protected resource is transitioned to
|
2810
|
-
# cold storage and when it expires.
|
3519
|
+
# cold storage and when it expires. Backup transitions and expires
|
2811
3520
|
# backups automatically according to the lifecycle that you define.
|
2812
3521
|
#
|
2813
3522
|
# Backups transitioned to cold storage must be stored in cold storage
|
@@ -2819,11 +3528,13 @@ module Aws::Backup
|
|
2819
3528
|
# Only Amazon EFS file system backups can be transitioned to cold
|
2820
3529
|
# storage.
|
2821
3530
|
#
|
3531
|
+
# Does not support continuous backups.
|
3532
|
+
#
|
2822
3533
|
# @option params [required, String] :backup_vault_name
|
2823
3534
|
# The name of a logical container where backups are stored. Backup
|
2824
3535
|
# vaults are identified by names that are unique to the account used to
|
2825
|
-
# create them and the
|
2826
|
-
# 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.
|
2827
3538
|
#
|
2828
3539
|
# @option params [required, String] :recovery_point_arn
|
2829
3540
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -2832,7 +3543,7 @@ module Aws::Backup
|
|
2832
3543
|
#
|
2833
3544
|
# @option params [Types::Lifecycle] :lifecycle
|
2834
3545
|
# The lifecycle defines when a protected resource is transitioned to
|
2835
|
-
# cold storage and when it expires.
|
3546
|
+
# cold storage and when it expires. Backup transitions and expires
|
2836
3547
|
# backups automatically according to the lifecycle that you define.
|
2837
3548
|
#
|
2838
3549
|
# Backups transitioned to cold storage must be stored in cold storage
|
@@ -2878,12 +3589,12 @@ module Aws::Backup
|
|
2878
3589
|
end
|
2879
3590
|
|
2880
3591
|
# Updates the current service opt-in settings for the Region. If
|
2881
|
-
# service-opt-in is enabled for a service,
|
2882
|
-
#
|
2883
|
-
#
|
2884
|
-
#
|
2885
|
-
#
|
2886
|
-
#
|
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.
|
2887
3598
|
#
|
2888
3599
|
# @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
|
2889
3600
|
# Updates the list of services along with the opt-in preferences for the
|
@@ -2908,6 +3619,75 @@ module Aws::Backup
|
|
2908
3619
|
req.send_request(options)
|
2909
3620
|
end
|
2910
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
|
+
|
2911
3691
|
# @!endgroup
|
2912
3692
|
|
2913
3693
|
# @param params ({})
|
@@ -2921,7 +3701,7 @@ module Aws::Backup
|
|
2921
3701
|
params: params,
|
2922
3702
|
config: config)
|
2923
3703
|
context[:gem_name] = 'aws-sdk-backup'
|
2924
|
-
context[:gem_version] = '1.
|
3704
|
+
context[:gem_version] = '1.31.0'
|
2925
3705
|
Seahorse::Client::Request.new(handlers, context)
|
2926
3706
|
end
|
2927
3707
|
|