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',
        'parameters': [
            {
                'key': 'string',
                'value': {...}|[...]|123|123.4|'string'|True|None
            },
        ],
        '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.
  - 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).
  - statusSummary (dict) –
    
    The deployment summary of the enabled control.
    - lastOperationIdentifier (string) –
      
      The last operation identifier for the enabled control.
    - status (string) –
      
      The deployment status of the enabled control.
      
      Valid values:
      - SUCCEEDED: The enabledControl configuration was deployed successfully.
      - UNDER_CHANGE: The enabledControl configuration is changing.
      - FAILED: The enabledControl 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.ThrottlingException
ControlTower.Client.exceptions.ResourceNotFoundException