get_calculation_execution

get_calculation_execution(**kwargs)

Describes a previously submitted calculation execution.

See also: AWS API Documentation

Request Syntax

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

Parameters

CalculationExecutionId (string) --

[REQUIRED]

The calculation execution UUID.

Return type

dict

Returns

Response Syntax

{
    'CalculationExecutionId': 'string',
    'SessionId': 'string',
    'Description': 'string',
    'WorkingDirectory': 'string',
    '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'
    },
    'Result': {
        'StdOutS3Uri': 'string',
        'StdErrorS3Uri': 'string',
        'ResultS3Uri': 'string',
        'ResultType': 'string'
    }
}

Response Structure

• (dict) --
  • CalculationExecutionId (string) --

    The calculation execution UUID.

  • SessionId (string) --

    The session ID that the calculation ran in.

  • Description (string) --

    The description of the calculation execution.

  • WorkingDirectory (string) --

    The Amazon S3 location in which calculation results are stored.

  • Status (dict) --

    Contains information about the status of the calculation.

    • 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 data processing unit (DPU) execution time and progress. This field is populated only when statistics are available.

    • DpuExecutionInMillis (integer) --

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

    • Progress (string) --

      The progress of the calculation.

  • Result (dict) --

    Contains result information. This field is populated only if the calculation is completed.

    • StdOutS3Uri (string) --

      The Amazon S3 location of the stdout file for the calculation.

    • StdErrorS3Uri (string) --

      The Amazon S3 location of the stderr error messages file for the calculation.

    • ResultS3Uri (string) --

      The Amazon S3 location of the folder for the calculation results.

    • ResultType (string) --

      The data format of the calculation result.

Exceptions

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