<?php
// This file was auto-generated from sdk-root/src/data/pi/2018-02-27/docs-2.json
return [ 'version' => '2.0', 'service' => '<fullname>Amazon RDS Performance Insights</fullname> <p>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.</p> <p>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.</p> <p>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.</p> <ul> <li> <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <i> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a> </i>. </p> </li> <li> <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <i> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a> </i>. </p> </li> <li> <p>To learn more about Performance Insights and Amazon DocumentDB clusters, go to the <i> <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html"> Amazon DocumentDB Developer Guide</a> </i>.</p> </li> </ul>', 'operations' => [ 'CreatePerformanceAnalysisReport' => '<p>Creates a new performance analysis report for a specific time period for the DB instance.</p>', 'DeletePerformanceAnalysisReport' => '<p>Deletes a performance analysis report.</p>', 'DescribeDimensionKeys' => '<p>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric. </p> <note> <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.</p> </note>', 'GetDimensionKeyDetails' => '<p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID. This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don\'t support retrieval of large SQL statement text, lock snapshots, and execution plans.</p>', 'GetPerformanceAnalysisReport' => '<p>Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be <code>RUNNING</code>, <code>SUCCEEDED</code>, or <code>FAILED</code>. The insights include the <code>description</code> and <code>recommendation</code> fields. </p>', 'GetResourceMetadata' => '<p>Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance. </p>', 'GetResourceMetrics' => '<p>Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.</p> <note> <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.</p> </note>', 'ListAvailableResourceDimensions' => '<p>Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.</p>', 'ListAvailableResourceMetrics' => '<p>Retrieve metrics of the specified types that can be queried for a specified DB instance. </p>', 'ListPerformanceAnalysisReports' => '<p>Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.</p>', 'ListTagsForResource' => '<p>Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.</p>', 'TagResource' => '<p>Adds metadata tags to the Amazon RDS Performance Insights resource.</p>', 'UntagResource' => '<p>Deletes the metadata tags from the Amazon RDS Performance Insights resource.</p>', ], 'shapes' => [ 'AcceptLanguage' => [ 'base' => NULL, 'refs' => [ 'GetPerformanceAnalysisReportRequest$AcceptLanguage' => '<p>The text language in the report. The default language is <code>EN_US</code> (English). </p>', ], ], 'AdditionalMetricsList' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysRequest$AdditionalMetrics' => '<p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response syntax is as follows: <code>"AdditionalMetrics" : { "<i>string</i>" : "<i>string</i>" }</code>.</p> <p>The only supported statistic function is <code>.avg</code>.</p>', ], ], 'AdditionalMetricsMap' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDescription$AdditionalMetrics' => '<p>A map that contains the value for each additional metric.</p>', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => '<p>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 <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>.</p>', 'TagResourceRequest$ResourceARN' => '<p>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 <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>.</p>', 'UntagResourceRequest$ResourceARN' => '<p>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 <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>.</p>', ], ], 'AnalysisReport' => [ 'base' => '<p>Retrieves the summary of the performance analysis report created for a time period.</p>', 'refs' => [ 'GetPerformanceAnalysisReportResponse$AnalysisReport' => '<p>The summary of the performance analysis report created for a time period.</p>', ], ], 'AnalysisReportId' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$AnalysisReportId' => '<p>The name of the analysis report.</p>', 'CreatePerformanceAnalysisReportResponse$AnalysisReportId' => '<p>A unique identifier for the created analysis report.</p>', 'DeletePerformanceAnalysisReportRequest$AnalysisReportId' => '<p>The unique identifier of the analysis report for deletion.</p>', 'GetPerformanceAnalysisReportRequest$AnalysisReportId' => '<p>A unique identifier of the created analysis report. For example, <code>report-12345678901234567</code> </p>', ], ], 'AnalysisReportSummary' => [ 'base' => '<p>Retrieves the details of the performance analysis report.</p>', 'refs' => [ 'AnalysisReportSummaryList$member' => NULL, ], ], 'AnalysisReportSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPerformanceAnalysisReportsResponse$AnalysisReports' => '<p>List of reports including the report identifier, start and end time, creation time, and status.</p>', ], ], 'AnalysisStatus' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$Status' => '<p>The status of the created analysis report.</p>', 'AnalysisReportSummary$Status' => '<p>The status of the analysis report.</p>', ], ], 'AuthorizedActionsList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsRequest$AuthorizedActions' => '<p>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.</p> <p>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.</p>', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ListPerformanceAnalysisReportsRequest$ListTags' => '<p>Specifies whether or not to include the list of tags in the response.</p>', ], ], 'ContextType' => [ 'base' => NULL, 'refs' => [ 'Insight$Context' => '<p>Indicates if the insight is causal or correlated insight.</p>', ], ], 'CreatePerformanceAnalysisReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePerformanceAnalysisReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'Data' => [ 'base' => '<p>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.</p>', 'refs' => [ 'DataList$member' => NULL, ], ], 'DataList' => [ 'base' => NULL, 'refs' => [ 'Insight$InsightData' => '<p>List of data objects containing metrics and references from the time range while generating the insight.</p>', 'Insight$BaselineData' => '<p> Metric names and values from the timeframe used as baseline to generate the insight.</p>', ], ], 'DataPoint' => [ 'base' => '<p>A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.</p>', 'refs' => [ 'DataPointsList$member' => NULL, ], ], 'DataPointsList' => [ 'base' => NULL, 'refs' => [ 'MetricKeyDataPoints$DataPoints' => '<p>An array of timestamp-value pairs, representing measurements over a period of time.</p>', ], ], 'DeletePerformanceAnalysisReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePerformanceAnalysisReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ResponseResourceMetric$Description' => '<p>The description of the metric.</p>', ], ], 'DescriptiveMap' => [ 'base' => NULL, 'refs' => [ 'PerformanceInsightsMetric$Dimensions' => '<p>A dimension map that contains the dimensions for this partition.</p>', 'PerformanceInsightsMetric$Filter' => '<p>The filter for the Performance Insights metric.</p>', ], ], 'DescriptiveString' => [ 'base' => NULL, 'refs' => [ 'DescriptiveMap$key' => NULL, 'DescriptiveMap$value' => NULL, 'PerformanceInsightsMetric$Metric' => '<p>The Performance Insights metric.</p>', 'PerformanceInsightsMetric$DisplayName' => '<p>The Performance Insights metric name.</p>', ], ], 'DetailStatus' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDetail$Status' => '<p>The status of the dimension detail data. Possible values include the following:</p> <ul> <li> <p> <code>AVAILABLE</code> - The dimension detail data is ready to be retrieved.</p> </li> <li> <p> <code>PROCESSING</code> - The dimension detail data isn\'t ready to be retrieved because more processing time is required. If the requested detail data has the status <code>PROCESSING</code>, Performance Insights returns the truncated query.</p> </li> <li> <p> <code>UNAVAILABLE</code> - The dimension detail data could not be collected successfully.</p> </li> </ul>', ], ], 'DimensionDetail' => [ 'base' => '<p>The information about a dimension.</p>', 'refs' => [ 'DimensionDetailList$member' => NULL, ], ], 'DimensionDetailList' => [ 'base' => NULL, 'refs' => [ 'DimensionGroupDetail$Dimensions' => '<p>The dimensions within a dimension group.</p>', ], ], 'DimensionGroup' => [ 'base' => '<p>A logical grouping of Performance Insights metrics for a related subject area. For example, the <code>db.sql</code> dimension group consists of the following dimensions:</p> <ul> <li> <p> <code>db.sql.id</code> - The hash of a running SQL statement, generated by Performance Insights.</p> </li> <li> <p> <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with <code>pi-</code>.</p> </li> <li> <p> <code>db.sql.statement</code> - The full text of the SQL statement that is running, for example, <code>SELECT * FROM employees</code>.</p> </li> <li> <p> <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights.</p> </li> </ul> <note> <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.</p> </note>', 'refs' => [ 'DescribeDimensionKeysRequest$GroupBy' => '<p>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. </p>', 'DescribeDimensionKeysRequest$PartitionBy' => '<p>For each dimension specified in <code>GroupBy</code>, specify a secondary dimension to further subdivide the partition keys in the response. </p>', 'MetricQuery$GroupBy' => '<p>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.</p>', ], ], 'DimensionGroupDetail' => [ 'base' => '<p>Information about dimensions within a dimension group.</p>', 'refs' => [ 'DimensionGroupDetailList$member' => NULL, ], ], 'DimensionGroupDetailList' => [ 'base' => NULL, 'refs' => [ 'MetricDimensionGroups$Groups' => '<p>The available dimension groups for a metric type.</p>', ], ], 'DimensionKeyDescription' => [ 'base' => '<p>An object that includes the requested dimension key values and aggregated metric values within a dimension group.</p>', 'refs' => [ 'DimensionKeyDescriptionList$member' => NULL, ], ], 'DimensionKeyDescriptionList' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysResponse$Keys' => '<p>The dimension keys that were requested.</p>', ], ], 'DimensionKeyDetail' => [ 'base' => '<p>An object that describes the details for a specified dimension.</p>', 'refs' => [ 'DimensionKeyDetailList$member' => NULL, ], ], 'DimensionKeyDetailList' => [ 'base' => NULL, 'refs' => [ 'GetDimensionKeyDetailsResponse$Dimensions' => '<p>The details for the requested dimensions.</p>', ], ], 'DimensionMap' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDescription$Dimensions' => '<p>A map of name-value pairs for the dimensions in the group.</p>', 'ResponsePartitionKey$Dimensions' => '<p>A dimension map that contains the dimensions for this partition.</p>', 'ResponseResourceMetricKey$Dimensions' => '<p>The valid dimensions for the metric.</p>', ], ], 'DimensionsMetricList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsRequest$Metrics' => '<p>The types of metrics for which to retrieve dimensions. Valid values include <code>db.load</code>.</p>', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'AdditionalMetricsMap$value' => NULL, 'DataPoint$Value' => '<p>The actual value associated with a particular <code>Timestamp</code>.</p>', 'DimensionKeyDescription$Total' => '<p>The aggregated metric value for the dimensions, over the requested time range.</p>', 'MetricValuesList$member' => NULL, 'PerformanceInsightsMetric$Value' => '<p>The value of the metric. For example, <code>9</code> for <code>db.load.avg</code>.</p>', ], ], 'ErrorString' => [ 'base' => NULL, 'refs' => [ 'InternalServiceError$Message' => NULL, 'InvalidArgumentException$Message' => NULL, 'NotAuthorizedException$Message' => NULL, ], ], 'FeatureMetadata' => [ 'base' => '<p>The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.</p>', 'refs' => [ 'FeatureMetadataMap$value' => NULL, ], ], 'FeatureMetadataMap' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetadataResponse$Features' => '<p>The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.</p>', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'FeatureMetadata$Status' => '<p>The status of the feature on the DB instance. Possible values include the following:</p> <ul> <li> <p> <code>ENABLED</code> - The feature is enabled on the instance.</p> </li> <li> <p> <code>DISABLED</code> - The feature is disabled on the instance.</p> </li> <li> <p> <code>UNSUPPORTED</code> - The feature isn\'t supported on the instance.</p> </li> <li> <p> <code>ENABLED_PENDING_REBOOT</code> - The feature is enabled on the instance but requires a reboot to take effect.</p> </li> <li> <p> <code>DISABLED_PENDING_REBOOT</code> - The feature is disabled on the instance but requires a reboot to take effect.</p> </li> <li> <p> <code>UNKNOWN</code> - The feature status couldn\'t be determined.</p> </li> </ul>', ], ], 'FineGrainedAction' => [ 'base' => NULL, 'refs' => [ 'AuthorizedActionsList$member' => NULL, ], ], 'GetDimensionKeyDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDimensionKeyDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPerformanceAnalysisReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPerformanceAnalysisReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ISOTimestamp' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$CreateTime' => '<p>The time you created the analysis report.</p>', 'AnalysisReport$StartTime' => '<p>The analysis start time in the report.</p>', 'AnalysisReport$EndTime' => '<p>The analysis end time in the report.</p>', 'AnalysisReportSummary$CreateTime' => '<p>The time you created the analysis report.</p>', 'AnalysisReportSummary$StartTime' => '<p>The start time of the analysis in the report.</p>', 'AnalysisReportSummary$EndTime' => '<p>The end time of the analysis in the report.</p>', 'CreatePerformanceAnalysisReportRequest$StartTime' => '<p>The start time defined for the analysis report.</p>', 'CreatePerformanceAnalysisReportRequest$EndTime' => '<p>The end time defined for the analysis report.</p>', 'DataPoint$Timestamp' => '<p>The time, in epoch format, associated with a particular <code>Value</code>.</p>', 'DescribeDimensionKeysRequest$StartTime' => '<p>The date and time specifying the beginning of the requested time series data. You must specify a <code>StartTime</code> within the past 7 days. The value specified is <i>inclusive</i>, which means that data points equal to or greater than <code>StartTime</code> are returned. </p> <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>. </p>', 'DescribeDimensionKeysRequest$EndTime' => '<p>The date and time specifying the end of the requested time series data. The value specified is <i>exclusive</i>, which means that data points less than (but not equal to) <code>EndTime</code> are returned.</p> <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>', 'DescribeDimensionKeysResponse$AlignedStartTime' => '<p>The start time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>. </p>', 'DescribeDimensionKeysResponse$AlignedEndTime' => '<p>The end time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>. </p>', 'GetResourceMetricsRequest$StartTime' => '<p>The date and time specifying the beginning of the requested time series query range. You can\'t specify a <code>StartTime</code> 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 <i>inclusive</i>. Thus, the command returns data points equal to or greater than <code>StartTime</code>.</p> <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>', 'GetResourceMetricsRequest$EndTime' => '<p>The date and time specifying the end of the requested time series query range. The value specified is <i>exclusive</i>. Thus, the command returns data points less than (but not equal to) <code>EndTime</code>.</p> <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>', 'GetResourceMetricsResponse$AlignedStartTime' => '<p>The start time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>.</p>', 'GetResourceMetricsResponse$AlignedEndTime' => '<p>The end time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>.</p>', 'Insight$StartTime' => '<p>The start time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>', 'Insight$EndTime' => '<p>The end time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>', ], ], 'IdentifierString' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$Identifier' => '<p>The unique identifier of the analysis report.</p>', 'CreatePerformanceAnalysisReportRequest$Identifier' => '<p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.</p> <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value. For example, specify <code>db-ADECBTYHKTSAUMUZQYPDS2GW4A</code>.</p>', 'DeletePerformanceAnalysisReportRequest$Identifier' => '<p>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 <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p> <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>', 'DescribeDimensionKeysRequest$Identifier' => '<p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.</p> <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value. For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>. </p>', 'GetDimensionKeyDetailsRequest$Identifier' => '<p>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 <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>. </p>', 'GetPerformanceAnalysisReportRequest$Identifier' => '<p>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 <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p> <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>', 'GetResourceMetadataRequest$Identifier' => '<p>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 <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>. </p>', 'GetResourceMetricsRequest$Identifier' => '<p>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 <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p> <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>', 'ListAvailableResourceDimensionsRequest$Identifier' => '<p>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 <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>', 'ListAvailableResourceMetricsRequest$Identifier' => '<p>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 <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>', 'ListPerformanceAnalysisReportsRequest$Identifier' => '<p>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 <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p> <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>', ], ], 'Insight' => [ 'base' => '<p>Retrieves the list of performance issues which are identified.</p>', 'refs' => [ 'InsightList$member' => NULL, ], ], 'InsightList' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$Insights' => '<p>The list of identified insights in the analysis report.</p>', 'Insight$SupportingInsights' => '<p>List of supporting insights that provide additional factors for the insight.</p>', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysRequest$PeriodInSeconds' => '<p>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: </p> <ul> <li> <p> <code>1</code> (one second)</p> </li> <li> <p> <code>60</code> (one minute)</p> </li> <li> <p> <code>300</code> (five minutes)</p> </li> <li> <p> <code>3600</code> (one hour)</p> </li> <li> <p> <code>86400</code> (twenty-four hours)</p> </li> </ul> <p>If you don\'t specify <code>PeriodInSeconds</code>, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response. </p>', 'GetResourceMetricsRequest$PeriodInSeconds' => '<p>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:</p> <ul> <li> <p> <code>1</code> (one second)</p> </li> <li> <p> <code>60</code> (one minute)</p> </li> <li> <p> <code>300</code> (five minutes)</p> </li> <li> <p> <code>3600</code> (one hour)</p> </li> <li> <p> <code>86400</code> (twenty-four hours)</p> </li> </ul> <p>If you don\'t specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>', ], ], 'InternalServiceError' => [ 'base' => '<p>The request failed due to an unknown error.</p>', 'refs' => [], ], 'InvalidArgumentException' => [ 'base' => '<p>One of the arguments provided is invalid for this request.</p>', 'refs' => [], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DimensionGroup$Limit' => '<p>The maximum number of items to fetch for this dimension group.</p>', ], ], 'ListAvailableResourceDimensionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceDimensionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPerformanceAnalysisReportsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPerformanceAnalysisReportsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MarkdownString' => [ 'base' => NULL, 'refs' => [ 'Insight$Description' => '<p>Description of the insight. For example: <code>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</code>.</p>', 'Recommendation$RecommendationDescription' => '<p>The recommendation details to help resolve the performance issue. For example, <code>Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id</code> </p>', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysRequest$MaxResults' => '<p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining results can be retrieved. </p>', 'GetResourceMetricsRequest$MaxResults' => '<p>The maximum number of items to return in the response.</p>', 'ListAvailableResourceDimensionsRequest$MaxResults' => '<p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining results can be retrieved.</p>', 'ListAvailableResourceMetricsRequest$MaxResults' => '<p>The maximum number of items to return. If the <code>MaxRecords</code> value is less than the number of existing items, the response includes a pagination token. </p>', 'ListPerformanceAnalysisReportsRequest$MaxResults' => '<p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxResults</code> value, a pagination token is included in the response so that the remaining results can be retrieved. </p>', ], ], 'MetricDimensionGroups' => [ 'base' => '<p>The available dimension information for a metric type.</p>', 'refs' => [ 'MetricDimensionsList$member' => NULL, ], ], 'MetricDimensionsList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsResponse$MetricDimensions' => '<p>The dimension information returned for requested metric types.</p>', ], ], 'MetricKeyDataPoints' => [ 'base' => '<p>A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.</p>', 'refs' => [ 'MetricKeyDataPointsList$member' => NULL, ], ], 'MetricKeyDataPointsList' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetricsResponse$MetricList' => '<p>An array of metric results, where each array element contains all of the data points for a particular dimension.</p>', ], ], 'MetricQuery' => [ 'base' => '<p>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 <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>. 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 (<code>GroupBy</code>), and return only those data points that match your criteria (<code>Filter</code>).</p>', 'refs' => [ 'MetricQueryList$member' => NULL, ], ], 'MetricQueryFilterMap' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysRequest$Filter' => '<p>One or more filters to apply in the request. Restrictions:</p> <ul> <li> <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or <code>Partition</code> parameters.</p> </li> <li> <p>A single filter for any other dimension in this dimension group.</p> </li> </ul> <note> <p>The <code>db.sql.db_id</code> filter isn\'t available for RDS for SQL Server DB instances.</p> </note>', 'MetricQuery$Filter' => '<p>One or more filters to apply in the request. Restrictions:</p> <ul> <li> <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> parameter.</p> </li> <li> <p>A single filter for any other dimension in this dimension group.</p> </li> </ul> <note> <p>The <code>db.sql.db_id</code> filter isn\'t available for RDS for SQL Server DB instances.</p> </note>', ], ], 'MetricQueryList' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetricsRequest$MetricQueries' => '<p>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 <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>.</p>', ], ], 'MetricTypeList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceMetricsRequest$MetricTypes' => '<p>The types of metrics to return in the response. Valid values in the array include the following:</p> <ul> <li> <p> <code>os</code> (OS counter metrics) - All engines</p> </li> <li> <p> <code>db</code> (DB load metrics) - All engines except for Amazon DocumentDB</p> </li> <li> <p> <code>db.sql.stats</code> (per-SQL metrics) - All engines except for Amazon DocumentDB</p> </li> <li> <p> <code>db.sql_tokenized.stats</code> (per-SQL digest metrics) - All engines except for Amazon DocumentDB</p> </li> </ul>', ], ], 'MetricValuesList' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDescription$Partitions' => '<p>If <code>PartitionBy</code> was specified, <code>PartitionKeys</code> contains the dimensions that were.</p>', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysRequest$NextToken' => '<p>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 <code>MaxRecords</code>.</p>', 'DescribeDimensionKeysResponse$NextToken' => '<p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>', 'GetResourceMetricsRequest$NextToken' => '<p>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 <code>MaxRecords</code>.</p>', 'GetResourceMetricsResponse$NextToken' => '<p>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 <code>MaxRecords</code>. </p>', 'ListAvailableResourceDimensionsRequest$NextToken' => '<p>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 <code>MaxRecords</code>. </p>', 'ListAvailableResourceDimensionsResponse$NextToken' => '<p>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 <code>MaxRecords</code>.</p>', 'ListAvailableResourceMetricsRequest$NextToken' => '<p>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 <code>MaxRecords</code>. </p>', 'ListAvailableResourceMetricsResponse$NextToken' => '<p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>', 'ListPerformanceAnalysisReportsRequest$NextToken' => '<p>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 <code>MaxResults</code>.</p>', 'ListPerformanceAnalysisReportsResponse$NextToken' => '<p>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 <code>MaxResults</code>.</p>', ], ], 'NotAuthorizedException' => [ 'base' => '<p>The user is not authorized to perform this request.</p>', 'refs' => [], ], 'PerformanceInsightsMetric' => [ 'base' => '<p>This data type helps to determine Performance Insights metric to render for the insight.</p>', 'refs' => [ 'Data$PerformanceInsightsMetric' => '<p>This field determines the Performance Insights metric to render for the insight. The <code>name</code> field refers to a Performance Insights metric. </p>', ], ], 'PeriodAlignment' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetricsRequest$PeriodAlignment' => '<p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>', ], ], 'Recommendation' => [ 'base' => '<p>The list of recommendations for the insight.</p>', 'refs' => [ 'RecommendationList$member' => NULL, ], ], 'RecommendationList' => [ 'base' => NULL, 'refs' => [ 'Insight$Recommendations' => '<p>List of recommendations for the insight. For example, <code>Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id</code>.</p>', ], ], 'RequestString' => [ 'base' => NULL, 'refs' => [ 'AdditionalMetricsMap$key' => NULL, 'DescribeDimensionKeysRequest$Metric' => '<p>The name of a Performance Insights metric to be measured.</p> <p>Valid values for <code>Metric</code> are:</p> <ul> <li> <p> <code>db.load.avg</code> - A scaled representation of the number of active sessions for the database engine. </p> </li> <li> <p> <code>db.sampledload.avg</code> - The raw number of active sessions for the database engine. </p> </li> </ul> <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and <code>db.sampledload.avg</code> are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code> showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only. </p>', 'DimensionMap$key' => NULL, 'DimensionMap$value' => NULL, 'GetDimensionKeyDetailsRequest$Group' => '<p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:</p> <ul> <li> <p> <code>db.execution_plan</code> (Amazon RDS and Aurora only)</p> </li> <li> <p> <code>db.lock_snapshot</code> (Aurora only)</p> </li> <li> <p> <code>db.query</code> (Amazon DocumentDB only)</p> </li> <li> <p> <code>db.sql</code> (Amazon RDS and Aurora only)</p> </li> </ul>', 'GetDimensionKeyDetailsRequest$GroupIdentifier' => '<p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is <code>db.sql.id</code>. The following group ID values are valid:</p> <ul> <li> <p> <code>db.execution_plan.id</code> for dimension group <code>db.execution_plan</code> (Aurora and RDS only)</p> </li> <li> <p> <code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p> </li> <li> <p> <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p> </li> <li> <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p> </li> </ul>', 'MetricQueryFilterMap$value' => NULL, ], ], 'RequestedDimensionList' => [ 'base' => NULL, 'refs' => [ 'GetDimensionKeyDetailsRequest$RequestedDimensions' => '<p>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:</p> <ul> <li> <p> <code>db.execution_plan</code> - Specify the dimension name <code>db.execution_plan.raw_plan</code> or the short dimension name <code>raw_plan</code> (Amazon RDS and Aurora only)</p> </li> <li> <p> <code>db.lock_snapshot</code> - Specify the dimension name <code>db.lock_snapshot.lock_trees</code> or the short dimension name <code>lock_trees</code>. (Aurora only)</p> </li> <li> <p> <code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name <code>statement</code> (Aurora and RDS only).</p> </li> <li> <p> <code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name <code>statement</code> (DocumentDB only).</p> </li> </ul>', ], ], 'ResponsePartitionKey' => [ 'base' => '<p>If <code>PartitionBy</code> was specified in a <code>DescribeDimensionKeys</code> request, the dimensions are returned in an array. Each element in the array specifies one dimension. </p>', 'refs' => [ 'ResponsePartitionKeyList$member' => NULL, ], ], 'ResponsePartitionKeyList' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysResponse$PartitionKeys' => '<p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains the breakdown of dimension keys by the specified partitions. </p>', ], ], 'ResponseResourceMetric' => [ 'base' => '<p>An object that contains the full name, description, and unit of a metric. </p>', 'refs' => [ 'ResponseResourceMetricList$member' => NULL, ], ], 'ResponseResourceMetricKey' => [ 'base' => '<p>An object describing a Performance Insights metric and one or more dimensions for that metric.</p>', 'refs' => [ 'MetricKeyDataPoints$Key' => '<p>The dimensions to which the data points apply.</p>', ], ], 'ResponseResourceMetricList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceMetricsResponse$Metrics' => '<p>An array of metrics available to query. Each array element contains the full name, description, and unit of the metric. </p>', ], ], 'SanitizedString' => [ 'base' => 'A generic string type that forbids characters that could expose our service (or services downstream) to security risks around injections.', 'refs' => [ 'AdditionalMetricsList$member' => NULL, 'DimensionGroup$Group' => '<p>The name of the dimension group. Valid values are as follows:</p> <ul> <li> <p> <code>db</code> - The name of the database to which the client is connected. The following values are permitted:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Aurora MySQL</p> </li> <li> <p>Amazon RDS MySQL</p> </li> <li> <p>Amazon RDS MariaDB</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.application</code> - The name of the application that is connected to the database. The following values are permitted:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.blocking_sql</code> - The SQL queries blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_session</code> - The sessions blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object</code> - The object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.host</code> - The host name of the connected client (all engines).</p> </li> <li> <p> <code>db.plans</code> - The execution plans for the query (only Aurora PostgreSQL).</p> </li> <li> <p> <code>db.query</code> - The query that is currently running (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query_tokenized</code> - The digest query (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).</p> </li> <li> <p> <code>db.sql</code> - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql_tokenized</code> - The SQL digest (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.user</code> - The user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event</code> - The event for which the database backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_state</code> - The event for which the database backend is waiting (only Amazon DocumentDB).</p> </li> </ul>', 'DimensionsMetricList$member' => NULL, 'MetricQuery$Metric' => '<p>The name of a Performance Insights metric to be measured.</p> <p>Valid values for <code>Metric</code> are:</p> <ul> <li> <p> <code>db.load.avg</code> - A scaled representation of the number of active sessions for the database engine.</p> </li> <li> <p> <code>db.sampledload.avg</code> - The raw number of active sessions for the database engine.</p> </li> <li> <p>The counter metrics listed in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS">Performance Insights operating system counters</a> in the <i>Amazon Aurora User Guide</i>.</p> </li> <li> <p>The counter metrics listed in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS">Performance Insights operating system counters</a> in the <i>Amazon RDS User Guide</i>.</p> </li> </ul> <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and <code>db.sampledload.avg</code> are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code> showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only.</p>', 'MetricQueryFilterMap$key' => NULL, 'MetricTypeList$member' => NULL, 'RequestedDimensionList$member' => NULL, 'SanitizedStringList$member' => NULL, ], ], 'SanitizedStringList' => [ 'base' => NULL, 'refs' => [ 'DimensionGroup$Dimensions' => '<p>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.</p> <p>Valid values for elements in the <code>Dimensions</code> array are:</p> <ul> <li> <p> <code>db.application.name</code> - The name of the application that is connected to the database. Valid values are as follows: </p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.blocking_sql.id</code> - The ID for each of the SQL queries blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_sql.sql</code> - The SQL text for each of the SQL queries blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_session.id</code> - The ID for each of the sessions blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object.id</code> - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object.type</code> - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object.value</code> - The value for each of the object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.host.id</code> - The host ID of the connected client (all engines).</p> </li> <li> <p> <code>db.host.name</code> - The host name of the connected client (all engines).</p> </li> <li> <p> <code>db.name</code> - The name of the database to which the client is connected. Valid values are as follows:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Aurora MySQL</p> </li> <li> <p>Amazon RDS MySQL</p> </li> <li> <p>Amazon RDS MariaDB</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.query.id</code> - The query ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.db_id</code> - The query ID generated by the database (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.statement</code> - The text of the query that is being run (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized_id</code> </p> </li> <li> <p> <code>db.query.tokenized.id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized.db_id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized.statement</code> - The text of the query digest (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.session_type.name</code> - The type of the current session (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.id</code> - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with <code>pi-</code> (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.statement</code> - The full text of the SQL statement that is running, as in <code>SELECT * FROM employees</code> (all engines except Amazon DocumentDB)</p> </li> <li> <p> <code>db.sql.tokenized_id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The <code>db.sql.tokenized_id</code> dimension fetches the value of the <code>db.sql_tokenized.id</code> dimension. Amazon RDS returns <code>db.sql.tokenized_id</code> from the <code>db.sql</code> dimension group. </p> </li> <li> <p> <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, <code>db.sql_tokenized.id</code> is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.</p> </li> <li> <p> <code>db.sql_tokenized.db_id</code> - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as <code>pi-2372568224</code> that Performance Insights generates if the native database ID isn\'t available (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql_tokenized.statement</code> - The text of the SQL digest, as in <code>SELECT * FROM employees WHERE employee_id = ?</code> (all engines except Amazon DocumentDB)</p> </li> <li> <p> <code>db.user.id</code> - The ID of the user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.user.name</code> - The name of the user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_state.name</code> - The event for which the backend is waiting (only Amazon DocumentDB).</p> </li> </ul>', ], ], 'ServiceType' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$ServiceType' => '<p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p> <ul> <li> <p> <code>RDS</code> </p> </li> <li> <p> <code>DOCDB</code> </p> </li> </ul>', 'CreatePerformanceAnalysisReportRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>', 'DeletePerformanceAnalysisReportRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>', 'DescribeDimensionKeysRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:</p> <ul> <li> <p> <code>RDS</code> </p> </li> <li> <p> <code>DOCDB</code> </p> </li> </ul>', 'GetDimensionKeyDetailsRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>', 'GetPerformanceAnalysisReportRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>', 'GetResourceMetadataRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights returns metrics.</p>', 'GetResourceMetricsRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p> <ul> <li> <p> <code>RDS</code> </p> </li> <li> <p> <code>DOCDB</code> </p> </li> </ul>', 'ListAvailableResourceDimensionsRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights returns metrics.</p>', 'ListAvailableResourceMetricsRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights returns metrics.</p>', 'ListPerformanceAnalysisReportsRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>', 'ListTagsForResourceRequest$ServiceType' => '<p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>', 'TagResourceRequest$ServiceType' => '<p>The Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>', 'UntagResourceRequest$ServiceType' => '<p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>', ], ], 'Severity' => [ 'base' => NULL, 'refs' => [ 'Insight$Severity' => '<p>The severity of the insight. The values are: <code>Low</code>, <code>Medium</code>, or <code>High</code>.</p>', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AnalysisReportSummary$AnalysisReportId' => '<p>The name of the analysis report.</p>', 'DimensionDetail$Identifier' => '<p>The identifier of a dimension.</p>', 'DimensionGroupDetail$Group' => '<p>The name of the dimension group.</p>', 'DimensionKeyDetail$Value' => '<p>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:</p> <ul> <li> <p> <code>db.query.statement</code> (Amazon DocumentDB)</p> </li> <li> <p> <code>db.sql.statement</code> (Amazon RDS and Aurora)</p> </li> </ul>', 'DimensionKeyDetail$Dimension' => '<p>The full name of the dimension. The full name includes the group name and key name. The following values are valid:</p> <ul> <li> <p> <code>db.query.statement</code> (Amazon DocumentDB)</p> </li> <li> <p> <code>db.sql.statement</code> (Amazon RDS and Aurora)</p> </li> </ul>', 'FeatureMetadataMap$key' => NULL, 'GetResourceMetadataResponse$Identifier' => '<p>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 <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>. </p>', 'GetResourceMetricsResponse$Identifier' => '<p>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 <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p>', 'Insight$InsightId' => '<p>The unique identifier for the insight. For example, <code>insight-12345678901234567</code>.</p>', 'Insight$InsightType' => '<p>The type of insight. For example, <code>HighDBLoad</code>, <code>HighCPU</code>, or <code>DominatingSQLs</code>.</p>', 'MetricDimensionGroups$Metric' => '<p>The metric type to which the dimension information belongs.</p>', 'Recommendation$RecommendationId' => '<p>The unique identifier for the recommendation.</p>', 'ResponseResourceMetric$Metric' => '<p>The full name of the metric.</p>', 'ResponseResourceMetric$Unit' => '<p>The unit of the metric.</p>', 'ResponseResourceMetricKey$Metric' => '<p>The name of a Performance Insights metric to be measured.</p> <p>Valid values for <code>Metric</code> are:</p> <ul> <li> <p> <code>db.load.avg</code> - A scaled representation of the number of active sessions for the database engine.</p> </li> <li> <p> <code>db.sampledload.avg</code> - The raw number of active sessions for the database engine.</p> </li> <li> <p>The counter metrics listed in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS">Performance Insights operating system counters</a> in the <i>Amazon Aurora User Guide</i>.</p> </li> <li> <p>The counter metrics listed in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS">Performance Insights operating system counters</a> in the <i>Amazon RDS User Guide</i>.</p> </li> </ul> <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and <code>db.sampledload.avg</code> are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code> showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only. </p>', ], ], 'Tag' => [ 'base' => '<p>Metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '<p>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 <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: <code>"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$"</code>).</p>', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '<p>The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.</p>', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AnalysisReportSummary$Tags' => '<p>List of all the tags added to the analysis report.</p>', 'CreatePerformanceAnalysisReportRequest$Tags' => '<p>The metadata assigned to the analysis report consisting of a key-value pair.</p>', 'ListTagsForResourceResponse$Tags' => '<p>The metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>', 'TagResourceRequest$Tags' => '<p>The metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '<p>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 <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$").</p>', ], ], 'TextFormat' => [ 'base' => NULL, 'refs' => [ 'GetPerformanceAnalysisReportRequest$TextFormat' => '<p>Indicates the text format in the report. The options are <code>PLAIN_TEXT</code> or <code>MARKDOWN</code>. The default value is <code>plain text</code>.</p>', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], ],];
