describe_pending_aggregation_requests `async` ¶

describe_pending_aggregation_requests(
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    limit: Optional[DescribePendingAggregationRequestsLimit] = None,
    next_token: Optional[String] = None,
) -> DescribePendingAggregationRequestsResponse

Returns a list of all pending aggregation requests.

Parameters:

limit (Optional[DescribePendingAggregationRequestsLimit], default: None ) –

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.
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.

Raises:

InvalidLimitException –

The specified limit is outside the allowable range.
InvalidNextTokenException –

The specified next token is not valid. Specify the nextToken string that was returned in the previous response to get the next page of results.
InvalidParameterValueException –

One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_config_service/_services/async_config_service.py

async def describe_pending_aggregation_requests(
    self,
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    limit: Optional[
        "capo_config_service.types.describe_pending_aggregation_requests_limit.DescribePendingAggregationRequestsLimit"
    ] = None,
    next_token: Optional["capo_config_service.types.string.String"] = None,
) -> "capo_config_service.types.describe_pending_aggregation_requests_response.DescribePendingAggregationRequestsResponse":
    """<p>Returns a list of all pending aggregation requests.</p>

    Args:
        limit: <p>The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.</p>
        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>

    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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_config_service.types.describe_pending_aggregation_requests_request.DescribePendingAggregationRequestsRequest]",
    ) -> AsyncOperationResponse[
        "capo_config_service.types.describe_pending_aggregation_requests_response.DescribePendingAggregationRequestsResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.describe_pending_aggregation_requests

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePendingAggregationRequests")
    )
    input_: capo_config_service.types.describe_pending_aggregation_requests_request.DescribePendingAggregationRequestsRequest = {}
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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

describe_pending_aggregation_requests async ¶

describe_pending_aggregation_requests `async` ¶