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' )
- Parameters:
GroupName (string) – Don’t use this parameter. Use
Group
instead.Group (string) – The name or the ARN of the resource group to modify.
Description (string) – The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
- Return type:
dict
- Returns:
Response Syntax
{ 'Group': { 'GroupArn': 'string', 'Name': 'string', 'Description': 'string' } }
Response Structure
(dict) –
Group (dict) –
The update description of the resource group.
GroupArn (string) –
The ARN of the resource group.
Name (string) –
The name of the resource group.
Description (string) –
The description of the resource group.
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