ControlTower / Client / list_enabled_baselines
list_enabled_baselines¶
- ControlTower.Client.list_enabled_baselines(**kwargs)¶
Returns a list of summaries describing
EnabledBaseline
resources. You can filter the list by the correspondingBaseline
orTarget
of theEnabledBaseline
resources. For usage examples, see the Amazon Web Services Control Tower User Guide.See also: AWS API Documentation
Request Syntax
response = client.list_enabled_baselines( filter={ 'baselineIdentifiers': [ 'string', ], 'inheritanceDriftStatuses': [ 'IN_SYNC'|'DRIFTED', ], 'parentIdentifiers': [ 'string', ], 'statuses': [ 'SUCCEEDED'|'FAILED'|'UNDER_CHANGE', ], 'targetIdentifiers': [ 'string', ] }, includeChildren=True|False, maxResults=123, nextToken='string' )
- Parameters:
filter (dict) –
A filter applied on the
ListEnabledBaseline
operation. Allowed filters arebaselineIdentifiers
andtargetIdentifiers
. The filter can be applied for either, or both.baselineIdentifiers (list) –
Identifiers for the
Baseline
objects returned as part of the filter operation.(string) –
inheritanceDriftStatuses (list) –
A list of
EnabledBaselineDriftStatus
items for enabled baselines.(string) –
parentIdentifiers (list) –
An optional filter that sets up a list of
parentIdentifiers
to filter the results of theListEnabledBaseline
output.(string) –
statuses (list) –
A list of
EnablementStatus
items.(string) –
targetIdentifiers (list) –
Identifiers for the targets of the
Baseline
filter operation.(string) –
includeChildren (boolean) – A value that can be set to include the child enabled baselines in responses. The default value is false.
maxResults (integer) – The maximum number of results to be shown.
nextToken (string) – A pagination token.
- Return type:
dict
- Returns:
Response Syntax
{ 'enabledBaselines': [ { 'arn': 'string', 'baselineIdentifier': 'string', 'baselineVersion': 'string', 'driftStatusSummary': { 'types': { 'inheritance': { 'status': 'IN_SYNC'|'DRIFTED' } } }, 'parentIdentifier': 'string', 'statusSummary': { 'lastOperationIdentifier': 'string', 'status': 'SUCCEEDED'|'FAILED'|'UNDER_CHANGE' }, 'targetIdentifier': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
enabledBaselines (list) –
Retuens a list of summaries of
EnabledBaseline
resources.(dict) –
Returns a summary of information about an
EnabledBaseline
object.arn (string) –
The ARN of the
EnabledBaseline
resourcebaselineIdentifier (string) –
The specific baseline that is 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.
parentIdentifier (string) –
An ARN that represents an object returned by
ListEnabledBaseline
, to describe an enabled baseline.statusSummary (dict) –
The deployment summary of an
EnabledControl
orEnabledBaseline
resource.lastOperationIdentifier (string) –
The last operation identifier for the enabled resource.
status (string) –
The deployment status of the enabled resource.
Valid values:
SUCCEEDED
: TheEnabledControl
orEnabledBaseline
configuration was deployed successfully.UNDER_CHANGE
: TheEnabledControl
orEnabledBaseline
configuration is changing.FAILED
: TheEnabledControl
orEnabledBaseline
configuration failed to deploy.
targetIdentifier (string) –
The target upon which the baseline is enabled.
nextToken (string) –
A pagination token.
Exceptions