Skip to content

list_capacity_providers

list_capacity_providers(
    *,
    config_overrides: Optional[LambdaClientConfig] = None,
    state: Optional[CapacityProviderState] = None,
    marker: Optional[String] = None,
    max_items: Optional[MaxFiftyListItems] = None,
) -> ListCapacityProvidersResponse

Returns a list of capacity providers in your account.

Parameters:

  • state (Optional[CapacityProviderState], default: None ) –

    Filter capacity providers by their current state.

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

    Specify the pagination token that's returned by a previous request to retrieve the next page of results.

  • max_items (Optional[MaxFiftyListItems], default: None ) –

    The maximum number of capacity providers to return.

Raises:

Source code in docs_src/capo_lambda/_services/_lambda.py
def list_capacity_providers(
    self,
    *,
    config_overrides: Optional[LambdaClientConfig] = None,
    state: Optional[
        "capo_lambda.types.capacity_provider_state.CapacityProviderState"
    ] = None,
    marker: Optional["capo_lambda.types.string.String"] = None,
    max_items: Optional[
        "capo_lambda.types.max_fifty_list_items.MaxFiftyListItems"
    ] = None,
) -> "capo_lambda.types.list_capacity_providers_response.ListCapacityProvidersResponse":
    """<p>Returns a list of capacity providers in your account.</p>

    Args:
        state: <p>Filter capacity providers by their current state.</p>
        marker: <p>Specify the pagination token that's returned by a previous request to retrieve the next page of results.</p>
        max_items: <p>The maximum number of capacity providers to return.</p>

    Raises:
        capo_lambda.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One of the parameters in the request is not valid.</p>
        capo_lambda.errors.service_exception.ServiceException: <p>The Lambda service encountered an internal error.</p>
        capo_lambda.errors.too_many_requests_exception.TooManyRequestsException: <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p>
        capo_lambda.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lambda.types.list_capacity_providers_request.ListCapacityProvidersRequest]",
    ) -> OperationResponse[
        "capo_lambda.types.list_capacity_providers_response.ListCapacityProvidersResponse"
    ]:
        import capo_lambda._operations.aws_gir_api_service.list_capacity_providers

        output, http_response = (
            capo_lambda._operations.aws_gir_api_service.list_capacity_providers.list_capacity_providers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCapacityProviders")
    )
    input_: capo_lambda.types.list_capacity_providers_request.ListCapacityProvidersRequest = {}
    if state is not None:
        input_["state"] = state
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output