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

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.
    - (dict) –
      
      An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
      - Type (string) –
        
        Specifies the type of group configuration item. Each item must have a unique value for type. For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
      - Parameters (list) –
        
        A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
        
        (dict) –
        
        A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
        
        Name (string) –
        
        The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
        
        Values (list) –
        
        The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
        
        (string) –
  - ProposedConfiguration (list) –
    
    If present, the new configuration that is in the process of being applied to the group.
    - (dict) –
      
      An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
      - Type (string) –
        
        Specifies the type of group configuration item. Each item must have a unique value for type. For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
      - Parameters (list) –
        
        A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
        
        (dict) –
        
        A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
        
        Name (string) –
        
        The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
        
        Values (list) –
        
        The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
        
        (string) –
  - 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.