Module Smaws_Client_PI.Types

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

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

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

    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 nonrec error_string = string
type nonrec not_authorized_exception = {
  1. message : error_string option;
}

The user is not authorized to perform this request.

type nonrec invalid_argument_exception = {
  1. message : error_string option;
}

One of the arguments provided is invalid for this request.

type nonrec internal_service_error = {
  1. message : error_string option;
}

The request failed due to an unknown error.

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

    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 : tag_key;
    (*

    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 nonrec tag_list = tag list
type nonrec 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 : amazon_resource_name;
    (*

    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 nonrec string_ = string
type nonrec severity =
  1. | HIGH
  2. | MEDIUM
  3. | LOW
type nonrec sanitized_string = string
type nonrec sanitized_string_list = sanitized_string list
type nonrec description = string
type nonrec response_resource_metric = {
  1. unit_ : string_ option;
    (*

    The unit of the metric.

    *)
  2. description : description 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 nonrec response_resource_metric_list = response_resource_metric list
type nonrec request_string = string
type nonrec dimension_map = (request_string * request_string) list
type nonrec response_resource_metric_key = {
  1. dimensions : dimension_map 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 nonrec response_partition_key = {
  1. dimensions : dimension_map;
    (*

    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 nonrec response_partition_key_list = response_partition_key list
type nonrec requested_dimension_list = sanitized_string list
type nonrec markdown_string = string
type nonrec recommendation = {
  1. recommendation_description : markdown_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 nonrec recommendation_list = recommendation list
type nonrec period_alignment =
  1. | START_TIME
  2. | END_TIME
type nonrec 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 nonrec list_tags_for_resource_request = {
  1. resource_ar_n : amazon_resource_name;
    (*

    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 nonrec iso_timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec analysis_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | RUNNING
type nonrec 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 : iso_timestamp option;
    (*

    The end time of the analysis in the report.

    *)
  4. start_time : iso_timestamp option;
    (*

    The start time of the analysis in the report.

    *)
  5. create_time : iso_timestamp 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 nonrec analysis_report_summary_list = analysis_report_summary list
type nonrec next_token = string
type nonrec list_performance_analysis_reports_response = {
  1. next_token : next_token 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 nonrec identifier_string = string
type nonrec max_results = int
type nonrec boolean_ = bool
type nonrec list_performance_analysis_reports_request = {
  1. list_tags : boolean_ option;
    (*

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

    *)
  2. max_results : max_results 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 : next_token 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 : 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 nonrec list_available_resource_metrics_response = {
  1. next_token : next_token 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 nonrec metric_type_list = sanitized_string list
type nonrec list_available_resource_metrics_request = {
  1. max_results : max_results 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 : next_token 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 : metric_type_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 : 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 nonrec dimension_detail = {
  1. identifier : string_ option;
    (*

    The identifier of a dimension.

    *)
}

The information about a dimension.

type nonrec dimension_detail_list = dimension_detail list
type nonrec 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 nonrec dimension_group_detail_list = dimension_group_detail list
type nonrec 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 nonrec metric_dimensions_list = metric_dimension_groups list
type nonrec list_available_resource_dimensions_response = {
  1. next_token : next_token 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_dimensions_list option;
    (*

    The dimension information returned for requested metric types.

    *)
}
type nonrec dimensions_metric_list = sanitized_string list
type nonrec fine_grained_action =
  1. | GET_RESOURCE_METRICS
  2. | GET_DIMENSION_KEY_DETAILS
  3. | DESCRIBE_DIMENSION_KEYS
type nonrec authorized_actions_list = fine_grained_action list
type nonrec list_available_resource_dimensions_request = {
  1. authorized_actions : authorized_actions_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 : next_token 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 : max_results 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 : dimensions_metric_list;
    (*

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

    *)
  5. identifier : 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 nonrec double = float
type nonrec data_point = {
  1. value : double;
    (*

    The actual value associated with a particular Timestamp.

    *)
  2. timestamp : iso_timestamp;
    (*

    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 nonrec data_points_list = data_point list
type nonrec metric_key_data_points = {
  1. data_points : data_points_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 nonrec metric_key_data_points_list = metric_key_data_points list
type nonrec get_resource_metrics_response = {
  1. next_token : next_token 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 : iso_timestamp 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 : iso_timestamp 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 nonrec limit = int
type nonrec dimension_group = {
  1. limit : limit option;
    (*

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

    *)
  2. dimensions : sanitized_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.blocking_sql.id - The ID for each of the SQL queries blocking the most DB load.
    • db.blocking_sql.sql - The SQL text for each of the SQL queries blocking the most DB load.
    • db.blocking_session.id - The ID for each of the sessions blocking the most DB load.
    • db.blocking_object.id - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.
    • db.blocking_object.type - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.
    • db.blocking_object.value - The value for each of the object resources acquired by other sessions that are blocking the most DB load.
    • 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 - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The db.sql.tokenized_id dimension fetches the value of the db.sql_tokenized.id dimension. Amazon RDS returns db.sql.tokenized_id from the db.sql dimension group.
    • 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 : sanitized_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.blocking_sql - The SQL queries blocking the most DB load.
    • db.blocking_session - The sessions blocking the most DB load.
    • db.blocking_object - The object resources acquired by other sessions that are blocking the most DB load.
    • db.host - The host name of the connected client (all engines).
    • db.plans - The execution plans for the query (only Aurora PostgreSQL).
    • 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 nonrec metric_query_filter_map = (sanitized_string * request_string) list
type nonrec metric_query = {
  1. filter : metric_query_filter_map 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.

    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

    *)
  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 : sanitized_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 nonrec metric_query_list = metric_query list
type nonrec integer = int
type nonrec 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 : next_token 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 : max_results option;
    (*

    The maximum number of items to return in the response.

    *)
  4. period_in_seconds : integer 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 : iso_timestamp;
    (*

    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 : iso_timestamp;
    (*

    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 : 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 nonrec feature_status =
  1. | UNKNOWN
  2. | DISABLED_PENDING_REBOOT
  3. | ENABLED_PENDING_REBOOT
  4. | UNSUPPORTED
  5. | DISABLED
  6. | ENABLED
type nonrec 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 nonrec feature_metadata_map = (string_ * feature_metadata) list
type nonrec get_resource_metadata_response = {
  1. features : feature_metadata_map 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 nonrec get_resource_metadata_request = {
  1. identifier : 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 nonrec analysis_report_id = string
type nonrec context_type =
  1. | CONTEXTUAL
  2. | CAUSAL
type nonrec descriptive_string = string
type nonrec descriptive_map = (descriptive_string * descriptive_string) list
type nonrec performance_insights_metric = {
  1. value : double option;
    (*

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

    *)
  2. filter : descriptive_map option;
    (*

    The filter for the Performance Insights metric.

    *)
  3. dimensions : descriptive_map option;
    (*

    A dimension map that contains the dimensions for this partition.

    *)
  4. display_name : descriptive_string option;
    (*

    The Performance Insights metric name.

    *)
  5. metric : descriptive_string option;
    (*

    The Performance Insights metric.

    *)
}

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

type nonrec 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 nonrec data_list = data list
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 : markdown_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 : iso_timestamp option;
    (*

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

    *)
  8. start_time : iso_timestamp 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.

    *)
}

Retrieves the list of performance issues which are identified.

and insight_list = insight list
type nonrec 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 : iso_timestamp option;
    (*

    The analysis end time in the report.

    *)
  4. start_time : iso_timestamp option;
    (*

    The analysis start time in the report.

    *)
  5. create_time : iso_timestamp 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 : identifier_string option;
    (*

    The unique identifier of the analysis report.

    *)
  8. analysis_report_id : analysis_report_id;
    (*

    The name of the analysis report.

    *)
}

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

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

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

    *)
}
type nonrec accept_language =
  1. | EN_US
type nonrec 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 : analysis_report_id;
    (*

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

    *)
  4. identifier : 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 nonrec detail_status =
  1. | UNAVAILABLE
  2. | PROCESSING
  3. | AVAILABLE
type nonrec 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 nonrec dimension_key_detail_list = dimension_key_detail list
type nonrec get_dimension_key_details_response = {
  1. dimensions : dimension_key_detail_list option;
    (*

    The details for the requested dimensions.

    *)
}
type nonrec get_dimension_key_details_request = {
  1. requested_dimensions : requested_dimension_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.execution_plan - Specify the dimension name db.execution_plan.raw_plan or the short dimension name raw_plan (Amazon RDS and Aurora only)
    • db.lock_snapshot - Specify the dimension name db.lock_snapshot.lock_trees or the short dimension name lock_trees. (Aurora only)
    • 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 : request_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.execution_plan.id for dimension group db.execution_plan (Aurora and RDS only)
    • db.sql.id for dimension group db.sql (Aurora and RDS only)
    • db.query.id for dimension group db.query (DocumentDB only)
    • For the dimension group db.lock_snapshot, the GroupIdentifier is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the GetResourceMetrics operation for a 1 second period.
    *)
  3. group : request_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.execution_plan (Amazon RDS and Aurora only)
    • db.lock_snapshot (Aurora only)
    • db.query (Amazon DocumentDB only)
    • db.sql (Amazon RDS and Aurora only)
    *)
  4. identifier : 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 nonrec additional_metrics_map = (request_string * double) list
type nonrec metric_values_list = double list
type nonrec dimension_key_description = {
  1. partitions : metric_values_list option;
    (*

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

    *)
  2. additional_metrics : additional_metrics_map option;
    (*

    A map that contains the value for each additional metric.

    *)
  3. total : double option;
    (*

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

    *)
  4. dimensions : dimension_map 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 nonrec dimension_key_description_list = dimension_key_description list
type nonrec describe_dimension_keys_response = {
  1. next_token : next_token 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 : iso_timestamp 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 : iso_timestamp 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 nonrec additional_metrics_list = sanitized_string list
type nonrec describe_dimension_keys_request = {
  1. next_token : next_token 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 : max_results 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 : metric_query_filter_map 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.

    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

    *)
  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 : additional_metrics_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}" \}

    .

    The only supported statistic function is .avg.

    *)
  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 : integer 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 : request_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 : iso_timestamp;
    (*

    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 : iso_timestamp;
    (*

    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 : 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 nonrec delete_performance_analysis_report_response = unit
type nonrec delete_performance_analysis_report_request = {
  1. analysis_report_id : analysis_report_id;
    (*

    The unique identifier of the analysis report for deletion.

    *)
  2. identifier : 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 nonrec create_performance_analysis_report_response = {
  1. analysis_report_id : analysis_report_id option;
    (*

    A unique identifier for the created analysis report.

    *)
}
type nonrec 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 : iso_timestamp;
    (*

    The end time defined for the analysis report.

    *)
  3. start_time : iso_timestamp;
    (*

    The start time defined for the analysis report.

    *)
  4. identifier : 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.

    *)
}