BcmDashboards class

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.

Constructors

BcmDashboards({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDashboard({required String name, required List<Widget> widgets, String? description, List<ResourceTag>? resourceTags}) → Future<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.
createScheduledReport({required ScheduledReportInput scheduledReport, String? clientToken, List<ResourceTag>? resourceTags}) → Future<CreateScheduledReportResponse>
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.
deleteDashboard({required String arn}) → Future<DeleteDashboardResponse>
Deletes a specified dashboard. This action cannot be undone.
deleteScheduledReport({required String arn}) → Future<DeleteScheduledReportResponse>
Deletes a specified scheduled report. This is an irreversible operation.
executeScheduledReport({required String arn, String? clientToken, bool? dryRun}) → Future<ExecuteScheduledReportResponse>
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.
getDashboard({required String arn}) → Future<GetDashboardResponse>
Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.
getResourcePolicy({required String resourceArn}) → Future<GetResourcePolicyResponse>
Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.
getScheduledReport({required String arn}) → Future<GetScheduledReportResponse>
Retrieves the configuration and metadata of a specified scheduled report.
listDashboards({int? maxResults, String? nextToken}) → Future<ListDashboardsResponse>
Returns a list of all dashboards in your account.
listScheduledReports({int? maxResults, String? nextToken}) → Future<ListScheduledReportsResponse>
Returns a list of scheduled reports in your account.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Returns a list of all tags associated with a specified dashboard resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
tagResource({required String resourceArn, required List<ResourceTag> resourceTags}) → Future<void>
Adds or updates tags for a specified dashboard resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> resourceTagKeys}) → Future<void>
Removes specified tags from a dashboard resource.
updateDashboard({required String arn, required String name, String? description, List<Widget>? widgets}) → Future<UpdateDashboardResponse>
Updates an existing dashboard's properties, including its name, description, and widget configurations.
updateScheduledReport({required String arn, bool? clearWidgetDateRangeOverride, bool? clearWidgetIds, String? dashboardArn, String? description, String? name, ScheduleConfig? scheduleConfig, String? scheduledReportExecutionRoleArn, DateTimeRange? widgetDateRangeOverride, List<String>? widgetIds}) → Future<UpdateScheduledReportResponse>
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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited