Skip to content

list_billing_groups async

list_billing_groups(
    *,
    config_overrides: Optional[AsyncbillingconductorClientConfig] = None,
    billing_period: Optional[BillingPeriod] = None,
    max_results: Optional[MaxBillingGroupResults] = None,
    next_token: Optional[Token] = None,
    filters: Optional[ListBillingGroupsFilter] = None,
) -> ListBillingGroupsOutput

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

Parameters:

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

    The preferred billing period to get billing groups.

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

    The maximum number of billing groups to retrieve.

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

    The pagination token that's used on subsequent calls to get billing groups.

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

    A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.

Raises:

Source code in docs_src/capo_billingconductor/_services/async_billingconductor.py
async def list_billing_groups(
    self,
    *,
    config_overrides: Optional[AsyncbillingconductorClientConfig] = None,
    billing_period: Optional[
        "capo_billingconductor.types.billing_period.BillingPeriod"
    ] = None,
    max_results: Optional[
        "capo_billingconductor.types.max_billing_group_results.MaxBillingGroupResults"
    ] = None,
    next_token: Optional["capo_billingconductor.types.token.Token"] = None,
    filters: Optional[
        "capo_billingconductor.types.list_billing_groups_filter.ListBillingGroupsFilter"
    ] = None,
) -> (
    "capo_billingconductor.types.list_billing_groups_output.ListBillingGroupsOutput"
):
    """<p>A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.</p>

    Args:
        billing_period: <p>The preferred billing period to get billing groups. </p>
        max_results: <p>The maximum number of billing groups to retrieve. </p>
        next_token: <p>The pagination token that's used on subsequent calls to get billing groups. </p>
        filters: <p>A <code>ListBillingGroupsFilter</code> that specifies the billing group and pricing plan to retrieve billing group information. </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.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that doesn't exist. </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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_billingconductor.types.list_billing_groups_input.ListBillingGroupsInput]",
    ) -> AsyncOperationResponse[
        "capo_billingconductor.types.list_billing_groups_output.ListBillingGroupsOutput"
    ]:
        import capo_billingconductor._operations.aws_billing_conductor.list_billing_groups

        (
            output,
            http_response,
        ) = await capo_billingconductor._operations.aws_billing_conductor.list_billing_groups.async_list_billing_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

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

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

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