pi/aws.sdk.kotlin.services.pi/PiClient

PiClient

Amazon RDS Performance Insights

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.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide.

Types

Builder

class Builder : AbstractSdkClientBuilder<PiClient.Config, PiClient.Config.Builder, PiClient>

Companion

object Companion : AbstractAwsSdkClientFactory<PiClient.Config, PiClient.Config.Builder, PiClient, PiClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: PiClient.Config

PiClient's configuration

Functions

createPerformanceAnalysisReport

abstract suspend fun createPerformanceAnalysisReport(input: CreatePerformanceAnalysisReportRequest): CreatePerformanceAnalysisReportResponse

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

deletePerformanceAnalysisReport

abstract suspend fun deletePerformanceAnalysisReport(input: DeletePerformanceAnalysisReportRequest): DeletePerformanceAnalysisReportResponse

Deletes a performance analysis report.

describeDimensionKeys

abstract suspend fun describeDimensionKeys(input: DescribeDimensionKeysRequest): DescribeDimensionKeysResponse

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

getDimensionKeyDetails

abstract suspend fun getDimensionKeyDetails(input: GetDimensionKeyDetailsRequest): 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

abstract suspend fun getPerformanceAnalysisReport(input: GetPerformanceAnalysisReportRequest): 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

abstract suspend fun getResourceMetadata(input: GetResourceMetadataRequest): 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

abstract suspend fun getResourceMetrics(input: GetResourceMetricsRequest): 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

abstract suspend fun listAvailableResourceDimensions(input: ListAvailableResourceDimensionsRequest): ListAvailableResourceDimensionsResponse

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

listAvailableResourceMetrics

abstract suspend fun listAvailableResourceMetrics(input: ListAvailableResourceMetricsRequest): ListAvailableResourceMetricsResponse

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

listPerformanceAnalysisReports

abstract suspend fun listPerformanceAnalysisReports(input: ListPerformanceAnalysisReportsRequest): ListPerformanceAnalysisReportsResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds metadata tags to the Amazon RDS Performance Insights resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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

Inherited functions

expect abstract fun close()

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.

describeDimensionKeysPaginated

fun PiClient.describeDimensionKeysPaginated(initialRequest: DescribeDimensionKeysRequest): Flow<DescribeDimensionKeysResponse>

fun PiClient.describeDimensionKeysPaginated(block: DescribeDimensionKeysRequest.Builder.() -> Unit): Flow<DescribeDimensionKeysResponse>

Paginate over DescribeDimensionKeysResponse results.

getDimensionKeyDetails

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

getPerformanceAnalysisReport

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

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

getResourceMetricsPaginated

fun PiClient.getResourceMetricsPaginated(initialRequest: GetResourceMetricsRequest): Flow<GetResourceMetricsResponse>

fun PiClient.getResourceMetricsPaginated(block: GetResourceMetricsRequest.Builder.() -> Unit): Flow<GetResourceMetricsResponse>

Paginate over GetResourceMetricsResponse results.

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.

listAvailableResourceDimensionsPaginated

fun PiClient.listAvailableResourceDimensionsPaginated(initialRequest: ListAvailableResourceDimensionsRequest): Flow<ListAvailableResourceDimensionsResponse>

fun PiClient.listAvailableResourceDimensionsPaginated(block: ListAvailableResourceDimensionsRequest.Builder.() -> Unit): Flow<ListAvailableResourceDimensionsResponse>

Paginate over ListAvailableResourceDimensionsResponse results.

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.

listAvailableResourceMetricsPaginated

fun PiClient.listAvailableResourceMetricsPaginated(initialRequest: ListAvailableResourceMetricsRequest): Flow<ListAvailableResourceMetricsResponse>

fun PiClient.listAvailableResourceMetricsPaginated(block: ListAvailableResourceMetricsRequest.Builder.() -> Unit): Flow<ListAvailableResourceMetricsResponse>

Paginate over ListAvailableResourceMetricsResponse results.

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.

listPerformanceAnalysisReportsPaginated

fun PiClient.listPerformanceAnalysisReportsPaginated(initialRequest: ListPerformanceAnalysisReportsRequest): Flow<ListPerformanceAnalysisReportsResponse>

fun PiClient.listPerformanceAnalysisReportsPaginated(block: ListPerformanceAnalysisReportsRequest.Builder.() -> Unit): Flow<ListPerformanceAnalysisReportsResponse>

Paginate over ListPerformanceAnalysisReportsResponse results.

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.