Smaws_Client_BCMDashboards (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_date_time_value : 
  value:Types.generic_string ->
  type_:Types.date_time_type ->
  unit ->
  Types.date_time_value

val make_date_time_range : 
  end_time:Types.date_time_value ->
  start_time:Types.date_time_value ->
  unit ->
  Types.date_time_range

val make_group_definition : 
  ?type_:Types.group_definition_type ->
  key:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.group_definition

val make_dimension_values : 
  ?match_options:Types.match_options ->
  values:Types.string_list ->
  key:Types.dimension ->
  unit ->
  Types.dimension_values

val make_tag_values : 
  ?match_options:Types.match_options ->
  ?values:Types.string_list ->
  ?key:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.tag_values

val make_cost_category_values : 
  ?match_options:Types.match_options ->
  ?values:Types.string_list ->
  ?key:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.cost_category_values

val make_expression : 
  ?cost_categories:Types.cost_category_values ->
  ?tags:Types.tag_values ->
  ?dimensions:Types.dimension_values ->
  ?not:Types.expression ->
  ?and_:Types.expressions ->
  ?or:Types.expressions ->
  unit ->
  Types.expression

val make_cost_and_usage_query : 
  ?filter:Types.expression ->
  ?group_by:Types.group_definitions ->
  granularity:Types.granularity ->
  time_range:Types.date_time_range ->
  metrics:Types.metric_names ->
  unit ->
  Types.cost_and_usage_query

val make_savings_plans_coverage_query : 
  ?filter:Types.expression ->
  ?group_by:Types.group_definitions ->
  ?granularity:Types.granularity ->
  ?metrics:Types.metric_names ->
  time_range:Types.date_time_range ->
  unit ->
  Types.savings_plans_coverage_query

val make_savings_plans_utilization_query : 
  ?filter:Types.expression ->
  ?granularity:Types.granularity ->
  time_range:Types.date_time_range ->
  unit ->
  Types.savings_plans_utilization_query

val make_reservation_coverage_query : 
  ?metrics:Types.metric_names ->
  ?filter:Types.expression ->
  ?granularity:Types.granularity ->
  ?group_by:Types.group_definitions ->
  time_range:Types.date_time_range ->
  unit ->
  Types.reservation_coverage_query

val make_reservation_utilization_query : 
  ?filter:Types.expression ->
  ?granularity:Types.granularity ->
  ?group_by:Types.group_definitions ->
  time_range:Types.date_time_range ->
  unit ->
  Types.reservation_utilization_query

val make_graph_display_config : 
  visual_type:Types.visual_type ->
  unit ->
  Types.graph_display_config

val make_table_display_config_struct : unit -> unit

val make_widget_config : 
  display_config:Types.display_config ->
  query_parameters:Types.query_parameters ->
  unit ->
  Types.widget_config

val make_widget : 
  ?horizontal_offset:Smaws_Lib.Smithy_api.Types.integer ->
  ?height:Types.widget_height ->
  ?width:Types.widget_width ->
  ?description:Types.description ->
  ?id:Types.widget_id ->
  configs:Types.widget_config_list ->
  title:Types.widget_title ->
  unit ->
  Types.widget

val make_update_scheduled_report_response : 
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.update_scheduled_report_response

val make_schedule_period : 
  ?end_time:Types.generic_time_stamp ->
  ?start_time:Types.generic_time_stamp ->
  unit ->
  Types.schedule_period

val make_schedule_config : 
  ?state:Types.schedule_state ->
  ?schedule_period:Types.schedule_period ->
  ?schedule_expression_time_zone:Types.generic_string ->
  ?schedule_expression:Types.generic_string ->
  unit ->
  Types.schedule_config

val make_update_scheduled_report_request : 
  ?clear_widget_date_range_override:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?clear_widget_ids:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?widget_date_range_override:Types.date_time_range ->
  ?widget_ids:Types.widget_id_list ->
  ?schedule_config:Types.schedule_config ->
  ?scheduled_report_execution_role_arn:Types.service_role_arn ->
  ?dashboard_arn:Types.dashboard_arn ->
  ?description:Types.description ->
  ?name:Types.scheduled_report_name ->
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.update_scheduled_report_request

val make_update_dashboard_response : 
  arn:Types.dashboard_arn ->
  unit ->
  Types.update_dashboard_response

val make_update_dashboard_request : 
  ?widgets:Types.widget_list ->
  ?description:Types.description ->
  name:Types.dashboard_name ->
  arn:Types.dashboard_arn ->
  unit ->
  Types.update_dashboard_request

val make_untag_resource_response : unit -> unit

val make_untag_resource_request : 
  resource_tag_keys:Types.resource_tag_key_list ->
  resource_arn:Types.resource_arn ->
  unit ->
  Types.untag_resource_request

val make_tag_resource_response : unit -> unit

val make_resource_tag : 
  value:Types.resource_tag_value ->
  key:Types.resource_tag_key ->
  unit ->
  Types.resource_tag

val make_tag_resource_request : 
  resource_tags:Types.resource_tag_list ->
  resource_arn:Types.resource_arn ->
  unit ->
  Types.tag_resource_request

val make_health_status : 
  ?status_reasons:Types.status_reason_list ->
  ?last_refreshed_at:Types.generic_time_stamp ->
  status_code:Types.health_status_code ->
  unit ->
  Types.health_status

val make_scheduled_report_summary : 
  ?widget_ids:Types.widget_id_list ->
  ?schedule_expression_time_zone:Types.generic_string ->
  health_status:Types.health_status ->
  state:Types.schedule_state ->
  schedule_expression:Types.generic_string ->
  dashboard_arn:Types.dashboard_arn ->
  name:Types.scheduled_report_name ->
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.scheduled_report_summary

val make_scheduled_report_input : 
  ?widget_date_range_override:Types.date_time_range ->
  ?widget_ids:Types.widget_id_list ->
  ?description:Types.description ->
  schedule_config:Types.schedule_config ->
  scheduled_report_execution_role_arn:Types.service_role_arn ->
  dashboard_arn:Types.dashboard_arn ->
  name:Types.scheduled_report_name ->
  unit ->
  Types.scheduled_report_input

val make_scheduled_report : 
  ?health_status:Types.health_status ->
  ?last_execution_at:Types.generic_time_stamp ->
  ?updated_at:Types.generic_time_stamp ->
  ?created_at:Types.generic_time_stamp ->
  ?widget_date_range_override:Types.date_time_range ->
  ?widget_ids:Types.widget_id_list ->
  ?description:Types.description ->
  ?arn:Types.scheduled_report_arn ->
  schedule_config:Types.schedule_config ->
  scheduled_report_execution_role_arn:Types.service_role_arn ->
  dashboard_arn:Types.dashboard_arn ->
  name:Types.scheduled_report_name ->
  unit ->
  Types.scheduled_report

val make_list_tags_for_resource_response : 
  ?resource_tags:Types.resource_tag_list ->
  unit ->
  Types.list_tags_for_resource_response

val make_list_tags_for_resource_request : 
  resource_arn:Types.resource_arn ->
  unit ->
  Types.list_tags_for_resource_request

val make_list_scheduled_reports_response : 
  ?next_token:Types.next_page_token ->
  scheduled_reports:Types.scheduled_report_summary_list ->
  unit ->
  Types.list_scheduled_reports_response

val make_list_scheduled_reports_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_page_token ->
  unit ->
  Types.list_scheduled_reports_request

val make_dashboard_reference : 
  ?description:Types.description ->
  updated_at:Types.generic_time_stamp ->
  created_at:Types.generic_time_stamp ->
  type_:Types.dashboard_type ->
  name:Types.dashboard_name ->
  arn:Types.dashboard_arn ->
  unit ->
  Types.dashboard_reference

val make_list_dashboards_response : 
  ?next_token:Types.next_page_token ->
  dashboards:Types.dashboard_reference_list ->
  unit ->
  Types.list_dashboards_response

val make_list_dashboards_request : 
  ?next_token:Types.next_page_token ->
  ?max_results:Types.max_results ->
  unit ->
  Types.list_dashboards_request

val make_get_scheduled_report_response : 
  scheduled_report:Types.scheduled_report ->
  unit ->
  Types.get_scheduled_report_response

val make_get_scheduled_report_request : 
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.get_scheduled_report_request

val make_get_resource_policy_response : 
  policy_document:Types.generic_string ->
  resource_arn:Types.dashboard_arn ->
  unit ->
  Types.get_resource_policy_response

val make_get_resource_policy_request : 
  resource_arn:Types.dashboard_arn ->
  unit ->
  Types.get_resource_policy_request

val make_get_dashboard_response : 
  ?description:Types.description ->
  updated_at:Types.generic_time_stamp ->
  created_at:Types.generic_time_stamp ->
  widgets:Types.widget_list ->
  type_:Types.dashboard_type ->
  name:Types.dashboard_name ->
  arn:Types.dashboard_arn ->
  unit ->
  Types.get_dashboard_response

val make_get_dashboard_request : 
  arn:Types.dashboard_arn ->
  unit ->
  Types.get_dashboard_request

val make_execute_scheduled_report_response : 
  ?execution_triggered:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?health_status:Types.health_status ->
  unit ->
  Types.execute_scheduled_report_response

val make_execute_scheduled_report_request : 
  ?dry_run:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?client_token:Types.client_token ->
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.execute_scheduled_report_request

val make_delete_scheduled_report_response : 
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.delete_scheduled_report_response

val make_delete_scheduled_report_request : 
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.delete_scheduled_report_request

val make_delete_dashboard_response : 
  arn:Types.dashboard_arn ->
  unit ->
  Types.delete_dashboard_response

val make_delete_dashboard_request : 
  arn:Types.dashboard_arn ->
  unit ->
  Types.delete_dashboard_request

val make_create_scheduled_report_response : 
  arn:Types.scheduled_report_arn ->
  unit ->
  Types.create_scheduled_report_response

val make_create_scheduled_report_request : 
  ?client_token:Types.client_token ->
  ?resource_tags:Types.resource_tag_list ->
  scheduled_report:Types.scheduled_report_input ->
  unit ->
  Types.create_scheduled_report_request

val make_create_dashboard_response : 
  arn:Types.dashboard_arn ->
  unit ->
  Types.create_dashboard_response

val make_create_dashboard_request : 
  ?resource_tags:Types.resource_tag_list ->
  ?description:Types.description ->
  widgets:Types.widget_list ->
  name:Types.dashboard_name ->
  unit ->
  Types.create_dashboard_request

Operations

module CreateDashboard : sig ... end

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.

module CreateScheduledReport : sig ... end

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.

module DeleteDashboard : sig ... end

Deletes a specified dashboard. This action cannot be undone.

module DeleteScheduledReport : sig ... end

Deletes a specified scheduled report. This is an irreversible operation.

module ExecuteScheduledReport : sig ... end

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.

module GetDashboard : sig ... end

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

module GetResourcePolicy : sig ... end

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

module GetScheduledReport : sig ... end

Retrieves the configuration and metadata of a specified scheduled report.

module ListDashboards : sig ... end

Returns a list of all dashboards in your account.

module ListScheduledReports : sig ... end

Returns a list of scheduled reports in your account.

module ListTagsForResource : sig ... end

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

module TagResource : sig ... end

Adds or updates tags for a specified dashboard resource.

module UntagResource : sig ... end

Removes specified tags from a dashboard resource.

module UpdateDashboard : sig ... end

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

module UpdateScheduledReport : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end