Skip to content

List Calculation Executions

athena_list_calculation_executions R Documentation

Lists the calculations that have been submitted to a session in descending order

Description

Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

Usage

athena_list_calculation_executions(SessionId, StateFilter, MaxResults,
  NextToken)

Arguments

SessionId

[required] The session ID.

StateFilter

A filter for a specific calculation execution state. 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.

MaxResults

The maximum number of calculation executions to return.

NextToken

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  Calculations = list(
    list(
      CalculationExecutionId = "string",
      Description = "string",
      Status = list(
        SubmissionDateTime = as.POSIXct(
          "2015-01-01"
        ),
        CompletionDateTime = as.POSIXct(
          "2015-01-01"
        ),
        State = "CREATING"|"CREATED"|"QUEUED"|"RUNNING"|"CANCELING"|"CANCELED"|"COMPLETED"|"FAILED",
        StateChangeReason = "string"
      )
    )
  )
)

Request syntax

svc$list_calculation_executions(
  SessionId = "string",
  StateFilter = "CREATING"|"CREATED"|"QUEUED"|"RUNNING"|"CANCELING"|"CANCELED"|"COMPLETED"|"FAILED",
  MaxResults = 123,
  NextToken = "string"
)