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

Amazonka.CognitoIdentityProvider.ListGroups

Description

Lists the groups associated with a user pool.

Calling this action requires developer credentials.

This operation returns paginated results.

Synopsis

Creating a Request

data ListGroups Source #

See: newListGroups smart constructor.

Constructors

ListGroups' 

Fields

  • nextToken :: 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.

  • limit :: Maybe Natural

    The limit of the request to list groups.

  • userPoolId :: Text

    The user pool ID for the user pool.

Instances

Instances details
Eq ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Read ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Show ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Generic ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type #

NFData ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

rnf :: ListGroups -> () #

Hashable ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

ToJSON ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

AWSPager ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

AWSRequest ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Associated Types

type AWSResponse ListGroups #

ToHeaders ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

toHeaders :: ListGroups -> [Header] #

ToPath ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

ToQuery ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

type Rep ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.CognitoIdentityProvider.ListGroups" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListGroups Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

newListGroups Source #

Create a value of ListGroups 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:nextToken:ListGroups', listGroups_nextToken - 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.

$sel:limit:ListGroups', listGroups_limit - The limit of the request to list groups.

$sel:userPoolId:ListGroups', listGroups_userPoolId - The user pool ID for the user pool.

Request Lenses

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

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.

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

The limit of the request to list groups.

listGroups_userPoolId :: Lens' ListGroups Text Source #

The user pool ID for the user pool.

Destructuring the Response

data ListGroupsResponse Source #

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse' 

Fields

  • groups :: Maybe [GroupType]

    The group objects for the groups.

  • nextToken :: 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListGroupsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Read ListGroupsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Show ListGroupsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Generic ListGroupsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type #

NFData ListGroupsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

rnf :: ListGroupsResponse -> () #

type Rep ListGroupsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListGroups

type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.CognitoIdentityProvider.ListGroups" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupType])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGroupsResponse Source #

Create a value of ListGroupsResponse 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:groups:ListGroupsResponse', listGroupsResponse_groups - The group objects for the groups.

$sel:nextToken:ListGroups', listGroupsResponse_nextToken - 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.

$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupType]) Source #

The group objects for the groups.

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

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.