Amazonka.Athena.ListCalculationExecutions

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

Creating a Request

data ListCalculationExecutions

See: newListCalculationExecutions smart constructor.

Constructors

ListCalculationExecutions'

Fields

• maxResults :: Maybe Natural

  The maximum number of calculation executions to return.

• nextToken :: Maybe Text

  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.

• stateFilter :: Maybe CalculationExecutionState

  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.

• sessionId :: Text

  The session ID.

Instances

ToJSON ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

toJSON :: ListCalculationExecutions -> Value

toEncoding :: ListCalculationExecutions -> Encoding

toJSONList :: [ListCalculationExecutions] -> Value

toEncodingList :: [ListCalculationExecutions] -> Encoding

ToHeaders ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

toHeaders :: ListCalculationExecutions -> [Header]

ToPath ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

toPath :: ListCalculationExecutions -> ByteString

ToQuery ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

toQuery :: ListCalculationExecutions -> QueryString

AWSRequest ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Associated Types

type AWSResponse ListCalculationExecutions

Methods

request :: (Service -> Service) -> ListCalculationExecutions -> Request ListCalculationExecutions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCalculationExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCalculationExecutions)))

Generic ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Associated Types

type Rep ListCalculationExecutions :: Type -> Type

Methods

from :: ListCalculationExecutions -> Rep ListCalculationExecutions x

to :: Rep ListCalculationExecutions x -> ListCalculationExecutions

Read ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

readsPrec :: Int -> ReadS ListCalculationExecutions

readList :: ReadS [ListCalculationExecutions]

readPrec :: ReadPrec ListCalculationExecutions

readListPrec :: ReadPrec [ListCalculationExecutions]

Show ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

showsPrec :: Int -> ListCalculationExecutions -> ShowS

show :: ListCalculationExecutions -> String

showList :: [ListCalculationExecutions] -> ShowS

NFData ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

rnf :: ListCalculationExecutions -> ()

Eq ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

(==) :: ListCalculationExecutions -> ListCalculationExecutions -> Bool

(/=) :: ListCalculationExecutions -> ListCalculationExecutions -> Bool

Hashable ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

hashWithSalt :: Int -> ListCalculationExecutions -> Int

hash :: ListCalculationExecutions -> Int

type AWSResponse ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

type AWSResponse ListCalculationExecutions = ListCalculationExecutionsResponse

type Rep ListCalculationExecutions

Defined in Amazonka.Athena.ListCalculationExecutions

type Rep ListCalculationExecutions = D1 ('MetaData "ListCalculationExecutions" "Amazonka.Athena.ListCalculationExecutions" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListCalculationExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stateFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CalculationExecutionState)) :*: S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListCalculationExecutions

Arguments

:: Text

ListCalculationExecutions

-> ListCalculationExecutions

Create a value of ListCalculationExecutions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListCalculationExecutions', listCalculationExecutions_maxResults - The maximum number of calculation executions to return.

ListCalculationExecutions, listCalculationExecutions_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.

$sel:stateFilter:ListCalculationExecutions', listCalculationExecutions_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.

ListCalculationExecutions, listCalculationExecutions_sessionId - The session ID.

Request Lenses

listCalculationExecutions_maxResults :: Lens' ListCalculationExecutions (Maybe Natural)

The maximum number of calculation executions to return.

listCalculationExecutions_nextToken :: Lens' ListCalculationExecutions (Maybe Text)

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.

listCalculationExecutions_stateFilter :: Lens' ListCalculationExecutions (Maybe CalculationExecutionState)

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.

listCalculationExecutions_sessionId :: Lens' ListCalculationExecutions Text

The session ID.

Destructuring the Response

data ListCalculationExecutionsResponse

See: newListCalculationExecutionsResponse smart constructor.

Constructors

ListCalculationExecutionsResponse'

Fields

• calculations :: Maybe [CalculationSummary]

  A list of CalculationSummary objects.

• nextToken :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListCalculationExecutionsResponse

Defined in Amazonka.Athena.ListCalculationExecutions

Associated Types

type Rep ListCalculationExecutionsResponse :: Type -> Type

Methods

from :: ListCalculationExecutionsResponse -> Rep ListCalculationExecutionsResponse x

to :: Rep ListCalculationExecutionsResponse x -> ListCalculationExecutionsResponse

Read ListCalculationExecutionsResponse

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

readsPrec :: Int -> ReadS ListCalculationExecutionsResponse

readList :: ReadS [ListCalculationExecutionsResponse]

readPrec :: ReadPrec ListCalculationExecutionsResponse

readListPrec :: ReadPrec [ListCalculationExecutionsResponse]

Show ListCalculationExecutionsResponse

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

showsPrec :: Int -> ListCalculationExecutionsResponse -> ShowS

show :: ListCalculationExecutionsResponse -> String

showList :: [ListCalculationExecutionsResponse] -> ShowS

NFData ListCalculationExecutionsResponse

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

rnf :: ListCalculationExecutionsResponse -> ()

Eq ListCalculationExecutionsResponse

Defined in Amazonka.Athena.ListCalculationExecutions

Methods

(==) :: ListCalculationExecutionsResponse -> ListCalculationExecutionsResponse -> Bool

(/=) :: ListCalculationExecutionsResponse -> ListCalculationExecutionsResponse -> Bool

type Rep ListCalculationExecutionsResponse

Defined in Amazonka.Athena.ListCalculationExecutions

type Rep ListCalculationExecutionsResponse = D1 ('MetaData "ListCalculationExecutionsResponse" "Amazonka.Athena.ListCalculationExecutions" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListCalculationExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "calculations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CalculationSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCalculationExecutionsResponse

Arguments

:: Int

$sel:httpStatus:ListCalculationExecutionsResponse'

-> ListCalculationExecutionsResponse

Create a value of ListCalculationExecutionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:calculations:ListCalculationExecutionsResponse', listCalculationExecutionsResponse_calculations - A list of CalculationSummary objects.

ListCalculationExecutions, listCalculationExecutionsResponse_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.

$sel:httpStatus:ListCalculationExecutionsResponse', listCalculationExecutionsResponse_httpStatus - The response's http status code.

Response Lenses

listCalculationExecutionsResponse_calculations :: Lens' ListCalculationExecutionsResponse (Maybe [CalculationSummary])

A list of CalculationSummary objects.

listCalculationExecutionsResponse_nextToken :: Lens' ListCalculationExecutionsResponse (Maybe Text)

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.

listCalculationExecutionsResponse_httpStatus :: Lens' ListCalculationExecutionsResponse Int

The response's http status code.