@aws-sdk/client-pi-node v0.1.0-preview.2
@aws-sdk/client-pi-node
Description
Installing
To install the this package using NPM, simply type the following into a terminal window:
npm install @aws-sdk/client-pi-node
Getting Started
Import
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(PIClient
) and the commands you need, for example DescribeDimensionKeysCommand
:
//JavaScript
const { PIClient } = require("@aws-sdk/client-pi-node/PIClient");
const {
DescribeDimensionKeysCommand
} = require("@aws-sdk/client-pi-node/commands/DescribeDimensionKeysCommand");
//TypeScript
import { PIClient } from "@aws-sdk/client-pi-node/PIClient";
import { DescribeDimensionKeysCommand } from "@aws-sdk/client-pi-node/commands/DescribeDimensionKeysCommand";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
- 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.
const pI = new PIClient({region: 'region'});
//clients can be shared by different commands
const params = {
ServiceType: /**a string value*/,
Identifier: /**a string value*/,
StartTime: /**a timestamp can be number, string or Date object*/,
EndTime: /**a timestamp can be number, string or Date object*/,
Metric: /**a string value*/,
GroupBy: { /**an object specifying GroupBy*/ },
};
const describeDimensionKeysCommand = new DescribeDimensionKeysCommand(params);
pI.send(describeDimensionKeysCommand).then(data => {
// do something
}).catch(error => {
// error handling
})
In addition to using promises, there are 2 other ways to send a request:
// async/await
try {
const data = await pI.send(describeDimensionKeysCommand);
// do something
} catch (error) {
// error handling
}
// callback
pI.send(describeDimensionKeysCommand, (err, data) => {
//do something
});
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
import * as AWS from "@aws-sdk/@aws-sdk/client-pi-node/PI";
const pI = new AWS.PI({ region: "region" });
pI.describeDimensionKeys(params, (err, data) => {
//do something
});
Troubleshooting
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await pI.send(describeDimensionKeysCommand);
// do something
} catch (error) {
const metadata = error.$metadata;
console.log(
`requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.
- Ask a question on StackOverflow and tag it with
aws-sdk-js
- Come join the AWS JavaScript community on gitter
- If it turns out that you may have found a bug, please open an issue
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-pi-node' package is updated. To contribute to SDK you can checkout our code generator package.
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago