Amazonka.Athena.ListNamedQueries

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

See: newListNamedQueries smart constructor.

Constructors

ListNamedQueries'

Fields

• maxResults :: Maybe Natural

  The maximum number of queries to return in this request.

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

Instances

ToJSON ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

toJSON :: ListNamedQueries -> Value

toEncoding :: ListNamedQueries -> Encoding

toJSONList :: [ListNamedQueries] -> Value

toEncodingList :: [ListNamedQueries] -> Encoding

ToHeaders ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

toHeaders :: ListNamedQueries -> [Header]

ToPath ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

toPath :: ListNamedQueries -> ByteString

ToQuery ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

toQuery :: ListNamedQueries -> QueryString

AWSPager ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

page :: ListNamedQueries -> AWSResponse ListNamedQueries -> Maybe ListNamedQueries

AWSRequest ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Associated Types

type AWSResponse ListNamedQueries

Methods

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

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

Generic ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Associated Types

type Rep ListNamedQueries :: Type -> Type

Methods

from :: ListNamedQueries -> Rep ListNamedQueries x

to :: Rep ListNamedQueries x -> ListNamedQueries

Read ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

readsPrec :: Int -> ReadS ListNamedQueries

readList :: ReadS [ListNamedQueries]

readPrec :: ReadPrec ListNamedQueries

readListPrec :: ReadPrec [ListNamedQueries]

Show ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

showsPrec :: Int -> ListNamedQueries -> ShowS

show :: ListNamedQueries -> String

showList :: [ListNamedQueries] -> ShowS

NFData ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

rnf :: ListNamedQueries -> ()

Eq ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

(==) :: ListNamedQueries -> ListNamedQueries -> Bool

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

Hashable ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

Methods

hashWithSalt :: Int -> ListNamedQueries -> Int

hash :: ListNamedQueries -> Int

type AWSResponse ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

type AWSResponse ListNamedQueries = ListNamedQueriesResponse

type Rep ListNamedQueries

Defined in Amazonka.Athena.ListNamedQueries

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

newListNamedQueries :: ListNamedQueries

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:maxResults:ListNamedQueries', listNamedQueries_maxResults - The maximum number of queries to return in this request.

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.

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.

Request Lenses

listNamedQueries_maxResults :: Lens' ListNamedQueries (Maybe Natural)

The maximum number of queries to return in this request.

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

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

Destructuring the Response

data ListNamedQueriesResponse

See: newListNamedQueriesResponse smart constructor.

Constructors

ListNamedQueriesResponse'

Fields

• namedQueryIds :: Maybe (NonEmpty Text)

  The list of unique query IDs.

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

Instances

Generic ListNamedQueriesResponse

Defined in Amazonka.Athena.ListNamedQueries

Associated Types

type Rep ListNamedQueriesResponse :: Type -> Type

Methods

from :: ListNamedQueriesResponse -> Rep ListNamedQueriesResponse x

to :: Rep ListNamedQueriesResponse x -> ListNamedQueriesResponse

Read ListNamedQueriesResponse

Defined in Amazonka.Athena.ListNamedQueries

Methods

readsPrec :: Int -> ReadS ListNamedQueriesResponse

readList :: ReadS [ListNamedQueriesResponse]

readPrec :: ReadPrec ListNamedQueriesResponse

readListPrec :: ReadPrec [ListNamedQueriesResponse]

Show ListNamedQueriesResponse

Defined in Amazonka.Athena.ListNamedQueries

Methods

showsPrec :: Int -> ListNamedQueriesResponse -> ShowS

show :: ListNamedQueriesResponse -> String

showList :: [ListNamedQueriesResponse] -> ShowS

NFData ListNamedQueriesResponse

Defined in Amazonka.Athena.ListNamedQueries

Methods

rnf :: ListNamedQueriesResponse -> ()

Eq ListNamedQueriesResponse

Defined in Amazonka.Athena.ListNamedQueries

Methods

(==) :: ListNamedQueriesResponse -> ListNamedQueriesResponse -> Bool

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

type Rep ListNamedQueriesResponse

Defined in Amazonka.Athena.ListNamedQueries

type Rep ListNamedQueriesResponse = D1 ('MetaData "ListNamedQueriesResponse" "Amazonka.Athena.ListNamedQueries" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListNamedQueriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namedQueryIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListNamedQueriesResponse

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:namedQueryIds:ListNamedQueriesResponse', listNamedQueriesResponse_namedQueryIds - The list of unique query IDs.

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:httpStatus:ListNamedQueriesResponse', listNamedQueriesResponse_httpStatus - The response's http status code.

Response Lenses

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

The list of unique query IDs.

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

listNamedQueriesResponse_httpStatus :: Lens' ListNamedQueriesResponse Int

The response's http status code.