amazonka-resourcegroups-1.6.0: Amazon Resource Groups SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ResourceGroups.ListGroups

Contents

Description

Returns a list of existing resource groups in your account.

This operation returns paginated results.

Synopsis

Creating a Request

listGroups :: ListGroups Source #

Creates a value of ListGroups with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lgNextToken - The NextToken value that is returned in a paginated ListGroups request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.
  • lgMaxResults - The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.

data ListGroups Source #

See: listGroups smart constructor.

Instances

Eq ListGroups Source # 
Data ListGroups Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListGroups -> c ListGroups #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListGroups #

toConstr :: ListGroups -> Constr #

dataTypeOf :: ListGroups -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListGroups) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListGroups) #

gmapT :: (forall b. Data b => b -> b) -> ListGroups -> ListGroups #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListGroups -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListGroups -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListGroups -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListGroups -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListGroups -> m ListGroups #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroups -> m ListGroups #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroups -> m ListGroups #

Read ListGroups Source # 
Show ListGroups Source # 
Generic ListGroups Source # 

Associated Types

type Rep ListGroups :: * -> * #

Hashable ListGroups Source # 
NFData ListGroups Source # 

Methods

rnf :: ListGroups -> () #

AWSPager ListGroups Source # 
AWSRequest ListGroups Source # 
ToHeaders ListGroups Source # 

Methods

toHeaders :: ListGroups -> [Header] #

ToPath ListGroups Source # 
ToQuery ListGroups Source # 
type Rep ListGroups Source # 
type Rep ListGroups = D1 * (MetaData "ListGroups" "Network.AWS.ResourceGroups.ListGroups" "amazonka-resourcegroups-1.6.0-BcTE97yO3xiNkTKZdYgRR" False) (C1 * (MetaCons "ListGroups'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lgNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))
type Rs ListGroups Source # 

Request Lenses

lgNextToken :: Lens' ListGroups (Maybe Text) Source #

The NextToken value that is returned in a paginated ListGroups request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

lgMaxResults :: Lens' ListGroups (Maybe Natural) Source #

The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.

Destructuring the Response

listGroupsResponse Source #

Creates a value of ListGroupsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ListGroupsResponse Source #

See: listGroupsResponse smart constructor.

Instances

Eq ListGroupsResponse Source # 
Data ListGroupsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListGroupsResponse -> c ListGroupsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListGroupsResponse #

toConstr :: ListGroupsResponse -> Constr #

dataTypeOf :: ListGroupsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListGroupsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListGroupsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListGroupsResponse -> ListGroupsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListGroupsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListGroupsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListGroupsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListGroupsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListGroupsResponse -> m ListGroupsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroupsResponse -> m ListGroupsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroupsResponse -> m ListGroupsResponse #

Read ListGroupsResponse Source # 
Show ListGroupsResponse Source # 
Generic ListGroupsResponse Source # 
NFData ListGroupsResponse Source # 

Methods

rnf :: ListGroupsResponse -> () #

type Rep ListGroupsResponse Source # 
type Rep ListGroupsResponse = D1 * (MetaData "ListGroupsResponse" "Network.AWS.ResourceGroups.ListGroups" "amazonka-resourcegroups-1.6.0-BcTE97yO3xiNkTKZdYgRR" False) (C1 * (MetaCons "ListGroupsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lgrsGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Group]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lgrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lgrsGroups :: Lens' ListGroupsResponse [Group] Source #

A list of resource groups.

lgrsNextToken :: Lens' ListGroupsResponse (Maybe Text) Source #

The NextToken value to include in a subsequent ListGroups request, to get more results.

lgrsResponseStatus :: Lens' ListGroupsResponse Int Source #

  • - | The response status code.