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

cognitoidentityprovider_update_group: Updates the specified group with the specified attributes

Description

Updates the specified group with the specified attributes.

Calling this action requires developer credentials.

If you don't provide a value for an attribute, it will be set to the default value.

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