billing/aws.sdk.kotlin.services.billing/BillingClient

BillingClient

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

Types

Builder

class Builder : AbstractSdkClientBuilder<BillingClient.Config, BillingClient.Config.Builder, BillingClient>

Companion

object Companion : AbstractAwsSdkClientFactory<BillingClient.Config, BillingClient.Config.Builder, BillingClient, BillingClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: BillingClient.Config

BillingClient's configuration

Functions

createBillingView

abstract suspend fun createBillingView(input: CreateBillingViewRequest): CreateBillingViewResponse

Creates a billing view with the specified billing view attributes.

deleteBillingView

abstract suspend fun deleteBillingView(input: DeleteBillingViewRequest): DeleteBillingViewResponse

Deletes the specified billing view.

getBillingView

abstract suspend fun getBillingView(input: GetBillingViewRequest): GetBillingViewResponse

Returns the metadata associated to the specified billing view ARN.

getResourcePolicy

abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest): GetResourcePolicyResponse

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

listBillingViews

abstract suspend fun listBillingViews(input: ListBillingViewsRequest = ListBillingViewsRequest { }): ListBillingViewsResponse

Lists the billing views available for a given time period.

listSourceViewsForBillingView

abstract suspend fun listSourceViewsForBillingView(input: ListSourceViewsForBillingViewRequest): ListSourceViewsForBillingViewResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists tags associated with the billing view resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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

updateBillingView

abstract suspend fun updateBillingView(input: UpdateBillingViewRequest): UpdateBillingViewResponse

An API to update the attributes of the billing view.

Inherited functions

expect abstract fun close()

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.

getBillingView

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

Returns the metadata associated to the specified billing view ARN.

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.

listBillingViewsPaginated

fun BillingClient.listBillingViewsPaginated(initialRequest: ListBillingViewsRequest = ListBillingViewsRequest { }): Flow<ListBillingViewsResponse>

fun BillingClient.listBillingViewsPaginated(block: ListBillingViewsRequest.Builder.() -> Unit): Flow<ListBillingViewsResponse>

Paginate over ListBillingViewsResponse results.

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.

listSourceViewsForBillingViewPaginated

fun BillingClient.listSourceViewsForBillingViewPaginated(initialRequest: ListSourceViewsForBillingViewRequest): Flow<ListSourceViewsForBillingViewResponse>

fun BillingClient.listSourceViewsForBillingViewPaginated(block: ListSourceViewsForBillingViewRequest.Builder.() -> Unit): Flow<ListSourceViewsForBillingViewResponse>

Paginate over ListSourceViewsForBillingViewResponse results.

listTagsForResource

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

Lists tags associated with the billing view resource.

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.

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.