/AWS1/CL_CGP=>UPDATEGROUP()

About UpdateGroup

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

Method Signature

IMPORTING

Required arguments:

IV_GROUPNAME TYPE /AWS1/CGPGROUPNAMETYPE /AWS1/CGPGROUPNAMETYPE

The name of the group.

IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE /AWS1/CGPUSERPOOLIDTYPE

The user pool ID for the user pool.

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/CGPDESCRIPTIONTYPE /AWS1/CGPDESCRIPTIONTYPE

A string containing the new description of the group.

IV_ROLEARN TYPE /AWS1/CGPARNTYPE /AWS1/CGPARNTYPE

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.

IV_PRECEDENCE TYPE /AWS1/CGPPRECEDENCETYPE /AWS1/CGPPRECEDENCETYPE

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CGPUPDATEGROUPRSP /AWS1/CL_CGPUPDATEGROUPRSP