Smaws_Client_BCMDashboards.Typestype nonrec metric_names = metric_name listtype nonrec date_time_value = {value : generic_string;The actual date/time value.
*)type_ : date_time_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).
type nonrec date_time_range = {end_time : date_time_value;The end time of the date range for querying data.
*)start_time : date_time_value;The start time of the date range for querying data.
*)}Defines a time period with explicit start and end times for data queries.
type nonrec group_definition = {type_ : group_definition_type option;The type of grouping to apply.
*)key : Smaws_Lib.Smithy_api.Types.string_;The key to use for grouping cost and usage data.
*)}Specifies how to group cost and usage data.
type nonrec group_definitions = group_definition listtype nonrec dimension = | PLATFORM| SCOPE| DEPLOYMENT_OPTION| CACHE_ENGINE| INSTANCE_TYPE_FAMILY| SAVINGS_PLANS_TYPE| LEGAL_ENTITY_NAME| DATABASE_ENGINE| COST_CATEGORY_NAME| RESERVATION_ID| BILLING_ENTITY| TENANCY| OPERATING_SYSTEM| TAG_KEY| SUBSCRIPTION_ID| RESOURCE_ID| RECORD_TYPE| USAGE_TYPE_GROUP| USAGE_TYPE| SERVICE| REGION| PURCHASE_TYPE| OPERATION| LINKED_ACCOUNT| INSTANCE_TYPE| AZtype nonrec string_list = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec match_options = match_option listtype nonrec dimension_values = {match_options : match_options option;The match options for dimension values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
values : string_list;The values to match for the specified dimension key.
*)key : dimension;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.
type nonrec tag_values = {match_options : match_options option;The match options for tag values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
values : string_list option;The values to match for the specified tag key.
*)key : Smaws_Lib.Smithy_api.Types.string_ option;The key of the tag to filter on.
*)}Specifies tag-based filtering options for cost and usage queries.
type nonrec cost_category_values = {match_options : match_options option;The match options for cost category values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.
values : string_list option;The values to match for the specified cost category key.
*)key : Smaws_Lib.Smithy_api.Types.string_ option;The key of the cost category to filter on.
*)}Specifies the values and match options for cost category-based filtering in cost and usage queries.
type expression = {cost_categories : cost_category_values option;The cost category values to include in the filter expression.
*)dimensions : dimension_values option;The dimension values to include in the filter expression.
*)not : expression option;An expression to negate with NOT logic.
*)and_ : expressions option;A list of expressions to combine with AND logic.
*)or : expressions option;A list of expressions to combine with OR logic.
*)}Defines complex filtering conditions using logical operators (AND, OR, NOT) and various filter types.
and expressions = expression listtype nonrec cost_and_usage_query = {filter : expression option;The filter expression to be applied to the cost and usage data.
*)group_by : group_definitions option;Specifies how to group the retrieved data, such as by SERVICE, ACCOUNT, or TAG.
granularity : granularity;The granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
time_range : date_time_range;The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.
*)metrics : metric_names;The specific cost and usage metrics to retrieve.
Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
}Defines the parameters for retrieving Amazon Web Services cost and usage data. Includes specifications for metrics, time periods, granularity, grouping dimensions, and filtering conditions.
type nonrec savings_plans_coverage_query = {filter : expression option;group_by : group_definitions option;Specifies how to group the Savings Plans coverage data, such as by service or instance family.
*)granularity : granularity option;The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
metrics : metric_names option;The coverage metrics to include in the results.
Valid value for SavingsPlansCoverageQuery metrics is SpendCoveredBySavingsPlans.
time_range : date_time_range;}Defines the parameters for querying Savings Plans coverage data, including metrics, grouping options, and time granularity.
type nonrec savings_plans_utilization_query = {filter : expression option;granularity : granularity option;The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
time_range : date_time_range;}Defines the parameters for querying Savings Plans utilization data, including time granularity and sorting preferences.
type nonrec reservation_coverage_query = {metrics : metric_names option;The coverage metrics to include in the results.
Valid values for ReservationCoverageQuery metrics are Hour, Unit, and Cost.
filter : expression option;granularity : granularity option;The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
group_by : group_definitions option;Specifies how to group the Reserved Instance coverage data, such as by service, Region, or instance type.
*)time_range : date_time_range;}Defines the parameters for querying Reserved Instance coverage data, including grouping options, metrics, and sorting preferences.
type nonrec reservation_utilization_query = {filter : expression option;granularity : granularity option;The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.
group_by : group_definitions option;Specifies how to group the Reserved Instance utilization data, such as by service, Region, or instance type.
*)time_range : date_time_range;}Defines the parameters for querying Reserved Instance utilization data, including grouping options and time granularity.
type nonrec query_parameters = | ReservationUtilization of reservation_utilization_queryThe parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.
*)| ReservationCoverage of reservation_coverage_queryThe parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.
*)| SavingsPlansUtilization of savings_plans_utilization_queryThe parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.
*)| SavingsPlansCoverage of savings_plans_coverage_queryThe parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.
*)| CostAndUsage of cost_and_usage_queryThe parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.
*)Defines the data retrieval parameters for a widget.
type nonrec graph_display_config = {visual_type : visual_type;The type of visualization to use for the data.
*)}Defines the visual representation settings for widget data, including the visualization type, styling options, and display preferences for different metric types.
type nonrec graph_display_config_map =
(generic_string * graph_display_config) listtype nonrec display_config = | Table of table_display_config_structThe configuration for tabular display of the widget data.
*)| Graph of graph_display_config_mapThe configuration for graphical display of the widget data, including chart type and visual options.
*)Defines how the widget's data should be visualized, including chart type, color schemes, axis configurations, and other display preferences.
type nonrec widget_config = {display_config : display_config;The configuration that determines how the retrieved data should be visualized in the widget.
*)query_parameters : query_parameters;The parameters that define what data the widget should retrieve and how it should be filtered or grouped.
*)}Defines the complete configuration for a widget, including data retrieval settings and visualization preferences.
type nonrec widget_config_list = widget_config listtype nonrec widget = {configs : widget_config_list;An array of configurations that define the data queries and display settings for the widget.
*)horizontal_offset : Smaws_Lib.Smithy_api.Types.integer option;Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.
*)height : widget_height option;The height of the widget in row spans. The dashboard layout consists of a grid system.
*)width : widget_width option;The width of the widget in column spans. The dashboard layout consists of a grid system.
*)description : description option;A description of the widget's purpose or the data it displays.
*)title : widget_title;The title of the widget.
*)id : widget_id option;The unique identifier for the widget.
*)}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.
type nonrec widget_list = widget listtype nonrec widget_id_list = Smaws_Lib.Smithy_api.Types.string_ listThe input parameters do not satisfy the requirements. Check the error message for specific validation details.
type nonrec update_scheduled_report_response = {arn : scheduled_report_arn;The ARN of the updated scheduled report.
*)}type nonrec schedule_period = {end_time : generic_time_stamp option;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.
start_time : generic_time_stamp option;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.
*)}Defines the active time period for execution of the scheduled report.
type nonrec schedule_config = {state : schedule_state option;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.
schedule_period : schedule_period option;The time period during which the schedule is active.
*)schedule_expression_time_zone : generic_string option;The time zone for the schedule expression, for example, UTC.
schedule_expression : generic_string option;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).
}Defines the schedule for a scheduled report, including the cron expression, time zone, active period, and the schedule state.
type nonrec update_scheduled_report_request = {clear_widget_date_range_override : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to clear existing widgetDateRangeOverride.
*)clear_widget_ids : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to clear existing widgetIds.
*)widget_date_range_override : date_time_range option;The date range override to apply to widgets in the scheduled report.
*)widget_ids : widget_id_list option;The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.
*)schedule_config : schedule_config option;The updated schedule configuration for the report.
*)scheduled_report_execution_role_arn : service_role_arn option;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.
*)dashboard_arn : dashboard_arn option;The ARN of the dashboard to associate with the scheduled report.
*)description : description option;The new description for the scheduled report.
*)name : scheduled_report_name option;The new name for the scheduled report.
*)arn : scheduled_report_arn;The ARN of the scheduled report to update.
*)}The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
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.
You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
type nonrec update_dashboard_request = {widgets : widget_list option;The updated array of widget configurations for the dashboard. Replaces all existing widgets.
*)description : description option;The new description for the dashboard.
*)name : dashboard_name;The new name for the dashboard.
*)arn : dashboard_arn;The ARN of the dashboard to update.
*)}type nonrec resource_tag_key_list = resource_tag_key listtype nonrec untag_resource_request = {resource_tag_keys : resource_tag_key_list;The keys of the tags to remove from the dashboard resource.
*)resource_arn : resource_arn;The unique identifier for the resource.
*)}type nonrec resource_tag = {value : resource_tag_value;The value of the tag to be attached to the dashboard resource.
*)key : resource_tag_key;The key of the tag to be attached to the dashboard resource.
*)}A key-value pair that can be attached to a dashboard for organization and management purposes.
type nonrec resource_tag_list = resource_tag listtype nonrec tag_resource_request = {resource_arn : resource_arn;The unique identifier for the resource.
*)}type nonrec status_reason_list = status_reason listThe request would exceed a service quota. Review the service quotas for Amazon Web Services Billing and Cost Management Dashboards and retry your request.
type nonrec health_status = {status_reasons : status_reason_list option;The list of reasons for the current health status. Only present when the status is UNHEALTHY.
last_refreshed_at : generic_time_stamp option;The timestamp when the health status was last refreshed.
*)status_code : health_status_code;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.
}Contains the health status information for a scheduled report, including the status code and any reasons for an unhealthy state.
type nonrec scheduled_report_summary = {widget_ids : widget_id_list option;The list of widget identifiers included in the scheduled report.
*)schedule_expression_time_zone : generic_string option;The time zone for the schedule expression, for example, UTC.
health_status : health_status;The health status of the scheduled report as of its last refresh time.
*)state : schedule_state;The state of the schedule: ENABLED or DISABLED.
schedule_expression : generic_string;The schedule expression that defines when the report runs.
*)dashboard_arn : dashboard_arn;The ARN of the dashboard associated with the scheduled report.
*)name : scheduled_report_name;The name of the scheduled report.
*)arn : scheduled_report_arn;The ARN of the scheduled report.
*)}Contains summary information for a scheduled report.
type nonrec scheduled_report_summary_list = scheduled_report_summary listtype nonrec scheduled_report_input = {widget_date_range_override : date_time_range option;The date range override to apply to widgets in the scheduled report.
*)widget_ids : widget_id_list option;The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.
*)description : description option;A description of the scheduled report's purpose or contents.
*)schedule_config : schedule_config;The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED.
scheduled_report_execution_role_arn : service_role_arn;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.
*)dashboard_arn : dashboard_arn;The ARN of the dashboard to generate the scheduled report from.
*)name : scheduled_report_name;The name of the scheduled report.
*)}Defines the configuration for creating a new scheduled report, including the dashboard, schedule, execution role, and optional widget settings.
type nonrec scheduled_report = {health_status : health_status option;The health status of the scheduled report at last refresh time.
*)last_execution_at : generic_time_stamp option;The timestamp of the most recent execution of the scheduled report.
*)updated_at : generic_time_stamp option;The timestamp when the scheduled report was last modified.
*)created_at : generic_time_stamp option;The timestamp when the scheduled report was created.
*)widget_date_range_override : date_time_range option;The date range override applied to widgets in the scheduled report.
*)widget_ids : widget_id_list option;The list of widget identifiers included in the scheduled report.
*)description : description option;A description of the scheduled report's purpose or contents.
*)schedule_config : schedule_config;The schedule configuration that defines when and how often the report is generated.
*)scheduled_report_execution_role_arn : service_role_arn;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.
*)dashboard_arn : dashboard_arn;The ARN of the dashboard associated with the scheduled report.
*)name : scheduled_report_name;The name of the scheduled report.
*)arn : scheduled_report_arn option;The ARN of the scheduled report.
*)}Contains the full configuration and metadata of a scheduled report.
type nonrec list_scheduled_reports_response = {next_token : next_page_token option;The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.
*)scheduled_reports : scheduled_report_summary_list;An array of scheduled report summaries, containing basic information about each scheduled report.
*)}type nonrec list_scheduled_reports_request = {max_results : max_results option;The maximum number of results to return in a single call. Valid range is 1 to 100. The default value is 50.
*)next_token : next_page_token option;The token for the next page of results. Use the value returned in the previous response.
*)}type nonrec dashboard_reference = {updated_at : generic_time_stamp;The timestamp when the dashboard was last modified.
*)created_at : generic_time_stamp;The timestamp when the dashboard was created.
*)type_ : dashboard_type;The dashboard type.
*)description : description option;The description of the referenced dashboard.
*)name : dashboard_name;The name of the referenced dashboard.
*)arn : dashboard_arn;The ARN of the referenced dashboard.
*)}Contains basic information about a dashboard, including its ARN, name, type, and timestamps.
type nonrec dashboard_reference_list = dashboard_reference listtype nonrec list_dashboards_response = {next_token : next_page_token option;The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.
*)dashboards : dashboard_reference_list;An array of dashboard references, containing basic information about each dashboard.
*)}type nonrec list_dashboards_request = {next_token : next_page_token option;The token for the next page of results. Use the value returned in the previous response.
*)max_results : max_results option;The maximum number of results to return in a single call. The default value is 20.
*)}type nonrec get_scheduled_report_response = {scheduled_report : scheduled_report;The scheduled report configuration and metadata.
*)}type nonrec get_scheduled_report_request = {arn : scheduled_report_arn;The ARN of the scheduled report to retrieve.
*)}type nonrec get_resource_policy_response = {policy_document : generic_string;The JSON policy document that represents the dashboard's resource-based policy.
*)resource_arn : dashboard_arn;The ARN of the dashboard for which the resource-based policy was retrieved.
*)}type nonrec get_resource_policy_request = {resource_arn : dashboard_arn;The ARN of the dashboard whose resource-based policy you want to retrieve.
*)}type nonrec get_dashboard_response = {updated_at : generic_time_stamp;The timestamp when the dashboard was last modified.
*)created_at : generic_time_stamp;The timestamp when the dashboard was created.
*)widgets : widget_list;An array of widget configurations that make up the dashboard.
*)type_ : dashboard_type;Indicates the dashboard type.
*)description : description option;The description of the retrieved dashboard.
*)name : dashboard_name;The name of the retrieved dashboard.
*)arn : dashboard_arn;The ARN of the retrieved dashboard.
*)}type nonrec get_dashboard_request = {arn : dashboard_arn;The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.
*)}type nonrec execute_scheduled_report_response = {execution_triggered : Smaws_Lib.Smithy_api.Types.boolean_ option;Indicates whether the execution was successfully triggered.
*)health_status : health_status option;The health status of the scheduled report after the execution request.
*)}type nonrec execute_scheduled_report_request = {dry_run : Smaws_Lib.Smithy_api.Types.boolean_ option;When set to true, validates the scheduled report configuration without triggering an actual execution.
client_token : client_token option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*)arn : scheduled_report_arn;The ARN of the scheduled report to execute.
*)}type nonrec delete_scheduled_report_response = {arn : scheduled_report_arn;The ARN of the scheduled report that was deleted.
*)}type nonrec delete_scheduled_report_request = {arn : scheduled_report_arn;The ARN of the scheduled report to delete.
*)}type nonrec delete_dashboard_response = {arn : dashboard_arn;The ARN of the dashboard that was deleted.
*)}type nonrec delete_dashboard_request = {arn : dashboard_arn;The ARN of the dashboard to be deleted.
*)}type nonrec create_scheduled_report_response = {arn : scheduled_report_arn;The ARN of the newly created scheduled report.
*)}type nonrec create_scheduled_report_request = {client_token : client_token option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*)scheduled_report : scheduled_report_input;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.
*)}type nonrec create_dashboard_response = {arn : dashboard_arn;The ARN of the newly created dashboard.
*)}type nonrec create_dashboard_request = {widgets : widget_list;An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.
*)description : description option;A description of the dashboard's purpose or contents.
*)name : dashboard_name;The name of the dashboard. The name must be unique within your account.
*)}