ConfigService / Paginator / ListConfigurationRecorders

ListConfigurationRecorders

class ConfigService.Paginator.ListConfigurationRecorders

paginator = client.get_paginator('list_configuration_recorders')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConfigService.Client.list_configuration_recorders().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'filterName': 'recordingScope',
            'filterValue': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  Filters the results based on a list of ConfigurationRecorderFilter objects that you specify.

  • (dict) –

    Filters configuration recorders by recording scope.

    • filterName (string) –

      The name of the type of filter. Currently, only recordingScope is supported.

    • filterValue (list) –

      The value of the filter. For recordingScope, valid values include: INTERNAL and PAID.

      INTERNAL indicates that the ConfigurationItems in scope for the configuration recorder are recorded for free.

      PAID indicates that the ConfigurationItems in scope for the configuration recorder impact the costs to your bill.

      • (string) –

• 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

{
    'ConfigurationRecorderSummaries': [
        {
            'arn': 'string',
            'name': 'string',
            'servicePrincipal': 'string',
            'recordingScope': 'INTERNAL'|'PAID'
        },
    ],

}

Response Structure

• (dict) –

  • ConfigurationRecorderSummaries (list) –

    A list of ConfigurationRecorderSummary objects that includes.

    • (dict) –

      A summary of a configuration recorder, including the arn, name, servicePrincipal, and recordingScope.

      • arn (string) –

        The Amazon Resource Name (ARN) of the configuration recorder.

      • name (string) –

        The name of the configuration recorder.

      • servicePrincipal (string) –

        For service-linked configuration recorders, indicates which Amazon Web Services service the configuration recorder is linked to.

      • recordingScope (string) –

        Indicates whether the ConfigurationItems in scope for the configuration recorder are recorded for free ( INTERNAL) or if you are charged a service fee for recording ( PAID).