AWS SDK for JavaScript Amp Client for Node.js, Browser and React Native
npm install @aws-sdk/client-ampAWS SDK for JavaScript Amp Client for Node.js, Browser and React Native.
Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.
For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
Amazon Managed Service for Prometheus includes two APIs.
Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers.
Use the Prometheus-compatible API to work within your Prometheus workspace.
npm install @aws-sdk/client-ampyarn add @aws-sdk/client-amppnpm add @aws-sdk/client-ampThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the AmpClient and
the commands you need, for example ListScrapersCommand:
``js`
// ES5 example
const { AmpClient, ListScrapersCommand } = require("@aws-sdk/client-amp");
`ts`
// ES6+ example
import { AmpClient, ListScrapersCommand } from "@aws-sdk/client-amp";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new AmpClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListScrapersCommand(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-amp";
const client = new AWS.Amp({ region: "REGION" });
// async/await.
try {
const data = await client.listScrapers(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listScrapers(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listScrapers(params, (err, data) => {
// process err and data.
});
`
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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-amp` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
CreateAlertManagerDefinition
Command API Reference / Input / Output
CreateAnomalyDetector
Command API Reference / Input / Output
CreateLoggingConfiguration
Command API Reference / Input / Output
CreateQueryLoggingConfiguration
Command API Reference / Input / Output
CreateRuleGroupsNamespace
Command API Reference / Input / Output
CreateScraper
Command API Reference / Input / Output
CreateWorkspace
Command API Reference / Input / Output
DeleteAlertManagerDefinition
Command API Reference / Input / Output
DeleteAnomalyDetector
Command API Reference / Input / Output
DeleteLoggingConfiguration
Command API Reference / Input / Output
DeleteQueryLoggingConfiguration
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeleteRuleGroupsNamespace
Command API Reference / Input / Output
DeleteScraper
Command API Reference / Input / Output
DeleteScraperLoggingConfiguration
Command API Reference / Input / Output
DeleteWorkspace
Command API Reference / Input / Output
DescribeAlertManagerDefinition
Command API Reference / Input / Output
DescribeAnomalyDetector
Command API Reference / Input / Output
DescribeLoggingConfiguration
Command API Reference / Input / Output
DescribeQueryLoggingConfiguration
Command API Reference / Input / Output
DescribeResourcePolicy
Command API Reference / Input / Output
DescribeRuleGroupsNamespace
Command API Reference / Input / Output
DescribeScraper
Command API Reference / Input / Output
DescribeScraperLoggingConfiguration
Command API Reference / Input / Output
DescribeWorkspace
Command API Reference / Input / Output
DescribeWorkspaceConfiguration
Command API Reference / Input / Output
GetDefaultScraperConfiguration
Command API Reference / Input / Output
ListAnomalyDetectors
Command API Reference / Input / Output
ListRuleGroupsNamespaces
Command API Reference / Input / Output
ListScrapers
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListWorkspaces
Command API Reference / Input / Output
PutAlertManagerDefinition
Command API Reference / Input / Output
PutAnomalyDetector
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
PutRuleGroupsNamespace
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateLoggingConfiguration
Command API Reference / Input / Output
UpdateQueryLoggingConfiguration
Command API Reference / Input / Output
UpdateScraper
Command API Reference / Input / Output
UpdateScraperLoggingConfiguration
Command API Reference / Input / Output
UpdateWorkspaceAlias
Command API Reference / Input / Output
UpdateWorkspaceConfiguration