GetResourceRequestStatus
Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the AWS Cloud Control API User Guide.
Request Syntax
{
"RequestToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- RequestToken
-
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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[-A-Za-z0-9+/=]+
Required: Yes
Response Syntax
{
"HooksProgressEvent": [
{
"FailureMode": "string",
"HookEventTime": number,
"HookStatus": "string",
"HookStatusMessage": "string",
"HookTypeArn": "string",
"HookTypeName": "string",
"HookTypeVersionId": "string",
"InvocationPoint": "string"
}
],
"ProgressEvent": {
"ErrorCode": "string",
"EventTime": number,
"HooksRequestToken": "string",
"Identifier": "string",
"Operation": "string",
"OperationStatus": "string",
"RequestToken": "string",
"ResourceModel": "string",
"RetryAfter": number,
"StatusMessage": "string",
"TypeName": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- HooksProgressEvent
-
Lists Hook invocations for the specified target in the request. This is a list since the same target can invoke multiple Hooks.
Type: Array of HookProgressEvent objects
- ProgressEvent
-
Represents the current status of the resource operation request.
Type: ProgressEvent object
Errors
For information about the errors that are common to all actions, see Common Errors.
- RequestTokenNotFoundException
-
A resource operation with the specified request token can't be found.
HTTP Status Code: 400
Examples
GetResourceRequestStatus
The following example returns the successful completion status of the specified resource creation operation.
Sample Request
https://cloudcontrolapi.us-east-1.amazonaws.com/
?Action=GetResourceRequestStatus
&RequestToken=b4a1cc5a-a2ae-4dec-9e1e-150123456789
&Version=2021-09-30
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20160316T233349Z
&X-Amz-SignedHeaders=content-type;host
&X-Amz-Signature=[Signature]
Sample Response
<GetResourceRequestStatusResponse xmlns="http://cloudcontrol.amazonaws.com/doc/2021-09-30/">
<GetResourceRequestStatusResult>
<ProgressEvent>
<Identifier>LogGroupResourceExample</Identifier>
<OperationStatus>SUCCESS</OperationStatus>
<EventTime>2021-07-27T18:52:57.406Z</EventTime>
<TypeName>AWS::Logs::LogGroup</TypeName>
<RequestToken>b4a1cc5a-a2ae-4dec-9e1e-150123456789</RequestToken>
<Operation>CREATE</Operation>
</ProgressEvent>
</GetResourceRequestStatusResult>
<ResponseMetadata>
<RequestId>620e5d19-0c03-4069-ae3b-9e0123456789</RequestId>
</ResponseMetadata>
</GetResourceRequestStatusResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: