PI

import { PI } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/pi.ts?docs=full";

class PI {

constructor(apiFactory: client.ApiFactory);

async createPerformanceAnalysisReport(params: CreatePerformanceAnalysisReportRequest, opts?: client.RequestOptions): Promise<CreatePerformanceAnalysisReportResponse>;

async deletePerformanceAnalysisReport(params: DeletePerformanceAnalysisReportRequest, opts?: client.RequestOptions): Promise<void>;

async describeDimensionKeys(params: DescribeDimensionKeysRequest, opts?: client.RequestOptions): Promise<DescribeDimensionKeysResponse>;

async getDimensionKeyDetails(params: GetDimensionKeyDetailsRequest, opts?: client.RequestOptions): Promise<GetDimensionKeyDetailsResponse>;

async getPerformanceAnalysisReport(params: GetPerformanceAnalysisReportRequest, opts?: client.RequestOptions): Promise<GetPerformanceAnalysisReportResponse>;

async getResourceMetadata(params: GetResourceMetadataRequest, opts?: client.RequestOptions): Promise<GetResourceMetadataResponse>;

async getResourceMetrics(params: GetResourceMetricsRequest, opts?: client.RequestOptions): Promise<GetResourceMetricsResponse>;

async listAvailableResourceDimensions(params: ListAvailableResourceDimensionsRequest, opts?: client.RequestOptions): Promise<ListAvailableResourceDimensionsResponse>;

async listAvailableResourceMetrics(params: ListAvailableResourceMetricsRequest, opts?: client.RequestOptions): Promise<ListAvailableResourceMetricsResponse>;

async listPerformanceAnalysisReports(params: ListPerformanceAnalysisReportsRequest, opts?: client.RequestOptions): Promise<ListPerformanceAnalysisReportsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new PI(apiFactory: client.ApiFactory)

[src]

§Methods

createPerformanceAnalysisReport(params: CreatePerformanceAnalysisReportRequest, opts?: client.RequestOptions): Promise<CreatePerformanceAnalysisReportResponse>

[src]

Creates a new performance analysis report for a specific time period for the DB instance.

deletePerformanceAnalysisReport(params: DeletePerformanceAnalysisReportRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a performance analysis report.

describeDimensionKeys(params: DescribeDimensionKeysRequest, opts?: client.RequestOptions): Promise<DescribeDimensionKeysResponse>

[src]

For a specific time period, retrieve the top N dimension keys for a metric.

Note: Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

getDimensionKeyDetails(params: GetDimensionKeyDetailsRequest, opts?: client.RequestOptions): Promise<GetDimensionKeyDetailsResponse>

[src]

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.

getPerformanceAnalysisReport(params: GetPerformanceAnalysisReportRequest, opts?: client.RequestOptions): Promise<GetPerformanceAnalysisReportResponse>

[src]

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.

getResourceMetadata(params: GetResourceMetadataRequest, opts?: client.RequestOptions): Promise<GetResourceMetadataResponse>

[src]

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.

getResourceMetrics(params: GetResourceMetricsRequest, opts?: client.RequestOptions): Promise<GetResourceMetricsResponse>

[src]

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.

Note: Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

listAvailableResourceDimensions(params: ListAvailableResourceDimensionsRequest, opts?: client.RequestOptions): Promise<ListAvailableResourceDimensionsResponse>

[src]

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

listAvailableResourceMetrics(params: ListAvailableResourceMetricsRequest, opts?: client.RequestOptions): Promise<ListAvailableResourceMetricsResponse>

[src]

Retrieve metrics of the specified types that can be queried for a specified DB instance.

listPerformanceAnalysisReports(params: ListPerformanceAnalysisReportsRequest, opts?: client.RequestOptions): Promise<ListPerformanceAnalysisReportsResponse>

[src]

Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds metadata tags to the Amazon RDS Performance Insights resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the metadata tags from the Amazon RDS Performance Insights resource.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]