get_group

ResourceGroups.Client.get_group(**kwargs)

Returns information about a specified resource group.

Minimum permissions

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

• resource-groups:GetGroup

See also: AWS API Documentation

Request Syntax

response = client.get_group(
    GroupName='string',
    Group='string'
)

Parameters

• GroupName (string) -- Deprecated - don't use this parameter. Use Group instead.
• Group (string) -- The name or the ARN of the resource group to retrieve.

Return type

dict

Returns

Response Syntax

{
    'Group': {
        'GroupArn': 'string',
        'Name': 'string',
        'Description': 'string'
    }
}

Response Structure

• (dict) --

  • Group (dict) --

    A structure that contains the metadata details for the specified resource group. Use GetGroupQuery and GetGroupConfiguration to get those additional details 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