invoicing/aws.sdk.kotlin.services.invoicing/InvoicingClient

InvoicingClient

Amazon Web Services Invoice Configuration

You can use Amazon Web Services Invoice Configuration APIs to programmatically create, update, delete, get, and list invoice units. You can also programmatically fetch the information of the invoice receiver. For example, business legal name, address, and invoicing contacts.

You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.

Service endpoint

You can use the following endpoints for Amazon Web Services Invoice Configuration:

http://invoicing.us-east-1.api.aws

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: InvoicingClient.Config

InvoicingClient's configuration

Functions

batchGetInvoiceProfile

abstract suspend fun batchGetInvoiceProfile(input: BatchGetInvoiceProfileRequest): BatchGetInvoiceProfileResponse

This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.

createInvoiceUnit

abstract suspend fun createInvoiceUnit(input: CreateInvoiceUnitRequest): CreateInvoiceUnitResponse

This creates a new invoice unit with the provided definition.

deleteInvoiceUnit

abstract suspend fun deleteInvoiceUnit(input: DeleteInvoiceUnitRequest): DeleteInvoiceUnitResponse

This deletes an invoice unit with the provided invoice unit ARN.

getInvoiceUnit

abstract suspend fun getInvoiceUnit(input: GetInvoiceUnitRequest): GetInvoiceUnitResponse

This retrieves the invoice unit definition.

listInvoiceSummaries

abstract suspend fun listInvoiceSummaries(input: ListInvoiceSummariesRequest): ListInvoiceSummariesResponse

Retrieves your invoice details programmatically, without line item details.

listInvoiceUnits

abstract suspend fun listInvoiceUnits(input: ListInvoiceUnitsRequest = ListInvoiceUnitsRequest { }): ListInvoiceUnitsResponse

This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for a resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds a tag to a resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag from a resource.

updateInvoiceUnit

abstract suspend fun updateInvoiceUnit(input: UpdateInvoiceUnitRequest): UpdateInvoiceUnitResponse

You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.

Inherited functions

batchGetInvoiceProfile

inline suspend fun InvoicingClient.batchGetInvoiceProfile(crossinline block: BatchGetInvoiceProfileRequest.Builder.() -> Unit): BatchGetInvoiceProfileResponse

This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.

expect abstract fun close()

createInvoiceUnit

inline suspend fun InvoicingClient.createInvoiceUnit(crossinline block: CreateInvoiceUnitRequest.Builder.() -> Unit): CreateInvoiceUnitResponse

This creates a new invoice unit with the provided definition.

deleteInvoiceUnit

inline suspend fun InvoicingClient.deleteInvoiceUnit(crossinline block: DeleteInvoiceUnitRequest.Builder.() -> Unit): DeleteInvoiceUnitResponse

This deletes an invoice unit with the provided invoice unit ARN.

getInvoiceUnit

inline suspend fun InvoicingClient.getInvoiceUnit(crossinline block: GetInvoiceUnitRequest.Builder.() -> Unit): GetInvoiceUnitResponse

This retrieves the invoice unit definition.

listInvoiceSummaries

inline suspend fun InvoicingClient.listInvoiceSummaries(crossinline block: ListInvoiceSummariesRequest.Builder.() -> Unit): ListInvoiceSummariesResponse

Retrieves your invoice details programmatically, without line item details.

listInvoiceSummariesPaginated

fun InvoicingClient.listInvoiceSummariesPaginated(initialRequest: ListInvoiceSummariesRequest): Flow<ListInvoiceSummariesResponse>

fun InvoicingClient.listInvoiceSummariesPaginated(block: ListInvoiceSummariesRequest.Builder.() -> Unit): Flow<ListInvoiceSummariesResponse>

Paginate over ListInvoiceSummariesResponse results.

listInvoiceUnits

inline suspend fun InvoicingClient.listInvoiceUnits(crossinline block: ListInvoiceUnitsRequest.Builder.() -> Unit): ListInvoiceUnitsResponse

This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.

listInvoiceUnitsPaginated

fun InvoicingClient.listInvoiceUnitsPaginated(initialRequest: ListInvoiceUnitsRequest = ListInvoiceUnitsRequest { }): Flow<ListInvoiceUnitsResponse>

fun InvoicingClient.listInvoiceUnitsPaginated(block: ListInvoiceUnitsRequest.Builder.() -> Unit): Flow<ListInvoiceUnitsResponse>

Paginate over ListInvoiceUnitsResponse results.

listTagsForResource

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

Lists the tags for a resource.

tagResource

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

Adds a tag to a resource.

untagResource

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

Removes a tag from a resource.

updateInvoiceUnit

inline suspend fun InvoicingClient.updateInvoiceUnit(crossinline block: UpdateInvoiceUnitRequest.Builder.() -> Unit): UpdateInvoiceUnitResponse

You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.

withConfig

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

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.