View Source AWS.Billing (aws-elixir v1.0.14)

You can use the Billing API to programatically list the billing views available to you for a given time period.

A billing view represents a set of billing data.

The Billing API provides the following endpoint:

https://billing.us-east-1.api.aws

Link to this section Summary

Functions

Associates one or more source billing views with an existing billing view.

Creates a billing view with the specified billing view attributes.

Deletes the specified billing view.

Removes the association between one or more source billing views and an existing billing view.

Retrieves billing preferences for the specified feature.

Returns the metadata associated to the specified billing view ARN.

Returns the per-billing-month allocation history for credits applied to an Amazon Web Services account's bills.

Returns the list of Amazon Web Services account credits for the specified account.

Returns the resource-based policy document attached to the resource in JSON format.

Lists the billing views available for a given time period.

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.

Lists tags associated with the billing view resource.

Redeems an Amazon Web Services promotional credit code on behalf of the calling account.

An API operation for adding one or more tags (key-value pairs) to a resource.

Removes one or more tags from a resource.

Updates billing preferences for the specified feature.

An API to update the attributes of the billing view.

Link to this section Functions

Link to this function

associate_source_views(client, input, options \\ [])

View Source

Associates one or more source billing views with an existing billing view.

This allows creating aggregate billing views that combine data from multiple sources.

Link to this function

create_billing_view(client, input, options \\ [])

View Source

Creates a billing view with the specified billing view attributes.

Link to this function

delete_billing_view(client, input, options \\ [])

View Source

Deletes the specified billing view.

Link to this function

disassociate_source_views(client, input, options \\ [])

View Source

Removes the association between one or more source billing views and an existing billing view.

This allows modifying the composition of aggregate billing views.

Link to this function

get_billing_preferences(client, input, options \\ [])

View Source

Retrieves billing preferences for the specified feature.

Each feature controls a distinct billing capability: which accounts can share Reserved Instances or credits, whether billing alerts are enabled, the historical record of sharing changes, and per-credit options.

Link to this function

get_billing_view(client, input, options \\ [])

View Source

Returns the metadata associated to the specified billing view ARN.

Link to this function

get_credit_allocation_history(client, input, options \\ [])

View Source

Returns the per-billing-month allocation history for credits applied to an Amazon Web Services account's bills.

Traverses the consolidated billing family to capture cross-account credit applications. Supports pagination and optional filtering to a single credit.

Link to this function

get_credits(client, input, options \\ [])

View Source

Returns the list of Amazon Web Services account credits for the specified account.

Each credit includes its identifier, type, monetary amounts, applicable products, expiration, sharing configuration, and current enabled status.

When the caller is the management account of a consolidated billing family and payerAccountFlag is true, the response aggregates credits across the entire family. Otherwise, the response includes only credits owned by the account specified in accountId.

Link to this function

get_resource_policy(client, input, options \\ [])

View Source

Returns the resource-based policy document attached to the resource in JSON format.

Link to this function

list_billing_views(client, input, options \\ [])

View Source

Lists the billing views available for a given time period.

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

Link to this function

list_source_views_for_billing_view(client, input, options \\ [])

View Source

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists tags associated with the billing view resource.

Link to this function

redeem_credits(client, input, options \\ [])

View Source

Redeems an Amazon Web Services promotional credit code on behalf of the calling account.

On success, a new credit is added to the account's credit ledger with the amount, validity period, and applicable products defined by the promotion. The credit is then automatically applied to subsequent bills according to the standard credit application order.

Link to this function

tag_resource(client, input, options \\ [])

View Source

An API operation for adding one or more tags (key-value pairs) to a resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes one or more tags from a resource.

Specify only tag keys in your request. Don't specify the value.

Link to this function

update_billing_preferences(client, input, options \\ [])

View Source

Updates billing preferences for the specified feature.

Each feature targets a distinct billing capability and has its own set of supported keys. The action sets the value for each provided key; keys not present in the request are unchanged.

Sharing keys (RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, and sharing keys under CREDIT_PREFERENCE_OPTIONS) may only be set by the management account of a consolidated billing family. The credit/{creditId}/status key may be set by member accounts for credits they own, or by the management account for any credit in the family.

Link to this function

update_billing_view(client, input, options \\ [])

View Source

An API to update the attributes of the billing view.