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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

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.

Synopsis

data ListQueryExecutions = ListQueryExecutions' {
- nextToken :: Maybe Text
- workGroup :: Maybe Text
- maxResults :: Maybe Natural
}
newListQueryExecutions :: ListQueryExecutions
listQueryExecutions_nextToken :: Lens' ListQueryExecutions (Maybe Text)
listQueryExecutions_workGroup :: Lens' ListQueryExecutions (Maybe Text)
listQueryExecutions_maxResults :: Lens' ListQueryExecutions (Maybe Natural)
data ListQueryExecutionsResponse = ListQueryExecutionsResponse' {
- queryExecutionIds :: Maybe (NonEmpty Text)
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListQueryExecutionsResponse :: Int -> ListQueryExecutionsResponse
listQueryExecutionsResponse_queryExecutionIds :: Lens' ListQueryExecutionsResponse (Maybe (NonEmpty Text))
listQueryExecutionsResponse_nextToken :: Lens' ListQueryExecutionsResponse (Maybe Text)
listQueryExecutionsResponse_httpStatus :: Lens' ListQueryExecutionsResponse Int

Creating a Request

data ListQueryExecutions Source #

See: newListQueryExecutions smart constructor.

Constructors

ListQueryExecutions'

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 queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.
maxResults :: Maybe Natural
The maximum number of query executions to return in this request.

Instances

Instances details

Eq ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods (==) :: ListQueryExecutions -> ListQueryExecutions -> Bool # (/=) :: ListQueryExecutions -> ListQueryExecutions -> Bool #
Read ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods readsPrec :: Int -> ReadS ListQueryExecutions # readList :: ReadS [ListQueryExecutions] # readPrec :: ReadPrec ListQueryExecutions # readListPrec :: ReadPrec [ListQueryExecutions] #
Show ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods showsPrec :: Int -> ListQueryExecutions -> ShowS # show :: ListQueryExecutions -> String # showList :: [ListQueryExecutions] -> ShowS #
Generic ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Associated Types type Rep ListQueryExecutions :: Type -> Type # Methods from :: ListQueryExecutions -> Rep ListQueryExecutions x # to :: Rep ListQueryExecutions x -> ListQueryExecutions #
NFData ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods rnf :: ListQueryExecutions -> () #
Hashable ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods hashWithSalt :: Int -> ListQueryExecutions -> Int # hash :: ListQueryExecutions -> Int #
ToJSON ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods toJSON :: ListQueryExecutions -> Value # toEncoding :: ListQueryExecutions -> Encoding # toJSONList :: [ListQueryExecutions] -> Value # toEncodingList :: [ListQueryExecutions] -> Encoding #
AWSPager ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods page :: ListQueryExecutions -> AWSResponse ListQueryExecutions -> Maybe ListQueryExecutions #
AWSRequest ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Associated Types type AWSResponse ListQueryExecutions # Methods request :: ListQueryExecutions -> Request ListQueryExecutions # response :: MonadResource m => Logger -> Service -> Proxy ListQueryExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListQueryExecutions))) #
ToHeaders ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods toHeaders :: ListQueryExecutions -> [Header] #
ToPath ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods toPath :: ListQueryExecutions -> ByteString #
ToQuery ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods toQuery :: ListQueryExecutions -> QueryString #
type Rep ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions type Rep ListQueryExecutions = D1 ('MetaData "ListQueryExecutions" "Amazonka.Athena.ListQueryExecutions" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "ListQueryExecutions'" '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 ListQueryExecutions Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions type AWSResponse ListQueryExecutions = ListQueryExecutionsResponse

newListQueryExecutions :: ListQueryExecutions Source #

Create a value of ListQueryExecutions 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:ListQueryExecutions', listQueryExecutions_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:ListQueryExecutions', listQueryExecutions_workGroup - The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.

$sel:maxResults:ListQueryExecutions', listQueryExecutions_maxResults - The maximum number of query executions to return in this request.

Request Lenses

listQueryExecutions_nextToken :: Lens' ListQueryExecutions (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.

listQueryExecutions_workGroup :: Lens' ListQueryExecutions (Maybe Text) Source #

The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.

listQueryExecutions_maxResults :: Lens' ListQueryExecutions (Maybe Natural) Source #

The maximum number of query executions to return in this request.

Destructuring the Response

data ListQueryExecutionsResponse Source #

See: newListQueryExecutionsResponse smart constructor.

Constructors

ListQueryExecutionsResponse'
Fields queryExecutionIds :: Maybe (NonEmpty Text) The unique IDs of each query execution as an array of strings. nextToken :: Maybe Text A token to be used by the next request if this request is truncated. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListQueryExecutionsResponse Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods (==) :: ListQueryExecutionsResponse -> ListQueryExecutionsResponse -> Bool # (/=) :: ListQueryExecutionsResponse -> ListQueryExecutionsResponse -> Bool #
Read ListQueryExecutionsResponse Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods readsPrec :: Int -> ReadS ListQueryExecutionsResponse # readList :: ReadS [ListQueryExecutionsResponse] # readPrec :: ReadPrec ListQueryExecutionsResponse # readListPrec :: ReadPrec [ListQueryExecutionsResponse] #
Show ListQueryExecutionsResponse Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods showsPrec :: Int -> ListQueryExecutionsResponse -> ShowS # show :: ListQueryExecutionsResponse -> String # showList :: [ListQueryExecutionsResponse] -> ShowS #
Generic ListQueryExecutionsResponse Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Associated Types type Rep ListQueryExecutionsResponse :: Type -> Type # Methods from :: ListQueryExecutionsResponse -> Rep ListQueryExecutionsResponse x # to :: Rep ListQueryExecutionsResponse x -> ListQueryExecutionsResponse #
NFData ListQueryExecutionsResponse Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions Methods rnf :: ListQueryExecutionsResponse -> () #
type Rep ListQueryExecutionsResponse Source #
Instance details Defined in Amazonka.Athena.ListQueryExecutions type Rep ListQueryExecutionsResponse = D1 ('MetaData "ListQueryExecutionsResponse" "Amazonka.Athena.ListQueryExecutions" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "ListQueryExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryExecutionIds") '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))))

newListQueryExecutionsResponse Source #

Arguments

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

Create a value of ListQueryExecutionsResponse 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:queryExecutionIds:ListQueryExecutionsResponse', listQueryExecutionsResponse_queryExecutionIds - The unique IDs of each query execution as an array of strings.

$sel:nextToken:ListQueryExecutions', listQueryExecutionsResponse_nextToken - A token to be used by the next request if this request is truncated.

$sel:httpStatus:ListQueryExecutionsResponse', listQueryExecutionsResponse_httpStatus - The response's http status code.

Response Lenses

listQueryExecutionsResponse_queryExecutionIds :: Lens' ListQueryExecutionsResponse (Maybe (NonEmpty Text)) Source #

The unique IDs of each query execution as an array of strings.

listQueryExecutionsResponse_nextToken :: Lens' ListQueryExecutionsResponse (Maybe Text) Source #

A token to be used by the next request if this request is truncated.

listQueryExecutionsResponse_httpStatus :: Lens' ListQueryExecutionsResponse Int Source #

The response's http status code.