bcmdataexports/aws.sdk.kotlin.services.bcmdataexports/BcmDataExportsClient

BcmDataExportsClient

interface BcmDataExportsClient : SdkClient

You can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost optimization recommendations.

The Data Exports API provides the following endpoint:

http://bcm-data-exports.us-east-1.api.aws

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: BcmDataExportsClient.Config

BcmDataExportsClient's configuration

Functions

createExport

abstract suspend fun createExport(input: CreateExportRequest): CreateExportResponse

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

deleteExport

abstract suspend fun deleteExport(input: DeleteExportRequest): DeleteExportResponse

Deletes an existing data export.

getExecution

abstract suspend fun getExecution(input: GetExecutionRequest): GetExecutionResponse

Exports data based on the source data update.

getExport

abstract suspend fun getExport(input: GetExportRequest): GetExportResponse

Views the definition of an existing data export.

getTable

abstract suspend fun getTable(input: GetTableRequest): GetTableResponse

Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.

listExecutions

abstract suspend fun listExecutions(input: ListExecutionsRequest): ListExecutionsResponse

Lists the historical executions for the export.

listExports

abstract suspend fun listExports(input: ListExportsRequest = ListExportsRequest { }): ListExportsResponse

Lists all data export definitions.

listTables

abstract suspend fun listTables(input: ListTablesRequest = ListTablesRequest { }): ListTablesResponse

Lists all available tables in data exports.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

List tags associated with an existing data export.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags for an existing data export definition.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Deletes tags associated with an existing data export definition.

updateExport

abstract suspend fun updateExport(input: UpdateExportRequest): UpdateExportResponse

Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.

Inherited functions

expect abstract fun close()

createExport

inline suspend fun BcmDataExportsClient.createExport(crossinline block: CreateExportRequest.Builder.() -> Unit): CreateExportResponse

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

deleteExport

inline suspend fun BcmDataExportsClient.deleteExport(crossinline block: DeleteExportRequest.Builder.() -> Unit): DeleteExportResponse

Deletes an existing data export.

getExecution

inline suspend fun BcmDataExportsClient.getExecution(crossinline block: GetExecutionRequest.Builder.() -> Unit): GetExecutionResponse

Exports data based on the source data update.

getExport

inline suspend fun BcmDataExportsClient.getExport(crossinline block: GetExportRequest.Builder.() -> Unit): GetExportResponse

Views the definition of an existing data export.

getTable

inline suspend fun BcmDataExportsClient.getTable(crossinline block: GetTableRequest.Builder.() -> Unit): GetTableResponse

Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.

listExecutions

inline suspend fun BcmDataExportsClient.listExecutions(crossinline block: ListExecutionsRequest.Builder.() -> Unit): ListExecutionsResponse

Lists the historical executions for the export.

listExecutionsPaginated

fun BcmDataExportsClient.listExecutionsPaginated(initialRequest: ListExecutionsRequest): Flow<ListExecutionsResponse>

fun BcmDataExportsClient.listExecutionsPaginated(block: ListExecutionsRequest.Builder.() -> Unit): Flow<ListExecutionsResponse>

Paginate over ListExecutionsResponse results.

listExports

inline suspend fun BcmDataExportsClient.listExports(crossinline block: ListExportsRequest.Builder.() -> Unit): ListExportsResponse

Lists all data export definitions.

listExportsPaginated

fun BcmDataExportsClient.listExportsPaginated(initialRequest: ListExportsRequest = ListExportsRequest { }): Flow<ListExportsResponse>

fun BcmDataExportsClient.listExportsPaginated(block: ListExportsRequest.Builder.() -> Unit): Flow<ListExportsResponse>

Paginate over ListExportsResponse results.

listTables

inline suspend fun BcmDataExportsClient.listTables(crossinline block: ListTablesRequest.Builder.() -> Unit): ListTablesResponse

Lists all available tables in data exports.

listTablesPaginated

fun BcmDataExportsClient.listTablesPaginated(initialRequest: ListTablesRequest = ListTablesRequest { }): Flow<ListTablesResponse>

fun BcmDataExportsClient.listTablesPaginated(block: ListTablesRequest.Builder.() -> Unit): Flow<ListTablesResponse>

Paginate over ListTablesResponse results.

listTagsForResource

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

List tags associated with an existing data export.

tagResource

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

Adds tags for an existing data export definition.

untagResource

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

Deletes tags associated with an existing data export definition.

updateExport

inline suspend fun BcmDataExportsClient.updateExport(crossinline block: UpdateExportRequest.Builder.() -> Unit): UpdateExportResponse

Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.

withConfig

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

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.