Module Smaws_Client_PI

PI client library built on EIO.

Types

module Types : sig ... end

Builders

val make_untag_resource_response : unit -> unit
val make_untag_resource_request : tag_keys:Types.tag_key_list -> resource_ar_n:Types.amazon_resource_name -> service_type:Types.service_type -> unit -> Types.untag_resource_request
val make_tag_resource_response : unit -> unit
val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_request : tags:Types.tag_list -> resource_ar_n:Types.amazon_resource_name -> service_type:Types.service_type -> unit -> Types.tag_resource_request
val make_response_resource_metric : ?unit_:Types.string_ -> ?description:Types.description -> ?metric:Types.string_ -> unit -> Types.response_resource_metric
val make_response_resource_metric_key : ?dimensions:Types.dimension_map -> metric:Types.string_ -> unit -> Types.response_resource_metric_key
val make_response_partition_key : dimensions:Types.dimension_map -> unit -> Types.response_partition_key
val make_recommendation : ?recommendation_description:Types.markdown_string -> ?recommendation_id:Types.string_ -> unit -> Types.recommendation
val make_list_tags_for_resource_response : ?tags:Types.tag_list -> unit -> Types.list_tags_for_resource_response
val make_list_tags_for_resource_request : resource_ar_n:Types.amazon_resource_name -> service_type:Types.service_type -> unit -> Types.list_tags_for_resource_request
val make_analysis_report_summary : ?tags:Types.tag_list -> ?status:Types.analysis_status -> ?end_time:Types.iso_timestamp -> ?start_time:Types.iso_timestamp -> ?create_time:Types.iso_timestamp -> ?analysis_report_id:Types.string_ -> unit -> Types.analysis_report_summary
val make_list_performance_analysis_reports_response : ?next_token:Types.next_token -> ?analysis_reports:Types.analysis_report_summary_list -> unit -> Types.list_performance_analysis_reports_response
val make_list_performance_analysis_reports_request : ?list_tags:Types.boolean_ -> ?max_results:Types.max_results -> ?next_token:Types.next_token -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.list_performance_analysis_reports_request
val make_list_available_resource_metrics_response : ?next_token:Types.next_token -> ?metrics:Types.response_resource_metric_list -> unit -> Types.list_available_resource_metrics_response
val make_list_available_resource_metrics_request : ?max_results:Types.max_results -> ?next_token:Types.next_token -> metric_types:Types.metric_type_list -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.list_available_resource_metrics_request
val make_dimension_detail : ?identifier:Types.string_ -> unit -> Types.dimension_detail
val make_dimension_group_detail : ?dimensions:Types.dimension_detail_list -> ?group:Types.string_ -> unit -> Types.dimension_group_detail
val make_metric_dimension_groups : ?groups:Types.dimension_group_detail_list -> ?metric:Types.string_ -> unit -> Types.metric_dimension_groups
val make_list_available_resource_dimensions_response : ?next_token:Types.next_token -> ?metric_dimensions:Types.metric_dimensions_list -> unit -> Types.list_available_resource_dimensions_response
val make_list_available_resource_dimensions_request : ?authorized_actions:Types.authorized_actions_list -> ?next_token:Types.next_token -> ?max_results:Types.max_results -> metrics:Types.dimensions_metric_list -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.list_available_resource_dimensions_request
val make_data_point : value:Types.double -> timestamp:Types.iso_timestamp -> unit -> Types.data_point
val make_metric_key_data_points : ?data_points:Types.data_points_list -> ?key:Types.response_resource_metric_key -> unit -> Types.metric_key_data_points
val make_get_resource_metrics_response : ?next_token:Types.next_token -> ?metric_list:Types.metric_key_data_points_list -> ?identifier:Types.string_ -> ?aligned_end_time:Types.iso_timestamp -> ?aligned_start_time:Types.iso_timestamp -> unit -> Types.get_resource_metrics_response
val make_dimension_group : ?limit:Types.limit -> ?dimensions:Types.sanitized_string_list -> group:Types.sanitized_string -> unit -> Types.dimension_group
val make_metric_query : ?filter:Types.metric_query_filter_map -> ?group_by:Types.dimension_group -> metric:Types.sanitized_string -> unit -> Types.metric_query
val make_get_resource_metrics_request : ?period_alignment:Types.period_alignment -> ?next_token:Types.next_token -> ?max_results:Types.max_results -> ?period_in_seconds:Types.integer -> end_time:Types.iso_timestamp -> start_time:Types.iso_timestamp -> metric_queries:Types.metric_query_list -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.get_resource_metrics_request
val make_feature_metadata : ?status:Types.feature_status -> unit -> Types.feature_metadata
val make_get_resource_metadata_response : ?features:Types.feature_metadata_map -> ?identifier:Types.string_ -> unit -> Types.get_resource_metadata_response
val make_get_resource_metadata_request : identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.get_resource_metadata_request
val make_performance_insights_metric : ?value:Types.double -> ?filter:Types.descriptive_map -> ?dimensions:Types.descriptive_map -> ?display_name:Types.descriptive_string -> ?metric:Types.descriptive_string -> unit -> Types.performance_insights_metric
val make_data : ?performance_insights_metric:Types.performance_insights_metric -> unit -> Types.data
val make_insight : ?baseline_data:Types.data_list -> ?insight_data:Types.data_list -> ?recommendations:Types.recommendation_list -> ?description:Types.markdown_string -> ?supporting_insights:Types.insight_list -> ?severity:Types.severity -> ?end_time:Types.iso_timestamp -> ?start_time:Types.iso_timestamp -> ?context:Types.context_type -> ?insight_type:Types.string_ -> insight_id:Types.string_ -> unit -> Types.insight
val make_analysis_report : ?insights:Types.insight_list -> ?status:Types.analysis_status -> ?end_time:Types.iso_timestamp -> ?start_time:Types.iso_timestamp -> ?create_time:Types.iso_timestamp -> ?service_type:Types.service_type -> ?identifier:Types.identifier_string -> analysis_report_id:Types.analysis_report_id -> unit -> Types.analysis_report
val make_get_performance_analysis_report_response : ?analysis_report:Types.analysis_report -> unit -> Types.get_performance_analysis_report_response
val make_get_performance_analysis_report_request : ?accept_language:Types.accept_language -> ?text_format:Types.text_format -> analysis_report_id:Types.analysis_report_id -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.get_performance_analysis_report_request
val make_dimension_key_detail : ?status:Types.detail_status -> ?dimension:Types.string_ -> ?value:Types.string_ -> unit -> Types.dimension_key_detail
val make_get_dimension_key_details_response : ?dimensions:Types.dimension_key_detail_list -> unit -> Types.get_dimension_key_details_response
val make_get_dimension_key_details_request : ?requested_dimensions:Types.requested_dimension_list -> group_identifier:Types.request_string -> group:Types.request_string -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.get_dimension_key_details_request
val make_dimension_key_description : ?partitions:Types.metric_values_list -> ?additional_metrics:Types.additional_metrics_map -> ?total:Types.double -> ?dimensions:Types.dimension_map -> unit -> Types.dimension_key_description
val make_describe_dimension_keys_response : ?next_token:Types.next_token -> ?keys:Types.dimension_key_description_list -> ?partition_keys:Types.response_partition_key_list -> ?aligned_end_time:Types.iso_timestamp -> ?aligned_start_time:Types.iso_timestamp -> unit -> Types.describe_dimension_keys_response
val make_describe_dimension_keys_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> ?filter:Types.metric_query_filter_map -> ?partition_by:Types.dimension_group -> ?additional_metrics:Types.additional_metrics_list -> ?period_in_seconds:Types.integer -> group_by:Types.dimension_group -> metric:Types.request_string -> end_time:Types.iso_timestamp -> start_time:Types.iso_timestamp -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.describe_dimension_keys_request
val make_delete_performance_analysis_report_response : unit -> unit
val make_delete_performance_analysis_report_request : analysis_report_id:Types.analysis_report_id -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.delete_performance_analysis_report_request
val make_create_performance_analysis_report_response : ?analysis_report_id:Types.analysis_report_id -> unit -> Types.create_performance_analysis_report_response
val make_create_performance_analysis_report_request : ?tags:Types.tag_list -> end_time:Types.iso_timestamp -> start_time:Types.iso_timestamp -> identifier:Types.identifier_string -> service_type:Types.service_type -> unit -> Types.create_performance_analysis_report_request

Operations

module CreatePerformanceAnalysisReport : sig ... end

Creates a new performance analysis report for a specific time period for the DB instance.

module DeletePerformanceAnalysisReport : sig ... end

Deletes a performance analysis report.

module DescribeDimensionKeys : sig ... end

For a specific time period, retrieve the top N dimension keys for a metric.

module GetDimensionKeyDetails : sig ... end

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text, lock snapshots, and execution plans.

module GetPerformanceAnalysisReport : sig ... end

Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.

module GetResourceMetadata : sig ... end

Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

module GetResourceMetrics : sig ... end

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.

module ListAvailableResourceDimensions : sig ... end

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

module ListAvailableResourceMetrics : sig ... end

Retrieve metrics of the specified types that can be queried for a specified DB instance.

module ListPerformanceAnalysisReports : sig ... end

Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

module ListTagsForResource : sig ... end

Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

module TagResource : sig ... end

Adds metadata tags to the Amazon RDS Performance Insights resource.

module UntagResource : sig ... end

Deletes the metadata tags from the Amazon RDS Performance Insights resource.

module Json_serializers : sig ... end
module Json_deserializers : sig ... end