2024/11/14 - AWS Cloud Control API - 6 updated api methods
Changes Added support for CloudFormation Hooks with Cloud Control API. The GetResourceRequestStatus API response now includes an optional HooksProgressEvent and HooksRequestToken parameter for Hooks Invocation Progress as part of resource operation with Cloud Control.
{'ProgressEvent': {'ErrorCode': {'UnauthorizedTaggingOperation'},
'HooksRequestToken': 'string'}}
Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.
Only resource operations requests with a status of PENDING or IN_PROGRESS can be canceled.
See also: AWS API Documentation
Request Syntax
client.cancel_resource_request(
RequestToken='string'
)
string
[REQUIRED]
The RequestToken of the ProgressEvent object returned by the resource operation request.
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'HooksRequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'UnauthorizedTaggingOperation'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProgressEvent (dict) --
Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
HooksRequestToken (string) --
The unique token representing the Hooks operation for the request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
The current status of the resource operation request.
PENDING: The resource operation hasn't yet started.
IN_PROGRESS: The resource operation is currently in progress.
SUCCESS: The resource operation has successfully completed.
FAILED: The resource operation has failed. Refer to the error code and status message for more information.
CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.
CANCEL_COMPLETE: The resource operation has been canceled.
EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
RetryAfter (datetime) --
When to next request the status of this resource operation request.
{'ProgressEvent': {'ErrorCode': {'UnauthorizedTaggingOperation'},
'HooksRequestToken': 'string'}}
Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent type returned by CreateResource.
See also: AWS API Documentation
Request Syntax
client.create_resource(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
ClientToken='string',
DesiredState='string'
)
string
[REQUIRED]
The name of the resource type.
string
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.
string
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.
If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.
For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
string
A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.
A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.
This field is autopopulated if not provided.
string
[REQUIRED]
Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.
Specify the desired state as one of the following:
A JSON blob
A local path containing the desired state in JSON data format
For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.
For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'HooksRequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'UnauthorizedTaggingOperation'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProgressEvent (dict) --
Represents the current status of the resource creation request.
After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by CreateResource.
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
HooksRequestToken (string) --
The unique token representing the Hooks operation for the request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
The current status of the resource operation request.
PENDING: The resource operation hasn't yet started.
IN_PROGRESS: The resource operation is currently in progress.
SUCCESS: The resource operation has successfully completed.
FAILED: The resource operation has failed. Refer to the error code and status message for more information.
CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.
CANCEL_COMPLETE: The resource operation has been canceled.
EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
RetryAfter (datetime) --
When to next request the status of this resource operation request.
{'ProgressEvent': {'ErrorCode': {'UnauthorizedTaggingOperation'},
'HooksRequestToken': 'string'}}
Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.
See also: AWS API Documentation
Request Syntax
client.delete_resource(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
ClientToken='string',
Identifier='string'
)
string
[REQUIRED]
The name of the resource type.
string
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.
string
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.
If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.
For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
string
A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.
A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier for the resource.
You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.
For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.
For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'HooksRequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'UnauthorizedTaggingOperation'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProgressEvent (dict) --
Represents the current status of the resource deletion request.
After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
HooksRequestToken (string) --
The unique token representing the Hooks operation for the request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
The current status of the resource operation request.
PENDING: The resource operation hasn't yet started.
IN_PROGRESS: The resource operation is currently in progress.
SUCCESS: The resource operation has successfully completed.
FAILED: The resource operation has failed. Refer to the error code and status message for more information.
CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.
CANCEL_COMPLETE: The resource operation has been canceled.
EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
RetryAfter (datetime) --
When to next request the status of this resource operation request.
{'HooksProgressEvent': [{'FailureMode': 'string',
'HookEventTime': 'timestamp',
'HookStatus': 'string',
'HookStatusMessage': 'string',
'HookTypeArn': 'string',
'HookTypeName': 'string',
'HookTypeVersionId': 'string',
'InvocationPoint': 'string'}],
'ProgressEvent': {'ErrorCode': {'UnauthorizedTaggingOperation'},
'HooksRequestToken': 'string'}}
Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.
See also: AWS API Documentation
Request Syntax
client.get_resource_request_status(
RequestToken='string'
)
string
[REQUIRED]
A unique token used to track the progress of the resource operation request.
Request tokens are included in the ProgressEvent type returned by a resource operation request.
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'HooksRequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'UnauthorizedTaggingOperation'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
},
'HooksProgressEvent': [
{
'HookTypeName': 'string',
'HookTypeVersionId': 'string',
'HookTypeArn': 'string',
'InvocationPoint': 'string',
'HookStatus': 'string',
'HookEventTime': datetime(2015, 1, 1),
'HookStatusMessage': 'string',
'FailureMode': 'string'
},
]
}
Response Structure
(dict) --
ProgressEvent (dict) --
Represents the current status of the resource operation request.
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
HooksRequestToken (string) --
The unique token representing the Hooks operation for the request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
The current status of the resource operation request.
PENDING: The resource operation hasn't yet started.
IN_PROGRESS: The resource operation is currently in progress.
SUCCESS: The resource operation has successfully completed.
FAILED: The resource operation has failed. Refer to the error code and status message for more information.
CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.
CANCEL_COMPLETE: The resource operation has been canceled.
EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
RetryAfter (datetime) --
When to next request the status of this resource operation request.
HooksProgressEvent (list) --
Lists Hook invocations for the specified target in the request. This is a list since the same target can invoke multiple Hooks.
(dict) --
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 Managing resource operation requests with Amazon Web Services Cloud Control API.
HookTypeName (string) --
The type name of the Hook being invoked.
HookTypeVersionId (string) --
The type version of the Hook being invoked.
HookTypeArn (string) --
The ARN of the Hook being invoked.
InvocationPoint (string) --
States whether the Hook is invoked before or after resource provisioning.
HookStatus (string) --
The status of the Hook invocation. The following are potential statuses:
HOOK_PENDING: The Hook was added to the invocation plan, but not yet invoked.
HOOK_IN_PROGRESS: The Hook was invoked, but hasn't completed.
HOOK_COMPLETE_SUCCEEDED: The Hook invocation is complete with a successful result.
HOOK_COMPLETE_FAILED: The Hook invocation is complete with a failed result.
HOOK_FAILED: The Hook invocation didn't complete successfully.
HookEventTime (datetime) --
The time that the Hook invocation request initiated.
HookStatusMessage (string) --
The message explaining the current Hook status.
FailureMode (string) --
The failure mode of the invocation. The following are the potential statuses:
FAIL: This will fail the Hook invocation and the request associated with it.
WARN: This will fail the Hook invocation, but not the request associated with it.
{'ResourceRequestStatusSummaries': {'ErrorCode': {'UnauthorizedTaggingOperation'},
'HooksRequestToken': 'string'}}
Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.
See also: AWS API Documentation
Request Syntax
client.list_resource_requests(
MaxResults=123,
NextToken='string',
ResourceRequestStatusFilter={
'Operations': [
'CREATE'|'DELETE'|'UPDATE',
],
'OperationStatuses': [
'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
]
}
)
integer
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
The default is 20.
string
If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
dict
The filter criteria to apply to the requests returned.
Operations (list) --
The operation types to include in the filter.
(string) --
OperationStatuses (list) --
The operation statuses to include in the filter.
PENDING: The operation has been requested, but not yet initiated.
IN_PROGRESS: The operation is in progress.
SUCCESS: The operation completed.
FAILED: The operation failed.
CANCEL_IN_PROGRESS: The operation is in the process of being canceled.
CANCEL_COMPLETE: The operation has been canceled.
(string) --
dict
Response Syntax
{
'ResourceRequestStatusSummaries': [
{
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'HooksRequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'UnauthorizedTaggingOperation'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceRequestStatusSummaries (list) --
The requests that match the specified filter criteria.
(dict) --
Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
HooksRequestToken (string) --
The unique token representing the Hooks operation for the request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
The current status of the resource operation request.
PENDING: The resource operation hasn't yet started.
IN_PROGRESS: The resource operation is currently in progress.
SUCCESS: The resource operation has successfully completed.
FAILED: The resource operation has failed. Refer to the error code and status message for more information.
CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.
CANCEL_COMPLETE: The resource operation has been canceled.
EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
RetryAfter (datetime) --
When to next request the status of this resource operation request.
NextToken (string) --
If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
{'ProgressEvent': {'ErrorCode': {'UnauthorizedTaggingOperation'},
'HooksRequestToken': 'string'}}
Updates the specified property values in the resource.
You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard.
For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by UpdateResource.
For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.
See also: AWS API Documentation
Request Syntax
client.update_resource(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
ClientToken='string',
Identifier='string',
PatchDocument='string'
)
string
[REQUIRED]
The name of the resource type.
string
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.
string
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.
If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.
For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
string
A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.
A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier for the resource.
You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.
For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.
For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.
string
[REQUIRED]
A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see Composing the patch document in the Amazon Web Services Cloud Control API User Guide.
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'HooksRequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'UnauthorizedTaggingOperation'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProgressEvent (dict) --
Represents the current status of the resource update request.
Use the RequestToken of the ProgressEvent with GetResourceRequestStatus to return the current status of a resource operation request.
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
HooksRequestToken (string) --
The unique token representing the Hooks operation for the request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
The current status of the resource operation request.
PENDING: The resource operation hasn't yet started.
IN_PROGRESS: The resource operation is currently in progress.
SUCCESS: The resource operation has successfully completed.
FAILED: The resource operation has failed. Refer to the error code and status message for more information.
CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.
CANCEL_COMPLETE: The resource operation has been canceled.
EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
RetryAfter (datetime) --
When to next request the status of this resource operation request.