xref: /aosp_15_r20/external/aws-sdk-java-v2/services/dlm/src/main/resources/codegen-resources/docs-2.json (revision 8a52c7834d808308836a99fc2a6e0ed8db339086)
1{
2  "version": "2.0",
3  "service": "<fullname>Amazon Data Lifecycle Manager</fullname> <p>With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.</p> <p>Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html\">Automating the Amazon EBS Snapshot Lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p>",
4  "operations": {
5    "CreateLifecyclePolicy": "<p>Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.</p>",
6    "DeleteLifecyclePolicy": "<p>Deletes the specified lifecycle policy and halts the automated operations that the policy specified.</p>",
7    "GetLifecyclePolicies": "<p>Gets summary information about all or the specified data lifecycle policies.</p> <p>To get complete information about a policy, use <a>GetLifecyclePolicy</a>.</p>",
8    "GetLifecyclePolicy": "<p>Gets detailed information about the specified lifecycle policy.</p>",
9    "UpdateLifecyclePolicy": "<p>Updates the specified lifecycle policy.</p>"
10  },
11  "shapes": {
12    "CopyTags": {
13      "base": null,
14      "refs": {
15        "Schedule$CopyTags": null
16      }
17    },
18    "Count": {
19      "base": null,
20      "refs": {
21        "RetainRule$Count": "<p>The number of snapshots to keep for each volume, up to a maximum of 1000.</p>"
22      }
23    },
24    "CreateLifecyclePolicyRequest": {
25      "base": null,
26      "refs": {
27      }
28    },
29    "CreateLifecyclePolicyResponse": {
30      "base": null,
31      "refs": {
32      }
33    },
34    "CreateRule": {
35      "base": "<p>Specifies when to create snapshots of EBS volumes.</p>",
36      "refs": {
37        "Schedule$CreateRule": "<p>The create rule.</p>"
38      }
39    },
40    "DeleteLifecyclePolicyRequest": {
41      "base": null,
42      "refs": {
43      }
44    },
45    "DeleteLifecyclePolicyResponse": {
46      "base": null,
47      "refs": {
48      }
49    },
50    "ErrorCode": {
51      "base": null,
52      "refs": {
53        "InternalServerException$Code": null,
54        "InvalidRequestException$Code": null,
55        "LimitExceededException$Code": null,
56        "ResourceNotFoundException$Code": null
57      }
58    },
59    "ErrorMessage": {
60      "base": null,
61      "refs": {
62        "InternalServerException$Message": null,
63        "InvalidRequestException$Message": null,
64        "LimitExceededException$Message": null,
65        "ResourceNotFoundException$Message": null
66      }
67    },
68    "ExecutionRoleArn": {
69      "base": null,
70      "refs": {
71        "CreateLifecyclePolicyRequest$ExecutionRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>",
72        "LifecyclePolicy$ExecutionRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>",
73        "UpdateLifecyclePolicyRequest$ExecutionRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>"
74      }
75    },
76    "GetLifecyclePoliciesRequest": {
77      "base": null,
78      "refs": {
79      }
80    },
81    "GetLifecyclePoliciesResponse": {
82      "base": null,
83      "refs": {
84      }
85    },
86    "GetLifecyclePolicyRequest": {
87      "base": null,
88      "refs": {
89      }
90    },
91    "GetLifecyclePolicyResponse": {
92      "base": null,
93      "refs": {
94      }
95    },
96    "GettablePolicyStateValues": {
97      "base": null,
98      "refs": {
99        "GetLifecyclePoliciesRequest$State": "<p>The activation state.</p>",
100        "LifecyclePolicy$State": "<p>The activation state of the lifecycle policy.</p>",
101        "LifecyclePolicySummary$State": "<p>The activation state of the lifecycle policy.</p>"
102      }
103    },
104    "InternalServerException": {
105      "base": "<p>The service failed in an unexpected way.</p>",
106      "refs": {
107      }
108    },
109    "Interval": {
110      "base": null,
111      "refs": {
112        "CreateRule$Interval": "<p>The interval. The supported values are 12 and 24.</p>"
113      }
114    },
115    "IntervalUnitValues": {
116      "base": null,
117      "refs": {
118        "CreateRule$IntervalUnit": "<p>The interval unit.</p>"
119      }
120    },
121    "InvalidRequestException": {
122      "base": "<p>Bad request. The request is missing required parameters or has invalid parameters.</p>",
123      "refs": {
124      }
125    },
126    "LifecyclePolicy": {
127      "base": "<p>Detailed information about a lifecycle policy.</p>",
128      "refs": {
129        "GetLifecyclePolicyResponse$Policy": "<p>Detailed information about the lifecycle policy.</p>"
130      }
131    },
132    "LifecyclePolicySummary": {
133      "base": "<p>Summary information about a lifecycle policy.</p>",
134      "refs": {
135        "LifecyclePolicySummaryList$member": null
136      }
137    },
138    "LifecyclePolicySummaryList": {
139      "base": null,
140      "refs": {
141        "GetLifecyclePoliciesResponse$Policies": "<p>Summary information about the lifecycle policies.</p>"
142      }
143    },
144    "LimitExceededException": {
145      "base": "<p>The request failed because a limit was exceeded.</p>",
146      "refs": {
147      }
148    },
149    "Parameter": {
150      "base": null,
151      "refs": {
152        "ParameterList$member": null
153      }
154    },
155    "ParameterList": {
156      "base": null,
157      "refs": {
158        "InvalidRequestException$RequiredParameters": "<p>The request omitted one or more required parameters.</p>",
159        "InvalidRequestException$MutuallyExclusiveParameters": "<p>The request included parameters that cannot be provided together.</p>"
160      }
161    },
162    "PolicyDescription": {
163      "base": null,
164      "refs": {
165        "CreateLifecyclePolicyRequest$Description": "<p>A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.</p>",
166        "LifecyclePolicy$Description": "<p>The description of the lifecycle policy.</p>",
167        "LifecyclePolicySummary$Description": "<p>The description of the lifecycle policy.</p>",
168        "UpdateLifecyclePolicyRequest$Description": "<p>A description of the lifecycle policy.</p>"
169      }
170    },
171    "PolicyDetails": {
172      "base": "<p>Specifies the configuration of a lifecycle policy.</p>",
173      "refs": {
174        "CreateLifecyclePolicyRequest$PolicyDetails": "<p>The configuration details of the lifecycle policy.</p> <p>Target tags cannot be re-used across lifecycle policies.</p>",
175        "LifecyclePolicy$PolicyDetails": "<p>The configuration of the lifecycle policy</p>",
176        "UpdateLifecyclePolicyRequest$PolicyDetails": "<p>The configuration of the lifecycle policy.</p> <p>Target tags cannot be re-used across policies.</p>"
177      }
178    },
179    "PolicyId": {
180      "base": null,
181      "refs": {
182        "CreateLifecyclePolicyResponse$PolicyId": "<p>The identifier of the lifecycle policy.</p>",
183        "DeleteLifecyclePolicyRequest$PolicyId": "<p>The identifier of the lifecycle policy.</p>",
184        "GetLifecyclePolicyRequest$PolicyId": "<p>The identifier of the lifecycle policy.</p>",
185        "LifecyclePolicy$PolicyId": "<p>The identifier of the lifecycle policy.</p>",
186        "LifecyclePolicySummary$PolicyId": "<p>The identifier of the lifecycle policy.</p>",
187        "PolicyIdList$member": null,
188        "UpdateLifecyclePolicyRequest$PolicyId": "<p>The identifier of the lifecycle policy.</p>"
189      }
190    },
191    "PolicyIdList": {
192      "base": null,
193      "refs": {
194        "GetLifecyclePoliciesRequest$PolicyIds": "<p>The identifiers of the data lifecycle policies.</p>",
195        "ResourceNotFoundException$ResourceIds": "<p>Value is a list of resource IDs that were not found.</p>"
196      }
197    },
198    "ResourceNotFoundException": {
199      "base": "<p>A requested resource was not found.</p>",
200      "refs": {
201      }
202    },
203    "ResourceTypeValues": {
204      "base": null,
205      "refs": {
206        "ResourceTypeValuesList$member": null
207      }
208    },
209    "ResourceTypeValuesList": {
210      "base": null,
211      "refs": {
212        "GetLifecyclePoliciesRequest$ResourceTypes": "<p>The resource type.</p>",
213        "PolicyDetails$ResourceTypes": "<p>The resource type.</p>"
214      }
215    },
216    "RetainRule": {
217      "base": "<p>Specifies the number of snapshots to keep for each EBS volume.</p>",
218      "refs": {
219        "Schedule$RetainRule": "<p>The retain rule.</p>"
220      }
221    },
222    "Schedule": {
223      "base": "<p>Specifies a schedule.</p>",
224      "refs": {
225        "ScheduleList$member": null
226      }
227    },
228    "ScheduleList": {
229      "base": null,
230      "refs": {
231        "PolicyDetails$Schedules": "<p>The schedule of policy-defined actions.</p>"
232      }
233    },
234    "ScheduleName": {
235      "base": null,
236      "refs": {
237        "Schedule$Name": "<p>The name of the schedule.</p>"
238      }
239    },
240    "SettablePolicyStateValues": {
241      "base": null,
242      "refs": {
243        "CreateLifecyclePolicyRequest$State": "<p>The desired activation state of the lifecycle policy after creation.</p>",
244        "UpdateLifecyclePolicyRequest$State": "<p>The desired activation state of the lifecycle policy after creation.</p>"
245      }
246    },
247    "String": {
248      "base": null,
249      "refs": {
250        "LimitExceededException$ResourceType": "<p>Value is the type of resource for which a limit was exceeded.</p>",
251        "ResourceNotFoundException$ResourceType": "<p>Value is the type of resource that was not found.</p>",
252        "Tag$Key": "<p>The tag key.</p>",
253        "Tag$Value": "<p>The tag value.</p>"
254      }
255    },
256    "Tag": {
257      "base": "<p>Specifies a tag for a resource.</p>",
258      "refs": {
259        "TagsToAddList$member": null,
260        "TargetTagList$member": null
261      }
262    },
263    "TagFilter": {
264      "base": null,
265      "refs": {
266        "TagsToAddFilterList$member": null,
267        "TargetTagsFilterList$member": null
268      }
269    },
270    "TagsToAddFilterList": {
271      "base": null,
272      "refs": {
273        "GetLifecyclePoliciesRequest$TagsToAdd": "<p>The tags to add to objects created by the policy.</p> <p>Tags are strings in the format <code>key=value</code>.</p> <p>These user-defined tags are added in addition to the AWS-added lifecycle tags.</p>"
274      }
275    },
276    "TagsToAddList": {
277      "base": null,
278      "refs": {
279        "Schedule$TagsToAdd": "<p>The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.</p>"
280      }
281    },
282    "TargetTagList": {
283      "base": null,
284      "refs": {
285        "PolicyDetails$TargetTags": "<p>The single tag that identifies targeted resources for this policy.</p>"
286      }
287    },
288    "TargetTagsFilterList": {
289      "base": null,
290      "refs": {
291        "GetLifecyclePoliciesRequest$TargetTags": "<p>The target tag for a policy.</p> <p>Tags are strings in the format <code>key=value</code>.</p>"
292      }
293    },
294    "Time": {
295      "base": null,
296      "refs": {
297        "TimesList$member": null
298      }
299    },
300    "TimesList": {
301      "base": null,
302      "refs": {
303        "CreateRule$Times": "<p>The time, in UTC, to start the operation.</p> <p>The operation occurs within a one-hour window following the specified time.</p>"
304      }
305    },
306    "Timestamp": {
307      "base": null,
308      "refs": {
309        "LifecyclePolicy$DateCreated": "<p>The local date and time when the lifecycle policy was created.</p>",
310        "LifecyclePolicy$DateModified": "<p>The local date and time when the lifecycle policy was last modified.</p>"
311      }
312    },
313    "UpdateLifecyclePolicyRequest": {
314      "base": null,
315      "refs": {
316      }
317    },
318    "UpdateLifecyclePolicyResponse": {
319      "base": null,
320      "refs": {
321      }
322    }
323  }
324}
325