bcmdashboards/aws.sdk.kotlin.services.bcmdashboards

Package-level declarations

Types

interface BcmDashboardsClient : SdkClient

Amazon Web Services Billing and Cost Management Dashboards is a service that enables you to create, manage, and share dashboards that combine multiple visualizations of your Amazon Web Services cost and usage data. You can combine multiple data sources including Cost Explorer, Savings Plans, and Reserved Instance metrics into unified dashboards, helping you analyze spending patterns and share cost insights across your organization.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createDashboard

inline suspend fun BcmDashboardsClient.createDashboard(crossinline block: CreateDashboardRequest.Builder.() -> Unit): CreateDashboardResponse

Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.

deleteDashboard

inline suspend fun BcmDashboardsClient.deleteDashboard(crossinline block: DeleteDashboardRequest.Builder.() -> Unit): DeleteDashboardResponse

Deletes a specified dashboard. This action cannot be undone.

getDashboard

inline suspend fun BcmDashboardsClient.getDashboard(crossinline block: GetDashboardRequest.Builder.() -> Unit): GetDashboardResponse

Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.

getResourcePolicy

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

Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.

listDashboards

inline suspend fun BcmDashboardsClient.listDashboards(crossinline block: ListDashboardsRequest.Builder.() -> Unit): ListDashboardsResponse

Returns a list of all dashboards in your account.

listTagsForResource

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

Returns a list of all tags associated with a specified dashboard resource.

tagResource

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

Adds or updates tags for a specified dashboard resource.

untagResource

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

Removes specified tags from a dashboard resource.

updateDashboard

inline suspend fun BcmDashboardsClient.updateDashboard(crossinline block: UpdateDashboardRequest.Builder.() -> Unit): UpdateDashboardResponse

Updates an existing dashboard's properties, including its name, description, and widget configurations.

withConfig

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

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.