Skip to content

list_pricing_rules

list_pricing_rules(
    *,
    config_overrides: Optional[billingconductorClientConfig] = None,
    billing_period: Optional[BillingPeriod] = None,
    filters: Optional[ListPricingRulesFilter] = None,
    max_results: Optional[MaxPricingRuleResults] = None,
    next_token: Optional[Token] = None,
) -> ListPricingRulesOutput

Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.

Parameters:

  • billing_period (Optional[BillingPeriod], default: None ) –

    The preferred billing period to get the pricing plan.

  • filters (Optional[ListPricingRulesFilter], default: None ) –

    A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information.

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

    The maximum number of pricing rules to retrieve.

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

    The pagination token that's used on subsequent call to get pricing rules.

Raises:

Source code in docs_src/capo_billingconductor/_services/billingconductor.py
def list_pricing_rules(
    self,
    *,
    config_overrides: Optional[billingconductorClientConfig] = None,
    billing_period: Optional[
        "capo_billingconductor.types.billing_period.BillingPeriod"
    ] = None,
    filters: Optional[
        "capo_billingconductor.types.list_pricing_rules_filter.ListPricingRulesFilter"
    ] = None,
    max_results: Optional[
        "capo_billingconductor.types.max_pricing_rule_results.MaxPricingRuleResults"
    ] = None,
    next_token: Optional["capo_billingconductor.types.token.Token"] = None,
) -> "capo_billingconductor.types.list_pricing_rules_output.ListPricingRulesOutput":
    """<p> Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans. </p>

    Args:
        billing_period: <p> The preferred billing period to get the pricing plan. </p>
        filters: <p> A <code>DescribePricingRuleFilter</code> that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information. </p>
        max_results: <p> The maximum number of pricing rules to retrieve. </p>
        next_token: <p> The pagination token that's used on subsequent call to get pricing rules. </p>

    Raises:
        capo_billingconductor.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. </p>
        capo_billingconductor.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request. </p>
        capo_billingconductor.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. </p>
        capo_billingconductor.errors.validation_exception.ValidationException: <p>The input doesn't match with the constraints specified by Amazon Web Services services.</p>
        capo_billingconductor.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_billingconductor.types.list_pricing_rules_input.ListPricingRulesInput]",
    ) -> OperationResponse[
        "capo_billingconductor.types.list_pricing_rules_output.ListPricingRulesOutput"
    ]:
        import capo_billingconductor._operations.aws_billing_conductor.list_pricing_rules

        output, http_response = (
            capo_billingconductor._operations.aws_billing_conductor.list_pricing_rules.list_pricing_rules(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_billingconductor.types.list_pricing_rules_output.ListPricingRulesOutput",
    ) -> dict[str, Any]:
        import capo_billingconductor.types.list_pricing_rules_output

        return (
            capo_billingconductor.types.list_pricing_rules_output.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListPricingRules", redact_output=_redact_output),
    )
    input_: capo_billingconductor.types.list_pricing_rules_input.ListPricingRulesInput = {}
    if billing_period is not None:
        input_["billing_period"] = billing_period
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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