Learn R Programming
paws.security.identity (version 0.1.12)

cognitoidentityprovider_list_groups: Lists the groups associated with a user pool

Description

Lists the groups associated with a user pool.

Calling this action requires developer credentials.

Usage

cognitoidentityprovider_list_groups(UserPoolId, Limit, NextToken)

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

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.

Request syntax

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