Skip to content

describe_configuration_aggregator_sources_status async

describe_configuration_aggregator_sources_status(
    configuration_aggregator_name: ConfigurationAggregatorName,
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    update_status: Optional[AggregatedSourceStatusTypeList] = None,
    next_token: Optional[String] = None,
    limit: Optional[Limit] = None,
) -> DescribeConfigurationAggregatorSourcesStatusResponse

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.

Parameters:

  • configuration_aggregator_name (ConfigurationAggregatorName) –

    The name of the configuration aggregator.

  • update_status (Optional[AggregatedSourceStatusTypeList], default: None ) –

    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.

  • next_token (Optional[String], default: None ) –

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

  • limit (Optional[Limit], default: None ) –

    The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.

Raises:

Source code in docs_src/capo_config_service/_services/async_config_service.py
async def describe_configuration_aggregator_sources_status(
    self,
    configuration_aggregator_name: "capo_config_service.types.configuration_aggregator_name.ConfigurationAggregatorName",
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    update_status: Optional[
        "capo_config_service.types.aggregated_source_status_type_list.AggregatedSourceStatusTypeList"
    ] = None,
    next_token: Optional["capo_config_service.types.string.String"] = None,
    limit: Optional["capo_config_service.types.limit.Limit"] = None,
) -> "capo_config_service.types.describe_configuration_aggregator_sources_status_response.DescribeConfigurationAggregatorSourcesStatusResponse":
    """<p>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. </p>

    Args:
        configuration_aggregator_name: <p>The name of the configuration aggregator.</p>
        update_status: <p>Filters the status type.</p> <ul> <li> <p>Valid value FAILED indicates errors while moving data.</p> </li> <li> <p>Valid value SUCCEEDED indicates the data was successfully moved.</p> </li> <li> <p>Valid value OUTDATED indicates the data is not the most recent.</p> </li> </ul>
        next_token: <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
        limit: <p>The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.</p>

    Raises:
        capo_config_service.errors.invalid_limit_exception.InvalidLimitException: <p>The specified limit is outside the allowable range.</p>
        capo_config_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The specified next token is not valid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results.</p>
        capo_config_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.</p>
        capo_config_service.errors.no_such_configuration_aggregator_exception.NoSuchConfigurationAggregatorException: <p>You have specified a configuration aggregator that does not exist.</p>
        capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_config_service.types.describe_configuration_aggregator_sources_status_request.DescribeConfigurationAggregatorSourcesStatusRequest]",
    ) -> AsyncOperationResponse[
        "capo_config_service.types.describe_configuration_aggregator_sources_status_response.DescribeConfigurationAggregatorSourcesStatusResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.describe_configuration_aggregator_sources_status

        (
            output,
            http_response,
        ) = await capo_config_service._operations.starling_dove_service.describe_configuration_aggregator_sources_status.async_describe_configuration_aggregator_sources_status(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeConfigurationAggregatorSourcesStatus"),
    )
    input_: capo_config_service.types.describe_configuration_aggregator_sources_status_request.DescribeConfigurationAggregatorSourcesStatusRequest = {
        "configuration_aggregator_name": configuration_aggregator_name
    }
    if update_status is not None:
        input_["update_status"] = update_status
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output