|
144 | 144 | "ListResourcesOutput$NextToken": "<p>If the request doesn't return all of the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListResources</code> again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to null.</p>" |
145 | 145 | } |
146 | 146 | }, |
| 147 | + "HookFailureMode": { |
| 148 | + "base": null, |
| 149 | + "refs": { |
| 150 | + "HookProgressEvent$FailureMode": "<p>The failure mode of the invocation. The following are the potential statuses:</p> <ul> <li> <p> <code>FAIL</code>: This will fail the Hook invocation and the request associated with it.</p> </li> <li> <p> <code>WARN</code>: This will fail the Hook invocation, but not the request associated with it.</p> </li> </ul>" |
| 151 | + } |
| 152 | + }, |
| 153 | + "HookInvocationPoint": { |
| 154 | + "base": null, |
| 155 | + "refs": { |
| 156 | + "HookProgressEvent$InvocationPoint": "<p>States whether the Hook is invoked before or after resource provisioning.</p>" |
| 157 | + } |
| 158 | + }, |
| 159 | + "HookProgressEvent": { |
| 160 | + "base": "<p>Represents the current status of applicable Hooks for a resource operation request. It contains list of Hook invocation information for the resource specified in the request since the same target can invoke multiple Hooks. For more information, see <a href=\"https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html\">Managing resource operation requests with Amazon Web Services Cloud Control API </a>.</p>", |
| 161 | + "refs": { |
| 162 | + "HooksProgressEvent$member": null |
| 163 | + } |
| 164 | + }, |
| 165 | + "HookStatus": { |
| 166 | + "base": null, |
| 167 | + "refs": { |
| 168 | + "HookProgressEvent$HookStatus": "<p>The status of the Hook invocation. The following are potential statuses:</p> <ul> <li> <p> <code>HOOK_PENDING</code>: The Hook was added to the invocation plan, but not yet invoked.</p> </li> <li> <p> <code>HOOK_IN_PROGRESS</code>: The Hook was invoked, but hasn't completed.</p> </li> <li> <p> <code>HOOK_COMPLETE_SUCCEEDED</code>: The Hook invocation is complete with a successful result.</p> </li> <li> <p> <code>HOOK_COMPLETE_FAILED</code>: The Hook invocation is complete with a failed result.</p> </li> <li> <p> <code>HOOK_FAILED</code>: The Hook invocation didn't complete successfully.</p> </li> </ul>" |
| 169 | + } |
| 170 | + }, |
| 171 | + "HookTypeArn": { |
| 172 | + "base": null, |
| 173 | + "refs": { |
| 174 | + "HookProgressEvent$HookTypeArn": "<p>The ARN of the Hook being invoked.</p>" |
| 175 | + } |
| 176 | + }, |
| 177 | + "HooksProgressEvent": { |
| 178 | + "base": null, |
| 179 | + "refs": { |
| 180 | + "GetResourceRequestStatusOutput$HooksProgressEvent": "<p>Lists Hook invocations for the specified target in the request. This is a list since the same target can invoke multiple Hooks.</p>" |
| 181 | + } |
| 182 | + }, |
147 | 183 | "Identifier": { |
148 | 184 | "base": null, |
149 | 185 | "refs": { |
|
240 | 276 | } |
241 | 277 | }, |
242 | 278 | "PatchDocument": { |
243 | | - "base": null, |
| 279 | + "base": "<p>Allow up to 256K length of Resource properties</p>", |
244 | 280 | "refs": { |
245 | 281 | "UpdateResourceInput$PatchDocument": "<p>A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see <a href=\"https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch\">Composing the patch document</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>" |
246 | 282 | } |
|
262 | 298 | } |
263 | 299 | }, |
264 | 300 | "Properties": { |
265 | | - "base": null, |
| 301 | + "base": "<p>Allow up to 256K length of Resource properties</p>", |
266 | 302 | "refs": { |
267 | 303 | "CreateResourceInput$DesiredState": "<p>Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.</p> <note> <p>Cloud Control API currently supports JSON as a structured data format.</p> </note> <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate\">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>", |
268 | 304 | "ListResourcesInput$ResourceModel": "<p>The resource model to use to select the resources to return.</p>", |
|
275 | 311 | "refs": { |
276 | 312 | "CancelResourceRequestInput$RequestToken": "<p>The <code>RequestToken</code> of the <code>ProgressEvent</code> object returned by the resource operation request.</p>", |
277 | 313 | "GetResourceRequestStatusInput$RequestToken": "<p>A unique token used to track the progress of the resource operation request.</p> <p>Request tokens are included in the <code>ProgressEvent</code> type returned by a resource operation request.</p>", |
278 | | - "ProgressEvent$RequestToken": "<p>The unique token representing this resource operation request.</p> <p>Use the <code>RequestToken</code> with <a href=\"https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html\">GetResourceRequestStatus</a> to return the current status of a resource operation request.</p>" |
| 314 | + "ProgressEvent$RequestToken": "<p>The unique token representing this resource operation request.</p> <p>Use the <code>RequestToken</code> with <a href=\"https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html\">GetResourceRequestStatus</a> to return the current status of a resource operation request.</p>", |
| 315 | + "ProgressEvent$HooksRequestToken": "<p>The unique token representing the Hooks operation for the request.</p>" |
279 | 316 | } |
280 | 317 | }, |
281 | 318 | "RequestTokenNotFoundException": { |
|
341 | 378 | "StatusMessage": { |
342 | 379 | "base": null, |
343 | 380 | "refs": { |
| 381 | + "HookProgressEvent$HookStatusMessage": "<p>The message explaining the current Hook status.</p>", |
344 | 382 | "ProgressEvent$StatusMessage": "<p>Any message explaining the current status.</p>" |
345 | 383 | } |
346 | 384 | }, |
|
352 | 390 | "Timestamp": { |
353 | 391 | "base": null, |
354 | 392 | "refs": { |
| 393 | + "HookProgressEvent$HookEventTime": "<p>The time that the Hook invocation request initiated.</p>", |
355 | 394 | "ProgressEvent$EventTime": "<p>When the resource operation request was initiated.</p>", |
356 | 395 | "ProgressEvent$RetryAfter": "<p>When to next request the status of this resource operation request.</p>" |
357 | 396 | } |
|
363 | 402 | "DeleteResourceInput$TypeName": "<p>The name of the resource type.</p>", |
364 | 403 | "GetResourceInput$TypeName": "<p>The name of the resource type.</p>", |
365 | 404 | "GetResourceOutput$TypeName": "<p>The name of the resource type.</p>", |
| 405 | + "HookProgressEvent$HookTypeName": "<p>The type name of the Hook being invoked.</p>", |
366 | 406 | "ListResourcesInput$TypeName": "<p>The name of the resource type.</p>", |
367 | 407 | "ListResourcesOutput$TypeName": "<p>The name of the resource type.</p>", |
368 | 408 | "ProgressEvent$TypeName": "<p>The name of the resource type used in the operation.</p>", |
|
380 | 420 | "CreateResourceInput$TypeVersionId": "<p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>", |
381 | 421 | "DeleteResourceInput$TypeVersionId": "<p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>", |
382 | 422 | "GetResourceInput$TypeVersionId": "<p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>", |
| 423 | + "HookProgressEvent$HookTypeVersionId": "<p>The type version of the Hook being invoked.</p>", |
383 | 424 | "ListResourcesInput$TypeVersionId": "<p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>", |
384 | 425 | "UpdateResourceInput$TypeVersionId": "<p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>" |
385 | 426 | } |
|
0 commit comments