View Source AWS.BCMDashboards (aws-elixir v1.0.11)

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.

Link to this section Summary

Functions

Creates a new dashboard that can contain multiple widgets displaying cost and usage data.

Creates a new scheduled report for a dashboard.

Deletes a specified dashboard.

Deletes a specified scheduled report.

Triggers an immediate execution of a scheduled report, outside of its regular schedule.

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

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

Retrieves the configuration and metadata of a specified scheduled report.

Returns a list of all dashboards in your account.

Returns a list of scheduled reports in your account.

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

Adds or updates tags for a specified dashboard resource.

Removes specified tags from a dashboard resource.

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

Updates an existing scheduled report's properties, including its name, description, schedule configuration, and widget settings.

Link to this section Functions

Link to this function

create_dashboard(client, input, options \\ [])

View Source

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 to this function

create_scheduled_report(client, input, options \\ [])

View Source

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 to this function

delete_dashboard(client, input, options \\ [])

View Source

Deletes a specified dashboard.

This action cannot be undone.

Link to this function

delete_scheduled_report(client, input, options \\ [])

View Source

Deletes a specified scheduled report.

This is an irreversible operation.

Link to this function

execute_scheduled_report(client, input, options \\ [])

View Source

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.

If a clientToken is provided, the service uses it for idempotency. Requests with the same client token will not trigger a new execution within the same minute.

Link to this function

get_dashboard(client, input, options \\ [])

View Source

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

Link to this function

get_resource_policy(client, input, options \\ [])

View Source

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

Link to this function

get_scheduled_report(client, input, options \\ [])

View Source

Retrieves the configuration and metadata of a specified scheduled report.

Link to this function

list_dashboards(client, input, options \\ [])

View Source

Returns a list of all dashboards in your account.

Link to this function

list_scheduled_reports(client, input, options \\ [])

View Source

Returns a list of scheduled reports in your account.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds or updates tags for a specified dashboard resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes specified tags from a dashboard resource.

Link to this function

update_dashboard(client, input, options \\ [])

View Source

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

Link to this function

update_scheduled_report(client, input, options \\ [])

View Source

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.