Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Athena.ListSessions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Creating a Request

data ListSessions Source #

See: newListSessions smart constructor.

Constructors

ListSessions'

Fields

maxResults :: Maybe Natural
The maximum number of sessions 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 SessionState
A filter for a specific session state. A description of each state follows.
CREATING - The session is being started, including acquiring resources.
CREATED - The session has been started.
IDLE - The session is able to accept a calculation.
BUSY - The session is processing another task and is unable to accept a calculation.
TERMINATING - The session is in the process of shutting down.
TERMINATED - The session and its resources are no longer running.
DEGRADED - The session has no healthy coordinators.
FAILED - Due to a failure, the session and its resources are no longer running.
workGroup :: Text
The workgroup to which the session belongs.

Instances

Instances details

ToJSON ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods toJSON :: ListSessions -> Value # toEncoding :: ListSessions -> Encoding # toJSONList :: [ListSessions] -> Value # toEncodingList :: [ListSessions] -> Encoding #
ToHeaders ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods toHeaders :: ListSessions -> [Header] #
ToPath ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods toPath :: ListSessions -> ByteString #
ToQuery ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods toQuery :: ListSessions -> QueryString #
AWSRequest ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Associated Types type AWSResponse ListSessions # Methods request :: (Service -> Service) -> ListSessions -> Request ListSessions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSessions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSessions))) #
Generic ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Associated Types type Rep ListSessions :: Type -> Type # Methods from :: ListSessions -> Rep ListSessions x # to :: Rep ListSessions x -> ListSessions #
Read ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods readsPrec :: Int -> ReadS ListSessions # readList :: ReadS [ListSessions] # readPrec :: ReadPrec ListSessions # readListPrec :: ReadPrec [ListSessions] #
Show ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods showsPrec :: Int -> ListSessions -> ShowS # show :: ListSessions -> String # showList :: [ListSessions] -> ShowS #
NFData ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods rnf :: ListSessions -> () #
Eq ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods (==) :: ListSessions -> ListSessions -> Bool # (/=) :: ListSessions -> ListSessions -> Bool #
Hashable ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods hashWithSalt :: Int -> ListSessions -> Int # hash :: ListSessions -> Int #
type AWSResponse ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions type AWSResponse ListSessions = ListSessionsResponse
type Rep ListSessions Source #
Instance details Defined in Amazonka.Athena.ListSessions type Rep ListSessions = D1 ('MetaData "ListSessions" "Amazonka.Athena.ListSessions" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListSessions'" '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 SessionState)) :*: S1 ('MetaSel ('Just "workGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSessions Source #

Arguments

:: Text	`ListSessions`
-> ListSessions

Create a value of ListSessions 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:ListSessions', listSessions_maxResults - The maximum number of sessions to return.

ListSessions, listSessions_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:ListSessions', listSessions_stateFilter - A filter for a specific session state. A description of each state follows.

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

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

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

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

ListSessions, listSessions_workGroup - The workgroup to which the session belongs.

Request Lenses

listSessions_maxResults :: Lens' ListSessions (Maybe Natural) Source #

The maximum number of sessions to return.

listSessions_nextToken :: Lens' ListSessions (Maybe Text) Source #

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.

listSessions_stateFilter :: Lens' ListSessions (Maybe SessionState) Source #

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

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

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

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

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

listSessions_workGroup :: Lens' ListSessions Text Source #

The workgroup to which the session belongs.

Destructuring the Response

data ListSessionsResponse Source #

See: newListSessionsResponse smart constructor.

Constructors

ListSessionsResponse'
Fields 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. sessions :: Maybe [SessionSummary] A list of sessions. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListSessionsResponse Source #
Instance details Defined in Amazonka.Athena.ListSessions Associated Types type Rep ListSessionsResponse :: Type -> Type # Methods from :: ListSessionsResponse -> Rep ListSessionsResponse x # to :: Rep ListSessionsResponse x -> ListSessionsResponse #
Read ListSessionsResponse Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods readsPrec :: Int -> ReadS ListSessionsResponse # readList :: ReadS [ListSessionsResponse] # readPrec :: ReadPrec ListSessionsResponse # readListPrec :: ReadPrec [ListSessionsResponse] #
Show ListSessionsResponse Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods showsPrec :: Int -> ListSessionsResponse -> ShowS # show :: ListSessionsResponse -> String # showList :: [ListSessionsResponse] -> ShowS #
NFData ListSessionsResponse Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods rnf :: ListSessionsResponse -> () #
Eq ListSessionsResponse Source #
Instance details Defined in Amazonka.Athena.ListSessions Methods (==) :: ListSessionsResponse -> ListSessionsResponse -> Bool # (/=) :: ListSessionsResponse -> ListSessionsResponse -> Bool #
type Rep ListSessionsResponse Source #
Instance details Defined in Amazonka.Athena.ListSessions type Rep ListSessionsResponse = D1 ('MetaData "ListSessionsResponse" "Amazonka.Athena.ListSessions" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListSessionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SessionSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSessionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSessionsResponse'`
-> ListSessionsResponse

Create a value of ListSessionsResponse 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:

ListSessions, listSessionsResponse_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:sessions:ListSessionsResponse', listSessionsResponse_sessions - A list of sessions.

$sel:httpStatus:ListSessionsResponse', listSessionsResponse_httpStatus - The response's http status code.

Response Lenses

listSessionsResponse_nextToken :: Lens' ListSessionsResponse (Maybe Text) Source #

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.

listSessionsResponse_sessions :: Lens' ListSessionsResponse (Maybe [SessionSummary]) Source #

A list of sessions.

listSessionsResponse_httpStatus :: Lens' ListSessionsResponse Int Source #

The response's http status code.