BcmDashboardsClient

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.

You can use the Amazon Web Services Billing and Cost Management Dashboards API to programmatically create, manage, and share dashboards. This includes creating custom dashboards, configuring widgets, managing dashboard permissions, and sharing dashboards across accounts in your organization.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion
Link copied to clipboard
class Config

Properties

Link copied to clipboard

BcmDashboardsClient's configuration

Functions

Link copied to clipboard

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.

Link copied to clipboard

Creates a new scheduled report for a dashboard. A scheduled report automatically generates and delivers dashboard snapshots on a recurring schedule. Reports are delivered within 15 minutes of the scheduled delivery time.

Link copied to clipboard

Deletes a specified dashboard. This action cannot be undone.

Link copied to clipboard

Deletes a specified scheduled report. This is an irreversible operation.

Link copied to clipboard

Triggers an immediate execution of a scheduled report, outside of its regular schedule. The scheduled report must be in ENABLED state. Calling this operation on a DISABLED scheduled report returns a ValidationException.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves the configuration and metadata of a specified scheduled report.

Link copied to clipboard
abstract suspend fun listDashboards(input: ListDashboardsRequest = ListDashboardsRequest { }): ListDashboardsResponse

Returns a list of all dashboards in your account.

Link copied to clipboard
abstract suspend fun listScheduledReports(input: ListScheduledReportsRequest = ListScheduledReportsRequest { }): ListScheduledReportsResponse

Returns a list of scheduled reports in your account.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or updates tags for a specified dashboard resource.

Link copied to clipboard

Removes specified tags from a dashboard resource.

Link copied to clipboard

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

Link copied to clipboard

Updates an existing scheduled report's properties, including its name, description, schedule configuration, and widget settings. Only the parameters included in the request are updated; all other properties remain unchanged.

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard

Creates a new scheduled report for a dashboard. A scheduled report automatically generates and delivers dashboard snapshots on a recurring schedule. Reports are delivered within 15 minutes of the scheduled delivery time.

Link copied to clipboard

Deletes a specified dashboard. This action cannot be undone.

Link copied to clipboard

Deletes a specified scheduled report. This is an irreversible operation.

Link copied to clipboard

Triggers an immediate execution of a scheduled report, outside of its regular schedule. The scheduled report must be in ENABLED state. Calling this operation on a DISABLED scheduled report returns a ValidationException.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves the configuration and metadata of a specified scheduled report.

Link copied to clipboard

Returns a list of all dashboards in your account.

Link copied to clipboard

Returns a list of scheduled reports in your account.

Link copied to clipboard

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

Link copied to clipboard

Adds or updates tags for a specified dashboard resource.

Link copied to clipboard

Removes specified tags from a dashboard resource.

Link copied to clipboard

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

Link copied to clipboard

Updates an existing scheduled report's properties, including its name, description, schedule configuration, and widget settings. Only the parameters included in the request are updated; all other properties remain unchanged.

Link copied to clipboard

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.