Module Smaws_Client_PI

PI client library built on EIO.

Types

type untag_resource_response = unit
type service_type =
  1. | DOCDB
  2. | RDS
type untag_resource_request = {
  1. tag_keys : string list;
    (*

    The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.

    *)
  2. resource_ar_n : string;
    (*

    The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    *)
  3. service_type : service_type;
    (*

    List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

    *)
}
type not_authorized_exception = {
  1. message : string option;
}

The user is not authorized to perform this request.

type invalid_argument_exception = {
  1. message : string option;
}

One of the arguments provided is invalid for this request.

type internal_service_error = {
  1. message : string option;
}

The request failed due to an unknown error.

type text_format =
  1. | MARKDOWN
  2. | PLAIN_TEXT
type tag_resource_response = unit
type tag = {
  1. value : string;
    (*

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

    *)
  2. key : string;
    (*

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

    *)
}

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

type tag_resource_request = {
  1. tags : tag list;
    (*

    The metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    *)
  2. resource_ar_n : string;
    (*

    The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    *)
  3. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

    *)
}
type severity =
  1. | HIGH
  2. | MEDIUM
  3. | LOW
type response_resource_metric = {
  1. unit_ : string option;
    (*

    The unit of the metric.

    *)
  2. description : string option;
    (*

    The description of the metric.

    *)
  3. metric : string option;
    (*

    The full name of the metric.

    *)
}

An object that contains the full name, description, and unit of a metric.

type response_resource_metric_key = {
  1. dimensions : (string * string) list option;
    (*

    The valid dimensions for the metric.

    *)
  2. metric : string;
    (*

    The name of a Performance Insights metric to be measured.

    Valid values for Metric are:

    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

    *)
}

An object describing a Performance Insights metric and one or more dimensions for that metric.

type response_partition_key = {
  1. dimensions : (string * string) list;
    (*

    A dimension map that contains the dimensions for this partition.

    *)
}

If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.

type recommendation = {
  1. recommendation_description : string option;
    (*

    The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id

    *)
  2. recommendation_id : string option;
    (*

    The unique identifier for the recommendation.

    *)
}

The list of recommendations for the insight.

type period_alignment =
  1. | START_TIME
  2. | END_TIME
type list_tags_for_resource_response = {
  1. tags : tag list option;
    (*

    The metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    *)
}
type list_tags_for_resource_request = {
  1. resource_ar_n : string;
    (*

    Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    *)
  2. service_type : service_type;
    (*

    List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

    *)
}
type analysis_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | RUNNING
type analysis_report_summary = {
  1. tags : tag list option;
    (*

    List of all the tags added to the analysis report.

    *)
  2. status : analysis_status option;
    (*

    The status of the analysis report.

    *)
  3. end_time : float option;
    (*

    The end time of the analysis in the report.

    *)
  4. start_time : float option;
    (*

    The start time of the analysis in the report.

    *)
  5. create_time : float option;
    (*

    The time you created the analysis report.

    *)
  6. analysis_report_id : string option;
    (*

    The name of the analysis report.

    *)
}

Retrieves the details of the performance analysis report.

type list_performance_analysis_reports_response = {
  1. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.

    *)
  2. analysis_reports : analysis_report_summary list option;
    (*

    List of reports including the report identifier, start and end time, creation time, and status.

    *)
}
type list_performance_analysis_reports_request = {
  1. list_tags : bool option;
    (*

    Specifies whether or not to include the list of tags in the response.

    *)
  2. max_results : int option;
    (*

    The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a pagination token is included in the response so that the remaining results can be retrieved.

    *)
  3. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.

    *)
  4. identifier : string;
    (*

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

    *)
  5. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

    *)
}
type list_available_resource_metrics_response = {
  1. next_token : string option;
    (*

    A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

    *)
  2. metrics : response_resource_metric list option;
    (*

    An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.

    *)
}
type list_available_resource_metrics_request = {
  1. max_results : int option;
    (*

    The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.

    *)
  2. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

    *)
  3. metric_types : string list;
    (*

    The types of metrics to return in the response. Valid values in the array include the following:

    • os (OS counter metrics) - All engines
    • db (DB load metrics) - All engines except for Amazon DocumentDB
    • db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
    • db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB
    *)
  4. identifier : string;
    (*

    An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

    *)
  5. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights returns metrics.

    *)
}
type dimension_detail = {
  1. identifier : string option;
    (*

    The identifier of a dimension.

    *)
}

The information about a dimension.

type dimension_group_detail = {
  1. dimensions : dimension_detail list option;
    (*

    The dimensions within a dimension group.

    *)
  2. group : string option;
    (*

    The name of the dimension group.

    *)
}

Information about dimensions within a dimension group.

type metric_dimension_groups = {
  1. groups : dimension_group_detail list option;
    (*

    The available dimension groups for a metric type.

    *)
  2. metric : string option;
    (*

    The metric type to which the dimension information belongs.

    *)
}

The available dimension information for a metric type.

type list_available_resource_dimensions_response = {
  1. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

    *)
  2. metric_dimensions : metric_dimension_groups list option;
    (*

    The dimension information returned for requested metric types.

    *)
}
type fine_grained_action =
  1. | GET_RESOURCE_METRICS
  2. | GET_DIMENSION_KEY_DETAILS
  3. | DESCRIBE_DIMENSION_KEYS
type list_available_resource_dimensions_request = {
  1. authorized_actions : fine_grained_action list option;
    (*

    The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions.

    When you don't specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them.

    *)
  2. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

    *)
  3. max_results : int option;
    (*

    The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

    *)
  4. metrics : string list;
    (*

    The types of metrics for which to retrieve dimensions. Valid values include db.load.

    *)
  5. identifier : string;
    (*

    An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

    *)
  6. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights returns metrics.

    *)
}
type data_point = {
  1. value : float;
    (*

    The actual value associated with a particular Timestamp.

    *)
  2. timestamp_ : float;
    (*

    The time, in epoch format, associated with a particular Value.

    *)
}

A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

type metric_key_data_points = {
  1. data_points : data_point list option;
    (*

    An array of timestamp-value pairs, representing measurements over a period of time.

    *)
  2. key : response_resource_metric_key option;
    (*

    The dimensions to which the data points apply.

    *)
}

A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.

type get_resource_metrics_response = {
  1. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

    *)
  2. metric_list : metric_key_data_points list option;
    (*

    An array of metric results, where each array element contains all of the data points for a particular dimension.

    *)
  3. identifier : string option;
    (*

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    *)
  4. aligned_end_time : float option;
    (*

    The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

    *)
  5. aligned_start_time : float option;
    (*

    The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

    *)
}
type dimension_group = {
  1. limit : int option;
    (*

    The maximum number of items to fetch for this dimension group.

    *)
  2. dimensions : string list option;
    (*

    A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.

    Valid values for elements in the Dimensions array are:

    • db.application.name - The name of the application that is connected to the database. Valid values are as follows:

      • Aurora PostgreSQL
      • Amazon RDS PostgreSQL
      • Amazon DocumentDB
    • db.host.id - The host ID of the connected client (all engines).
    • db.host.name - The host name of the connected client (all engines).

    • db.name - The name of the database to which the client is connected. Valid values are as follows:

      • Aurora PostgreSQL
      • Amazon RDS PostgreSQL
      • Aurora MySQL
      • Amazon RDS MySQL
      • Amazon RDS MariaDB
      • Amazon DocumentDB
    • db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).
    • db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).
    • db.query.statement - The text of the query that is being run (only Amazon DocumentDB).
    • db.query.tokenized_id
    • db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
    • db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
    • db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).
    • db.session_type.name - The type of the current session (only Amazon DocumentDB).
    • db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
    • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).
    • db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)
    • db.sql.tokenized_id
    • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.
    • db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).
    • db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)
    • db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).
    • db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).
    • db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).
    • db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
    • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).
    • db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).
    *)
  3. group : string;
    (*

    The name of the dimension group. Valid values are as follows:

    • db - The name of the database to which the client is connected. The following values are permitted:

      • Aurora PostgreSQL
      • Amazon RDS PostgreSQL
      • Aurora MySQL
      • Amazon RDS MySQL
      • Amazon RDS MariaDB
      • Amazon DocumentDB

    • db.application - The name of the application that is connected to the database. The following values are permitted:

      • Aurora PostgreSQL
      • Amazon RDS PostgreSQL
      • Amazon DocumentDB
    • db.host - The host name of the connected client (all engines).
    • db.query - The query that is currently running (only Amazon DocumentDB).
    • db.query_tokenized - The digest query (only Amazon DocumentDB).
    • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
    • db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
    • db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).
    • db.user - The user logged in to the database (all engines except Amazon DocumentDB).
    • db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).
    • db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
    • db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).
    *)
}

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:

  • db.sql.id - The hash of a running SQL statement, generated by Performance Insights.
  • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.
  • db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.
  • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

type metric_query = {
  1. filter : (string * string) list option;
    (*

    One or more filters to apply in the request. Restrictions:

    • Any number of filters by the same dimension, as specified in the GroupBy parameter.
    • A single filter for any other dimension in this dimension group.
    *)
  2. group_by : dimension_group option;
    (*

    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

    *)
  3. metric : string;
    (*

    The name of a Performance Insights metric to be measured.

    Valid values for Metric are:

    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

    *)
}

A single query to be processed. You must provide the metric to query and append an aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return only those data points that match your criteria (Filter).

type get_resource_metrics_request = {
  1. period_alignment : period_alignment option;
    (*

    The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

    *)
  2. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

    *)
  3. max_results : int option;
    (*

    The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

    *)
  4. period_in_seconds : int option;
    (*

    The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

    • 1 (one second)
    • 60 (one minute)
    • 300 (five minutes)
    • 3600 (one hour)
    • 86400 (twenty-four hours)

    If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

    *)
  5. end_time : float;
    (*

    The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.

    The value for EndTime must be later than the value for StartTime.

    *)
  6. start_time : float;
    (*

    The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.

    The value for StartTime must be earlier than the value for EndTime.

    *)
  7. metric_queries : metric_query list;
    (*

    An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

    *)
  8. identifier : string;
    (*

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

    *)
  9. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

    • RDS
    • DOCDB
    *)
}
type feature_status =
  1. | UNKNOWN
  2. | DISABLED_PENDING_REBOOT
  3. | ENABLED_PENDING_REBOOT
  4. | UNSUPPORTED
  5. | DISABLED
  6. | ENABLED
type feature_metadata = {
  1. status : feature_status option;
    (*

    The status of the feature on the DB instance. Possible values include the following:

    • ENABLED - The feature is enabled on the instance.
    • DISABLED - The feature is disabled on the instance.
    • UNSUPPORTED - The feature isn't supported on the instance.
    • ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.
    • DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.
    • UNKNOWN - The feature status couldn't be determined.
    *)
}

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

type get_resource_metadata_response = {
  1. features : (string * feature_metadata) list option;
    (*

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

    *)
  2. identifier : string option;
    (*

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

    *)
}
type get_resource_metadata_request = {
  1. identifier : string;
    (*

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

    *)
  2. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights returns metrics.

    *)
}
type context_type =
  1. | CONTEXTUAL
  2. | CAUSAL
type performance_insights_metric = {
  1. value : float option;
    (*

    The value of the metric. For example, 9 for db.load.avg.

    *)
  2. dimensions : (string * string) list option;
    (*

    A dimension map that contains the dimensions for this partition.

    *)
  3. display_name : string option;
    (*

    The Performance Insights metric name.

    *)
  4. metric : string option;
    (*

    The Performance Insights metric.

    *)
}

This data type helps to determine Performance Insights metric to render for the insight.

type data = {
  1. performance_insights_metric : performance_insights_metric option;
    (*

    This field determines the Performance Insights metric to render for the insight. The name field refers to a Performance Insights metric.

    *)
}

List of data objects which provide details about source metrics. This field can be used to determine the PI metric to render for the insight. This data type also includes static values for the metrics for the Insight that were calculated and included in text and annotations on the DB load chart.

type insight = {
  1. baseline_data : data list option;
    (*

    Metric names and values from the timeframe used as baseline to generate the insight.

    *)
  2. insight_data : data list option;
    (*

    List of data objects containing metrics and references from the time range while generating the insight.

    *)
  3. recommendations : recommendation list option;
    (*

    List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id.

    *)
  4. description : string option;
    (*

    Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.

    *)
  5. supporting_insights : insight list option;
    (*

    List of supporting insights that provide additional factors for the insight.

    *)
  6. severity : severity option;
    (*

    The severity of the insight. The values are: Low, Medium, or High.

    *)
  7. end_time : float option;
    (*

    The end time of the insight. For example, 2018-10-30T00:00:00Z.

    *)
  8. start_time : float option;
    (*

    The start time of the insight. For example, 2018-10-30T00:00:00Z.

    *)
  9. context : context_type option;
    (*

    Indicates if the insight is causal or correlated insight.

    *)
  10. insight_type : string option;
    (*

    The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.

    *)
  11. insight_id : string;
    (*

    The unique identifier for the insight. For example, insight-12345678901234567.

    *)
}
type analysis_report = {
  1. insights : insight list option;
    (*

    The list of identified insights in the analysis report.

    *)
  2. status : analysis_status option;
    (*

    The status of the created analysis report.

    *)
  3. end_time : float option;
    (*

    The analysis end time in the report.

    *)
  4. start_time : float option;
    (*

    The analysis start time in the report.

    *)
  5. create_time : float option;
    (*

    The time you created the analysis report.

    *)
  6. service_type : service_type option;
    (*

    List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

    • RDS
    • DOCDB
    *)
  7. identifier : string option;
    (*

    The unique identifier of the analysis report.

    *)
  8. analysis_report_id : string;
    (*

    The name of the analysis report.

    *)
}

Retrieves the summary of the performance analysis report created for a time period.

type get_performance_analysis_report_response = {
  1. analysis_report : analysis_report option;
    (*

    The summary of the performance analysis report created for a time period.

    *)
}
type accept_language =
  1. | EN_US
type get_performance_analysis_report_request = {
  1. accept_language : accept_language option;
    (*

    The text language in the report. The default language is EN_US (English).

    *)
  2. text_format : text_format option;
    (*

    Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.

    *)
  3. analysis_report_id : string;
    (*

    A unique identifier of the created analysis report. For example, report-12345678901234567

    *)
  4. identifier : string;
    (*

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

    *)
  5. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

    *)
}
type detail_status =
  1. | UNAVAILABLE
  2. | PROCESSING
  3. | AVAILABLE
type dimension_key_detail = {
  1. status : detail_status option;
    (*

    The status of the dimension detail data. Possible values include the following:

    • AVAILABLE - The dimension detail data is ready to be retrieved.
    • PROCESSING - The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the status PROCESSING, Performance Insights returns the truncated query.
    • UNAVAILABLE - The dimension detail data could not be collected successfully.
    *)
  2. dimension : string option;
    (*

    The full name of the dimension. The full name includes the group name and key name. The following values are valid:

    • db.query.statement (Amazon DocumentDB)
    • db.sql.statement (Amazon RDS and Aurora)
    *)
  3. value : string option;
    (*

    The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

    • db.query.statement (Amazon DocumentDB)
    • db.sql.statement (Amazon RDS and Aurora)
    *)
}

An object that describes the details for a specified dimension.

type get_dimension_key_details_response = {
  1. dimensions : dimension_key_detail list option;
    (*

    The details for the requested dimensions.

    *)
}
type get_dimension_key_details_request = {
  1. requested_dimensions : string list option;
    (*

    A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

    • db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).
    • db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).
    *)
  2. group_identifier : string;
    (*

    The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

    • db.sql.id for dimension group db.sql (Aurora and RDS only)
    • db.query.id for dimension group db.query (DocumentDB only)
    *)
  3. group : string;
    (*

    The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

    • db.query (Amazon DocumentDB only)
    • db.sql (Amazon RDS and Aurora only)
    *)
  4. identifier : string;
    (*

    The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

    *)
  5. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

    *)
}
type dimension_key_description = {
  1. partitions : float list option;
    (*

    If PartitionBy was specified, PartitionKeys contains the dimensions that were.

    *)
  2. additional_metrics : (string * float) list option;
    (*

    A map that contains the value for each additional metric.

    *)
  3. total : float option;
    (*

    The aggregated metric value for the dimensions, over the requested time range.

    *)
  4. dimensions : (string * string) list option;
    (*

    A map of name-value pairs for the dimensions in the group.

    *)
}

An object that includes the requested dimension key values and aggregated metric values within a dimension group.

type describe_dimension_keys_response = {
  1. next_token : string option;
    (*

    A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

    *)
  2. keys : dimension_key_description list option;
    (*

    The dimension keys that were requested.

    *)
  3. partition_keys : response_partition_key list option;
    (*

    If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

    *)
  4. aligned_end_time : float option;
    (*

    The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

    *)
  5. aligned_start_time : float option;
    (*

    The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

    *)
}
type describe_dimension_keys_request = {
  1. next_token : string option;
    (*

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

    *)
  2. max_results : int option;
    (*

    The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

    *)
  3. filter : (string * string) list option;
    (*

    One or more filters to apply in the request. Restrictions:

    • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.
    • A single filter for any other dimension in this dimension group.
    *)
  4. partition_by : dimension_group option;
    (*

    For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

    *)
  5. additional_metrics : string list option;
    (*

    Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows:

    "AdditionalMetrics" : \{ "{i string}" : "{i string}" \}

    .

    *)
  6. group_by : dimension_group;
    (*

    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

    *)
  7. period_in_seconds : int option;
    (*

    The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

    • 1 (one second)
    • 60 (one minute)
    • 300 (five minutes)
    • 3600 (one hour)
    • 86400 (twenty-four hours)

    If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

    *)
  8. metric : string;
    (*

    The name of a Performance Insights metric to be measured.

    Valid values for Metric are:

    • db.load.avg - A scaled representation of the number of active sessions for the database engine.
    • db.sampledload.avg - The raw number of active sessions for the database engine.

    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

    *)
  9. end_time : float;
    (*

    The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

    The value for EndTime must be later than the value for StartTime.

    *)
  10. start_time : float;
    (*

    The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

    The value for StartTime must be earlier than the value for EndTime.

    *)
  11. identifier : string;
    (*

    An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

    To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

    *)
  12. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

    • RDS
    • DOCDB
    *)
}
type delete_performance_analysis_report_response = unit
type delete_performance_analysis_report_request = {
  1. analysis_report_id : string;
    (*

    The unique identifier of the analysis report for deletion.

    *)
  2. identifier : string;
    (*

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

    *)
  3. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

    *)
}
type create_performance_analysis_report_response = {
  1. analysis_report_id : string option;
    (*

    A unique identifier for the created analysis report.

    *)
}
type create_performance_analysis_report_request = {
  1. tags : tag list option;
    (*

    The metadata assigned to the analysis report consisting of a key-value pair.

    *)
  2. end_time : float;
    (*

    The end time defined for the analysis report.

    *)
  3. start_time : float;
    (*

    The start time defined for the analysis report.

    *)
  4. identifier : string;
    (*

    An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

    To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.

    *)
  5. service_type : service_type;
    (*

    The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

    *)
}

Amazon RDS Performance Insights Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

type base_document = Smaws_Lib.Json.t

Builders

val make_untag_resource_response : unit -> untag_resource_response

Create a untag_resource_response type

val make_untag_resource_request : tag_keys:string list -> resource_ar_n:string -> service_type:service_type -> unit -> untag_resource_request

Create a untag_resource_request type

val make_tag_resource_response : unit -> tag_resource_response

Create a tag_resource_response type

val make_tag : value:string -> key:string -> unit -> tag

Create a tag type

val make_tag_resource_request : tags:tag list -> resource_ar_n:string -> service_type:service_type -> unit -> tag_resource_request

Create a tag_resource_request type

val make_response_resource_metric : ?unit_:string -> ?description:string -> ?metric:string -> unit -> response_resource_metric

Create a response_resource_metric type

val make_response_resource_metric_key : ?dimensions:(string * string) list -> metric:string -> unit -> response_resource_metric_key

Create a response_resource_metric_key type

val make_response_partition_key : dimensions:(string * string) list -> unit -> response_partition_key

Create a response_partition_key type

val make_recommendation : ?recommendation_description:string -> ?recommendation_id:string -> unit -> recommendation

Create a recommendation type

val make_list_tags_for_resource_response : ?tags:tag list -> unit -> list_tags_for_resource_response

Create a list_tags_for_resource_response type

val make_list_tags_for_resource_request : resource_ar_n:string -> service_type:service_type -> unit -> list_tags_for_resource_request

Create a list_tags_for_resource_request type

val make_analysis_report_summary : ?tags:tag list -> ?status:analysis_status -> ?end_time:float -> ?start_time:float -> ?create_time:float -> ?analysis_report_id:string -> unit -> analysis_report_summary

Create a analysis_report_summary type

val make_list_performance_analysis_reports_response : ?next_token:string -> ?analysis_reports:analysis_report_summary list -> unit -> list_performance_analysis_reports_response

Create a list_performance_analysis_reports_response type

val make_list_performance_analysis_reports_request : ?list_tags:bool -> ?max_results:int -> ?next_token:string -> identifier:string -> service_type:service_type -> unit -> list_performance_analysis_reports_request

Create a list_performance_analysis_reports_request type

val make_list_available_resource_metrics_response : ?next_token:string -> ?metrics:response_resource_metric list -> unit -> list_available_resource_metrics_response

Create a list_available_resource_metrics_response type

val make_list_available_resource_metrics_request : ?max_results:int -> ?next_token:string -> metric_types:string list -> identifier:string -> service_type:service_type -> unit -> list_available_resource_metrics_request

Create a list_available_resource_metrics_request type

val make_dimension_detail : ?identifier:string -> unit -> dimension_detail

Create a dimension_detail type

val make_dimension_group_detail : ?dimensions:dimension_detail list -> ?group:string -> unit -> dimension_group_detail

Create a dimension_group_detail type

val make_metric_dimension_groups : ?groups:dimension_group_detail list -> ?metric:string -> unit -> metric_dimension_groups

Create a metric_dimension_groups type

val make_list_available_resource_dimensions_response : ?next_token:string -> ?metric_dimensions:metric_dimension_groups list -> unit -> list_available_resource_dimensions_response

Create a list_available_resource_dimensions_response type

val make_list_available_resource_dimensions_request : ?authorized_actions:fine_grained_action list -> ?next_token:string -> ?max_results:int -> metrics:string list -> identifier:string -> service_type:service_type -> unit -> list_available_resource_dimensions_request

Create a list_available_resource_dimensions_request type

val make_data_point : value:float -> timestamp_:float -> unit -> data_point

Create a data_point type

val make_metric_key_data_points : ?data_points:data_point list -> ?key:response_resource_metric_key -> unit -> metric_key_data_points

Create a metric_key_data_points type

val make_get_resource_metrics_response : ?next_token:string -> ?metric_list:metric_key_data_points list -> ?identifier:string -> ?aligned_end_time:float -> ?aligned_start_time:float -> unit -> get_resource_metrics_response

Create a get_resource_metrics_response type

val make_dimension_group : ?limit:int -> ?dimensions:string list -> group:string -> unit -> dimension_group

Create a dimension_group type

val make_metric_query : ?filter:(string * string) list -> ?group_by:dimension_group -> metric:string -> unit -> metric_query

Create a metric_query type

val make_get_resource_metrics_request : ?period_alignment:period_alignment -> ?next_token:string -> ?max_results:int -> ?period_in_seconds:int -> end_time:float -> start_time:float -> metric_queries:metric_query list -> identifier:string -> service_type:service_type -> unit -> get_resource_metrics_request

Create a get_resource_metrics_request type

val make_feature_metadata : ?status:feature_status -> unit -> feature_metadata

Create a feature_metadata type

val make_get_resource_metadata_response : ?features:(string * feature_metadata) list -> ?identifier:string -> unit -> get_resource_metadata_response

Create a get_resource_metadata_response type

val make_get_resource_metadata_request : identifier:string -> service_type:service_type -> unit -> get_resource_metadata_request

Create a get_resource_metadata_request type

val make_performance_insights_metric : ?value:float -> ?dimensions:(string * string) list -> ?display_name:string -> ?metric:string -> unit -> performance_insights_metric

Create a performance_insights_metric type

val make_data : ?performance_insights_metric:performance_insights_metric -> unit -> data

Create a data type

val make_insight : ?baseline_data:data list -> ?insight_data:data list -> ?recommendations:recommendation list -> ?description:string -> ?supporting_insights:insight list -> ?severity:severity -> ?end_time:float -> ?start_time:float -> ?context:context_type -> ?insight_type:string -> insight_id:string -> unit -> insight

Create a insight type

val make_analysis_report : ?insights:insight list -> ?status:analysis_status -> ?end_time:float -> ?start_time:float -> ?create_time:float -> ?service_type:service_type -> ?identifier:string -> analysis_report_id:string -> unit -> analysis_report

Create a analysis_report type

val make_get_performance_analysis_report_response : ?analysis_report:analysis_report -> unit -> get_performance_analysis_report_response

Create a get_performance_analysis_report_response type

val make_get_performance_analysis_report_request : ?accept_language:accept_language -> ?text_format:text_format -> analysis_report_id:string -> identifier:string -> service_type:service_type -> unit -> get_performance_analysis_report_request

Create a get_performance_analysis_report_request type

val make_dimension_key_detail : ?status:detail_status -> ?dimension:string -> ?value:string -> unit -> dimension_key_detail

Create a dimension_key_detail type

val make_get_dimension_key_details_response : ?dimensions:dimension_key_detail list -> unit -> get_dimension_key_details_response

Create a get_dimension_key_details_response type

val make_get_dimension_key_details_request : ?requested_dimensions:string list -> group_identifier:string -> group:string -> identifier:string -> service_type:service_type -> unit -> get_dimension_key_details_request

Create a get_dimension_key_details_request type

val make_dimension_key_description : ?partitions:float list -> ?additional_metrics:(string * float) list -> ?total:float -> ?dimensions:(string * string) list -> unit -> dimension_key_description

Create a dimension_key_description type

val make_describe_dimension_keys_response : ?next_token:string -> ?keys:dimension_key_description list -> ?partition_keys:response_partition_key list -> ?aligned_end_time:float -> ?aligned_start_time:float -> unit -> describe_dimension_keys_response

Create a describe_dimension_keys_response type

val make_describe_dimension_keys_request : ?next_token:string -> ?max_results:int -> ?filter:(string * string) list -> ?partition_by:dimension_group -> ?additional_metrics:string list -> ?period_in_seconds:int -> group_by:dimension_group -> metric:string -> end_time:float -> start_time:float -> identifier:string -> service_type:service_type -> unit -> describe_dimension_keys_request

Create a describe_dimension_keys_request type

val make_delete_performance_analysis_report_response : unit -> delete_performance_analysis_report_response

Create a delete_performance_analysis_report_response type

val make_delete_performance_analysis_report_request : analysis_report_id:string -> identifier:string -> service_type:service_type -> unit -> delete_performance_analysis_report_request

Create a delete_performance_analysis_report_request type

val make_create_performance_analysis_report_response : ?analysis_report_id:string -> unit -> create_performance_analysis_report_response

Create a create_performance_analysis_report_response type

val make_create_performance_analysis_report_request : ?tags:tag list -> end_time:float -> start_time:float -> identifier:string -> service_type:service_type -> unit -> create_performance_analysis_report_request

Create a create_performance_analysis_report_request type

Operations

module CreatePerformanceAnalysisReport : sig ... end
module DeletePerformanceAnalysisReport : sig ... end
module DescribeDimensionKeys : sig ... end
module GetDimensionKeyDetails : sig ... end
module GetPerformanceAnalysisReport : sig ... end
module GetResourceMetadata : sig ... end
module GetResourceMetrics : sig ... end
module ListAvailableResourceDimensions : sig ... end
module ListAvailableResourceMetrics : sig ... end
module ListPerformanceAnalysisReports : sig ... end
module ListTagsForResource : sig ... end
module TagResource : sig ... end
module UntagResource : sig ... end