@aws-sdk/client-ssm-contacts
Description
AWS SDK for JavaScript SSMContacts Client for Node.js, Browser and React Native.
Systems Manager Incident Manager is an incident management console designed to help users
mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.
An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of
impact, highlighting relevant troubleshooting data, and providing collaboration tools to
get services back up and running. To achieve the primary goal of reducing the
time-to-resolution of critical incidents, Incident Manager automates response plans
and enables responder team escalation.
Installing
To install the this package, simply type add or install @aws-sdk/client-ssm-contacts
using your favorite package manager:
npm install @aws-sdk/client-ssm-contacts
yarn add @aws-sdk/client-ssm-contacts
pnpm add @aws-sdk/client-ssm-contacts
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SSMContactsClient
and
the commands you need, for example ListContactsCommand
:
const { SSMContactsClient, ListContactsCommand } = require("@aws-sdk/client-ssm-contacts");
import { SSMContactsClient, ListContactsCommand } from "@aws-sdk/client-ssm-contacts";
Usage
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.
const client = new SSMContactsClient({ region: "REGION" });
const params = {
};
const command = new ListContactsCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} 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.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, 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
import * as AWS from "@aws-sdk/client-ssm-contacts";
const client = new AWS.SSMContacts({ region: "REGION" });
try {
const data = await client.listContacts(params);
} catch (error) {
}
client
.listContacts(params)
.then((data) => {
})
.catch((error) => {
});
client.listContacts(params, (err, data) => {
});
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 client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
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.
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-ssm-contacts
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)
AcceptPage
Command API Reference / Input / Output
ActivateContactChannel
Command API Reference / Input / Output
CreateContact
Command API Reference / Input / Output
CreateContactChannel
Command API Reference / Input / Output
CreateRotation
Command API Reference / Input / Output
CreateRotationOverride
Command API Reference / Input / Output
DeactivateContactChannel
Command API Reference / Input / Output
DeleteContact
Command API Reference / Input / Output
DeleteContactChannel
Command API Reference / Input / Output
DeleteRotation
Command API Reference / Input / Output
DeleteRotationOverride
Command API Reference / Input / Output
DescribeEngagement
Command API Reference / Input / Output
DescribePage
Command API Reference / Input / Output
GetContact
Command API Reference / Input / Output
GetContactChannel
Command API Reference / Input / Output
GetContactPolicy
Command API Reference / Input / Output
GetRotation
Command API Reference / Input / Output
GetRotationOverride
Command API Reference / Input / Output
ListContactChannels
Command API Reference / Input / Output
ListContacts
Command API Reference / Input / Output
ListEngagements
Command API Reference / Input / Output
ListPageReceipts
Command API Reference / Input / Output
ListPageResolutions
Command API Reference / Input / Output
ListPagesByContact
Command API Reference / Input / Output
ListPagesByEngagement
Command API Reference / Input / Output
ListPreviewRotationShifts
Command API Reference / Input / Output
ListRotationOverrides
Command API Reference / Input / Output
ListRotations
Command API Reference / Input / Output
ListRotationShifts
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
PutContactPolicy
Command API Reference / Input / Output
SendActivationCode
Command API Reference / Input / Output
StartEngagement
Command API Reference / Input / Output
StopEngagement
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateContact
Command API Reference / Input / Output
UpdateContactChannel
Command API Reference / Input / Output
UpdateRotation
Command API Reference / Input / Output