Skip to content

list_bill_estimate_commitments

list_bill_estimate_commitments(
    bill_estimate_id: ResourceId,
    *,
    config_overrides: Optional[BCMPricingCalculatorClientConfig] = None,
    next_token: Optional[NextPageToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListBillEstimateCommitmentsResponse

Lists the commitments associated with a bill estimate.

Parameters:

  • bill_estimate_id (ResourceId) –

    The unique identifier of the bill estimate to list commitments for.

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

    A token to retrieve the next page of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return per page.

Raises:

Source code in docs_src/capo_bcm_pricing_calculator/_services/bcm_pricing_calculator.py
def list_bill_estimate_commitments(
    self,
    bill_estimate_id: "capo_bcm_pricing_calculator.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[BCMPricingCalculatorClientConfig] = None,
    next_token: Optional[
        "capo_bcm_pricing_calculator.types.next_page_token.NextPageToken"
    ] = None,
    max_results: Optional[
        "capo_bcm_pricing_calculator.types.max_results.MaxResults"
    ] = None,
) -> "capo_bcm_pricing_calculator.types.list_bill_estimate_commitments_response.ListBillEstimateCommitmentsResponse":
    """<p> Lists the commitments associated with a bill estimate. </p>

    Args:
        bill_estimate_id: <p> The unique identifier of the bill estimate to list commitments for. </p>
        next_token: <p> A token to retrieve the next page of results. </p>
        max_results: <p> The maximum number of results to return per page. </p>

    Raises:
        capo_bcm_pricing_calculator.errors.access_denied_exception.AccessDeniedException: <p> You do not have sufficient access to perform this action. </p>
        capo_bcm_pricing_calculator.errors.internal_server_exception.InternalServerException: <p> An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support. </p>
        capo_bcm_pricing_calculator.errors.throttling_exception.ThrottlingException: <p> The request was denied due to request throttling. </p>
        capo_bcm_pricing_calculator.errors.validation_exception.ValidationException: <p> The input provided fails to satisfy the constraints specified by an Amazon Web Services service. </p>
        capo_bcm_pricing_calculator.errors.data_unavailable_exception.DataUnavailableException: <p> The requested data is currently unavailable. </p>
        capo_bcm_pricing_calculator.errors.resource_not_found_exception.ResourceNotFoundException: <p> The specified resource was not found. </p>
        capo_bcm_pricing_calculator.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bcm_pricing_calculator.types.list_bill_estimate_commitments_request.ListBillEstimateCommitmentsRequest]",
    ) -> OperationResponse[
        "capo_bcm_pricing_calculator.types.list_bill_estimate_commitments_response.ListBillEstimateCommitmentsResponse"
    ]:
        import capo_bcm_pricing_calculator._operations.awsbcm_pricing_calculator.list_bill_estimate_commitments

        output, http_response = (
            capo_bcm_pricing_calculator._operations.awsbcm_pricing_calculator.list_bill_estimate_commitments.list_bill_estimate_commitments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBillEstimateCommitments")
    )
    input_: capo_bcm_pricing_calculator.types.list_bill_estimate_commitments_request.ListBillEstimateCommitmentsRequest = {
        "bill_estimate_id": bill_estimate_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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