Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Athena.ListNamedQueries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

This operation returns paginated results.

Creating a Request

data ListNamedQueries Source #

See: newListNamedQueries smart constructor.

Constructors

ListNamedQueries'

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.
workGroup :: Maybe Text
The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.
maxResults :: Maybe Natural
The maximum number of queries to return in this request.

Instances

Instances details

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

newListNamedQueries :: ListNamedQueries Source #

Create a value of ListNamedQueries 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:nextToken:ListNamedQueries', listNamedQueries_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:workGroup:ListNamedQueries', listNamedQueries_workGroup - The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.

$sel:maxResults:ListNamedQueries', listNamedQueries_maxResults - The maximum number of queries to return in this request.

Request Lenses

listNamedQueries_nextToken :: Lens' ListNamedQueries (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.

listNamedQueries_workGroup :: Lens' ListNamedQueries (Maybe Text) Source #

The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.

listNamedQueries_maxResults :: Lens' ListNamedQueries (Maybe Natural) Source #

The maximum number of queries to return in this request.

Destructuring the Response

data ListNamedQueriesResponse Source #

See: newListNamedQueriesResponse smart constructor.

Constructors

ListNamedQueriesResponse'
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. namedQueryIds :: Maybe (NonEmpty Text) The list of unique query IDs. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListNamedQueriesResponse Source #

Arguments

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

Create a value of ListNamedQueriesResponse 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:nextToken:ListNamedQueries', listNamedQueriesResponse_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:namedQueryIds:ListNamedQueriesResponse', listNamedQueriesResponse_namedQueryIds - The list of unique query IDs.

$sel:httpStatus:ListNamedQueriesResponse', listNamedQueriesResponse_httpStatus - The response's http status code.

Response Lenses

listNamedQueriesResponse_nextToken :: Lens' ListNamedQueriesResponse (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.

listNamedQueriesResponse_namedQueryIds :: Lens' ListNamedQueriesResponse (Maybe (NonEmpty Text)) Source #

The list of unique query IDs.

listNamedQueriesResponse_httpStatus :: Lens' ListNamedQueriesResponse Int Source #

The response's http status code.