ControlTower / Paginator / ListEnabledBaselines
ListEnabledBaselines#
- class ControlTower.Paginator.ListEnabledBaselines#
paginator = client.get_paginator('list_enabled_baselines')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
ControlTower.Client.list_enabled_baselines()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( filter={ 'baselineIdentifiers': [ 'string', ], 'parentIdentifiers': [ 'string', ], 'targetIdentifiers': [ 'string', ] }, includeChildren=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': '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) –
parentIdentifiers (list) –
An optional filter that sets up a list of
parentIdentifiers
to filter the results of theListEnabledBaseline
output.(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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'enabledBaselines': [ { 'arn': 'string', 'baselineIdentifier': 'string', 'baselineVersion': 'string', '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.
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 token to resume pagination.