describe_configuration_aggregator_sources_status

ConfigService.Client.describe_configuration_aggregator_sources_status(**kwargs)

Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration_aggregator_sources_status(
    ConfigurationAggregatorName='string',
    UpdateStatus=[
        'FAILED'|'SUCCEEDED'|'OUTDATED',
    ],
    NextToken='string',
    Limit=123
)

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) --
• NextToken (string) -- The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
• Limit (integer) -- The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.

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'
        },
    ],
    'NextToken': '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.

  • NextToken (string) --

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Exceptions

• ConfigService.Client.exceptions.InvalidParameterValueException
• ConfigService.Client.exceptions.NoSuchConfigurationAggregatorException
• ConfigService.Client.exceptions.InvalidNextTokenException
• ConfigService.Client.exceptions.InvalidLimitException