BillingClient

Suggest an Edit

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

Installation

NPM
npm install @aws-sdk/client-billing
Yarn
yarn add @aws-sdk/client-billing
pnpm
pnpm add @aws-sdk/client-billing

BillingClient Operations

Command
Summary
CreateBillingViewCommand

Creates a billing view with the specified billing view attributes.

DeleteBillingViewCommand

Deletes the specified billing view.

GetBillingViewCommand

Returns the metadata associated to the specified billing view ARN.

GetResourcePolicyCommand

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

ListBillingViewsCommand

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.

ListSourceViewsForBillingViewCommand

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

ListTagsForResourceCommand

Lists tags associated with the billing view resource.

TagResourceCommand

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

UntagResourceCommand

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

UpdateBillingViewCommand

An API to update the attributes of the billing view.

BillingClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: BillingClientConfig