PI

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

class PI {

constructor(apiFactory: client.ApiFactory);

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

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

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>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new PI(apiFactory: client.ApiFactory)

[src]

§Methods

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.statementcassociated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.

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 aggregation and filtering criteria for each group.

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]