pi/aws.sdk.kotlin.services.pi

Package-level declarations

Types

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createPerformanceAnalysisReport

inline suspend fun PiClient.createPerformanceAnalysisReport(crossinline block: CreatePerformanceAnalysisReportRequest.Builder.() -> Unit): CreatePerformanceAnalysisReportResponse

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

deletePerformanceAnalysisReport

inline suspend fun PiClient.deletePerformanceAnalysisReport(crossinline block: DeletePerformanceAnalysisReportRequest.Builder.() -> Unit): DeletePerformanceAnalysisReportResponse

Deletes a performance analysis report.

describeDimensionKeys

inline suspend fun PiClient.describeDimensionKeys(crossinline block: DescribeDimensionKeysRequest.Builder.() -> Unit): DescribeDimensionKeysResponse

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

getDimensionKeyDetails

inline suspend fun PiClient.getDimensionKeyDetails(crossinline block: GetDimensionKeyDetailsRequest.Builder.() -> Unit): GetDimensionKeyDetailsResponse

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, lock snapshots, and execution plans.

getPerformanceAnalysisReport

inline suspend fun PiClient.getPerformanceAnalysisReport(crossinline block: GetPerformanceAnalysisReportRequest.Builder.() -> Unit): GetPerformanceAnalysisReportResponse

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

inline suspend fun PiClient.getResourceMetadata(crossinline block: GetResourceMetadataRequest.Builder.() -> Unit): GetResourceMetadataResponse

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

inline suspend fun PiClient.getResourceMetrics(crossinline block: GetResourceMetricsRequest.Builder.() -> Unit): GetResourceMetricsResponse

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.

listAvailableResourceDimensions

inline suspend fun PiClient.listAvailableResourceDimensions(crossinline block: ListAvailableResourceDimensionsRequest.Builder.() -> Unit): ListAvailableResourceDimensionsResponse

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

listAvailableResourceMetrics

inline suspend fun PiClient.listAvailableResourceMetrics(crossinline block: ListAvailableResourceMetricsRequest.Builder.() -> Unit): ListAvailableResourceMetricsResponse

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

listPerformanceAnalysisReports

inline suspend fun PiClient.listPerformanceAnalysisReports(crossinline block: ListPerformanceAnalysisReportsRequest.Builder.() -> Unit): ListPerformanceAnalysisReportsResponse

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

listTagsForResource

inline suspend fun PiClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

tagResource

inline suspend fun PiClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds metadata tags to the Amazon RDS Performance Insights resource.

untagResource

inline suspend fun PiClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

withConfig

fun PiClient.withConfig(block: PiClient.Config.Builder.() -> Unit): PiClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.