get_calculation_execution_status

get_calculation_execution_status(**kwargs)

Gets the status of a current calculation.

See also: AWS API Documentation

Request Syntax

response = client.get_calculation_execution_status(
    CalculationExecutionId='string'
)

Parameters

CalculationExecutionId (string) --

[REQUIRED]

The calculation execution UUID.

Return type

dict

Returns

Response Syntax

{
    'Status': {
        'SubmissionDateTime': datetime(2015, 1, 1),
        'CompletionDateTime': datetime(2015, 1, 1),
        'State': 'CREATING'|'CREATED'|'QUEUED'|'RUNNING'|'CANCELING'|'CANCELED'|'COMPLETED'|'FAILED',
        'StateChangeReason': 'string'
    },
    'Statistics': {
        'DpuExecutionInMillis': 123,
        'Progress': 'string'
    }
}

Response Structure

• (dict) --
  • Status (dict) --

    Contains information about the calculation execution status.

    • SubmissionDateTime (datetime) --

      The date and time the calculation was submitted for processing.

    • CompletionDateTime (datetime) --

      The date and time the calculation completed processing.

    • State (string) --

      The state of the calculation execution. A description of each state follows.

      CREATING - The calculation is in the process of being created.

      CREATED - The calculation has been created and is ready to run.

      QUEUED - The calculation has been queued for processing.

      RUNNING - The calculation is running.

      CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

      CANCELED - The calculation is no longer running as the result of a cancel request.

      COMPLETED - The calculation has completed without error.

      FAILED - The calculation failed and is no longer running.

    • StateChangeReason (string) --

      The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

  • Statistics (dict) --

    Contains information about the DPU execution time and progress.

    • DpuExecutionInMillis (integer) --

      The data processing unit execution time in milliseconds for the calculation.

    • Progress (string) --

      The progress of the calculation.

Exceptions

• Athena.Client.exceptions.InternalServerException
• Athena.Client.exceptions.InvalidRequestException
• Athena.Client.exceptions.ResourceNotFoundException