Amazonka.CognitoIdentityProvider.ListGroups

Lists the groups associated with a user pool.

Calling this action requires developer credentials.

This operation returns paginated results.

Creating a Request

data ListGroups

See: newListGroups smart constructor.

Constructors

ListGroups'

Fields

• limit :: Maybe Natural

  The limit of the request to list 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.

• userPoolId :: Text

  The user pool ID for the user pool.

Instances

ToJSON ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

toJSON :: ListGroups -> Value

toEncoding :: ListGroups -> Encoding

toJSONList :: [ListGroups] -> Value

toEncodingList :: [ListGroups] -> Encoding

ToHeaders ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

toHeaders :: ListGroups -> [Header]

ToPath ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

toPath :: ListGroups -> ByteString

ToQuery ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

toQuery :: ListGroups -> QueryString

AWSPager ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

page :: ListGroups -> AWSResponse ListGroups -> Maybe ListGroups

AWSRequest ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Associated Types

type AWSResponse ListGroups

Methods

request :: (Service -> Service) -> ListGroups -> Request ListGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGroups)))

Generic ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type

Methods

from :: ListGroups -> Rep ListGroups x

to :: Rep ListGroups x -> ListGroups

Read ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroups

readList :: ReadS [ListGroups]

readPrec :: ReadPrec ListGroups

readListPrec :: ReadPrec [ListGroups]

Show ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

showsPrec :: Int -> ListGroups -> ShowS

show :: ListGroups -> String

showList :: [ListGroups] -> ShowS

NFData ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

rnf :: ListGroups -> ()

Eq ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

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

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

Hashable ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

hashWithSalt :: Int -> ListGroups -> Int

hash :: ListGroups -> Int

type AWSResponse ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

type AWSResponse ListGroups = ListGroupsResponse

type Rep ListGroups

Defined in Amazonka.CognitoIdentityProvider.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.CognitoIdentityProvider.ListGroups" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListGroups

Arguments

:: Text

ListGroups

-> ListGroups

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:limit:ListGroups', listGroups_limit - The limit of the request to list groups.

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.

ListGroups, listGroups_userPoolId - The user pool ID for the user pool.

Request Lenses

listGroups_limit :: Lens' ListGroups (Maybe Natural)

The limit of the request to list groups.

listGroups_nextToken :: 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.

listGroups_userPoolId :: Lens' ListGroups Text

The user pool ID for the user pool.

Destructuring the Response

data ListGroupsResponse

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

Generic ListGroupsResponse

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type

Methods

from :: ListGroupsResponse -> Rep ListGroupsResponse x

to :: Rep ListGroupsResponse x -> ListGroupsResponse

Read ListGroupsResponse

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroupsResponse

readList :: ReadS [ListGroupsResponse]

readPrec :: ReadPrec ListGroupsResponse

readListPrec :: ReadPrec [ListGroupsResponse]

Show ListGroupsResponse

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

showsPrec :: Int -> ListGroupsResponse -> ShowS

show :: ListGroupsResponse -> String

showList :: [ListGroupsResponse] -> ShowS

NFData ListGroupsResponse

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

rnf :: ListGroupsResponse -> ()

Eq ListGroupsResponse

Defined in Amazonka.CognitoIdentityProvider.ListGroups

Methods

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

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

type Rep ListGroupsResponse

Defined in Amazonka.CognitoIdentityProvider.ListGroups

type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.CognitoIdentityProvider.ListGroups" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" '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

Arguments

:: Int

$sel:httpStatus:ListGroupsResponse'

-> ListGroupsResponse

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.

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])

The group objects for the groups.

listGroupsResponse_nextToken :: 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.

listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int

The response's http status code.