Get Group

cognitoidentityprovider_get_group

R Documentation

Given a user pool ID and a group name, returns information about the user group

Description

Given a user pool ID and a group name, returns information about the user group.

For more information about user pool groups, see Adding groups to 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_get_group(GroupName, UserPoolId)

Arguments

GroupName	[required] The name of the group that you want to get information about.
UserPoolId	[required] The ID of the user pool that contains the group that you want to query.

Value

A list with the following syntax:

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

Request syntax

svc$get_group(
  GroupName = "string",
  UserPoolId = "string"
)