Amazonka.Athena.ListQueryExecutions

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.

Creating a Request

data ListQueryExecutions

See: newListQueryExecutions smart constructor.

Constructors

ListQueryExecutions'

Fields

• maxResults :: Maybe Natural

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

Instances

ToJSON ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

toJSON :: ListQueryExecutions -> Value

toEncoding :: ListQueryExecutions -> Encoding

toJSONList :: [ListQueryExecutions] -> Value

toEncodingList :: [ListQueryExecutions] -> Encoding

ToHeaders ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

toHeaders :: ListQueryExecutions -> [Header]

ToPath ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

toPath :: ListQueryExecutions -> ByteString

ToQuery ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

toQuery :: ListQueryExecutions -> QueryString

AWSPager ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

page :: ListQueryExecutions -> AWSResponse ListQueryExecutions -> Maybe ListQueryExecutions

AWSRequest ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Associated Types

type AWSResponse ListQueryExecutions

Methods

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

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

Generic ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Associated Types

type Rep ListQueryExecutions :: Type -> Type

Methods

from :: ListQueryExecutions -> Rep ListQueryExecutions x

to :: Rep ListQueryExecutions x -> ListQueryExecutions

Read ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

readsPrec :: Int -> ReadS ListQueryExecutions

readList :: ReadS [ListQueryExecutions]

readPrec :: ReadPrec ListQueryExecutions

readListPrec :: ReadPrec [ListQueryExecutions]

Show ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

showsPrec :: Int -> ListQueryExecutions -> ShowS

show :: ListQueryExecutions -> String

showList :: [ListQueryExecutions] -> ShowS

NFData ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

rnf :: ListQueryExecutions -> ()

Eq ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

(==) :: ListQueryExecutions -> ListQueryExecutions -> Bool

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

Hashable ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

Methods

hashWithSalt :: Int -> ListQueryExecutions -> Int

hash :: ListQueryExecutions -> Int

type AWSResponse ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

type AWSResponse ListQueryExecutions = ListQueryExecutionsResponse

type Rep ListQueryExecutions

Defined in Amazonka.Athena.ListQueryExecutions

type Rep ListQueryExecutions = D1 ('MetaData "ListQueryExecutions" "Amazonka.Athena.ListQueryExecutions" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListQueryExecutions'" '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)))))

newListQueryExecutions :: ListQueryExecutions

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:maxResults:ListQueryExecutions', listQueryExecutions_maxResults - The maximum number of query executions to return in this request.

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.

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.

Request Lenses

listQueryExecutions_maxResults :: Lens' ListQueryExecutions (Maybe Natural)

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

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

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

Destructuring the Response

data ListQueryExecutionsResponse

See: newListQueryExecutionsResponse smart constructor.

Constructors

ListQueryExecutionsResponse'

Fields

• nextToken :: Maybe Text

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

• queryExecutionIds :: Maybe (NonEmpty Text)

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListQueryExecutionsResponse

Defined in Amazonka.Athena.ListQueryExecutions

Associated Types

type Rep ListQueryExecutionsResponse :: Type -> Type

Methods

from :: ListQueryExecutionsResponse -> Rep ListQueryExecutionsResponse x

to :: Rep ListQueryExecutionsResponse x -> ListQueryExecutionsResponse

Read ListQueryExecutionsResponse

Defined in Amazonka.Athena.ListQueryExecutions

Methods

readsPrec :: Int -> ReadS ListQueryExecutionsResponse

readList :: ReadS [ListQueryExecutionsResponse]

readPrec :: ReadPrec ListQueryExecutionsResponse

readListPrec :: ReadPrec [ListQueryExecutionsResponse]

Show ListQueryExecutionsResponse

Defined in Amazonka.Athena.ListQueryExecutions

Methods

showsPrec :: Int -> ListQueryExecutionsResponse -> ShowS

show :: ListQueryExecutionsResponse -> String

showList :: [ListQueryExecutionsResponse] -> ShowS

NFData ListQueryExecutionsResponse

Defined in Amazonka.Athena.ListQueryExecutions

Methods

rnf :: ListQueryExecutionsResponse -> ()

Eq ListQueryExecutionsResponse

Defined in Amazonka.Athena.ListQueryExecutions

Methods

(==) :: ListQueryExecutionsResponse -> ListQueryExecutionsResponse -> Bool

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

type Rep ListQueryExecutionsResponse

Defined in Amazonka.Athena.ListQueryExecutions

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

newListQueryExecutionsResponse

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:

ListQueryExecutions, listQueryExecutionsResponse_nextToken - A token to be used by the next request if this request is truncated.

$sel:queryExecutionIds:ListQueryExecutionsResponse', listQueryExecutionsResponse_queryExecutionIds - The unique IDs of each query execution as an array of strings.

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

Response Lenses

listQueryExecutionsResponse_nextToken :: Lens' ListQueryExecutionsResponse (Maybe Text)

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

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

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

listQueryExecutionsResponse_httpStatus :: Lens' ListQueryExecutionsResponse Int

The response's http status code.