List Groups

cognitoidentityprovider_list_groups

R Documentation

Given a user pool ID, returns user pool groups and their details

Description

Given a user pool ID, returns user pool groups and their details.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_list_groups(UserPoolId, Limit, NextToken)

Arguments

UserPoolId	[required] The ID of the user pool where you want to list user groups.
Limit	The maximum number of groups that you want Amazon Cognito to return in the response.
NextToken	This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Value

A list with the following syntax:

list(
  Groups = list(
    list(
      GroupName = "string",
      UserPoolId = "string",
      Description = "string",
      RoleArn = "string",
      Precedence = 123,
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      CreationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_groups(
  UserPoolId = "string",
  Limit = 123,
  NextToken = "string"
)