Amazonka.Athena.ListNotebookSessions

Lists, in descending order, the sessions that have been created in a notebook 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 ListNotebookSessions

See: newListNotebookSessions smart constructor.

Constructors

ListNotebookSessions'

Fields

• maxResults :: Maybe Natural

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

• notebookId :: Text

  The ID of the notebook to list sessions for.

Instances

ToJSON ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

toJSON :: ListNotebookSessions -> Value

toEncoding :: ListNotebookSessions -> Encoding

toJSONList :: [ListNotebookSessions] -> Value

toEncodingList :: [ListNotebookSessions] -> Encoding

ToHeaders ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

toHeaders :: ListNotebookSessions -> [Header]

ToPath ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

toPath :: ListNotebookSessions -> ByteString

ToQuery ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

toQuery :: ListNotebookSessions -> QueryString

AWSRequest ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Associated Types

type AWSResponse ListNotebookSessions

Methods

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

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

Generic ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Associated Types

type Rep ListNotebookSessions :: Type -> Type

Methods

from :: ListNotebookSessions -> Rep ListNotebookSessions x

to :: Rep ListNotebookSessions x -> ListNotebookSessions

Read ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

readsPrec :: Int -> ReadS ListNotebookSessions

readList :: ReadS [ListNotebookSessions]

readPrec :: ReadPrec ListNotebookSessions

readListPrec :: ReadPrec [ListNotebookSessions]

Show ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

showsPrec :: Int -> ListNotebookSessions -> ShowS

show :: ListNotebookSessions -> String

showList :: [ListNotebookSessions] -> ShowS

NFData ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

rnf :: ListNotebookSessions -> ()

Eq ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

(==) :: ListNotebookSessions -> ListNotebookSessions -> Bool

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

Hashable ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

Methods

hashWithSalt :: Int -> ListNotebookSessions -> Int

hash :: ListNotebookSessions -> Int

type AWSResponse ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

type AWSResponse ListNotebookSessions = ListNotebookSessionsResponse

type Rep ListNotebookSessions

Defined in Amazonka.Athena.ListNotebookSessions

type Rep ListNotebookSessions = D1 ('MetaData "ListNotebookSessions" "Amazonka.Athena.ListNotebookSessions" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListNotebookSessions'" '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 "notebookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListNotebookSessions

Arguments

:: Text

ListNotebookSessions

-> ListNotebookSessions

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

ListNotebookSessions, listNotebookSessions_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.

ListNotebookSessions, listNotebookSessions_notebookId - The ID of the notebook to list sessions for.

Request Lenses

listNotebookSessions_maxResults :: Lens' ListNotebookSessions (Maybe Natural)

The maximum number of notebook sessions to return.

listNotebookSessions_nextToken :: Lens' ListNotebookSessions (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.

listNotebookSessions_notebookId :: Lens' ListNotebookSessions Text

The ID of the notebook to list sessions for.

Destructuring the Response

data ListNotebookSessionsResponse

See: newListNotebookSessionsResponse smart constructor.

Constructors

ListNotebookSessionsResponse'

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.

• httpStatus :: Int

  The response's http status code.

• notebookSessionsList :: [NotebookSessionSummary]

  A list of the sessions belonging to the notebook.

Instances

Generic ListNotebookSessionsResponse

Defined in Amazonka.Athena.ListNotebookSessions

Associated Types

type Rep ListNotebookSessionsResponse :: Type -> Type

Methods

from :: ListNotebookSessionsResponse -> Rep ListNotebookSessionsResponse x

to :: Rep ListNotebookSessionsResponse x -> ListNotebookSessionsResponse

Read ListNotebookSessionsResponse

Defined in Amazonka.Athena.ListNotebookSessions

Methods

readsPrec :: Int -> ReadS ListNotebookSessionsResponse

readList :: ReadS [ListNotebookSessionsResponse]

readPrec :: ReadPrec ListNotebookSessionsResponse

readListPrec :: ReadPrec [ListNotebookSessionsResponse]

Show ListNotebookSessionsResponse

Defined in Amazonka.Athena.ListNotebookSessions

Methods

showsPrec :: Int -> ListNotebookSessionsResponse -> ShowS

show :: ListNotebookSessionsResponse -> String

showList :: [ListNotebookSessionsResponse] -> ShowS

NFData ListNotebookSessionsResponse

Defined in Amazonka.Athena.ListNotebookSessions

Methods

rnf :: ListNotebookSessionsResponse -> ()

Eq ListNotebookSessionsResponse

Defined in Amazonka.Athena.ListNotebookSessions

Methods

(==) :: ListNotebookSessionsResponse -> ListNotebookSessionsResponse -> Bool

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

type Rep ListNotebookSessionsResponse

Defined in Amazonka.Athena.ListNotebookSessions

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

newListNotebookSessionsResponse

Arguments

:: Int

$sel:httpStatus:ListNotebookSessionsResponse'

-> ListNotebookSessionsResponse

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

ListNotebookSessions, listNotebookSessionsResponse_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:ListNotebookSessionsResponse', listNotebookSessionsResponse_httpStatus - The response's http status code.

$sel:notebookSessionsList:ListNotebookSessionsResponse', listNotebookSessionsResponse_notebookSessionsList - A list of the sessions belonging to the notebook.

Response Lenses

listNotebookSessionsResponse_nextToken :: Lens' ListNotebookSessionsResponse (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.

listNotebookSessionsResponse_httpStatus :: Lens' ListNotebookSessionsResponse Int

The response's http status code.

listNotebookSessionsResponse_notebookSessionsList :: Lens' ListNotebookSessionsResponse [NotebookSessionSummary]

A list of the sessions belonging to the notebook.