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.
", "operations": { "CreateDashboard": "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": "Deletes a specified dashboard. This action cannot be undone.
", "GetDashboard": "Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.
", "GetResourcePolicy": "Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.
", "ListDashboards": "Returns a list of all dashboards in your account.
", "ListTagsForResource": "Returns a list of all tags associated with a specified dashboard resource.
", "TagResource": "Adds or updates tags for a specified dashboard resource.
", "UntagResource": "Removes specified tags from a dashboard resource.
", "UpdateDashboard": "Updates an existing dashboard's properties, including its name, description, and widget configurations.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
", "refs": {} }, "CostAndUsageQuery": { "base": "Defines the parameters for retrieving Amazon Web Services cost and usage data. Includes specifications for metrics, time periods, granularity, grouping dimensions, and filtering conditions.
", "refs": { "QueryParameters$costAndUsage": "The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.
" } }, "CostCategoryValues": { "base": "Specifies the values and match options for cost category-based filtering in cost and usage queries.
", "refs": { "Expression$costCategories": "The cost category values to include in the filter expression.
" } }, "CreateDashboardRequest": { "base": null, "refs": {} }, "CreateDashboardResponse": { "base": null, "refs": {} }, "DashboardArn": { "base": null, "refs": { "CreateDashboardResponse$arn": "The ARN of the newly created dashboard.
", "DashboardReference$arn": "The ARN of the referenced dashboard.
", "DeleteDashboardRequest$arn": "The ARN of the dashboard to be deleted.
", "DeleteDashboardResponse$arn": "The ARN of the dashboard that was deleted.
", "GetDashboardRequest$arn": "The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.
", "GetDashboardResponse$arn": "The ARN of the retrieved dashboard.
", "GetResourcePolicyRequest$resourceArn": "The ARN of the dashboard whose resource-based policy you want to retrieve.
", "GetResourcePolicyResponse$resourceArn": "The ARN of the dashboard for which the resource-based policy was retrieved.
", "ListTagsForResourceRequest$resourceArn": "The unique identifier for the resource.
", "TagResourceRequest$resourceArn": "The unique identifier for the resource.
", "UntagResourceRequest$resourceArn": "The unique identifier for the resource.
", "UpdateDashboardRequest$arn": "The ARN of the dashboard to update.
", "UpdateDashboardResponse$arn": "The ARN of the updated dashboard.
" } }, "DashboardName": { "base": null, "refs": { "CreateDashboardRequest$name": "The name of the dashboard. The name must be unique within your account.
", "DashboardReference$name": "The name of the referenced dashboard.
", "GetDashboardResponse$name": "The name of the retrieved dashboard.
", "UpdateDashboardRequest$name": "The new name for the dashboard. If not specified, the existing name is retained.
" } }, "DashboardReference": { "base": "Contains basic information about a dashboard, including its ARN, name, type, and timestamps.
", "refs": { "DashboardReferenceList$member": null } }, "DashboardReferenceList": { "base": null, "refs": { "ListDashboardsResponse$dashboards": "An array of dashboard references, containing basic information about each dashboard.
" } }, "DashboardType": { "base": null, "refs": { "DashboardReference$type": "The dashboard type.
", "GetDashboardResponse$type": "Indicates the dashboard type.
" } }, "DateTimeRange": { "base": "Defines a time period with explicit start and end times for data queries.
", "refs": { "CostAndUsageQuery$timeRange": "The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.
", "ReservationCoverageQuery$timeRange": null, "ReservationUtilizationQuery$timeRange": null, "SavingsPlansCoverageQuery$timeRange": null, "SavingsPlansUtilizationQuery$timeRange": null } }, "DateTimeType": { "base": null, "refs": { "DateTimeValue$type": "The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.
Represents a point in time that can be specified as either an absolute date (for example, \"2025-07-01\") or a relative time period using ISO 8601 duration format (for example, \"-P3M\" for three months ago).
", "refs": { "DateTimeRange$startTime": "The start time of the date range for querying data.
", "DateTimeRange$endTime": "The end time of the date range for querying data.
" } }, "DeleteDashboardRequest": { "base": null, "refs": {} }, "DeleteDashboardResponse": { "base": null, "refs": {} }, "Description": { "base": null, "refs": { "CreateDashboardRequest$description": "A description of the dashboard's purpose or contents.
", "DashboardReference$description": "The description of the referenced dashboard.
", "GetDashboardResponse$description": "The description of the retrieved dashboard.
", "UpdateDashboardRequest$description": "The new description for the dashboard. If not specified, the existing description is retained.
", "Widget$description": "A description of the widget's purpose or the data it displays.
" } }, "Dimension": { "base": null, "refs": { "DimensionValues$key": "The key of the dimension to filter on (for example, SERVICE, USAGE_TYPE, or OPERATION).
Specifies the values and match options for dimension-based filtering in cost and usage queries.
", "refs": { "Expression$dimensions": "The dimension values to include in the filter expression.
" } }, "DisplayConfig": { "base": "Defines how the widget's data should be visualized, including chart type, color schemes, axis configurations, and other display preferences.
", "refs": { "WidgetConfig$displayConfig": "The configuration that determines how the retrieved data should be visualized in the widget.
" } }, "Expression": { "base": "Defines complex filtering conditions using logical operators (AND, OR, NOT) and various filter types.
The filter expression to be applied to the cost and usage data.
", "Expression$not": "An expression to negate with NOT logic.
", "Expressions$member": null, "ReservationCoverageQuery$filter": null, "ReservationUtilizationQuery$filter": null, "SavingsPlansCoverageQuery$filter": null, "SavingsPlansUtilizationQuery$filter": null } }, "Expressions": { "base": null, "refs": { "Expression$or": "A list of expressions to combine with OR logic.
", "Expression$and": "A list of expressions to combine with AND logic.
" } }, "GenericString": { "base": null, "refs": { "AccessDeniedException$message": null, "DateTimeValue$value": "The actual date/time value.
", "GetResourcePolicyResponse$policyDocument": "The JSON policy document that represents the dashboard's resource-based policy.
", "GraphDisplayConfigMap$key": null, "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "GenericTimeStamp": { "base": null, "refs": { "DashboardReference$createdAt": "The timestamp when the dashboard was created.
", "DashboardReference$updatedAt": "The timestamp when the dashboard was last modified.
", "GetDashboardResponse$createdAt": "The timestamp when the dashboard was created.
", "GetDashboardResponse$updatedAt": "The timestamp when the dashboard was last modified.
" } }, "GetDashboardRequest": { "base": null, "refs": {} }, "GetDashboardResponse": { "base": null, "refs": {} }, "GetResourcePolicyRequest": { "base": null, "refs": {} }, "GetResourcePolicyResponse": { "base": null, "refs": {} }, "Granularity": { "base": null, "refs": { "CostAndUsageQuery$granularity": "The granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
" } }, "GraphDisplayConfig": { "base": "Defines the visual representation settings for widget data, including the visualization type, styling options, and display preferences for different metric types.
", "refs": { "GraphDisplayConfigMap$value": null } }, "GraphDisplayConfigMap": { "base": null, "refs": { "DisplayConfig$graph": "The configuration for graphical display of the widget data, including chart type and visual options.
" } }, "GroupDefinition": { "base": "Specifies how to group cost and usage data.
", "refs": { "GroupDefinitions$member": null } }, "GroupDefinitionKeyString": { "base": null, "refs": { "GroupDefinition$key": "The key to use for grouping cost and usage data.
" } }, "GroupDefinitionType": { "base": null, "refs": { "GroupDefinition$type": "The type of grouping to apply.
" } }, "GroupDefinitions": { "base": null, "refs": { "CostAndUsageQuery$groupBy": "Specifies how to group the retrieved data, such as by SERVICE, ACCOUNT, or TAG.
Specifies how to group the Reserved Instance coverage data, such as by service, Region, or instance type.
", "ReservationUtilizationQuery$groupBy": "Specifies how to group the Reserved Instance utilization data, such as by service, Region, or instance type.
", "SavingsPlansCoverageQuery$groupBy": "Specifies how to group the Savings Plans coverage data, such as by service or instance family.
" } }, "Integer": { "base": null, "refs": { "Widget$horizontalOffset": "Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.
" } }, "InternalServerException": { "base": "An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
", "refs": {} }, "ListDashboardsRequest": { "base": null, "refs": {} }, "ListDashboardsResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "MatchOption": { "base": null, "refs": { "MatchOptions$member": null } }, "MatchOptions": { "base": null, "refs": { "CostCategoryValues$matchOptions": "The match options for cost category values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
The match options for dimension values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
The match options for tag values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
The maximum number of results to return in a single call. The default value is 20.
" } }, "MetricName": { "base": null, "refs": { "MetricNames$member": null } }, "MetricNames": { "base": null, "refs": { "CostAndUsageQuery$metrics": "The specific cost and usage metrics to retrieve.
Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
The coverage metrics to include in the results.
Valid values for ReservationCoverageQuery metrics are Hour, Unit, and Cost.
The coverage metrics to include in the results.
Valid value for SavingsPlansCoverageQuery metrics is SpendCoveredBySavingsPlans.
The token for the next page of results. Use the value returned in the previous response.
", "ListDashboardsResponse$nextToken": "The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.
" } }, "QueryParameters": { "base": "Defines the data retrieval parameters for a widget.
", "refs": { "WidgetConfig$queryParameters": "The parameters that define what data the widget should retrieve and how it should be filtered or grouped.
" } }, "ReservationCoverageQuery": { "base": "Defines the parameters for querying Reserved Instance coverage data, including grouping options, metrics, and sorting preferences.
", "refs": { "QueryParameters$reservationCoverage": "The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.
" } }, "ReservationUtilizationQuery": { "base": "Defines the parameters for querying Reserved Instance utilization data, including grouping options and time granularity.
", "refs": { "QueryParameters$reservationUtilization": "The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.
" } }, "ResourceNotFoundException": { "base": "The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
", "refs": {} }, "ResourceTag": { "base": "A key-value pair that can be attached to a dashboard for organization and management purposes.
", "refs": { "ResourceTagList$member": null } }, "ResourceTagKey": { "base": null, "refs": { "ResourceTag$key": "The key of the tag to be attached to the dashboard resource.
", "ResourceTagKeyList$member": null } }, "ResourceTagKeyList": { "base": null, "refs": { "UntagResourceRequest$resourceTagKeys": "The keys of the tags to remove from the dashboard resource.
" } }, "ResourceTagList": { "base": null, "refs": { "CreateDashboardRequest$resourceTags": "The tags to apply to the dashboard resource for organization and management.
", "ListTagsForResourceResponse$resourceTags": "The list of tags associated with the specified dashboard resource.
", "TagResourceRequest$resourceTags": "The tags to add to the dashboard resource.
" } }, "ResourceTagValue": { "base": null, "refs": { "ResourceTag$value": "The value of the tag to be attached to the dashboard resource.
" } }, "SavingsPlansCoverageQuery": { "base": "Defines the parameters for querying Savings Plans coverage data, including metrics, grouping options, and time granularity.
", "refs": { "QueryParameters$savingsPlansCoverage": "The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.
" } }, "SavingsPlansUtilizationQuery": { "base": "Defines the parameters for querying Savings Plans utilization data, including time granularity and sorting preferences.
", "refs": { "QueryParameters$savingsPlansUtilization": "The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.
" } }, "ServiceQuotaExceededException": { "base": "The request would exceed service quotas. For example, attempting to create more than 20 widgets in a dashboard or exceeding the maximum number of dashboards per account.
", "refs": {} }, "String": { "base": null, "refs": { "CostCategoryValues$key": "The key of the cost category to filter on.
", "StringList$member": null, "TagValues$key": "The key of the tag to filter on.
" } }, "StringList": { "base": null, "refs": { "CostCategoryValues$values": "The values to match for the specified cost category key.
", "DimensionValues$values": "The values to match for the specified dimension key.
", "TagValues$values": "The values to match for the specified tag key.
" } }, "TableDisplayConfigStruct": { "base": "Configuration structure for customizing the tabular display of widget data.
", "refs": { "DisplayConfig$table": "The configuration for tabular display of the widget data.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValues": { "base": "Specifies tag-based filtering options for cost and usage queries.
", "refs": { "Expression$tags": "The tag values to include in the filter expression.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
", "refs": {} }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateDashboardRequest": { "base": null, "refs": {} }, "UpdateDashboardResponse": { "base": null, "refs": {} }, "ValidationException": { "base": "The input parameters do not satisfy the requirements. Check the error message for specific validation details.
", "refs": {} }, "VisualType": { "base": null, "refs": { "GraphDisplayConfig$visualType": "The type of visualization to use for the data.
" } }, "Widget": { "base": "A configurable visualization component within a dashboard that displays specific cost and usage metrics. Each widget can show data as charts or tables and includes settings for data querying, filtering, and visual presentation.
", "refs": { "WidgetList$member": null } }, "WidgetConfig": { "base": "Defines the complete configuration for a widget, including data retrieval settings and visualization preferences.
", "refs": { "WidgetConfigList$member": null } }, "WidgetConfigList": { "base": null, "refs": { "Widget$configs": "An array of configurations that define the data queries and display settings for the widget.
" } }, "WidgetHeight": { "base": null, "refs": { "Widget$height": "The height of the widget in row spans. The dashboard layout consists of a grid system.
" } }, "WidgetList": { "base": null, "refs": { "CreateDashboardRequest$widgets": "An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.
", "GetDashboardResponse$widgets": "An array of widget configurations that make up the dashboard.
", "UpdateDashboardRequest$widgets": "The updated array of widget configurations for the dashboard. Replaces all existing widgets.
" } }, "WidgetTitle": { "base": null, "refs": { "Widget$title": "The title of the widget.
" } }, "WidgetWidth": { "base": null, "refs": { "Widget$width": "The width of the widget in column spans. The dashboard layout consists of a grid system.
" } } } }