NAME

Paws::CognitoIdp::UpdateGroup - Arguments for method UpdateGroup on Paws::CognitoIdp

DESCRIPTION

This class represents the parameters used for calling the method UpdateGroup on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method UpdateGroup.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateGroup.

SYNOPSIS

my $cognito-idp = Paws->service('CognitoIdp');
my $UpdateGroupResponse = $cognito -idp->UpdateGroup(
  GroupName   => 'MyGroupNameType',
  UserPoolId  => 'MyUserPoolIdType',
  Description => 'MyDescriptionType',    # OPTIONAL
  Precedence  => 1,                      # OPTIONAL
  RoleArn     => 'MyArnType',            # OPTIONAL
);

# Results:
my $Group = $UpdateGroupResponse->Group;

# Returns a L<Paws::CognitoIdp::UpdateGroupResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/UpdateGroup

ATTRIBUTES

Description => Str

A string containing the new description of the group.

REQUIRED GroupName => Str

The name of the group.

Precedence => Int

The new precedence value for the group. For more information about this parameter, see CreateGroup (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html).

RoleArn => Str

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

REQUIRED UserPoolId => Str

The user pool ID for the user pool.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateGroup in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues