CloudControlApi / Client / cancel_resource_request

cancel_resource_request#

CloudControlApi.Client.cancel_resource_request(**kwargs)#

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

response = client.cancel_resource_request(
    RequestToken='string'
)
Parameters:

RequestToken (string) –

[REQUIRED]

The RequestToken of the ProgressEvent object returned by the resource operation request.

Return type:

dict

Returns:

Response Syntax

{
    'ProgressEvent': {
        'TypeName': 'string',
        'Identifier': 'string',
        'RequestToken': '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'|'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.

        Note

        In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

      • 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 (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.

Exceptions

  • CloudControlApi.Client.exceptions.ConcurrentModificationException

  • CloudControlApi.Client.exceptions.RequestTokenNotFoundException