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.RedshiftServerLess.ListWorkgroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a list of specified workgroups.

This operation returns paginated results.

Creating a Request

data ListWorkgroups Source #

See: newListWorkgroups smart constructor.

Constructors

ListWorkgroups'
Fields maxResults :: Maybe Natural An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results. nextToken :: Maybe Text If your initial ListWorkgroups operation returns a `nextToken`, you can include the returned `nextToken` in following ListNamespaces operations, which returns results in the next page.

Instances

Instances details

ToJSON ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods toJSON :: ListWorkgroups -> Value # toEncoding :: ListWorkgroups -> Encoding # toJSONList :: [ListWorkgroups] -> Value # toEncodingList :: [ListWorkgroups] -> Encoding #
ToHeaders ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods toHeaders :: ListWorkgroups -> [Header] #
ToPath ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods toPath :: ListWorkgroups -> ByteString #
ToQuery ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods toQuery :: ListWorkgroups -> QueryString #
AWSPager ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods page :: ListWorkgroups -> AWSResponse ListWorkgroups -> Maybe ListWorkgroups #
AWSRequest ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.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.RedshiftServerLess.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.RedshiftServerLess.ListWorkgroups Methods readsPrec :: Int -> ReadS ListWorkgroups # readList :: ReadS [ListWorkgroups] # readPrec :: ReadPrec ListWorkgroups # readListPrec :: ReadPrec [ListWorkgroups] #
Show ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods showsPrec :: Int -> ListWorkgroups -> ShowS # show :: ListWorkgroups -> String # showList :: [ListWorkgroups] -> ShowS #
NFData ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods rnf :: ListWorkgroups -> () #
Eq ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods (==) :: ListWorkgroups -> ListWorkgroups -> Bool # (/=) :: ListWorkgroups -> ListWorkgroups -> Bool #
Hashable ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods hashWithSalt :: Int -> ListWorkgroups -> Int # hash :: ListWorkgroups -> Int #
type AWSResponse ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups type AWSResponse ListWorkgroups = ListWorkgroupsResponse
type Rep ListWorkgroups Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups type Rep ListWorkgroups = D1 ('MetaData "ListWorkgroups" "Amazonka.RedshiftServerLess.ListWorkgroups" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" '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 - An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

ListWorkgroups, listWorkgroups_nextToken - If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

Request Lenses

listWorkgroups_maxResults :: Lens' ListWorkgroups (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listWorkgroups_nextToken :: Lens' ListWorkgroups (Maybe Text) Source #

If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

Destructuring the Response

data ListWorkgroupsResponse Source #

See: newListWorkgroupsResponse smart constructor.

Constructors

ListWorkgroupsResponse'
Fields nextToken :: Maybe Text If `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token. httpStatus :: Int The response's http status code. workgroups :: [Workgroup] The returned array of workgroups.

Instances

Instances details

Generic ListWorkgroupsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.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.RedshiftServerLess.ListWorkgroups Methods readsPrec :: Int -> ReadS ListWorkgroupsResponse # readList :: ReadS [ListWorkgroupsResponse] # readPrec :: ReadPrec ListWorkgroupsResponse # readListPrec :: ReadPrec [ListWorkgroupsResponse] #
Show ListWorkgroupsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods showsPrec :: Int -> ListWorkgroupsResponse -> ShowS # show :: ListWorkgroupsResponse -> String # showList :: [ListWorkgroupsResponse] -> ShowS #
NFData ListWorkgroupsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods rnf :: ListWorkgroupsResponse -> () #
Eq ListWorkgroupsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups Methods (==) :: ListWorkgroupsResponse -> ListWorkgroupsResponse -> Bool # (/=) :: ListWorkgroupsResponse -> ListWorkgroupsResponse -> Bool #
type Rep ListWorkgroupsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListWorkgroups type Rep ListWorkgroupsResponse = D1 ('MetaData "ListWorkgroupsResponse" "Amazonka.RedshiftServerLess.ListWorkgroups" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "ListWorkgroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "workgroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Workgroup]))))

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 - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

$sel:httpStatus:ListWorkgroupsResponse', listWorkgroupsResponse_httpStatus - The response's http status code.

$sel:workgroups:ListWorkgroupsResponse', listWorkgroupsResponse_workgroups - The returned array of workgroups.

Response Lenses

listWorkgroupsResponse_nextToken :: Lens' ListWorkgroupsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

listWorkgroupsResponse_httpStatus :: Lens' ListWorkgroupsResponse Int Source #

The response's http status code.

listWorkgroupsResponse_workgroups :: Lens' ListWorkgroupsResponse [Workgroup] Source #

The returned array of workgroups.