{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-pi","description":"AWS Performance Insights","version":"2018-02-27","base_url":"","endpoints":13,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS Performance Insights\n@version 2018-02-27\n@auth AWS SigV4\n@endpoints 13\n@toc root(13)\n\n@endpoint POST /\n@desc Creates a new performance analysis report for a specific time period for the DB instance.\n@required {ServiceType: str, Identifier: str, StartTime: str(timestamp), EndTime: str(timestamp)}\n@optional {Tags: [Tag]}\n@returns(200) {AnalysisReportId: str?}\n\n@endpoint POST /\n@desc Deletes a performance analysis report.\n@required {ServiceType: str, Identifier: str, AnalysisReportId: str}\n\n@endpoint POST /\n@desc For a specific time period, retrieve the top N dimension keys for a metric.   Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.\n@required {ServiceType: str, Identifier: str, StartTime: str(timestamp), EndTime: str(timestamp), Metric: str, GroupBy: DimensionGroup}\n@optional {PeriodInSeconds: int, AdditionalMetrics: [str], PartitionBy: DimensionGroup, Filter: map<str,str>, MaxResults: int, NextToken: str}\n@returns(200) {AlignedStartTime: str(timestamp)?, AlignedEndTime: str(timestamp)?, PartitionKeys: [ResponsePartitionKey]?, Keys: [DimensionKeyDescription]?, NextToken: str?}\n\n@endpoint POST /\n@desc Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.\n@required {ServiceType: str, Identifier: str, Group: str, GroupIdentifier: str}\n@optional {RequestedDimensions: [str]}\n@returns(200) {Dimensions: [DimensionKeyDetail]?}\n\n@endpoint POST /\n@desc Retrieves 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.\n@required {ServiceType: str, Identifier: str, AnalysisReportId: str}\n@optional {TextFormat: str, AcceptLanguage: str}\n@returns(200) {AnalysisReport: AnalysisReport?{AnalysisReportId: str, Identifier: str?, ServiceType: str?, CreateTime: str(timestamp)?, StartTime: str(timestamp)?, EndTime: str(timestamp)?, Status: str?, Insights: [Insight]?}}\n\n@endpoint POST /\n@desc Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.\n@required {ServiceType: str, Identifier: str}\n@returns(200) {Identifier: str?, Features: map<str,FeatureMetadata>?}\n\n@endpoint POST /\n@desc Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.  Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.\n@required {ServiceType: str, Identifier: str, MetricQueries: [MetricQuery], StartTime: str(timestamp), EndTime: str(timestamp)}\n@optional {PeriodInSeconds: int, MaxResults: int, NextToken: str, PeriodAlignment: str}\n@returns(200) {AlignedStartTime: str(timestamp)?, AlignedEndTime: str(timestamp)?, Identifier: str?, MetricList: [MetricKeyDataPoints]?, NextToken: str?}\n\n@endpoint POST /\n@desc Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.\n@required {ServiceType: str, Identifier: str, Metrics: [str]}\n@optional {MaxResults: int, NextToken: str, AuthorizedActions: [str]}\n@returns(200) {MetricDimensions: [MetricDimensionGroups]?, NextToken: str?}\n\n@endpoint POST /\n@desc Retrieve metrics of the specified types that can be queried for a specified DB instance.\n@required {ServiceType: str, Identifier: str, MetricTypes: [str]}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {Metrics: [ResponseResourceMetric]?, NextToken: str?}\n\n@endpoint POST /\n@desc Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.\n@required {ServiceType: str, Identifier: str}\n@optional {NextToken: str, MaxResults: int, ListTags: bool}\n@returns(200) {AnalysisReports: [AnalysisReportSummary]?, NextToken: str?}\n\n@endpoint POST /\n@desc Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.\n@required {ServiceType: str, ResourceARN: str}\n@returns(200) {Tags: [Tag]?}\n\n@endpoint POST /\n@desc Adds metadata tags to the Amazon RDS Performance Insights resource.\n@required {ServiceType: str, ResourceARN: str, Tags: [Tag]}\n\n@endpoint POST /\n@desc Deletes the metadata tags from the Amazon RDS Performance Insights resource.\n@required {ServiceType: str, ResourceARN: str, TagKeys: [str]}\n\n@end\n"}