Network.AWS.CognitoIdentityProvider.ListGroups

Lists the groups associated with a user pool.

Requires developer credentials.

Creating a Request

listGroups

Arguments

:: Text

lgUserPoolId

-> ListGroups

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 - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
• lgLimit - The limit of the request to list groups.
• lgUserPoolId - The user pool ID for the user pool.

data ListGroups

See: listGroups smart constructor.

Instances

Eq ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

(==) :: ListGroups -> ListGroups -> Bool

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

Data ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

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

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroups

readList :: ReadS [ListGroups]

readPrec :: ReadPrec ListGroups

readListPrec :: ReadPrec [ListGroups]

Show ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

showsPrec :: Int -> ListGroups -> ShowS

show :: ListGroups -> String

showList :: [ListGroups] -> ShowS

Generic ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type

Methods

from :: ListGroups -> Rep ListGroups x

to :: Rep ListGroups x -> ListGroups

Hashable ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

hashWithSalt :: Int -> ListGroups -> Int

hash :: ListGroups -> Int

ToJSON ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

toJSON :: ListGroups -> Value

toEncoding :: ListGroups -> Encoding

toJSONList :: [ListGroups] -> Value

toEncodingList :: [ListGroups] -> Encoding

AWSRequest ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Associated Types

type Rs ListGroups :: Type

Methods

request :: ListGroups -> Request ListGroups

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListGroups -> ClientResponse -> m (Response ListGroups)

ToHeaders ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

toHeaders :: ListGroups -> [Header]

ToPath ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

toPath :: ListGroups -> ByteString

ToQuery ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

toQuery :: ListGroups -> QueryString

NFData ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

rnf :: ListGroups -> ()

type Rep ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

type Rep ListGroups = D1 (MetaData "ListGroups" "Network.AWS.CognitoIdentityProvider.ListGroups" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "ListGroups'" PrefixI True) (S1 (MetaSel (Just "_lgNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lgLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_lgUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs ListGroups

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

type Rs ListGroups = ListGroupsResponse

Request Lenses

lgNextToken :: Lens' ListGroups (Maybe Text)

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

lgLimit :: Lens' ListGroups (Maybe Natural)

The limit of the request to list groups.

lgUserPoolId :: Lens' ListGroups Text

The user pool ID for the user pool.

Destructuring the Response

listGroupsResponse

Arguments

:: Int

lgrsResponseStatus

-> ListGroupsResponse

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:

• lgrsGroups - The group objects for the groups.
• lgrsNextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
• lgrsResponseStatus - -- | The response status code.

data ListGroupsResponse

See: listGroupsResponse smart constructor.

Instances

Eq ListGroupsResponse

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

(==) :: ListGroupsResponse -> ListGroupsResponse -> Bool

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

Data ListGroupsResponse

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

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

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroupsResponse

readList :: ReadS [ListGroupsResponse]

readPrec :: ReadPrec ListGroupsResponse

readListPrec :: ReadPrec [ListGroupsResponse]

Show ListGroupsResponse

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

showsPrec :: Int -> ListGroupsResponse -> ShowS

show :: ListGroupsResponse -> String

showList :: [ListGroupsResponse] -> ShowS

Generic ListGroupsResponse

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type

Methods

from :: ListGroupsResponse -> Rep ListGroupsResponse x

to :: Rep ListGroupsResponse x -> ListGroupsResponse

NFData ListGroupsResponse

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

Methods

rnf :: ListGroupsResponse -> ()

type Rep ListGroupsResponse

Defined in Network.AWS.CognitoIdentityProvider.ListGroups

type Rep ListGroupsResponse = D1 (MetaData "ListGroupsResponse" "Network.AWS.CognitoIdentityProvider.ListGroups" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "ListGroupsResponse'" PrefixI True) (S1 (MetaSel (Just "_lgrsGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GroupType])) :*: (S1 (MetaSel (Just "_lgrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lgrsGroups :: Lens' ListGroupsResponse [GroupType]

The group objects for the groups.

lgrsNextToken :: Lens' ListGroupsResponse (Maybe Text)

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

lgrsResponseStatus :: Lens' ListGroupsResponse Int

• - | The response status code.