@aws-sdk/client-pi

Description

AWS SDK for JavaScript PI Client for Node.js, Browser and React Native.

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
  .

  
  

Installing

To install this package, simply type add or install @aws-sdk/client-pi
using your favorite package manager:
- npm install @aws-sdk/client-pi
- yarn add @aws-sdk/client-pi
- pnpm add @aws-sdk/client-pi

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the PIClient and
the commands you need, for example ListTagsForResourceCommand:

``js
// ES5 example
const { PIClient, ListTagsForResourceCommand } = require("@aws-sdk/client-pi");
`

`ts
// ES6+ example
import { PIClient, ListTagsForResourceCommand } from "@aws-sdk/client-pi";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new PIClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListTagsForResourceCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-pi";
const client = new AWS.PI({ region: "REGION" });

// async/await.
try {
const data = await client.listTagsForResource(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listTagsForResource(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listTagsForResource(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-pi` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CreatePerformanceAnalysisReport

Command API Reference / Input / Output

DeletePerformanceAnalysisReport

Command API Reference / Input / Output

DescribeDimensionKeys

Command API Reference / Input / Output

GetDimensionKeyDetails

Command API Reference / Input / Output

GetPerformanceAnalysisReport

Command API Reference / Input / Output

GetResourceMetadata

Command API Reference / Input / Output

GetResourceMetrics

Command API Reference / Input / Output

ListAvailableResourceDimensions

Command API Reference / Input / Output

ListAvailableResourceMetrics

Command API Reference / Input / Output

ListPerformanceAnalysisReports

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output