Skip to content

list_bill_scenarios

list_bill_scenarios(
    *,
    config_overrides: Optional[BCMPricingCalculatorClientConfig] = None,
    filters: Optional[ListBillScenariosFilters] = None,
    created_at_filter: Optional[FilterTimestamp] = None,
    expires_at_filter: Optional[FilterTimestamp] = None,
    next_token: Optional[NextPageToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListBillScenariosResponse

Lists all bill scenarios for the account.

Parameters:

Raises:

Source code in docs_src/capo_bcm_pricing_calculator/_services/bcm_pricing_calculator.py
def list_bill_scenarios(
    self,
    *,
    config_overrides: Optional[BCMPricingCalculatorClientConfig] = None,
    filters: Optional[
        "capo_bcm_pricing_calculator.types.list_bill_scenarios_filters.ListBillScenariosFilters"
    ] = None,
    created_at_filter: Optional[
        "capo_bcm_pricing_calculator.types.filter_timestamp.FilterTimestamp"
    ] = None,
    expires_at_filter: Optional[
        "capo_bcm_pricing_calculator.types.filter_timestamp.FilterTimestamp"
    ] = 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_scenarios_response.ListBillScenariosResponse":
    """<p> Lists all bill scenarios for the account. </p>

    Args:
        filters: <p> Filters to apply to the list of bill scenarios. </p>
        created_at_filter: <p> Filter bill scenarios based on the creation date. </p>
        expires_at_filter: <p> Filter bill scenarios based on the expiration date. </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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bcm_pricing_calculator.types.list_bill_scenarios_request.ListBillScenariosRequest]",
    ) -> OperationResponse[
        "capo_bcm_pricing_calculator.types.list_bill_scenarios_response.ListBillScenariosResponse"
    ]:
        import capo_bcm_pricing_calculator._operations.awsbcm_pricing_calculator.list_bill_scenarios

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBillScenarios")
    )
    input_: capo_bcm_pricing_calculator.types.list_bill_scenarios_request.ListBillScenariosRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if created_at_filter is not None:
        input_["created_at_filter"] = created_at_filter
    if expires_at_filter is not None:
        input_["expires_at_filter"] = expires_at_filter
    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