Amazonka.Athena.ListExecutors

Lists, in descending order, the executors that have been submitted to a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Creating a Request

data ListExecutors

See: newListExecutors smart constructor.

Constructors

ListExecutors'

Fields

• executorStateFilter :: Maybe ExecutorState

  A filter for a specific executor state. A description of each state follows.

  CREATING - The executor is being started, including acquiring resources.

  CREATED - The executor has been started.

  REGISTERED - The executor has been registered.

  TERMINATING - The executor is in the process of shutting down.

  TERMINATED - The executor is no longer running.

  FAILED - Due to a failure, the executor is no longer running.

• maxResults :: Maybe Natural

  The maximum number of executors 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.

• sessionId :: Text

  The session ID.

Instances

ToJSON ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

toJSON :: ListExecutors -> Value

toEncoding :: ListExecutors -> Encoding

toJSONList :: [ListExecutors] -> Value

toEncodingList :: [ListExecutors] -> Encoding

ToHeaders ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

toHeaders :: ListExecutors -> [Header]

ToPath ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

toPath :: ListExecutors -> ByteString

ToQuery ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

toQuery :: ListExecutors -> QueryString

AWSRequest ListExecutors

Defined in Amazonka.Athena.ListExecutors

Associated Types

type AWSResponse ListExecutors

Methods

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

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

Generic ListExecutors

Defined in Amazonka.Athena.ListExecutors

Associated Types

type Rep ListExecutors :: Type -> Type

Methods

from :: ListExecutors -> Rep ListExecutors x

to :: Rep ListExecutors x -> ListExecutors

Read ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

readsPrec :: Int -> ReadS ListExecutors

readList :: ReadS [ListExecutors]

readPrec :: ReadPrec ListExecutors

readListPrec :: ReadPrec [ListExecutors]

Show ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

showsPrec :: Int -> ListExecutors -> ShowS

show :: ListExecutors -> String

showList :: [ListExecutors] -> ShowS

NFData ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

rnf :: ListExecutors -> ()

Eq ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

(==) :: ListExecutors -> ListExecutors -> Bool

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

Hashable ListExecutors

Defined in Amazonka.Athena.ListExecutors

Methods

hashWithSalt :: Int -> ListExecutors -> Int

hash :: ListExecutors -> Int

type AWSResponse ListExecutors

Defined in Amazonka.Athena.ListExecutors

type AWSResponse ListExecutors = ListExecutorsResponse

type Rep ListExecutors

Defined in Amazonka.Athena.ListExecutors

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

newListExecutors

Arguments

:: Text

ListExecutors

-> ListExecutors

Create a value of ListExecutors 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:executorStateFilter:ListExecutors', listExecutors_executorStateFilter - A filter for a specific executor state. A description of each state follows.

CREATING - The executor is being started, including acquiring resources.

CREATED - The executor has been started.

REGISTERED - The executor has been registered.

TERMINATING - The executor is in the process of shutting down.

TERMINATED - The executor is no longer running.

FAILED - Due to a failure, the executor is no longer running.

$sel:maxResults:ListExecutors', listExecutors_maxResults - The maximum number of executors to return.

ListExecutors, listExecutors_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.

ListExecutors, listExecutors_sessionId - The session ID.

Request Lenses

listExecutors_executorStateFilter :: Lens' ListExecutors (Maybe ExecutorState)

A filter for a specific executor state. A description of each state follows.

CREATING - The executor is being started, including acquiring resources.

CREATED - The executor has been started.

REGISTERED - The executor has been registered.

TERMINATING - The executor is in the process of shutting down.

TERMINATED - The executor is no longer running.

FAILED - Due to a failure, the executor is no longer running.

listExecutors_maxResults :: Lens' ListExecutors (Maybe Natural)

The maximum number of executors to return.

listExecutors_nextToken :: Lens' ListExecutors (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.

listExecutors_sessionId :: Lens' ListExecutors Text

The session ID.

Destructuring the Response

data ListExecutorsResponse

See: newListExecutorsResponse smart constructor.

Constructors

ListExecutorsResponse'

Fields

• executorsSummary :: Maybe [ExecutorsSummary]

  Contains summary information about the executor.

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

• sessionId :: Text

  The session ID.

Instances

Generic ListExecutorsResponse

Defined in Amazonka.Athena.ListExecutors

Associated Types

type Rep ListExecutorsResponse :: Type -> Type

Methods

from :: ListExecutorsResponse -> Rep ListExecutorsResponse x

to :: Rep ListExecutorsResponse x -> ListExecutorsResponse

Read ListExecutorsResponse

Defined in Amazonka.Athena.ListExecutors

Methods

readsPrec :: Int -> ReadS ListExecutorsResponse

readList :: ReadS [ListExecutorsResponse]

readPrec :: ReadPrec ListExecutorsResponse

readListPrec :: ReadPrec [ListExecutorsResponse]

Show ListExecutorsResponse

Defined in Amazonka.Athena.ListExecutors

Methods

showsPrec :: Int -> ListExecutorsResponse -> ShowS

show :: ListExecutorsResponse -> String

showList :: [ListExecutorsResponse] -> ShowS

NFData ListExecutorsResponse

Defined in Amazonka.Athena.ListExecutors

Methods

rnf :: ListExecutorsResponse -> ()

Eq ListExecutorsResponse

Defined in Amazonka.Athena.ListExecutors

Methods

(==) :: ListExecutorsResponse -> ListExecutorsResponse -> Bool

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

type Rep ListExecutorsResponse

Defined in Amazonka.Athena.ListExecutors

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

newListExecutorsResponse

Arguments

:: Int

$sel:httpStatus:ListExecutorsResponse'

-> Text

ListExecutors

-> ListExecutorsResponse

Create a value of ListExecutorsResponse 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:executorsSummary:ListExecutorsResponse', listExecutorsResponse_executorsSummary - Contains summary information about the executor.

ListExecutors, listExecutorsResponse_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:ListExecutorsResponse', listExecutorsResponse_httpStatus - The response's http status code.

ListExecutors, listExecutorsResponse_sessionId - The session ID.

Response Lenses

listExecutorsResponse_executorsSummary :: Lens' ListExecutorsResponse (Maybe [ExecutorsSummary])

Contains summary information about the executor.

listExecutorsResponse_nextToken :: Lens' ListExecutorsResponse (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.

listExecutorsResponse_httpStatus :: Lens' ListExecutorsResponse Int

The response's http status code.

listExecutorsResponse_sessionId :: Lens' ListExecutorsResponse Text

The session ID.