Get Group

cognitoidentityprovider_get_group

R Documentation

Gets a group¶

Description¶

Gets a group.

Calling this action requires developer credentials.

Usage¶

cognitoidentityprovider_get_group(GroupName, UserPoolId)

Arguments¶

GroupName: [required] The name of the group.
UserPoolId: [required] The user pool ID for the user pool.

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