Update Group

cognitoidentityprovider_update_group

R Documentation

Updates the specified group with the specified attributes

Description

Updates the specified group with the specified attributes.

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_update_group(GroupName, UserPoolId, Description,
  RoleArn, Precedence)

Arguments

GroupName

[required] The name of the group.

UserPoolId

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

Description

A string containing the new description of the group.

RoleArn

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Precedence

The new precedence value for the group. For more information about this parameter, see create_group.

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$update_group(
  GroupName = "string",
  UserPoolId = "string",
  Description = "string",
  RoleArn = "string",
  Precedence = 123
)