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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Displays the notebook files for the specified workgroup in paginated format.

Synopsis

data ListNotebookMetadata = ListNotebookMetadata' {
- filters :: Maybe FilterDefinition
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- workGroup :: Text
}
newListNotebookMetadata :: Text -> ListNotebookMetadata
listNotebookMetadata_filters :: Lens' ListNotebookMetadata (Maybe FilterDefinition)
listNotebookMetadata_maxResults :: Lens' ListNotebookMetadata (Maybe Natural)
listNotebookMetadata_nextToken :: Lens' ListNotebookMetadata (Maybe Text)
listNotebookMetadata_workGroup :: Lens' ListNotebookMetadata Text
data ListNotebookMetadataResponse = ListNotebookMetadataResponse' {
- nextToken :: Maybe Text
- notebookMetadataList :: Maybe [NotebookMetadata]
- httpStatus :: Int
}
newListNotebookMetadataResponse :: Int -> ListNotebookMetadataResponse
listNotebookMetadataResponse_nextToken :: Lens' ListNotebookMetadataResponse (Maybe Text)
listNotebookMetadataResponse_notebookMetadataList :: Lens' ListNotebookMetadataResponse (Maybe [NotebookMetadata])
listNotebookMetadataResponse_httpStatus :: Lens' ListNotebookMetadataResponse Int

Creating a Request

data ListNotebookMetadata Source #

See: newListNotebookMetadata smart constructor.

Constructors

ListNotebookMetadata'
Fields filters :: Maybe FilterDefinition Search filter string. maxResults :: Maybe Natural Specifies the maximum number of results to return. nextToken :: Maybe Text A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. workGroup :: Text The name of the Spark enabled workgroup to retrieve notebook metadata for.

Instances

Instances details

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

newListNotebookMetadata Source #

Arguments

:: Text	`ListNotebookMetadata`
-> ListNotebookMetadata

Create a value of ListNotebookMetadata 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:filters:ListNotebookMetadata', listNotebookMetadata_filters - Search filter string.

$sel:maxResults:ListNotebookMetadata', listNotebookMetadata_maxResults - Specifies the maximum number of results to return.

ListNotebookMetadata, listNotebookMetadata_nextToken - A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

ListNotebookMetadata, listNotebookMetadata_workGroup - The name of the Spark enabled workgroup to retrieve notebook metadata for.

Request Lenses

listNotebookMetadata_filters :: Lens' ListNotebookMetadata (Maybe FilterDefinition) Source #

Search filter string.

listNotebookMetadata_maxResults :: Lens' ListNotebookMetadata (Maybe Natural) Source #

Specifies the maximum number of results to return.

listNotebookMetadata_nextToken :: Lens' ListNotebookMetadata (Maybe Text) Source #

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

listNotebookMetadata_workGroup :: Lens' ListNotebookMetadata Text Source #

The name of the Spark enabled workgroup to retrieve notebook metadata for.

Destructuring the Response

data ListNotebookMetadataResponse Source #

See: newListNotebookMetadataResponse smart constructor.

Constructors

ListNotebookMetadataResponse'

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.
notebookMetadataList :: Maybe [NotebookMetadata]
The list of notebook metadata for the specified workgroup.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListNotebookMetadataResponse Source #

Arguments

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

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

ListNotebookMetadata, listNotebookMetadataResponse_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:notebookMetadataList:ListNotebookMetadataResponse', listNotebookMetadataResponse_notebookMetadataList - The list of notebook metadata for the specified workgroup.

$sel:httpStatus:ListNotebookMetadataResponse', listNotebookMetadataResponse_httpStatus - The response's http status code.

Response Lenses

listNotebookMetadataResponse_nextToken :: Lens' ListNotebookMetadataResponse (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.

listNotebookMetadataResponse_notebookMetadataList :: Lens' ListNotebookMetadataResponse (Maybe [NotebookMetadata]) Source #

The list of notebook metadata for the specified workgroup.

listNotebookMetadataResponse_httpStatus :: Lens' ListNotebookMetadataResponse Int Source #

The response's http status code.