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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists available workgroups for the account.

Creating a Request

data ListWorkGroups Source #

See: newListWorkGroups smart constructor.

Constructors

ListWorkGroups'
Fields maxResults :: Maybe Natural The maximum number of workgroups 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.

Instances

Instances details

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

newListWorkGroups :: ListWorkGroups Source #

Create a value of ListWorkGroups 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:ListWorkGroups', listWorkGroups_maxResults - The maximum number of workgroups to return in this request.

ListWorkGroups, listWorkGroups_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.

Request Lenses

listWorkGroups_maxResults :: Lens' ListWorkGroups (Maybe Natural) Source #

The maximum number of workgroups to return in this request.

listWorkGroups_nextToken :: Lens' ListWorkGroups (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.

Destructuring the Response

data ListWorkGroupsResponse Source #

See: newListWorkGroupsResponse smart constructor.

Constructors

ListWorkGroupsResponse'

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.
workGroups :: Maybe [WorkGroupSummary]
A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListWorkGroupsResponse Source #

Arguments

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

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

ListWorkGroups, listWorkGroupsResponse_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:workGroups:ListWorkGroupsResponse', listWorkGroupsResponse_workGroups - A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.

$sel:httpStatus:ListWorkGroupsResponse', listWorkGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listWorkGroupsResponse_nextToken :: Lens' ListWorkGroupsResponse (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.

listWorkGroupsResponse_workGroups :: Lens' ListWorkGroupsResponse (Maybe [WorkGroupSummary]) Source #

A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.

listWorkGroupsResponse_httpStatus :: Lens' ListWorkGroupsResponse Int Source #

The response's http status code.