ResourceGroups / Client / update_group

update_group#

ResourceGroups.Client.update_group(**kwargs)#

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroup

See also: AWS API Documentation

Request Syntax

response = client.update_group(
    GroupName='string',
    Group='string',
    Description='string',
    Criticality=123,
    Owner='string',
    DisplayName='string'
)
Parameters:

  • GroupName (string) – Don’t use this parameter. Use Group instead.

  • Group (string) – The name or the ARN of the resource group to update.

  • Description (string) – The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.

  • Criticality (integer) – The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.

  • Owner (string) – A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.

  • DisplayName (string) – The name of the application group, which you can change at any time.

Return type:

dict

Returns:

Response Syntax

{
    'Group': {
        'GroupArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'Criticality': 123,
        'Owner': 'string',
        'DisplayName': 'string',
        'ApplicationTag': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Group (dict) –

      The update description of the resource group.

      • GroupArn (string) –

        The Amazon resource name (ARN) of the resource group.

      • Name (string) –

        The name of the resource group.

      • Description (string) –

        The description of the resource group.

      • Criticality (integer) –

        The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.

      • Owner (string) –

        A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.

      • DisplayName (string) –

        The name of the application group, which you can change at any time.

      • ApplicationTag (dict) –

        A tag that defines the application group membership. This tag is only supported for application groups.

        • (string) –

          • (string) –

Exceptions

  • ResourceGroups.Client.exceptions.BadRequestException

  • ResourceGroups.Client.exceptions.ForbiddenException

  • ResourceGroups.Client.exceptions.NotFoundException

  • ResourceGroups.Client.exceptions.MethodNotAllowedException

  • ResourceGroups.Client.exceptions.TooManyRequestsException

  • ResourceGroups.Client.exceptions.InternalServerErrorException