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

cognitoidentityprovider_list_users_in_group: Lists the users in the specified group

Description

Lists the users in the specified group.

Calling this action requires developer credentials.

Usage

cognitoidentityprovider_list_users_in_group(UserPoolId, GroupName,
  Limit, NextToken)

Value

A list with the following syntax:

list(
  Users = list(
    list(
      Username = "string",
      Attributes = list(
        list(
          Name = "string",
          Value = "string"
        )
      ),
      UserCreateDate = as.POSIXct(
        "2015-01-01"
      ),
      UserLastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      Enabled = TRUE|FALSE,
      UserStatus = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD",
      MFAOptions = list(
        list(
          DeliveryMedium = "SMS"|"EMAIL",
          AttributeName = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Arguments

UserPoolId

[required] The user pool ID for the user pool.

GroupName

[required] The name of the group.

Limit

The limit of the request to list users.

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_users_in_group(
  UserPoolId = "string",
  GroupName = "string",
  Limit = 123,
  NextToken = "string"
)