List Groups

cognitoidentityprovider_list_groups

R Documentation

Lists the groups associated with a user pool

Description

Lists the groups associated with a user pool.

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 user pool ID for the user pool.

Limit

The limit of the request to list groups.

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.

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