ControlTower / Client / get_enabled_baseline

get_enabled_baseline¶

ControlTower.Client.get_enabled_baseline(**kwargs)¶

Retrieve details of an EnabledBaseline resource by specifying its identifier.

Request Syntax

response = client.get_enabled_baseline(
    enabledBaselineIdentifier='string'
)

Parameters:

enabledBaselineIdentifier (string) –

[REQUIRED]

Identifier of the EnabledBaseline resource to be retrieved, in ARN format.

Return type:

dict

Returns:

Response Syntax

{
    'enabledBaselineDetails': {
        'arn': 'string',
        'baselineIdentifier': 'string',
        'baselineVersion': 'string',
        'driftStatusSummary': {
            'types': {
                'inheritance': {
                    'status': 'IN_SYNC'|'DRIFTED'
                }
            }
        },
        'parameters': [
            {
                'key': 'string',
                'value': {...}|[...]|123|123.4|'string'|True|None
            },
        ],
        'parentIdentifier': 'string',
        'statusSummary': {
            'lastOperationIdentifier': 'string',
            'status': 'SUCCEEDED'|'FAILED'|'UNDER_CHANGE'
        },
        'targetIdentifier': 'string'
    }
}

Response Structure

(dict) –
- enabledBaselineDetails (dict) –
  
  Details of the EnabledBaseline resource.
  - arn (string) –
    
    The ARN of the EnabledBaseline resource.
  - baselineIdentifier (string) –
    
    The specific Baseline enabled as part of the EnabledBaseline resource.
  - baselineVersion (string) –
    
    The enabled version of the Baseline.
  - driftStatusSummary (dict) –
    
    The drift status of the enabled baseline.
    - types (dict) –
      
      The types of drift that can be detected for an enabled baseline. Amazon Web Services Control Tower detects inheritance drift on enabled baselines that apply at the OU level.
      - inheritance (dict) –
        
        At least one account within the target OU does not match the baseline configuration defined on that OU. An account is in inheritance drift when it does not match the configuration of a parent OU, possibly a new parent OU, if the account is moved.
        
        status (string) –
        
        The inheritance drift status for enabled baselines.
  - parameters (list) –
    
    Shows the parameters that are applied when enabling this Baseline.
    - (dict) –
      
      Summary of an applied parameter to an EnabledBaseline resource.
      - key (string) –
        
        A string denoting the parameter key.
      - value (document) –
        
        A low-level document object of any type (for example, a Java Object).
  - parentIdentifier (string) –
    
    An ARN that represents the parent EnabledBaseline at the Organizational Unit (OU) level, from which the child EnabledBaseline inherits its configuration. The value is returned by GetEnabledBaseline.
  - statusSummary (dict) –
    
    The deployment summary of an EnabledControl or EnabledBaseline resource.
    - lastOperationIdentifier (string) –
      
      The last operation identifier for the enabled resource.
    - status (string) –
      
      The deployment status of the enabled resource.
      
      Valid values:
      - SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.
      - UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.
      - FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.
  - targetIdentifier (string) –
    
    The target on which to enable the Baseline.

Exceptions

ControlTower.Client.exceptions.ValidationException
ControlTower.Client.exceptions.InternalServerException
ControlTower.Client.exceptions.AccessDeniedException
ControlTower.Client.exceptions.ResourceNotFoundException
ControlTower.Client.exceptions.ThrottlingException