Creates a new performance analysis report for a specific time period for the + * DB instance.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, CreatePerformanceAnalysisReportCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, CreatePerformanceAnalysisReportCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const input = { // CreatePerformanceAnalysisReportRequest + * ServiceType: "RDS" || "DOCDB", // required + * Identifier: "STRING_VALUE", // required + * StartTime: new Date("TIMESTAMP"), // required + * EndTime: new Date("TIMESTAMP"), // required + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreatePerformanceAnalysisReportCommand(input); + * const response = await client.send(command); + * // { // CreatePerformanceAnalysisReportResponse + * // AnalysisReportId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreatePerformanceAnalysisReportCommandInput - {@link CreatePerformanceAnalysisReportCommandInput} + * @returns {@link CreatePerformanceAnalysisReportCommandOutput} + * @see {@link CreatePerformanceAnalysisReportCommandInput} for command's `input` shape. + * @see {@link CreatePerformanceAnalysisReportCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + * @throws {@link InternalServiceError} (server fault) + *The request failed due to an unknown error.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *One of the arguments provided is invalid for this request.
+ * + * @throws {@link NotAuthorizedException} (client fault) + *The user is not authorized to perform this request.
+ * + * @throws {@link PIServiceException} + *Base exception class for all service exceptions from PI service.
+ * + */ +export class CreatePerformanceAnalysisReportCommand extends $Command< + CreatePerformanceAnalysisReportCommandInput, + CreatePerformanceAnalysisReportCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreatePerformanceAnalysisReportCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a performance analysis report.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, DeletePerformanceAnalysisReportCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, DeletePerformanceAnalysisReportCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const input = { // DeletePerformanceAnalysisReportRequest + * ServiceType: "RDS" || "DOCDB", // required + * Identifier: "STRING_VALUE", // required + * AnalysisReportId: "STRING_VALUE", // required + * }; + * const command = new DeletePerformanceAnalysisReportCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeletePerformanceAnalysisReportCommandInput - {@link DeletePerformanceAnalysisReportCommandInput} + * @returns {@link DeletePerformanceAnalysisReportCommandOutput} + * @see {@link DeletePerformanceAnalysisReportCommandInput} for command's `input` shape. + * @see {@link DeletePerformanceAnalysisReportCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + * @throws {@link InternalServiceError} (server fault) + *The request failed due to an unknown error.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *One of the arguments provided is invalid for this request.
+ * + * @throws {@link NotAuthorizedException} (client fault) + *The user is not authorized to perform this request.
+ * + * @throws {@link PIServiceException} + *Base exception class for all service exceptions from PI service.
+ * + */ +export class DeletePerformanceAnalysisReportCommand extends $Command< + DeletePerformanceAnalysisReportCommandInput, + DeletePerformanceAnalysisReportCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeletePerformanceAnalysisReportCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves the report including the report ID, status, time details, and the insights
+ * with recommendations. The report status can be RUNNING,
+ * SUCCEEDED, or FAILED. The insights include the
+ * description and recommendation fields.
The request failed due to an unknown error.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *One of the arguments provided is invalid for this request.
+ * + * @throws {@link NotAuthorizedException} (client fault) + *The user is not authorized to perform this request.
+ * + * @throws {@link PIServiceException} + *Base exception class for all service exceptions from PI service.
+ * + */ +export class GetPerformanceAnalysisReportCommand extends $Command< + GetPerformanceAnalysisReportCommandInput, + GetPerformanceAnalysisReportCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetPerformanceAnalysisReportCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, ListPerformanceAnalysisReportsCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, ListPerformanceAnalysisReportsCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const input = { // ListPerformanceAnalysisReportsRequest + * ServiceType: "RDS" || "DOCDB", // required + * Identifier: "STRING_VALUE", // required + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * ListTags: true || false, + * }; + * const command = new ListPerformanceAnalysisReportsCommand(input); + * const response = await client.send(command); + * // { // ListPerformanceAnalysisReportsResponse + * // AnalysisReports: [ // AnalysisReportSummaryList + * // { // AnalysisReportSummary + * // AnalysisReportId: "STRING_VALUE", + * // CreateTime: new Date("TIMESTAMP"), + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // Status: "RUNNING" || "SUCCEEDED" || "FAILED", + * // Tags: [ // TagList + * // { // Tag + * // Key: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListPerformanceAnalysisReportsCommandInput - {@link ListPerformanceAnalysisReportsCommandInput} + * @returns {@link ListPerformanceAnalysisReportsCommandOutput} + * @see {@link ListPerformanceAnalysisReportsCommandInput} for command's `input` shape. + * @see {@link ListPerformanceAnalysisReportsCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + * @throws {@link InternalServiceError} (server fault) + *The request failed due to an unknown error.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *One of the arguments provided is invalid for this request.
+ * + * @throws {@link NotAuthorizedException} (client fault) + *The user is not authorized to perform this request.
+ * + * @throws {@link PIServiceException} + *Base exception class for all service exceptions from PI service.
+ * + */ +export class ListPerformanceAnalysisReportsCommand extends $Command< + ListPerformanceAnalysisReportsCommandInput, + ListPerformanceAnalysisReportsCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListPerformanceAnalysisReportsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, ListTagsForResourceCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, ListTagsForResourceCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const input = { // ListTagsForResourceRequest + * ServiceType: "RDS" || "DOCDB", // required + * ResourceARN: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceResponse + * // Tags: [ // TagList + * // { // Tag + * // Key: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput} + * @returns {@link ListTagsForResourceCommandOutput} + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + * @throws {@link InternalServiceError} (server fault) + *The request failed due to an unknown error.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *One of the arguments provided is invalid for this request.
+ * + * @throws {@link NotAuthorizedException} (client fault) + *The user is not authorized to perform this request.
+ * + * @throws {@link PIServiceException} + *Base exception class for all service exceptions from PI service.
+ * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTagsForResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAdds metadata tags to the Amazon RDS Performance Insights resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, TagResourceCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, TagResourceCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const input = { // TagResourceRequest + * ServiceType: "RDS" || "DOCDB", // required + * ResourceARN: "STRING_VALUE", // required + * Tags: [ // TagList // required + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param TagResourceCommandInput - {@link TagResourceCommandInput} + * @returns {@link TagResourceCommandOutput} + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + * @throws {@link InternalServiceError} (server fault) + *The request failed due to an unknown error.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *One of the arguments provided is invalid for this request.
+ * + * @throws {@link NotAuthorizedException} (client fault) + *The user is not authorized to perform this request.
+ * + * @throws {@link PIServiceException} + *Base exception class for all service exceptions from PI service.
+ * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: TagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the metadata tags from the Amazon RDS Performance Insights resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, UntagResourceCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, UntagResourceCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const input = { // UntagResourceRequest + * ServiceType: "RDS" || "DOCDB", // required + * ResourceARN: "STRING_VALUE", // required + * TagKeys: [ // TagKeyList // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagResourceCommandInput - {@link UntagResourceCommandInput} + * @returns {@link UntagResourceCommandOutput} + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + * @throws {@link InternalServiceError} (server fault) + *The request failed due to an unknown error.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *One of the arguments provided is invalid for this request.
+ * + * @throws {@link NotAuthorizedException} (client fault) + *The user is not authorized to perform this request.
+ * + * @throws {@link PIServiceException} + *Base exception class for all service exceptions from PI service.
+ * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThis data type helps to determine Performance Insights metric to render for the insight.
+ */ +export interface PerformanceInsightsMetric { + /** + * @public + *The Performance Insights metric.
+ */ + Metric?: string; + + /** + * @public + *The Performance Insights metric name.
+ */ + DisplayName?: string; + + /** + * @public + *A dimension map that contains the dimensions for this partition.
+ */ + Dimensions?: RecordThe value of the metric. For example, 9 for db.load.avg.
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.
+ */ +export interface Data { + /** + * @public + *This field determines the Performance Insights metric to render
+ * for the insight. The name field refers to a Performance Insights metric.
+ *
The list of recommendations for the insight.
+ */ +export interface Recommendation { + /** + * @public + *The unique identifier for the recommendation.
+ */ + RecommendationId?: string; + + /** + * @public + *The recommendation details to help resolve the performance issue. For example,
+ * Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
+ *
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
+ */ +export interface Tag { + /** + * @public + *A key is the required name of the tag. The string value can be from 1 to 128 Unicode
+ * characters in length and can't be prefixed with aws: or rds:.
+ * The string can only contain only the set of Unicode letters, digits,
+ * white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p\{L\}\\p\{Z\}\\p\{N\}_.:/=+\\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256
+ * Unicode characters in length and can't be prefixed with aws: or rds:.
+ * The string can only contain only the set of Unicode letters, digits,
+ * white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p\{L\}\\p\{Z\}\\p\{N\}_.:/=+\\-@]*)$").
Retrieves the details of the performance analysis report.
+ */ +export interface AnalysisReportSummary { + /** + * @public + *The name of the analysis report.
+ */ + AnalysisReportId?: string; + + /** + * @public + *The time you created the analysis report.
+ */ + CreateTime?: Date; + + /** + * @public + *The start time of the analysis in the report.
+ */ + StartTime?: Date; + + /** + * @public + *The end time of the analysis in the report.
+ */ + EndTime?: Date; + + /** + * @public + *The status of the analysis report.
+ */ + Status?: AnalysisStatus | string; + + /** + * @public + *List of all the tags added to the analysis report.
+ */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface CreatePerformanceAnalysisReportRequest { + /** + * @public + *The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from + * this data source.
+ *To use an Amazon RDS instance as a data source, you specify its DbiResourceId value.
+ * For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.
The start time defined for the analysis report.
+ */ + StartTime: Date | undefined; + + /** + * @public + *The end time defined for the analysis report.
+ */ + EndTime: Date | undefined; + + /** + * @public + *The metadata assigned to the analysis report consisting of a key-value pair.
+ */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface CreatePerformanceAnalysisReportResponse { + /** + * @public + *A unique identifier for the created analysis report.
+ */ + AnalysisReportId?: string; +} + +/** + * @public + *The request failed due to an unknown error.
+ */ +export class InternalServiceError extends __BaseException { + readonly name: "InternalServiceError" = "InternalServiceError"; + readonly $fault: "server" = "server"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeOne of the arguments provided is invalid for this request.
+ */ +export class InvalidArgumentException extends __BaseException { + readonly name: "InvalidArgumentException" = "InvalidArgumentException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe user is not authorized to perform this request.
+ */ +export class NotAuthorizedException extends __BaseException { + readonly name: "NotAuthorizedException" = "NotAuthorizedException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
@@ -21,6 +341,38 @@ export interface DataPoint { Value: number | undefined; } +/** + * @public + */ +export interface DeletePerformanceAnalysisReportRequest { + /** + * @public + *The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source.
+ * In the console, the identifier is shown as ResourceID. When you
+ * call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify
+ * db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The unique identifier of the analysis report for deletion.
+ */ + AnalysisReportId: string | undefined; +} + +/** + * @public + */ +export interface DeletePerformanceAnalysisReportResponse {} + /** * @public *A logical grouping of Performance Insights metrics for a related subject area. For example, the @@ -297,20 +649,6 @@ export interface DimensionGroup { Limit?: number; } -/** - * @public - * @enum - */ -export const ServiceType = { - DOCDB: "DOCDB", - RDS: "RDS", -} as const; - -/** - * @public - */ -export type ServiceType = (typeof ServiceType)[keyof typeof ServiceType]; - /** * @public */ @@ -558,72 +896,6 @@ export interface DescribeDimensionKeysResponse { NextToken?: string; } -/** - * @public - *
The request failed due to an unknown error.
- */ -export class InternalServiceError extends __BaseException { - readonly name: "InternalServiceError" = "InternalServiceError"; - readonly $fault: "server" = "server"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeOne of the arguments provided is invalid for this request.
- */ -export class InvalidArgumentException extends __BaseException { - readonly name: "InvalidArgumentException" = "InvalidArgumentException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe user is not authorized to perform this request.
- */ -export class NotAuthorizedException extends __BaseException { - readonly name: "NotAuthorizedException" = "NotAuthorizedException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeA list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns + * all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
+ *
+ * db.sql - Specify either the full dimension name db.sql.statement or the short dimension name
+ * statement (Aurora and RDS only).
+ * db.query - Specify either the full dimension name db.query.statement or the short dimension name
+ * statement (DocumentDB only).
The details for the requested dimensions.
+ */ + Dimensions?: DimensionKeyDetail[]; +} + +/** + * @public + * @enum + */ +export const TextFormat = { + MARKDOWN: "MARKDOWN", + PLAIN_TEXT: "PLAIN_TEXT", +} as const; + +/** + * @public + */ +export type TextFormat = (typeof TextFormat)[keyof typeof TextFormat]; + +/** + * @public + */ +export interface GetPerformanceAnalysisReportRequest { + /** + * @public + *The Amazon Web Services service for which Performance Insights will return metrics. Valid value is
+ * RDS.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers
+ * metrics from this data source. In the console, the identifier is shown as
+ * ResourceID. When you call DescribeDBInstances, the identifier is
+ * returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify
+ * db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns - * all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
- *
- * db.sql - Specify either the full dimension name db.sql.statement or the short dimension name
- * statement (Aurora and RDS only).
- * db.query - Specify either the full dimension name db.query.statement or the short dimension name
- * statement (DocumentDB only).
A unique identifier of the created analysis report. For example,
+ * report-12345678901234567
+ *
The details for the requested dimensions.
+ *Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default
+ * value is plain text.
The text language in the report. The default language is EN_US (English).
+ *
The Amazon Web Services service for which Performance Insights returns metrics. Valid value is
+ * RDS.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the
+ * console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is
+ * returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify
+ * db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An optional pagination token provided by a previous request.
+ * If this parameter is specified, the response includes only records beyond
+ * the token, up to the value specified by MaxResults.
The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a
+ * pagination token is included in the response so that the remaining results can be retrieved.
Specifies whether or not to include the list of tags in the response.
+ */ + ListTags?: boolean; +} + +/** + * @public + */ +export interface ListPerformanceAnalysisReportsResponse { + /** + * @public + *List of reports including the report identifier, start and end time, creation time, + * and status.
+ */ + AnalysisReports?: AnalysisReportSummary[]; + + /** + * @public + *An optional pagination token provided by a previous request.
+ * If this parameter is specified, the response includes only records beyond the token,
+ * up to the value specified by MaxResults.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
Lists all the tags for the Amazon RDS Performance Insights resource. This value is an + * Amazon Resource Name (ARN). For information about creating an ARN, + * see + * Constructing an RDS Amazon Resource Name (ARN).
+ */ + ResourceARN: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + * @public + *The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
+ */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface TagResourceRequest { + /** + * @public + *The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about + * creating an ARN, see + * Constructing an RDS Amazon Resource Name (ARN).
+ */ + ResourceARN: string | undefined; + + /** + * @public + *The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
+ */ + Tags: Tag[] | undefined; +} + +/** + * @public + */ +export interface TagResourceResponse {} + +/** + * @public + */ +export interface UntagResourceRequest { + /** + * @public + *List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about + * creating an ARN, see + * Constructing an RDS Amazon Resource Name (ARN).
+ */ + ResourceARN: string | undefined; + + /** + * @public + *The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.
+ */ + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceResponse {} + +/** + * @public + *Retrieves the list of performance issues which are identified.
+ */ +export interface Insight { + /** + * @public + *The unique identifier for the insight. For example, insight-12345678901234567.
The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.
Indicates if the insight is causal or correlated insight.
+ */ + Context?: ContextType | string; + + /** + * @public + *The start time of the insight. For example, 2018-10-30T00:00:00Z.
The end time of the insight. For example, 2018-10-30T00:00:00Z.
The severity of the insight. The values are: Low, Medium, or High.
List of supporting insights that provide additional factors for the insight.
+ */ + SupportingInsights?: Insight[]; + + /** + * @public + *Description of the insight. For example:
+ * A high severity Insight found between 02:00 to 02:30,
+ * where there was an unusually high DB load 600x above baseline.
+ * Likely performance impact.
List of recommendations for the insight.
+ * For example, Investigate the following SQLs that contributed
+ * to 100% of the total DBLoad during that time period: sql-id.
List of data objects containing metrics and references from the time range while generating the insight.
+ */ + InsightData?: Data[]; + + /** + * @public + *+ * Metric names and values from the timeframe + * used as baseline to generate the insight.
+ */ + BaselineData?: Data[]; +} + +/** + * @public + *Retrieves the summary of the performance analysis report created for a time period.
+ */ +export interface AnalysisReport { + /** + * @public + *The name of the analysis report.
+ */ + AnalysisReportId: string | undefined; + + /** + * @public + *The unique identifier of the analysis report.
+ */ + Identifier?: string; + + /** + * @public + *List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
+ *
+ * RDS
+ *
+ * DOCDB
+ *
The time you created the analysis report.
+ */ + CreateTime?: Date; + + /** + * @public + *The analysis start time in the report.
+ */ + StartTime?: Date; + + /** + * @public + *The analysis end time in the report.
+ */ + EndTime?: Date; + + /** + * @public + *The status of the created analysis report.
+ */ + Status?: AnalysisStatus | string; + + /** + * @public + *The list of identified insights in the analysis report.
+ */ + Insights?: Insight[]; +} + +/** + * @public + */ +export interface GetPerformanceAnalysisReportResponse { + /** + * @public + *The summary of the performance analysis report created for a time period.
+ */ + AnalysisReport?: AnalysisReport; +} + +/** + * @internal + */ +export const RecommendationFilterSensitiveLog = (obj: Recommendation): any => ({ + ...obj, + ...(obj.RecommendationDescription && { RecommendationDescription: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const InsightFilterSensitiveLog = (obj: Insight): any => ({ + ...obj, + ...(obj.SupportingInsights && { + SupportingInsights: obj.SupportingInsights.map((item) => InsightFilterSensitiveLog(item)), + }), + ...(obj.Description && { Description: SENSITIVE_STRING }), + ...(obj.Recommendations && { + Recommendations: obj.Recommendations.map((item) => RecommendationFilterSensitiveLog(item)), + }), +}); + +/** + * @internal + */ +export const AnalysisReportFilterSensitiveLog = (obj: AnalysisReport): any => ({ + ...obj, + ...(obj.Insights && { Insights: obj.Insights.map((item) => InsightFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const GetPerformanceAnalysisReportResponseFilterSensitiveLog = ( + obj: GetPerformanceAnalysisReportResponse +): any => ({ + ...obj, + ...(obj.AnalysisReport && { AnalysisReport: AnalysisReportFilterSensitiveLog(obj.AnalysisReport) }), +}); diff --git a/clients/client-pi/src/pagination/ListPerformanceAnalysisReportsPaginator.ts b/clients/client-pi/src/pagination/ListPerformanceAnalysisReportsPaginator.ts new file mode 100644 index 000000000000..0dcd479952ce --- /dev/null +++ b/clients/client-pi/src/pagination/ListPerformanceAnalysisReportsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListPerformanceAnalysisReportsCommand, + ListPerformanceAnalysisReportsCommandInput, + ListPerformanceAnalysisReportsCommandOutput, +} from "../commands/ListPerformanceAnalysisReportsCommand"; +import { PIClient } from "../PIClient"; +import { PIPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: PIClient, + input: ListPerformanceAnalysisReportsCommandInput, + ...args: any +): PromiseThe name of the analysis report.
", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.pi#IdentifierString", + "traits": { + "smithy.api#documentation": "The unique identifier of the analysis report.
" + } + }, + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
\n\n RDS\n
\n DOCDB\n
The time you created the analysis report.
" + } + }, + "StartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The analysis start time in the report.
" + } + }, + "EndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The analysis end time in the report.
" + } + }, + "Status": { + "target": "com.amazonaws.pi#AnalysisStatus", + "traits": { + "smithy.api#documentation": "The status of the created analysis report.
" + } + }, + "Insights": { + "target": "com.amazonaws.pi#InsightList", + "traits": { + "smithy.api#documentation": "The list of identified insights in the analysis report.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Retrieves the summary of the performance analysis report created for a time period.
" + } + }, + "com.amazonaws.pi#AnalysisReportId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^report-[0-9a-f]{17}$" + } + }, + "com.amazonaws.pi#AnalysisReportSummary": { + "type": "structure", + "members": { + "AnalysisReportId": { + "target": "com.amazonaws.pi#String", + "traits": { + "smithy.api#documentation": "The name of the analysis report.
" + } + }, + "CreateTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The time you created the analysis report.
" + } + }, + "StartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The start time of the analysis in the report.
" + } + }, + "EndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The end time of the analysis in the report.
" + } + }, + "Status": { + "target": "com.amazonaws.pi#AnalysisStatus", + "traits": { + "smithy.api#documentation": "The status of the analysis report.
" + } + }, + "Tags": { + "target": "com.amazonaws.pi#TagList", + "traits": { + "smithy.api#documentation": "List of all the tags added to the analysis report.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Retrieves the details of the performance analysis report.
" + } + }, + "com.amazonaws.pi#AnalysisReportSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#AnalysisReportSummary" + } + }, + "com.amazonaws.pi#AnalysisStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.pi#Boolean": { + "type": "boolean" + }, + "com.amazonaws.pi#ContextType": { + "type": "enum", + "members": { + "CAUSAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAUSAL" + } + }, + "CONTEXTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTEXTUAL" + } + } + } + }, + "com.amazonaws.pi#CreatePerformanceAnalysisReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#CreatePerformanceAnalysisReportRequest" + }, + "output": { + "target": "com.amazonaws.pi#CreatePerformanceAnalysisReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new performance analysis report for a specific time period for the\n DB instance.
" + } + }, + "com.amazonaws.pi#CreatePerformanceAnalysisReportRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.
\nTo use an Amazon RDS instance as a data source, you specify its DbiResourceId value. \n For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.
The start time defined for the analysis report.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The end time defined for the analysis report.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pi#TagList", + "traits": { + "smithy.api#documentation": "The metadata assigned to the analysis report consisting of a key-value pair.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#CreatePerformanceAnalysisReportResponse": { + "type": "structure", + "members": { + "AnalysisReportId": { + "target": "com.amazonaws.pi#AnalysisReportId", + "traits": { + "smithy.api#documentation": "A unique identifier for the created analysis report.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pi#Data": { + "type": "structure", + "members": { + "PerformanceInsightsMetric": { + "target": "com.amazonaws.pi#PerformanceInsightsMetric", + "traits": { + "smithy.api#documentation": "This field determines the Performance Insights metric to render \n for the insight. The name field refers to a Performance Insights metric. \n
List of data objects which provide details about source metrics. \n This field can be used to determine the PI metric to render\n for the insight. This data type also includes static values \n for the metrics for the Insight that were calculated and included \n in text and annotations on the DB load chart.
" + } + }, + "com.amazonaws.pi#DataList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Data" + } + }, "com.amazonaws.pi#DataPoint": { "type": "structure", "members": { @@ -78,6 +358,65 @@ "target": "com.amazonaws.pi#DataPoint" } }, + "com.amazonaws.pi#DeletePerformanceAnalysisReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#DeletePerformanceAnalysisReportRequest" + }, + "output": { + "target": "com.amazonaws.pi#DeletePerformanceAnalysisReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a performance analysis report.
" + } + }, + "com.amazonaws.pi#DeletePerformanceAnalysisReportRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. \n In the console, the identifier is shown as ResourceID. When you \n call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The unique identifier of the analysis report for deletion.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#DeletePerformanceAnalysisReportResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pi#DescribeDimensionKeys": { "type": "operation", "input": { @@ -117,7 +456,7 @@ } }, "Identifier": { - "target": "com.amazonaws.pi#RequestString", + "target": "com.amazonaws.pi#IdentifierString", "traits": { "smithy.api#documentation": "An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.
\nTo use an Amazon RDS instance as a data source, you specify its DbiResourceId value. \n For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.\n
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,\n GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID.\n This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large\n SQL statement text.
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
The ID for a data source from which to gather dimension data. This ID must be immutable and \n unique within an Amazon Web Services Region. When a DB instance is the data source, specify its \n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.\n
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are\n valid:
\n\n db.query (Amazon DocumentDB only)
\n db.sql (Amazon RDS and Aurora only)
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is\n db.sql.id. The following group ID values are valid:
\n db.sql.id for dimension group db.sql (Aurora and RDS only)
\n db.query.id for dimension group db.query (DocumentDB only)
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\n all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
\n\n db.sql - Specify either the full dimension name db.sql.statement or the short dimension name\n statement (Aurora and RDS only).
\n db.query - Specify either the full dimension name db.query.statement or the short dimension name\n statement (DocumentDB only).
The details for the requested dimensions.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pi#GetDimensionKeyDetails": { + "com.amazonaws.pi#GetPerformanceAnalysisReport": { "type": "operation", "input": { - "target": "com.amazonaws.pi#GetDimensionKeyDetailsRequest" + "target": "com.amazonaws.pi#GetPerformanceAnalysisReportRequest" }, "output": { - "target": "com.amazonaws.pi#GetDimensionKeyDetailsResponse" + "target": "com.amazonaws.pi#GetPerformanceAnalysisReportResponse" }, "errors": [ { @@ -516,44 +953,43 @@ } ], "traits": { - "smithy.api#documentation": "Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,\n GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID.\n This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large\n SQL statement text.
Retrieves the report including the report ID, status, time details, and the insights\n with recommendations. The report status can be RUNNING,\n SUCCEEDED, or FAILED. The insights include the\n description and recommendation fields.
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is\n RDS.
The ID for a data source from which to gather dimension data. This ID must be immutable and \n unique within an Amazon Web Services Region. When a DB instance is the data source, specify its \n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.\n
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers \n metrics from this data source. In the console, the identifier is shown as \n ResourceID. When you call DescribeDBInstances, the identifier is\n returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are\n valid:
\n\n db.query (Amazon DocumentDB only)
\n db.sql (Amazon RDS and Aurora only)
A unique identifier of the created analysis report. For example,\n report-12345678901234567\n
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is\n db.sql.id. The following group ID values are valid:
\n db.sql.id for dimension group db.sql (Aurora and RDS only)
\n db.query.id for dimension group db.query (DocumentDB only)
Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default\n value is plain text.
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\n all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
\n\n db.sql - Specify either the full dimension name db.sql.statement or the short dimension name\n statement (Aurora and RDS only).
\n db.query - Specify either the full dimension name db.query.statement or the short dimension name\n statement (DocumentDB only).
The text language in the report. The default language is EN_US (English). \n
The details for the requested dimensions.
" + "smithy.api#documentation": "The summary of the performance analysis report created for a time period.
" } } }, @@ -609,7 +1045,7 @@ } }, "Identifier": { - "target": "com.amazonaws.pi#RequestString", + "target": "com.amazonaws.pi#IdentifierString", "traits": { "smithy.api#documentation": "An immutable identifier for a data source that is unique for an Amazon Web Services Region. \n Performance Insights gathers metrics from this data source. To use a DB instance as a data source, \n specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.\n
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\n console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is\n returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The unique identifier for the insight. For example, insight-12345678901234567.
The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.
Indicates if the insight is causal or correlated insight.
" + } + }, + "StartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The start time of the insight. For example, 2018-10-30T00:00:00Z.
The end time of the insight. For example, 2018-10-30T00:00:00Z.
The severity of the insight. The values are: Low, Medium, or High.
List of supporting insights that provide additional factors for the insight.
" + } + }, + "Description": { + "target": "com.amazonaws.pi#MarkdownString", + "traits": { + "smithy.api#documentation": "Description of the insight. For example:\n A high severity Insight found between 02:00 to 02:30,\n where there was an unusually high DB load 600x above baseline. \n Likely performance impact.
List of recommendations for the insight.\n For example, Investigate the following SQLs that contributed \n to 100% of the total DBLoad during that time period: sql-id.
List of data objects containing metrics and references from the time range while generating the insight.
" + } + }, + "BaselineData": { + "target": "com.amazonaws.pi#DataList", + "traits": { + "smithy.api#documentation": "\n Metric names and values from the timeframe \n used as baseline to generate the insight.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Retrieves the list of performance issues which are identified.
" + } + }, + "com.amazonaws.pi#InsightList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Insight" } }, "com.amazonaws.pi#Integer": { @@ -861,7 +1378,7 @@ } }, "Identifier": { - "target": "com.amazonaws.pi#RequestString", + "target": "com.amazonaws.pi#IdentifierString", "traits": { "smithy.api#documentation": "An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers\n metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its\n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
The types of metrics for which to retrieve dimensions. Valid values include db.load.
The types of metrics for which to retrieve dimensions. Valid values include db.load.
The maximum number of items to return in the response. If more items exist than the specified \n MaxRecords value, a pagination token is included in the response so that the remaining \n results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
The dimension information returned for requested metric types.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pi#NextToken", + "traits": { + "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.
Retrieve metrics of the specified types that can be queried for a specified DB instance.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.pi#ListAvailableResourceMetricsRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics.
", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.pi#IdentifierString", + "traits": { + "smithy.api#documentation": "An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers\n metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its\n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
The types of metrics to return in the response. Valid values in the array include the following:
\n\n os (OS counter metrics) - All engines
\n db (DB load metrics) - All engines except for Amazon DocumentDB
\n db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
\n db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
The maximum number of items to return. If the MaxRecords value is less than the number \n of existing items, the response includes a pagination token.
An array of metrics available to query. Each array element contains the full name, \n description, and unit of the metric.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.pi#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the\n previous request. To get the remaining records, specify NextToken in a separate request with this value.
Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.pi#ListPerformanceAnalysisReportsRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics. Valid value is\n RDS.
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\n console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is\n returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An optional pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond\n the token, up to the value specified by MaxResults.
The maximum number of items to return in the response. If more items exist than the specified \n MaxRecords value, a pagination token is included in the response so that the remaining \n results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a\n pagination token is included in the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
Specifies whether or not to include the list of tags in the response.
" } } }, @@ -891,19 +1585,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.pi#ListAvailableResourceDimensionsResponse": { + "com.amazonaws.pi#ListPerformanceAnalysisReportsResponse": { "type": "structure", "members": { - "MetricDimensions": { - "target": "com.amazonaws.pi#MetricDimensionsList", + "AnalysisReports": { + "target": "com.amazonaws.pi#AnalysisReportSummaryList", "traits": { - "smithy.api#documentation": "The dimension information returned for requested metric types.
" + "smithy.api#documentation": "List of reports including the report identifier, start and end time, creation time,\n and status.
" } }, "NextToken": { "target": "com.amazonaws.pi#NextToken", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond the token, \n up to the value specified by MaxResults.
Retrieve metrics of the specified types that can be queried for a specified DB instance.\n
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
" } }, - "com.amazonaws.pi#ListAvailableResourceMetricsRequest": { + "com.amazonaws.pi#ListTagsForResourceRequest": { "type": "structure", "members": { "ServiceType": { "target": "com.amazonaws.pi#ServiceType", "traits": { - "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics.
", - "smithy.api#required": {} - } - }, - "Identifier": { - "target": "com.amazonaws.pi#RequestString", - "traits": { - "smithy.api#documentation": "An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers\n metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its\n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The types of metrics to return in the response. Valid values in the array include the following:
\n\n os (OS counter metrics) - All engines
\n db (DB load metrics) - All engines except for Amazon DocumentDB
\n db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
\n db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB
Lists all the tags for the Amazon RDS Performance Insights resource. This value is an \n Amazon Resource Name (ARN). For information about creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).
", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.pi#NextToken", - "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
The maximum number of items to return. If the MaxRecords value is less than the number \n of existing items, the response includes a pagination token.
An array of metrics available to query. Each array element contains the full name, \n description, and unit of the metric.\n
" - } - }, - "NextToken": { - "target": "com.amazonaws.pi#NextToken", + "Tags": { + "target": "com.amazonaws.pi#TagList", "traits": { - "smithy.api#documentation": "A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the\n previous request. To get the remaining records, specify NextToken in a separate request with this value.
The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" } } }, @@ -1000,6 +1664,17 @@ "smithy.api#output": {} } }, + "com.amazonaws.pi#MarkdownString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8000 + }, + "smithy.api#pattern": "^(.|\\n)*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.pi#MaxResults": { "type": "integer", "traits": { @@ -1128,7 +1803,7 @@ "min": 1, "max": 8192 }, - "smithy.api#pattern": "^[\\s\\S]*$" + "smithy.api#pattern": "^[a-zA-Z0-9_=-]+$" } }, "com.amazonaws.pi#NotAuthorizedException": { @@ -1143,16 +1818,57 @@ "smithy.api#error": "client" } }, + "com.amazonaws.pi#PerformanceInsightsMetric": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.pi#DescriptiveString", + "traits": { + "smithy.api#documentation": "The Performance Insights metric.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.pi#DescriptiveString", + "traits": { + "smithy.api#documentation": "The Performance Insights metric name.
" + } + }, + "Dimensions": { + "target": "com.amazonaws.pi#DescriptiveMap", + "traits": { + "smithy.api#documentation": "A dimension map that contains the dimensions for this partition.
" + } + }, + "Value": { + "target": "com.amazonaws.pi#Double", + "traits": { + "smithy.api#documentation": "The value of the metric. For example, 9 for db.load.avg.
This data type helps to determine Performance Insights metric to render for the insight.
" + } + }, "com.amazonaws.pi#PerformanceInsightsv20180227": { "type": "service", "version": "2018-02-27", "operations": [ + { + "target": "com.amazonaws.pi#CreatePerformanceAnalysisReport" + }, + { + "target": "com.amazonaws.pi#DeletePerformanceAnalysisReport" + }, { "target": "com.amazonaws.pi#DescribeDimensionKeys" }, { "target": "com.amazonaws.pi#GetDimensionKeyDetails" }, + { + "target": "com.amazonaws.pi#GetPerformanceAnalysisReport" + }, { "target": "com.amazonaws.pi#GetResourceMetadata" }, @@ -1164,6 +1880,18 @@ }, { "target": "com.amazonaws.pi#ListAvailableResourceMetrics" + }, + { + "target": "com.amazonaws.pi#ListPerformanceAnalysisReports" + }, + { + "target": "com.amazonaws.pi#ListTagsForResource" + }, + { + "target": "com.amazonaws.pi#TagResource" + }, + { + "target": "com.amazonaws.pi#UntagResource" } ], "traits": { @@ -1243,52 +1971,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -1296,13 +2028,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1312,224 +2053,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://pi-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://pi-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://pi-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://pi-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [ + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ + true, { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://pi.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://pi.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://pi.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://pi.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1964,6 +2656,17 @@ "UseDualStack": false } }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1977,6 +2680,17 @@ "UseDualStack": false } }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1990,6 +2704,17 @@ "UseDualStack": false } }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2003,6 +2728,17 @@ "UseDualStack": false } }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2066,6 +2802,12 @@ "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -2089,6 +2831,32 @@ } } }, + "com.amazonaws.pi#Recommendation": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.pi#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the recommendation.
" + } + }, + "RecommendationDescription": { + "target": "com.amazonaws.pi#MarkdownString", + "traits": { + "smithy.api#documentation": "The recommendation details to help resolve the performance issue. For example, \n Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id\n
The list of recommendations for the insight.
" + } + }, + "com.amazonaws.pi#RecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Recommendation" + } + }, "com.amazonaws.pi#RequestString": { "type": "string", "traits": { @@ -2214,6 +2982,29 @@ } } }, + "com.amazonaws.pi#Severity": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, "com.amazonaws.pi#String": { "type": "string", "traits": { @@ -2223,6 +3014,207 @@ }, "smithy.api#pattern": "\\S" } + }, + "com.amazonaws.pi#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.pi#TagKey", + "traits": { + "smithy.api#documentation": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode \n characters in length and can't be prefixed with aws: or rds:. \n The string can only contain only the set of Unicode letters, digits, \n white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
A value is the optional value of the tag. The string value can be from 1 to 256 \n Unicode characters in length and can't be prefixed with aws: or rds:. \n The string can only contain only the set of Unicode letters, digits, \n white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" + } + }, + "com.amazonaws.pi#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.pi#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.pi#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.pi#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pi#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Adds metadata tags to the Amazon RDS Performance Insights resource.
" + } + }, + "com.amazonaws.pi#TagResourceRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, see \n Constructing an RDS Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pi#TagList", + "traits": { + "smithy.api#documentation": "The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pi#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.pi#TextFormat": { + "type": "enum", + "members": { + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "MARKDOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MARKDOWN" + } + } + } + }, + "com.amazonaws.pi#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pi#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the metadata tags from the Amazon RDS Performance Insights resource.
" + } + }, + "com.amazonaws.pi#UntagResourceRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, see \n Constructing an RDS Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.pi#TagKeyList", + "traits": { + "smithy.api#documentation": "The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } } } }