@aws-sdk/client-pi 3.388.0 → 3.392.0

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

@@ -1,5 +1,267 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { PIServiceException as __BaseException } from "./PIServiceException";
+/**
+ * @public
+ * @enum
+ */
+export declare const AcceptLanguage: {
+    readonly EN_US: "EN_US";
+};
+/**
+ * @public
+ */
+export type AcceptLanguage = (typeof AcceptLanguage)[keyof typeof AcceptLanguage];
+/**
+ * @public
+ * <p>This data type helps to determine Performance Insights metric to render for the insight.</p>
+ */
+export interface PerformanceInsightsMetric {
+    /**
+     * @public
+     * <p>The Performance Insights metric.</p>
+     */
+    Metric?: string;
+    /**
+     * @public
+     * <p>The Performance Insights metric name.</p>
+     */
+    DisplayName?: string;
+    /**
+     * @public
+     * <p>A dimension map that contains the dimensions for this partition.</p>
+     */
+    Dimensions?: Record<string, string>;
+    /**
+     * @public
+     * <p>The value of the metric. For example, <code>9</code> for <code>db.load.avg</code>.</p>
+     */
+    Value?: number;
+}
+/**
+ * @public
+ * <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>
+ */
+export interface Data {
+    /**
+     * @public
+     * <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>
+     */
+    PerformanceInsightsMetric?: PerformanceInsightsMetric;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ContextType: {
+    readonly CAUSAL: "CAUSAL";
+    readonly CONTEXTUAL: "CONTEXTUAL";
+};
+/**
+ * @public
+ */
+export type ContextType = (typeof ContextType)[keyof typeof ContextType];
+/**
+ * @public
+ * <p>The list of recommendations for the insight.</p>
+ */
+export interface Recommendation {
+    /**
+     * @public
+     * <p>The unique identifier for the recommendation.</p>
+     */
+    RecommendationId?: string;
+    /**
+     * @public
+     * <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>
+     */
+    RecommendationDescription?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const Severity: {
+    readonly HIGH: "HIGH";
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+};
+/**
+ * @public
+ */
+export type Severity = (typeof Severity)[keyof typeof Severity];
+/**
+ * @public
+ * @enum
+ */
+export declare const ServiceType: {
+    readonly DOCDB: "DOCDB";
+    readonly RDS: "RDS";
+};
+/**
+ * @public
+ */
+export type ServiceType = (typeof ServiceType)[keyof typeof ServiceType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AnalysisStatus: {
+    readonly FAILED: "FAILED";
+    readonly RUNNING: "RUNNING";
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type AnalysisStatus = (typeof AnalysisStatus)[keyof typeof AnalysisStatus];
+/**
+ * @public
+ * <p>Metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>
+ */
+export interface Tag {
+    /**
+     * @public
+     * <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>
+     */
+    Key: string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    Value: string | undefined;
+}
+/**
+ * @public
+ * <p>Retrieves the details of the performance analysis report.</p>
+ */
+export interface AnalysisReportSummary {
+    /**
+     * @public
+     * <p>The name of the analysis report.</p>
+     */
+    AnalysisReportId?: string;
+    /**
+     * @public
+     * <p>The time you created the analysis report.</p>
+     */
+    CreateTime?: Date;
+    /**
+     * @public
+     * <p>The start time of the analysis in the report.</p>
+     */
+    StartTime?: Date;
+    /**
+     * @public
+     * <p>The end time of the analysis in the report.</p>
+     */
+    EndTime?: Date;
+    /**
+     * @public
+     * <p>The status of the analysis report.</p>
+     */
+    Status?: AnalysisStatus | string;
+    /**
+     * @public
+     * <p>List of all the tags added to the analysis report.</p>
+     */
+    Tags?: Tag[];
+}
+/**
+ * @public
+ */
+export interface CreatePerformanceAnalysisReportRequest {
+    /**
+     * @public
+     * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>
+     */
+    ServiceType: ServiceType | string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    Identifier: string | undefined;
+    /**
+     * @public
+     * <p>The start time defined for the analysis report.</p>
+     */
+    StartTime: Date | undefined;
+    /**
+     * @public
+     * <p>The end time defined for the analysis report.</p>
+     */
+    EndTime: Date | undefined;
+    /**
+     * @public
+     * <p>The metadata assigned to the analysis report consisting of a key-value pair.</p>
+     */
+    Tags?: Tag[];
+}
+/**
+ * @public
+ */
+export interface CreatePerformanceAnalysisReportResponse {
+    /**
+     * @public
+     * <p>A unique identifier for the created analysis report.</p>
+     */
+    AnalysisReportId?: string;
+}
+/**
+ * @public
+ * <p>The request failed due to an unknown error.</p>
+ */
+export declare class InternalServiceError extends __BaseException {
+    readonly name: "InternalServiceError";
+    readonly $fault: "server";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
+}
+/**
+ * @public
+ * <p>One of the arguments provided is invalid for this request.</p>
+ */
+export declare class InvalidArgumentException extends __BaseException {
+    readonly name: "InvalidArgumentException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
+}
+/**
+ * @public
+ * <p>The user is not authorized to perform this request.</p>
+ */
+export declare class NotAuthorizedException extends __BaseException {
+    readonly name: "NotAuthorizedException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
+}
 /**
  * @public
  * <p>A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.</p>
@@ -16,6 +278,35 @@ export interface DataPoint {
      */
     Value: number | undefined;
 }
+/**
+ * @public
+ */
+export interface DeletePerformanceAnalysisReportRequest {
+    /**
+     * @public
+     * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>
+     */
+    ServiceType: ServiceType | string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    Identifier: string | undefined;
+    /**
+     * @public
+     * <p>The unique identifier of the analysis report for deletion.</p>
+     */
+    AnalysisReportId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeletePerformanceAnalysisReportResponse {
+}
 /**
  * @public
  * <p>A logical grouping of Performance Insights metrics for a related subject area. For example, the
@@ -289,18 +580,6 @@ export interface DimensionGroup {
      */
     Limit?: number;
 }
-/**
- * @public
- * @enum
- */
-export declare const ServiceType: {
-    readonly DOCDB: "DOCDB";
-    readonly RDS: "RDS";
-};
-/**
- * @public
- */
-export type ServiceType = (typeof ServiceType)[keyof typeof ServiceType];
 /**
  * @public
  */
@@ -526,45 +805,6 @@ export interface DescribeDimensionKeysResponse {
      */
     NextToken?: string;
 }
-/**
- * @public
- * <p>The request failed due to an unknown error.</p>
- */
-export declare class InternalServiceError extends __BaseException {
-    readonly name: "InternalServiceError";
-    readonly $fault: "server";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
-}
-/**
- * @public
- * <p>One of the arguments provided is invalid for this request.</p>
- */
-export declare class InvalidArgumentException extends __BaseException {
-    readonly name: "InvalidArgumentException";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
-}
-/**
- * @public
- * <p>The user is not authorized to perform this request.</p>
- */
-export declare class NotAuthorizedException extends __BaseException {
-    readonly name: "NotAuthorizedException";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
-}
 /**
  * @public
  * @enum
@@ -794,6 +1034,58 @@ export interface GetDimensionKeyDetailsResponse {
      */
     Dimensions?: DimensionKeyDetail[];
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const TextFormat: {
+    readonly MARKDOWN: "MARKDOWN";
+    readonly PLAIN_TEXT: "PLAIN_TEXT";
+};
+/**
+ * @public
+ */
+export type TextFormat = (typeof TextFormat)[keyof typeof TextFormat];
+/**
+ * @public
+ */
+export interface GetPerformanceAnalysisReportRequest {
+    /**
+     * @public
+     * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is
+     *             <code>RDS</code>.</p>
+     */
+    ServiceType: ServiceType | string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    Identifier: string | undefined;
+    /**
+     * @public
+     * <p>A unique identifier of the created analysis report. For example,
+     *             <code>report-12345678901234567</code>
+     *          </p>
+     */
+    AnalysisReportId: string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    TextFormat?: TextFormat | string;
+    /**
+     * @public
+     * <p>The text language in the report. The default language is <code>EN_US</code> (English).
+     *         </p>
+     */
+    AcceptLanguage?: AcceptLanguage | string;
+}
 /**
  * @public
  */
@@ -1253,3 +1545,293 @@ export interface ListAvailableResourceMetricsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListPerformanceAnalysisReportsRequest {
+    /**
+     * @public
+     * <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid value is
+     *             <code>RDS</code>.</p>
+     */
+    ServiceType: ServiceType | string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    Identifier: string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <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>
+     */
+    MaxResults?: number;
+    /**
+     * @public
+     * <p>Specifies whether or not to include the list of tags in the response.</p>
+     */
+    ListTags?: boolean;
+}
+/**
+ * @public
+ */
+export interface ListPerformanceAnalysisReportsResponse {
+    /**
+     * @public
+     * <p>List of reports including the report identifier, start and end time, creation time,
+     *             and status.</p>
+     */
+    AnalysisReports?: AnalysisReportSummary[];
+    /**
+     * @public
+     * <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>
+     */
+    NextToken?: string;
+}
+/**
+ * @public
+ */
+export interface ListTagsForResourceRequest {
+    /**
+     * @public
+     * <p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>
+     */
+    ServiceType: ServiceType | string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    ResourceARN: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListTagsForResourceResponse {
+    /**
+     * @public
+     * <p>The metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>
+     */
+    Tags?: Tag[];
+}
+/**
+ * @public
+ */
+export interface TagResourceRequest {
+    /**
+     * @public
+     * <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>
+     */
+    ServiceType: ServiceType | string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    ResourceARN: string | undefined;
+    /**
+     * @public
+     * <p>The metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>
+     */
+    Tags: Tag[] | undefined;
+}
+/**
+ * @public
+ */
+export interface TagResourceResponse {
+}
+/**
+ * @public
+ */
+export interface UntagResourceRequest {
+    /**
+     * @public
+     * <p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>
+     */
+    ServiceType: ServiceType | string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    ResourceARN: string | undefined;
+    /**
+     * @public
+     * <p>The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.</p>
+     */
+    TagKeys: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UntagResourceResponse {
+}
+/**
+ * @public
+ * <p>Retrieves the list of performance issues which are identified.</p>
+ */
+export interface Insight {
+    /**
+     * @public
+     * <p>The unique identifier for the insight. For example, <code>insight-12345678901234567</code>.</p>
+     */
+    InsightId: string | undefined;
+    /**
+     * @public
+     * <p>The type of insight. For example, <code>HighDBLoad</code>, <code>HighCPU</code>, or <code>DominatingSQLs</code>.</p>
+     */
+    InsightType?: string;
+    /**
+     * @public
+     * <p>Indicates if the insight is causal or correlated insight.</p>
+     */
+    Context?: ContextType | string;
+    /**
+     * @public
+     * <p>The start time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>
+     */
+    StartTime?: Date;
+    /**
+     * @public
+     * <p>The end time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>
+     */
+    EndTime?: Date;
+    /**
+     * @public
+     * <p>The severity of the insight. The values are: <code>Low</code>, <code>Medium</code>, or <code>High</code>.</p>
+     */
+    Severity?: Severity | string;
+    /**
+     * @public
+     * <p>List of supporting insights that provide additional factors for the insight.</p>
+     */
+    SupportingInsights?: Insight[];
+    /**
+     * @public
+     * <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>
+     */
+    Description?: string;
+    /**
+     * @public
+     * <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>
+     */
+    Recommendations?: Recommendation[];
+    /**
+     * @public
+     * <p>List of data objects containing metrics and references from the time range while generating the insight.</p>
+     */
+    InsightData?: Data[];
+    /**
+     * @public
+     * <p>
+     *             Metric names and values from the timeframe
+     *             used as baseline to generate the insight.</p>
+     */
+    BaselineData?: Data[];
+}
+/**
+ * @public
+ * <p>Retrieves the summary of the performance analysis report created for a time period.</p>
+ */
+export interface AnalysisReport {
+    /**
+     * @public
+     * <p>The name of the analysis report.</p>
+     */
+    AnalysisReportId: string | undefined;
+    /**
+     * @public
+     * <p>The unique identifier of the analysis report.</p>
+     */
+    Identifier?: string;
+    /**
+     * @public
+     * <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>
+     */
+    ServiceType?: ServiceType | string;
+    /**
+     * @public
+     * <p>The time you created the analysis report.</p>
+     */
+    CreateTime?: Date;
+    /**
+     * @public
+     * <p>The analysis start time in the report.</p>
+     */
+    StartTime?: Date;
+    /**
+     * @public
+     * <p>The analysis end time in the report.</p>
+     */
+    EndTime?: Date;
+    /**
+     * @public
+     * <p>The status of the created analysis report.</p>
+     */
+    Status?: AnalysisStatus | string;
+    /**
+     * @public
+     * <p>The list of identified insights in the analysis report.</p>
+     */
+    Insights?: Insight[];
+}
+/**
+ * @public
+ */
+export interface GetPerformanceAnalysisReportResponse {
+    /**
+     * @public
+     * <p>The summary of the performance analysis report created for a time period.</p>
+     */
+    AnalysisReport?: AnalysisReport;
+}
+/**
+ * @internal
+ */
+export declare const RecommendationFilterSensitiveLog: (obj: Recommendation) => any;
+/**
+ * @internal
+ */
+export declare const InsightFilterSensitiveLog: (obj: Insight) => any;
+/**
+ * @internal
+ */
+export declare const AnalysisReportFilterSensitiveLog: (obj: AnalysisReport) => any;
+/**
+ * @internal
+ */
+export declare const GetPerformanceAnalysisReportResponseFilterSensitiveLog: (obj: GetPerformanceAnalysisReportResponse) => any;