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 |
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.
Synopsis
- data ListSessions = ListSessions' {}
- newListSessions :: Text -> ListSessions
- listSessions_maxResults :: Lens' ListSessions (Maybe Natural)
- listSessions_nextToken :: Lens' ListSessions (Maybe Text)
- listSessions_stateFilter :: Lens' ListSessions (Maybe SessionState)
- listSessions_workGroup :: Lens' ListSessions Text
- data ListSessionsResponse = ListSessionsResponse' {
- nextToken :: Maybe Text
- sessions :: Maybe [SessionSummary]
- httpStatus :: Int
- newListSessionsResponse :: Int -> ListSessionsResponse
- listSessionsResponse_nextToken :: Lens' ListSessionsResponse (Maybe Text)
- listSessionsResponse_sessions :: Lens' ListSessionsResponse (Maybe [SessionSummary])
- listSessionsResponse_httpStatus :: Lens' ListSessionsResponse Int
Creating a Request
data ListSessions Source #
See: newListSessions
smart constructor.
ListSessions' | |
|
Instances
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.
ListSessionsResponse' | |
|
Instances
newListSessionsResponse Source #
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.