ResourceGroups / Client / get_group_configuration

get_group_configuration#

ResourceGroups.Client.get_group_configuration(**kwargs)#

Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups.

Minimum permissions

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

  • resource-groups:GetGroupConfiguration

See also: AWS API Documentation

Request Syntax

response = client.get_group_configuration(
    Group='string'
)
Parameters:

Group (string) – The name or the ARN of the resource group for which you want to retrive the service configuration.

Return type:

dict

Returns:

Response Syntax

{
    'GroupConfiguration': {
        'Configuration': [
            {
                'Type': 'string',
                'Parameters': [
                    {
                        'Name': 'string',
                        'Values': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'ProposedConfiguration': [
            {
                'Type': 'string',
                'Parameters': [
                    {
                        'Name': 'string',
                        'Values': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'Status': 'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
        'FailureReason': 'string'
    }
}

Response Structure

  • (dict) –

    • GroupConfiguration (dict) –

      A structure that describes the service configuration attached with the specified group. For details about the service configuration syntax, see Service configurations for Resource Groups.

      • Configuration (list) –

        The configuration currently associated with the group and in effect.

      • ProposedConfiguration (list) –

        If present, the new configuration that is in the process of being applied to the group.

      • Status (string) –

        The current status of an attempt to update the group configuration.

      • FailureReason (string) –

        If present, the reason why a request to update the group configuration failed.

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