CloudControlApi / Client / get_resource_request_status

get_resource_request_status#

CloudControlApi.Client.get_resource_request_status(**kwargs)#

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.

Request Syntax

response = client.get_resource_request_status(
    RequestToken='string'
)

Parameters:

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

Return type:

dict

Returns:

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

Exceptions

CloudControlApi.Client.exceptions.RequestTokenNotFoundException