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":{ "name":"CreateScheduledReport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateScheduledReportRequest"}, "output":{"shape":"CreateScheduledReportResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"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":{ "name":"DeleteDashboard", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDashboardRequest"}, "output":{"shape":"DeleteDashboardResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Deletes a specified dashboard. This action cannot be undone.
" }, "DeleteScheduledReport":{ "name":"DeleteScheduledReport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteScheduledReportRequest"}, "output":{"shape":"DeleteScheduledReportResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes a specified scheduled report. This is an irreversible operation.
" }, "ExecuteScheduledReport":{ "name":"ExecuteScheduledReport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExecuteScheduledReportRequest"}, "output":{"shape":"ExecuteScheduledReportResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.
", "readonly":true }, "GetResourcePolicy":{ "name":"GetResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetResourcePolicyRequest"}, "output":{"shape":"GetResourcePolicyResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.
", "readonly":true }, "GetScheduledReport":{ "name":"GetScheduledReport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetScheduledReportRequest"}, "output":{"shape":"GetScheduledReportResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves the configuration and metadata of a specified scheduled report.
", "readonly":true }, "ListDashboards":{ "name":"ListDashboards", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDashboardsRequest"}, "output":{"shape":"ListDashboardsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Returns a list of all dashboards in your account.
", "readonly":true }, "ListScheduledReports":{ "name":"ListScheduledReports", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListScheduledReportsRequest"}, "output":{"shape":"ListScheduledReportsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Returns a list of scheduled reports in your account.
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of all tags associated with a specified dashboard resource.
", "readonly":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Adds or updates tags for a specified dashboard resource.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Removes specified tags from a dashboard resource.
" }, "UpdateDashboard":{ "name":"UpdateDashboard", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDashboardRequest"}, "output":{"shape":"UpdateDashboardResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Updates an existing dashboard's properties, including its name, description, and widget configurations.
" }, "UpdateScheduledReport":{ "name":"UpdateScheduledReport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateScheduledReportRequest"}, "output":{"shape":"UpdateScheduledReportResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"GenericString"} }, "documentation":"You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
", "exception":true }, "Boolean":{ "type":"boolean", "box":true }, "ClientToken":{ "type":"string", "max":128, "min":1, "pattern":"[\\u0021-\\u007E]+" }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"GenericString"} }, "documentation":"The request could not be completed due to a conflict with the current state of the resource. For example, attempting to create a resource that already exists or is being created.
", "exception":true }, "CostAndUsageQuery":{ "type":"structure", "required":[ "metrics", "timeRange", "granularity" ], "members":{ "metrics":{ "shape":"MetricNames", "documentation":"The specific cost and usage metrics to retrieve.
Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.
" }, "granularity":{ "shape":"Granularity", "documentation":"The granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
Specifies how to group the retrieved data, such as by SERVICE, ACCOUNT, or TAG.
The filter expression to be applied to the cost and usage data.
" } }, "documentation":"Defines the parameters for retrieving Amazon Web Services cost and usage data. Includes specifications for metrics, time periods, granularity, grouping dimensions, and filtering conditions.
" }, "CostCategoryValues":{ "type":"structure", "members":{ "key":{ "shape":"String", "documentation":"The key of the cost category to filter on.
" }, "values":{ "shape":"StringList", "documentation":"The values to match for the specified cost category key.
" }, "matchOptions":{ "shape":"MatchOptions", "documentation":"The match options for cost category values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
Specifies the values and match options for cost category-based filtering in cost and usage queries.
" }, "CreateDashboardRequest":{ "type":"structure", "required":[ "name", "widgets" ], "members":{ "name":{ "shape":"DashboardName", "documentation":"The name of the dashboard. The name must be unique within your account.
" }, "description":{ "shape":"Description", "documentation":"A description of the dashboard's purpose or contents.
" }, "widgets":{ "shape":"WidgetList", "documentation":"An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.
" }, "resourceTags":{ "shape":"ResourceTagList", "documentation":"The tags to apply to the dashboard resource for organization and management.
" } } }, "CreateDashboardResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"DashboardArn", "documentation":"The ARN of the newly created dashboard.
" } } }, "CreateScheduledReportRequest":{ "type":"structure", "required":["scheduledReport"], "members":{ "scheduledReport":{ "shape":"ScheduledReportInput", "documentation":"The configuration for the scheduled report, including the dashboard to report on, the schedule, and the execution role that the service will use to generate the dashboard snapshot.
" }, "resourceTags":{ "shape":"ResourceTagList", "documentation":"The tags to apply to the scheduled report resource for organization and management.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken":true } } }, "CreateScheduledReportResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the newly created scheduled report.
" } } }, "DashboardArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\\*|[-a-z0-9]+)" }, "DashboardName":{ "type":"string", "max":50, "min":2, "pattern":"(?!.* {2})[a-zA-Z][a-zA-Z0-9 _-]{0,48}[a-zA-Z0-9_-]" }, "DashboardReference":{ "type":"structure", "required":[ "arn", "name", "type", "createdAt", "updatedAt" ], "members":{ "arn":{ "shape":"DashboardArn", "documentation":"The ARN of the referenced dashboard.
" }, "name":{ "shape":"DashboardName", "documentation":"The name of the referenced dashboard.
" }, "description":{ "shape":"Description", "documentation":"The description of the referenced dashboard.
" }, "type":{ "shape":"DashboardType", "documentation":"The dashboard type.
" }, "createdAt":{ "shape":"GenericTimeStamp", "documentation":"The timestamp when the dashboard was created.
" }, "updatedAt":{ "shape":"GenericTimeStamp", "documentation":"The timestamp when the dashboard was last modified.
" } }, "documentation":"Contains basic information about a dashboard, including its ARN, name, type, and timestamps.
" }, "DashboardReferenceList":{ "type":"list", "member":{"shape":"DashboardReference"} }, "DashboardType":{ "type":"string", "enum":["CUSTOM"] }, "DateTimeRange":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{ "shape":"DateTimeValue", "documentation":"The start time of the date range for querying data.
" }, "endTime":{ "shape":"DateTimeValue", "documentation":"The end time of the date range for querying data.
" } }, "documentation":"Defines a time period with explicit start and end times for data queries.
" }, "DateTimeType":{ "type":"string", "enum":[ "ABSOLUTE", "RELATIVE" ] }, "DateTimeValue":{ "type":"structure", "required":[ "type", "value" ], "members":{ "type":{ "shape":"DateTimeType", "documentation":"The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.
The actual date/time value.
" } }, "documentation":"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).
" }, "DeleteDashboardRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard to be deleted.
" } } }, "DeleteDashboardResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard that was deleted.
" } } }, "DeleteScheduledReportRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the scheduled report to delete.
" } } }, "DeleteScheduledReportResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the scheduled report that was deleted.
" } } }, "Description":{ "type":"string", "max":200, "min":1, "pattern":"(?!.* {2})[ a-zA-Z0-9.,!?;:@#$%&\\-_/\\\\]*" }, "Dimension":{ "type":"string", "enum":[ "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "RESOURCE_ID", "SUBSCRIPTION_ID", "TAG_KEY", "OPERATING_SYSTEM", "TENANCY", "BILLING_ENTITY", "RESERVATION_ID", "COST_CATEGORY_NAME", "DATABASE_ENGINE", "LEGAL_ENTITY_NAME", "SAVINGS_PLANS_TYPE", "INSTANCE_TYPE_FAMILY", "CACHE_ENGINE", "DEPLOYMENT_OPTION", "SCOPE", "PLATFORM" ] }, "DimensionValues":{ "type":"structure", "required":[ "key", "values" ], "members":{ "key":{ "shape":"Dimension", "documentation":"The key of the dimension to filter on (for example, SERVICE, USAGE_TYPE, or OPERATION).
The values to match for the specified dimension key.
" }, "matchOptions":{ "shape":"MatchOptions", "documentation":"The match options for dimension values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
Specifies the values and match options for dimension-based filtering in cost and usage queries.
" }, "DisplayConfig":{ "type":"structure", "members":{ "graph":{ "shape":"GraphDisplayConfigMap", "documentation":"The configuration for graphical display of the widget data, including chart type and visual options.
" }, "table":{ "shape":"TableDisplayConfigStruct", "documentation":"The configuration for tabular display of the widget data.
" } }, "documentation":"Defines how the widget's data should be visualized, including chart type, color schemes, axis configurations, and other display preferences.
", "union":true }, "ExecuteScheduledReportRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the scheduled report to execute.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken":true }, "dryRun":{ "shape":"Boolean", "documentation":"When set to true, validates the scheduled report configuration without triggering an actual execution.
The health status of the scheduled report after the execution request.
" }, "executionTriggered":{ "shape":"Boolean", "documentation":"Indicates whether the execution was successfully triggered.
" } } }, "Expression":{ "type":"structure", "members":{ "or":{ "shape":"Expressions", "documentation":"A list of expressions to combine with OR logic.
" }, "and":{ "shape":"Expressions", "documentation":"A list of expressions to combine with AND logic.
" }, "not":{ "shape":"Expression", "documentation":"An expression to negate with NOT logic.
" }, "dimensions":{ "shape":"DimensionValues", "documentation":"The dimension values to include in the filter expression.
" }, "tags":{ "shape":"TagValues", "documentation":"The tag values to include in the filter expression.
" }, "costCategories":{ "shape":"CostCategoryValues", "documentation":"The cost category values to include in the filter expression.
" } }, "documentation":"Defines complex filtering conditions using logical operators (AND, OR, NOT) and various filter types.
The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.
" } } }, "GetDashboardResponse":{ "type":"structure", "required":[ "arn", "name", "type", "widgets", "createdAt", "updatedAt" ], "members":{ "arn":{ "shape":"DashboardArn", "documentation":"The ARN of the retrieved dashboard.
" }, "name":{ "shape":"DashboardName", "documentation":"The name of the retrieved dashboard.
" }, "description":{ "shape":"Description", "documentation":"The description of the retrieved dashboard.
" }, "type":{ "shape":"DashboardType", "documentation":"Indicates the dashboard type.
" }, "widgets":{ "shape":"WidgetList", "documentation":"An array of widget configurations that make up the dashboard.
" }, "createdAt":{ "shape":"GenericTimeStamp", "documentation":"The timestamp when the dashboard was created.
" }, "updatedAt":{ "shape":"GenericTimeStamp", "documentation":"The timestamp when the dashboard was last modified.
" } } }, "GetResourcePolicyRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard whose resource-based policy you want to retrieve.
" } } }, "GetResourcePolicyResponse":{ "type":"structure", "required":[ "resourceArn", "policyDocument" ], "members":{ "resourceArn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard for which the resource-based policy was retrieved.
" }, "policyDocument":{ "shape":"GenericString", "documentation":"The JSON policy document that represents the dashboard's resource-based policy.
" } } }, "GetScheduledReportRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the scheduled report to retrieve.
" } } }, "GetScheduledReportResponse":{ "type":"structure", "required":["scheduledReport"], "members":{ "scheduledReport":{ "shape":"ScheduledReport", "documentation":"The scheduled report configuration and metadata.
" } } }, "Granularity":{ "type":"string", "enum":[ "HOURLY", "DAILY", "MONTHLY" ] }, "GraphDisplayConfig":{ "type":"structure", "required":["visualType"], "members":{ "visualType":{ "shape":"VisualType", "documentation":"The type of visualization to use for the data.
" } }, "documentation":"Defines the visual representation settings for widget data, including the visualization type, styling options, and display preferences for different metric types.
" }, "GraphDisplayConfigMap":{ "type":"map", "key":{"shape":"GenericString"}, "value":{"shape":"GraphDisplayConfig"} }, "GroupDefinition":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"GroupDefinitionKeyString", "documentation":"The key to use for grouping cost and usage data.
" }, "type":{ "shape":"GroupDefinitionType", "documentation":"The type of grouping to apply.
" } }, "documentation":"Specifies how to group cost and usage data.
" }, "GroupDefinitionKeyString":{ "type":"string", "max":1024, "min":1, "pattern":"[\\S\\s]*" }, "GroupDefinitionType":{ "type":"string", "enum":[ "DIMENSION", "TAG", "COST_CATEGORY" ] }, "GroupDefinitions":{ "type":"list", "member":{"shape":"GroupDefinition"} }, "HealthStatus":{ "type":"structure", "required":["statusCode"], "members":{ "statusCode":{ "shape":"HealthStatusCode", "documentation":"The health status code. HEALTHY indicates the scheduled report is configured properly and has all required permissions to execute. UNHEALTHY indicates the scheduled report is unable to deliver the notification to the default Amazon EventBridge EventBus in your account and your action is needed. The reason for the unhealthy state is captured in the health status reasons.
The timestamp when the health status was last refreshed.
" }, "statusReasons":{ "shape":"StatusReasonList", "documentation":"The list of reasons for the current health status. Only present when the status is UNHEALTHY.
Contains the health status information for a scheduled report, including the status code and any reasons for an unhealthy state.
" }, "HealthStatusCode":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY" ] }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"GenericString"} }, "documentation":"An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
", "exception":true, "fault":true }, "ListDashboardsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 20.
" }, "nextToken":{ "shape":"NextPageToken", "documentation":"The token for the next page of results. Use the value returned in the previous response.
" } } }, "ListDashboardsResponse":{ "type":"structure", "required":["dashboards"], "members":{ "dashboards":{ "shape":"DashboardReferenceList", "documentation":"An array of dashboard references, containing basic information about each dashboard.
" }, "nextToken":{ "shape":"NextPageToken", "documentation":"The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.
" } } }, "ListScheduledReportsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextPageToken", "documentation":"The token for the next page of results. Use the value returned in the previous response.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. Valid range is 1 to 100. The default value is 50.
" } } }, "ListScheduledReportsResponse":{ "type":"structure", "required":["scheduledReports"], "members":{ "scheduledReports":{ "shape":"ScheduledReportSummaryList", "documentation":"An array of scheduled report summaries, containing basic information about each scheduled report.
" }, "nextToken":{ "shape":"NextPageToken", "documentation":"The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"The unique identifier for the resource.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "resourceTags":{ "shape":"ResourceTagList", "documentation":"The list of tags associated with the specified dashboard resource.
" } } }, "MatchOption":{ "type":"string", "enum":[ "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE" ] }, "MatchOptions":{ "type":"list", "member":{"shape":"MatchOption"} }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "MetricName":{ "type":"string", "enum":[ "AmortizedCost", "BlendedCost", "NetAmortizedCost", "NetUnblendedCost", "NormalizedUsageAmount", "UnblendedCost", "UsageQuantity", "SpendCoveredBySavingsPlans", "Hour", "Unit", "Cost" ] }, "MetricNames":{ "type":"list", "member":{"shape":"MetricName"} }, "NextPageToken":{ "type":"string", "max":8192, "min":1, "pattern":"[\\S\\s]*" }, "QueryParameters":{ "type":"structure", "members":{ "costAndUsage":{ "shape":"CostAndUsageQuery", "documentation":"The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.
" }, "savingsPlansCoverage":{ "shape":"SavingsPlansCoverageQuery", "documentation":"The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.
" }, "savingsPlansUtilization":{ "shape":"SavingsPlansUtilizationQuery", "documentation":"The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.
" }, "reservationCoverage":{ "shape":"ReservationCoverageQuery", "documentation":"The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.
" }, "reservationUtilization":{ "shape":"ReservationUtilizationQuery", "documentation":"The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.
" } }, "documentation":"Defines the data retrieval parameters for a widget.
", "union":true }, "ReservationCoverageQuery":{ "type":"structure", "required":["timeRange"], "members":{ "timeRange":{"shape":"DateTimeRange"}, "groupBy":{ "shape":"GroupDefinitions", "documentation":"Specifies how to group the Reserved Instance coverage data, such as by service, Region, or instance type.
" }, "granularity":{ "shape":"Granularity", "documentation":"The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
The coverage metrics to include in the results.
Valid values for ReservationCoverageQuery metrics are Hour, Unit, and Cost.
Defines the parameters for querying Reserved Instance coverage data, including grouping options, metrics, and sorting preferences.
" }, "ReservationUtilizationQuery":{ "type":"structure", "required":["timeRange"], "members":{ "timeRange":{"shape":"DateTimeRange"}, "groupBy":{ "shape":"GroupDefinitions", "documentation":"Specifies how to group the Reserved Instance utilization data, such as by service, Region, or instance type.
" }, "granularity":{ "shape":"Granularity", "documentation":"The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
Defines the parameters for querying Reserved Instance utilization data, including grouping options and time granularity.
" }, "ResourceArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:(dashboard|scheduled-report)/(\\*|[-a-z0-9]+)" }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"GenericString"} }, "documentation":"The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
", "exception":true }, "ResourceTag":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"ResourceTagKey", "documentation":"The key of the tag to be attached to the dashboard resource.
" }, "value":{ "shape":"ResourceTagValue", "documentation":"The value of the tag to be attached to the dashboard resource.
" } }, "documentation":"A key-value pair that can be attached to a dashboard for organization and management purposes.
" }, "ResourceTagKey":{ "type":"string", "max":128, "min":1, "pattern":"[\\S\\s]*" }, "ResourceTagKeyList":{ "type":"list", "member":{"shape":"ResourceTagKey"}, "max":200, "min":0 }, "ResourceTagList":{ "type":"list", "member":{"shape":"ResourceTag"}, "max":200, "min":0 }, "ResourceTagValue":{ "type":"string", "max":256, "min":0, "pattern":"[\\S\\s]*" }, "SavingsPlansCoverageQuery":{ "type":"structure", "required":["timeRange"], "members":{ "timeRange":{"shape":"DateTimeRange"}, "metrics":{ "shape":"MetricNames", "documentation":"The coverage metrics to include in the results.
Valid value for SavingsPlansCoverageQuery metrics is SpendCoveredBySavingsPlans.
The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
Specifies how to group the Savings Plans coverage data, such as by service or instance family.
" }, "filter":{"shape":"Expression"} }, "documentation":"Defines the parameters for querying Savings Plans coverage data, including metrics, grouping options, and time granularity.
" }, "SavingsPlansUtilizationQuery":{ "type":"structure", "required":["timeRange"], "members":{ "timeRange":{"shape":"DateTimeRange"}, "granularity":{ "shape":"Granularity", "documentation":"The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
Defines the parameters for querying Savings Plans utilization data, including time granularity and sorting preferences.
" }, "ScheduleConfig":{ "type":"structure", "members":{ "scheduleExpression":{ "shape":"GenericString", "documentation":"The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).
The time zone for the schedule expression, for example, UTC.
The time period during which the schedule is active.
" }, "state":{ "shape":"ScheduleState", "documentation":"The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
Defines the schedule for a scheduled report, including the cron expression, time zone, active period, and the schedule state.
" }, "SchedulePeriod":{ "type":"structure", "members":{ "startTime":{ "shape":"GenericTimeStamp", "documentation":"The start time of the schedule period. If not specified, defaults to the time of the create or update request. The start time cannot be more than 5 minutes before the time of the request.
" }, "endTime":{ "shape":"GenericTimeStamp", "documentation":"The end time of the schedule period. If not specified, defaults to 3 years from the time of the create or update request. The maximum allowed value is 3 years from the current time. Setting an end time beyond this limit returns a ValidationException.
Defines the active time period for execution of the scheduled report.
" }, "ScheduleState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "ScheduledReport":{ "type":"structure", "required":[ "name", "dashboardArn", "scheduledReportExecutionRoleArn", "scheduleConfig" ], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the scheduled report.
" }, "name":{ "shape":"ScheduledReportName", "documentation":"The name of the scheduled report.
" }, "dashboardArn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard associated with the scheduled report.
" }, "scheduledReportExecutionRoleArn":{ "shape":"ServiceRoleArn", "documentation":"The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.
" }, "scheduleConfig":{ "shape":"ScheduleConfig", "documentation":"The schedule configuration that defines when and how often the report is generated.
" }, "description":{ "shape":"Description", "documentation":"A description of the scheduled report's purpose or contents.
" }, "widgetIds":{ "shape":"WidgetIdList", "documentation":"The list of widget identifiers included in the scheduled report.
" }, "widgetDateRangeOverride":{ "shape":"DateTimeRange", "documentation":"The date range override applied to widgets in the scheduled report.
" }, "createdAt":{ "shape":"GenericTimeStamp", "documentation":"The timestamp when the scheduled report was created.
" }, "updatedAt":{ "shape":"GenericTimeStamp", "documentation":"The timestamp when the scheduled report was last modified.
" }, "lastExecutionAt":{ "shape":"GenericTimeStamp", "documentation":"The timestamp of the most recent execution of the scheduled report.
" }, "healthStatus":{ "shape":"HealthStatus", "documentation":"The health status of the scheduled report at last refresh time.
" } }, "documentation":"Contains the full configuration and metadata of a scheduled report.
" }, "ScheduledReportArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:scheduled-report/(\\*|[-a-z0-9]+)" }, "ScheduledReportInput":{ "type":"structure", "required":[ "name", "dashboardArn", "scheduledReportExecutionRoleArn", "scheduleConfig" ], "members":{ "name":{ "shape":"ScheduledReportName", "documentation":"The name of the scheduled report.
" }, "dashboardArn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard to generate the scheduled report from.
" }, "scheduledReportExecutionRoleArn":{ "shape":"ServiceRoleArn", "documentation":"The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.
" }, "scheduleConfig":{ "shape":"ScheduleConfig", "documentation":"The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED.
A description of the scheduled report's purpose or contents.
" }, "widgetIds":{ "shape":"WidgetIdList", "documentation":"The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.
" }, "widgetDateRangeOverride":{ "shape":"DateTimeRange", "documentation":"The date range override to apply to widgets in the scheduled report.
" } }, "documentation":"Defines the configuration for creating a new scheduled report, including the dashboard, schedule, execution role, and optional widget settings.
" }, "ScheduledReportName":{ "type":"string", "max":50, "min":2, "pattern":"(?!.* {2})[a-zA-Z][a-zA-Z0-9 _-]{0,48}[a-zA-Z0-9_-]" }, "ScheduledReportSummary":{ "type":"structure", "required":[ "arn", "name", "dashboardArn", "scheduleExpression", "state", "healthStatus" ], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the scheduled report.
" }, "name":{ "shape":"ScheduledReportName", "documentation":"The name of the scheduled report.
" }, "dashboardArn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard associated with the scheduled report.
" }, "scheduleExpression":{ "shape":"GenericString", "documentation":"The schedule expression that defines when the report runs.
" }, "state":{ "shape":"ScheduleState", "documentation":"The state of the schedule: ENABLED or DISABLED.
The health status of the scheduled report as of its last refresh time.
" }, "scheduleExpressionTimeZone":{ "shape":"GenericString", "documentation":"The time zone for the schedule expression, for example, UTC.
The list of widget identifiers included in the scheduled report.
" } }, "documentation":"Contains summary information for a scheduled report.
" }, "ScheduledReportSummaryList":{ "type":"list", "member":{"shape":"ScheduledReportSummary"} }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"GenericString"} }, "documentation":"The request would exceed a service quota. Review the service quotas for Amazon Web Services Billing and Cost Management Dashboards and retry your request.
", "exception":true }, "ServiceRoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_/-]+" }, "StatusReason":{ "type":"string", "enum":[ "DATA_SOURCE_ACCESS_DENIED", "EXECUTION_ROLE_ASSUME_FAILED", "EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS", "DASHBOARD_NOT_FOUND", "DASHBOARD_ACCESS_DENIED", "INTERNAL_FAILURE", "WIDGET_ID_NOT_FOUND" ] }, "StatusReasonList":{ "type":"list", "member":{"shape":"StatusReason"} }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "TableDisplayConfigStruct":{ "type":"structure", "members":{}, "documentation":"Configuration structure for customizing the tabular display of widget data.
" }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "resourceTags" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"The unique identifier for the resource.
" }, "resourceTags":{ "shape":"ResourceTagList", "documentation":"The tags to add to the dashboard resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValues":{ "type":"structure", "members":{ "key":{ "shape":"String", "documentation":"The key of the tag to filter on.
" }, "values":{ "shape":"StringList", "documentation":"The values to match for the specified tag key.
" }, "matchOptions":{ "shape":"MatchOptions", "documentation":"The match options for tag values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
Specifies tag-based filtering options for cost and usage queries.
" }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"GenericString"} }, "documentation":"The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "resourceTagKeys" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"The unique identifier for the resource.
" }, "resourceTagKeys":{ "shape":"ResourceTagKeyList", "documentation":"The keys of the tags to remove from the dashboard resource.
" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateDashboardRequest":{ "type":"structure", "required":[ "arn", "name" ], "members":{ "arn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard to update.
" }, "name":{ "shape":"DashboardName", "documentation":"The new name for the dashboard.
" }, "description":{ "shape":"Description", "documentation":"The new description for the dashboard.
" }, "widgets":{ "shape":"WidgetList", "documentation":"The updated array of widget configurations for the dashboard. Replaces all existing widgets.
" } } }, "UpdateDashboardResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"DashboardArn", "documentation":"The ARN of the updated dashboard.
" } } }, "UpdateScheduledReportRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the scheduled report to update.
" }, "name":{ "shape":"ScheduledReportName", "documentation":"The new name for the scheduled report.
" }, "description":{ "shape":"Description", "documentation":"The new description for the scheduled report.
" }, "dashboardArn":{ "shape":"DashboardArn", "documentation":"The ARN of the dashboard to associate with the scheduled report.
" }, "scheduledReportExecutionRoleArn":{ "shape":"ServiceRoleArn", "documentation":"The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.
" }, "scheduleConfig":{ "shape":"ScheduleConfig", "documentation":"The updated schedule configuration for the report.
" }, "widgetIds":{ "shape":"WidgetIdList", "documentation":"The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.
" }, "widgetDateRangeOverride":{ "shape":"DateTimeRange", "documentation":"The date range override to apply to widgets in the scheduled report.
" }, "clearWidgetIds":{ "shape":"Boolean", "documentation":"Set to true to clear existing widgetIds.
" }, "clearWidgetDateRangeOverride":{ "shape":"Boolean", "documentation":"Set to true to clear existing widgetDateRangeOverride.
" } } }, "UpdateScheduledReportResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ScheduledReportArn", "documentation":"The ARN of the updated scheduled report.
" } } }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"GenericString"} }, "documentation":"The input parameters do not satisfy the requirements. Check the error message for specific validation details.
", "exception":true }, "VisualType":{ "type":"string", "enum":[ "LINE", "BAR", "STACK" ] }, "Widget":{ "type":"structure", "required":[ "title", "configs" ], "members":{ "id":{ "shape":"WidgetId", "documentation":"The unique identifier for the widget.
" }, "title":{ "shape":"WidgetTitle", "documentation":"The title of the widget.
" }, "description":{ "shape":"Description", "documentation":"A description of the widget's purpose or the data it displays.
" }, "width":{ "shape":"WidgetWidth", "documentation":"The width of the widget in column spans. The dashboard layout consists of a grid system.
" }, "height":{ "shape":"WidgetHeight", "documentation":"The height of the widget in row spans. The dashboard layout consists of a grid system.
" }, "horizontalOffset":{ "shape":"Integer", "documentation":"Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.
" }, "configs":{ "shape":"WidgetConfigList", "documentation":"An array of configurations that define the data queries and display settings for the widget.
" } }, "documentation":"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.
" }, "WidgetConfig":{ "type":"structure", "required":[ "queryParameters", "displayConfig" ], "members":{ "queryParameters":{ "shape":"QueryParameters", "documentation":"The parameters that define what data the widget should retrieve and how it should be filtered or grouped.
" }, "displayConfig":{ "shape":"DisplayConfig", "documentation":"The configuration that determines how the retrieved data should be visualized in the widget.
" } }, "documentation":"Defines the complete configuration for a widget, including data retrieval settings and visualization preferences.
" }, "WidgetConfigList":{ "type":"list", "member":{"shape":"WidgetConfig"}, "max":2, "min":1 }, "WidgetHeight":{ "type":"integer", "box":true, "max":10, "min":4 }, "WidgetId":{ "type":"string", "max":32, "min":32, "pattern":"[0-9a-f]{32}" }, "WidgetIdList":{ "type":"list", "member":{"shape":"String"}, "max":1, "min":0 }, "WidgetList":{ "type":"list", "member":{"shape":"Widget"}, "max":20, "min":0 }, "WidgetTitle":{ "type":"string", "max":50, "min":2, "pattern":"(?!.* {2})[a-zA-Z0-9_-][ a-zA-Z0-9_-]*[a-zA-Z0-9_-]" }, "WidgetWidth":{ "type":"integer", "box":true, "max":6, "min":2 } }, "documentation":"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.
" }