billing/aws.sdk.kotlin.services.billing

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateSourceViews

inline suspend fun BillingClient.associateSourceViews(crossinline block: AssociateSourceViewsRequest.Builder.() -> Unit): AssociateSourceViewsResponse

Associates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.

createBillingView

inline suspend fun BillingClient.createBillingView(crossinline block: CreateBillingViewRequest.Builder.() -> Unit): CreateBillingViewResponse

Creates a billing view with the specified billing view attributes.

deleteBillingView

inline suspend fun BillingClient.deleteBillingView(crossinline block: DeleteBillingViewRequest.Builder.() -> Unit): DeleteBillingViewResponse

Deletes the specified billing view.

disassociateSourceViews

inline suspend fun BillingClient.disassociateSourceViews(crossinline block: DisassociateSourceViewsRequest.Builder.() -> Unit): DisassociateSourceViewsResponse

Removes the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.

getBillingPreferences

inline suspend fun BillingClient.getBillingPreferences(crossinline block: GetBillingPreferencesRequest.Builder.() -> Unit): GetBillingPreferencesResponse

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.

getBillingView

inline suspend fun BillingClient.getBillingView(crossinline block: GetBillingViewRequest.Builder.() -> Unit): GetBillingViewResponse

Returns the metadata associated to the specified billing view ARN.

getCreditAllocationHistory

inline suspend fun BillingClient.getCreditAllocationHistory(crossinline block: GetCreditAllocationHistoryRequest.Builder.() -> Unit): GetCreditAllocationHistoryResponse

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.

getCredits

inline suspend fun BillingClient.getCredits(crossinline block: GetCreditsRequest.Builder.() -> Unit): GetCreditsResponse

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.

getResourcePolicy

inline suspend fun BillingClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

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

listBillingViews

inline suspend fun BillingClient.listBillingViews(crossinline block: ListBillingViewsRequest.Builder.() -> Unit): ListBillingViewsResponse

Lists the billing views available for a given time period.

listSourceViewsForBillingView

inline suspend fun BillingClient.listSourceViewsForBillingView(crossinline block: ListSourceViewsForBillingViewRequest.Builder.() -> Unit): ListSourceViewsForBillingViewResponse

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

listTagsForResource

inline suspend fun BillingClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists tags associated with the billing view resource.

redeemCredits

inline suspend fun BillingClient.redeemCredits(crossinline block: RedeemCreditsRequest.Builder.() -> Unit): RedeemCreditsResponse

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.

tagResource

inline suspend fun BillingClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun BillingClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateBillingPreferences

inline suspend fun BillingClient.updateBillingPreferences(crossinline block: UpdateBillingPreferencesRequest.Builder.() -> Unit): UpdateBillingPreferencesResponse

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.

updateBillingView

inline suspend fun BillingClient.updateBillingView(crossinline block: UpdateBillingViewRequest.Builder.() -> Unit): UpdateBillingViewResponse

An API to update the attributes of the billing view.

withConfig

fun BillingClient.withConfig(block: BillingClient.Config.Builder.() -> Unit): BillingClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.