You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
AWS SDK for JavaScript SSM Client for Node.js, Browser and React Native.
Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure
end-to-end management solution for hybrid cloud environments that enables safe and secure
operations at scale.
For information about each of the tools that comprise Systems Manager, see Using
Systems Manager tools in the Amazon Web Services Systems Manager User Guide.
To install this package, simply type add or install @aws-sdk/client-ssm
using your favorite package manager:
npm install @aws-sdk/client-ssm
yarn add @aws-sdk/client-ssm
pnpm add @aws-sdk/client-ssm
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SSMClient and
the commands you need, for example ListNodesCommand:
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.
// a client can be shared by different commands.constclient=newSSMClient({region: "REGION"});constparams={/** input parameters */};constcommand=newListNodesCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
// async/await.try{constdata=awaitclient.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.
client.send(command).then((data)=>{// process data.},(error)=>{// error handling.});
Promises can also be called using .catch() and .finally() as follows:
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.
// 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
import*asAWSfrom"@aws-sdk/client-ssm";constclient=newAWS.SSM({region: "REGION"});// async/await.try{constdata=awaitclient.listNodes(params);// process data.}catch(error){// error handling.}// Promises.client.listNodes(params).then((data)=>{// process data.}).catch((error)=>{// error handling.});// callbacks.client.listNodes(params,(err,data)=>{// process err and 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{constdata=awaitclient.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.
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-ssm package is updated.
To contribute to client you can check our generate clients scripts.
