AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . cloudcontrol ]
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
get-resource-request-status
--request-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--request-token
(string)
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.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To get the status information of a resource request
The following get-resource-request-status
example returns status information about the specified resource request.
aws cloudcontrol get-resource-request-status \
--request-token "e1a6b86e-46bd-41ac-bfba-001234567890"
Output:
{
"ProgressEvent": {
"TypeName": "AWS::Kinesis::Stream",
"Identifier": "Demo",
"RequestToken": "e1a6b86e-46bd-41ac-bfba-001234567890",
"Operation": "CREATE",
"OperationStatus": "FAILED",
"EventTime": 1632950268.481,
"StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.",
"ErrorCode": "AlreadyExists"
}
}
For more information, see Managing resource operation requests in the Cloud Control API User Guide.
ProgressEvent -> (structure)
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.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status ofSUCCESS
.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.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 -> (timestamp)
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 -> (timestamp)
When to next request the status of this resource operation request.