@aws-sdk/client-rds 3.476.0 → 3.477.0

package/dist-types/models/models_1.d.ts

@@ -1904,6 +1904,732 @@ export interface DescribeDBProxyTargetsResponse {
      */
     Marker?: string;
 }
+/**
+ * @public
+ * <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>
+ */
+export interface PerformanceInsightsMetricDimensionGroup {
+    /**
+     * @public
+     * <p>A list of specific dimensions from a dimension group. If this list isn't included, then all of the dimensions in the group were requested, or are present in the response.</p>
+     */
+    Dimensions?: string[];
+    /**
+     * @public
+     * <p>The available dimension groups for Performance Insights metric type.</p>
+     */
+    Group?: string;
+    /**
+     * @public
+     * <p>The maximum number of items to fetch for this dimension group.</p>
+     */
+    Limit?: number;
+}
+/**
+ * @public
+ * <p>A single Performance Insights metric query to process. You must provide the metric to the query.
+ *             If other parameters aren't specified, Performance Insights returns all data points for the
+ *             specified metric. Optionally, you can request the data points to be aggregated by dimension
+ *             group (<code>GroupBy</code>) and return only those data points that match your criteria (<code>Filter</code>).</p>
+ *          <p>Constraints:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Must be a valid Performance Insights query.</p>
+ *             </li>
+ *          </ul>
+ */
+export interface PerformanceInsightsMetricQuery {
+    /**
+     * @public
+     * <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>
+     */
+    GroupBy?: PerformanceInsightsMetricDimensionGroup;
+    /**
+     * @public
+     * <p>The name of a Performance Insights metric to be measured.</p>
+     *          <p>Valid Values:</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>
+     *          </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>
+     */
+    Metric?: string;
+}
+/**
+ * @public
+ * <p>The query to retrieve metric data points.</p>
+ */
+export interface MetricQuery {
+    /**
+     * @public
+     * <p>The Performance Insights query that you can use to retrieve Performance Insights metric data points.</p>
+     */
+    PerformanceInsightsMetricQuery?: PerformanceInsightsMetricQuery;
+}
+/**
+ * @public
+ * <p>The metric reference details when the reference is a scalar.</p>
+ */
+export interface ScalarReferenceDetails {
+    /**
+     * @public
+     * <p>The value of a scalar reference.</p>
+     */
+    Value?: number;
+}
+/**
+ * @public
+ * <p>The reference details of a metric.</p>
+ */
+export interface ReferenceDetails {
+    /**
+     * @public
+     * <p>The metric reference details when the reference is a scalar.</p>
+     */
+    ScalarReferenceDetails?: ScalarReferenceDetails;
+}
+/**
+ * @public
+ * <p>The reference (threshold) for a metric.</p>
+ */
+export interface MetricReference {
+    /**
+     * @public
+     * <p>The name of the metric reference.</p>
+     */
+    Name?: string;
+    /**
+     * @public
+     * <p>The details of a performance issue.</p>
+     */
+    ReferenceDetails?: ReferenceDetails;
+}
+/**
+ * @public
+ * <p>The representation of a metric.</p>
+ */
+export interface Metric {
+    /**
+     * @public
+     * <p>The name of a metric.</p>
+     */
+    Name?: string;
+    /**
+     * @public
+     * <p>A list of metric references (thresholds).</p>
+     */
+    References?: MetricReference[];
+    /**
+     * @public
+     * <p>The details of different statistics for a metric. The description might contain markdown.</p>
+     */
+    StatisticsDetails?: string;
+    /**
+     * @public
+     * <p>The query to retrieve metric data points.</p>
+     */
+    MetricQuery?: MetricQuery;
+}
+/**
+ * @public
+ * <p>Details of the performance issue.</p>
+ */
+export interface PerformanceIssueDetails {
+    /**
+     * @public
+     * <p>The time when the performance issue started.</p>
+     */
+    StartTime?: Date;
+    /**
+     * @public
+     * <p>The time when the performance issue stopped.</p>
+     */
+    EndTime?: Date;
+    /**
+     * @public
+     * <p>The metrics that are relevant to the performance issue.</p>
+     */
+    Metrics?: Metric[];
+    /**
+     * @public
+     * <p>The analysis of the performance issue. The information might contain markdown.</p>
+     */
+    Analysis?: string;
+}
+/**
+ * @public
+ * <p>The details of an issue with your DB instances, DB clusters, and DB parameter groups.</p>
+ */
+export interface IssueDetails {
+    /**
+     * @public
+     * <p>A detailed description of the issue when the recommendation category is <code>performance</code>.</p>
+     */
+    PerformanceIssueDetails?: PerformanceIssueDetails;
+}
+/**
+ * @public
+ * <p>A link to documentation that provides additional information for a recommendation.</p>
+ */
+export interface DocLink {
+    /**
+     * @public
+     * <p>The text with the link to documentation for the recommendation.</p>
+     */
+    Text?: string;
+    /**
+     * @public
+     * <p>The URL for the documentation for the recommendation.</p>
+     */
+    Url?: string;
+}
+/**
+ * @public
+ * <p>The additional attributes of <code>RecommendedAction</code> data type.</p>
+ */
+export interface ContextAttribute {
+    /**
+     * @public
+     * <p>The key of <code>ContextAttribute</code>.</p>
+     */
+    Key?: string;
+    /**
+     * @public
+     * <p>The value of <code>ContextAttribute</code>.</p>
+     */
+    Value?: string;
+}
+/**
+ * @public
+ * <p>A single parameter to use with the <code>RecommendedAction</code> API operation to apply the action.</p>
+ */
+export interface RecommendedActionParameter {
+    /**
+     * @public
+     * <p>The key of the parameter to use with the <code>RecommendedAction</code> API operation.</p>
+     */
+    Key?: string;
+    /**
+     * @public
+     * <p>The value of the parameter to use with the <code>RecommendedAction</code> API operation.</p>
+     */
+    Value?: string;
+}
+/**
+ * @public
+ * <p>The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.</p>
+ */
+export interface RecommendedAction {
+    /**
+     * @public
+     * <p>The unique identifier of the recommended action.</p>
+     */
+    ActionId?: string;
+    /**
+     * @public
+     * <p>A short description to summarize the action. The description might contain markdown.</p>
+     */
+    Title?: string;
+    /**
+     * @public
+     * <p>A detailed description of the action. The description might contain markdown.</p>
+     */
+    Description?: string;
+    /**
+     * @public
+     * <p>An API operation for the action.</p>
+     */
+    Operation?: string;
+    /**
+     * @public
+     * <p>The parameters for the API operation.</p>
+     */
+    Parameters?: RecommendedActionParameter[];
+    /**
+     * @public
+     * <p>The methods to apply the recommended action.</p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>manual</code> - The action requires you to resolve the recommendation manually.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>immediately</code> - The action is applied immediately.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>next-maintainance-window</code> - The action is applied during the next scheduled maintainance.</p>
+     *             </li>
+     *          </ul>
+     */
+    ApplyModes?: string[];
+    /**
+     * @public
+     * <p>The status of the action.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>ready</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>applied</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>scheduled</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>resolved</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     */
+    Status?: string;
+    /**
+     * @public
+     * <p>The details of the issue.</p>
+     */
+    IssueDetails?: IssueDetails;
+    /**
+     * @public
+     * <p>The supporting attributes to explain the recommended action.</p>
+     */
+    ContextAttributes?: ContextAttribute[];
+}
+/**
+ * @public
+ * <p>The recommendation for your DB instances, DB clusters, and DB parameter groups.</p>
+ */
+export interface DBRecommendation {
+    /**
+     * @public
+     * <p>The unique identifier of the recommendation.</p>
+     */
+    RecommendationId?: string;
+    /**
+     * @public
+     * <p>A value that indicates the type of recommendation. This value determines how the description is rendered.</p>
+     */
+    TypeId?: string;
+    /**
+     * @public
+     * <p>The severity level of the recommendation. The severity level can help you decide the
+     *             urgency with which to address the recommendation.</p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>high</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>medium</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>low</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>informational</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     */
+    Severity?: string;
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.</p>
+     */
+    ResourceArn?: string;
+    /**
+     * @public
+     * <p>The current status of the recommendation.</p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>active</code> - The recommendations which are ready for you to apply.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>pending</code> - The applied or scheduled recommendations which are in progress.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>resolved</code> - The recommendations which are completed.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>dismissed</code> - The recommendations that you dismissed.</p>
+     *             </li>
+     *          </ul>
+     */
+    Status?: string;
+    /**
+     * @public
+     * <p>The time when the recommendation was created. For example, <code>2023-09-28T01:13:53.931000+00:00</code>.</p>
+     */
+    CreatedTime?: Date;
+    /**
+     * @public
+     * <p>The time when the recommendation was last updated.</p>
+     */
+    UpdatedTime?: Date;
+    /**
+     * @public
+     * <p>A short description of the issue identified for this recommendation. The description might contain markdown.</p>
+     */
+    Detection?: string;
+    /**
+     * @public
+     * <p>A short description of the recommendation to resolve an issue. The description might contain markdown.</p>
+     */
+    Recommendation?: string;
+    /**
+     * @public
+     * <p>A detailed description of the recommendation. The description might contain markdown.</p>
+     */
+    Description?: string;
+    /**
+     * @public
+     * <p>The reason why this recommendation was created. The information might contain markdown.</p>
+     */
+    Reason?: string;
+    /**
+     * @public
+     * <p>A list of recommended actions.</p>
+     */
+    RecommendedActions?: RecommendedAction[];
+    /**
+     * @public
+     * <p>The category of the recommendation.</p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>performance efficiency</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>security</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>reliability</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>cost optimization</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>operational excellence</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>sustainability</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     */
+    Category?: string;
+    /**
+     * @public
+     * <p>The Amazon Web Services service that generated the recommendations.</p>
+     */
+    Source?: string;
+    /**
+     * @public
+     * <p>A short description of the recommendation type. The description might contain markdown.</p>
+     */
+    TypeDetection?: string;
+    /**
+     * @public
+     * <p>A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.</p>
+     */
+    TypeRecommendation?: string;
+    /**
+     * @public
+     * <p>A short description that explains the possible impact of an issue.</p>
+     */
+    Impact?: string;
+    /**
+     * @public
+     * <p>Additional information about the recommendation. The information might contain markdown.</p>
+     */
+    AdditionalInfo?: string;
+    /**
+     * @public
+     * <p>A link to documentation that provides additional information about the recommendation.</p>
+     */
+    Links?: DocLink[];
+    /**
+     * @public
+     * <p>Details of the issue that caused the recommendation.</p>
+     */
+    IssueDetails?: IssueDetails;
+}
+/**
+ * @public
+ */
+export interface DBRecommendationsMessage {
+    /**
+     * @public
+     * <p>A list of recommendations which is returned from <code>DescribeDBRecommendations</code> API request.</p>
+     */
+    DBRecommendations?: DBRecommendation[];
+    /**
+     * @public
+     * <p>An optional pagination token provided by a previous <code>DBRecommendationsMessage</code> request.  This token can be used
+     *             later in a <code>DescribeDBRecomendations</code> request.
+     *         </p>
+     */
+    Marker?: string;
+}
+/**
+ * @public
+ */
+export interface DescribeDBRecommendationsMessage {
+    /**
+     * @public
+     * <p>A filter to include only the recommendations that were updated after this specified time.</p>
+     */
+    LastUpdatedAfter?: Date;
+    /**
+     * @public
+     * <p>A filter to include only the recommendations that were updated before this specified time.</p>
+     */
+    LastUpdatedBefore?: Date;
+    /**
+     * @public
+     * <p>The language that you choose to return the list of recommendations.</p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>en</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>en_UK</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>de</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>es</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>fr</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>id</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>it</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ja</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ko</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>pt_BR</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>zh_TW</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>zh_CN</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     */
+    Locale?: string;
+    /**
+     * @public
+     * <p>A filter that specifies one or more recommendations to describe.</p>
+     *          <p>Supported Filters:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>recommendation-id</code> - Accepts a list of recommendation identifiers. The results list
+     *                 only includes the recommendations whose identifier is one of the specified filter values.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>status</code> - Accepts a list of recommendation statuses.</p>
+     *                <p>Valid values:</p>
+     *                <ul>
+     *                   <li>
+     *                      <p>
+     *                         <code>active</code> - The recommendations which are ready for you to apply.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>pending</code> - The applied or scheduled recommendations which are in progress.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>resolved</code> - The recommendations which are completed.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>dismissed</code> - The recommendations that you dismissed.</p>
+     *                   </li>
+     *                </ul>
+     *                <p>The results list only includes the recommendations whose status is one of the specified filter values.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>severity</code> - Accepts a list of recommendation severities. The results list only includes
+     *                 the recommendations whose severity is one of the specified filter values.</p>
+     *                <p>Valid values:</p>
+     *                <ul>
+     *                   <li>
+     *                      <p>
+     *                         <code>high</code>
+     *                      </p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>medium</code>
+     *                      </p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>low</code>
+     *                      </p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>informational</code>
+     *                      </p>
+     *                   </li>
+     *                </ul>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>type-id</code> - Accepts a list of recommendation type identifiers. The results list only
+     *             includes the recommendations whose type is one of the specified filter values.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>dbi-resource-id</code> - Accepts a list of database resource identifiers. The results list only
+     *                 includes the recommendations that generated for the specified databases.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>cluster-resource-id</code> - Accepts a list of cluster resource identifiers. The results list only
+     *                 includes the recommendations that generated for the specified clusters.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>pg-arn</code> - Accepts a list of parameter group ARNs. The results list only
+     *                 includes the recommendations that generated for the specified parameter groups.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>cluster-pg-arn</code> - Accepts a list of cluster parameter group ARNs. The results list only
+     *                 includes the recommendations that generated for the specified cluster parameter groups.</p>
+     *             </li>
+     *          </ul>
+     */
+    Filters?: Filter[];
+    /**
+     * @public
+     * <p>The maximum number of recommendations to include in the response. If more records exist than the
+     *             specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so
+     *             that you can retrieve the remaining results.</p>
+     */
+    MaxRecords?: number;
+    /**
+     * @public
+     * <p>An optional pagination token provided by a previous <code>DescribeDBRecommendations</code> request.
+     *             If this parameter is specified, the response includes only records beyond the marker, up to the
+     *             value specified by <code>MaxRecords</code>.
+     *            </p>
+     */
+    Marker?: string;
+}
 /**
  * @public
  * <p>Contains the result of a successful invocation of the <code>DescribeDBSecurityGroups</code> action.</p>
@@ -7455,6 +8181,78 @@ export interface ModifyDBProxyTargetGroupResponse {
      */
     DBProxyTargetGroup?: DBProxyTargetGroup;
 }
+/**
+ * @public
+ */
+export interface DBRecommendationMessage {
+    /**
+     * @public
+     * <p>The recommendation for your DB instances, DB clusters, and DB parameter groups.</p>
+     */
+    DBRecommendation?: DBRecommendation;
+}
+/**
+ * @public
+ * <p>The recommended status to update for the specified recommendation action ID.</p>
+ */
+export interface RecommendedActionUpdate {
+    /**
+     * @public
+     * <p>A unique identifier of the updated recommendation action.</p>
+     */
+    ActionId: string | undefined;
+    /**
+     * @public
+     * <p>The status of the updated recommendation action.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>applied</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>scheduled</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     */
+    Status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ModifyDBRecommendationMessage {
+    /**
+     * @public
+     * <p>The identifier of the recommendation to update.</p>
+     */
+    RecommendationId: string | undefined;
+    /**
+     * @public
+     * <p>The language of the modified recommendation.</p>
+     */
+    Locale?: string;
+    /**
+     * @public
+     * <p>The recommendation status to update.</p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>active</p>
+     *             </li>
+     *             <li>
+     *                <p>dismissed</p>
+     *             </li>
+     *          </ul>
+     */
+    Status?: string;
+    /**
+     * @public
+     * <p>The list of recommended action status to update. You can update multiple recommended actions at one time.</p>
+     */
+    RecommendedActionUpdates?: RecommendedActionUpdate[];
+}
 /**
  * @public
  */