ConfigService / Paginator / DescribeConfigurationAggregatorSourcesStatus

DescribeConfigurationAggregatorSourcesStatus

class ConfigService.Paginator.DescribeConfigurationAggregatorSourcesStatus

paginator = client.get_paginator('describe_configuration_aggregator_sources_status')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConfigurationAggregatorName='string',
    UpdateStatus=[
        'FAILED'|'SUCCEEDED'|'OUTDATED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ConfigurationAggregatorName (string) –

  [REQUIRED]

  The name of the configuration aggregator.

• UpdateStatus (list) –

  Filters the status type.

  • Valid value FAILED indicates errors while moving data.

  • Valid value SUCCEEDED indicates the data was successfully moved.

  • Valid value OUTDATED indicates the data is not the most recent.

  • (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

{
    'AggregatedSourceStatusList': [
        {
            'SourceId': 'string',
            'SourceType': 'ACCOUNT'|'ORGANIZATION',
            'AwsRegion': 'string',
            'LastUpdateStatus': 'FAILED'|'SUCCEEDED'|'OUTDATED',
            'LastUpdateTime': datetime(2015, 1, 1),
            'LastErrorCode': 'string',
            'LastErrorMessage': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • AggregatedSourceStatusList (list) –

    Returns an AggregatedSourceStatus object.

    • (dict) –

      The current sync status between the source and the aggregator account.

      • SourceId (string) –

        The source account ID or an organization.

      • SourceType (string) –

        The source account or an organization.

      • AwsRegion (string) –

        The region authorized to collect aggregated data.

      • LastUpdateStatus (string) –

        Filters the last updated status type.

        • Valid value FAILED indicates errors while moving data.

        • Valid value SUCCEEDED indicates the data was successfully moved.

        • Valid value OUTDATED indicates the data is not the most recent.

      • LastUpdateTime (datetime) –

        The time of the last update.

      • LastErrorCode (string) –

        The error code that Config returned when the source account aggregation last failed.

      • LastErrorMessage (string) –

        The message indicating that the source account aggregation failed due to an error.