@aws-sdk/client-ssm

Description

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.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up
Amazon Web Services Systems Manager.

Related resources

• 
  

  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.

  
  


• 
  

  For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
  
  Systems Manager Automation Runbook Reference
  .

  
  


• 
  

  For information about AppConfig, a tool in Systems Manager, see the
  AppConfig User Guide
  
  and the
  AppConfig
  API Reference
  .

  
  


• 
  

  For information about Incident Manager, a tool in Systems Manager, see the
  Systems Manager Incident Manager User
  Guide
  and the
  Systems Manager Incident Manager API
  Reference
  .

  
  

Installing

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

$3

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:

``js
// ES5 example
const { SSMClient, ListNodesCommand } = require("@aws-sdk/client-ssm");
`

`ts
// ES6+ example
import { SSMClient, ListNodesCommand } from "@aws-sdk/client-ssm";
`

$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 SSMClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListNodesCommand(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-ssm";
const client = new AWS.SSM({ region: "REGION" });

// async/await.
try {
const data = await client.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.
});
`

$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-ssm` 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)

AddTagsToResource

Command API Reference / Input / Output

AssociateOpsItemRelatedItem

Command API Reference / Input / Output

CancelCommand

Command API Reference / Input / Output

CancelMaintenanceWindowExecution

Command API Reference / Input / Output

CreateActivation

Command API Reference / Input / Output

CreateAssociation

Command API Reference / Input / Output

CreateAssociationBatch

Command API Reference / Input / Output

CreateDocument

Command API Reference / Input / Output

CreateMaintenanceWindow

Command API Reference / Input / Output

CreateOpsItem

Command API Reference / Input / Output

CreateOpsMetadata

Command API Reference / Input / Output

CreatePatchBaseline

Command API Reference / Input / Output

CreateResourceDataSync

Command API Reference / Input / Output

DeleteActivation

Command API Reference / Input / Output

DeleteAssociation

Command API Reference / Input / Output

DeleteDocument

Command API Reference / Input / Output

DeleteInventory

Command API Reference / Input / Output

DeleteMaintenanceWindow

Command API Reference / Input / Output

DeleteOpsItem

Command API Reference / Input / Output

DeleteOpsMetadata

Command API Reference / Input / Output

DeleteParameter

Command API Reference / Input / Output

DeleteParameters

Command API Reference / Input / Output

DeletePatchBaseline

Command API Reference / Input / Output

DeleteResourceDataSync

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeregisterManagedInstance

Command API Reference / Input / Output

DeregisterPatchBaselineForPatchGroup

Command API Reference / Input / Output

DeregisterTargetFromMaintenanceWindow

Command API Reference / Input / Output

DeregisterTaskFromMaintenanceWindow

Command API Reference / Input / Output

DescribeActivations

Command API Reference / Input / Output

DescribeAssociation

Command API Reference / Input / Output

DescribeAssociationExecutions

Command API Reference / Input / Output

DescribeAssociationExecutionTargets

Command API Reference / Input / Output

DescribeAutomationExecutions

Command API Reference / Input / Output

DescribeAutomationStepExecutions

Command API Reference / Input / Output

DescribeAvailablePatches

Command API Reference / Input / Output

DescribeDocument

Command API Reference / Input / Output

DescribeDocumentPermission

Command API Reference / Input / Output

DescribeEffectiveInstanceAssociations

Command API Reference / Input / Output

DescribeEffectivePatchesForPatchBaseline

Command API Reference / Input / Output

DescribeInstanceAssociationsStatus

Command API Reference / Input / Output

DescribeInstanceInformation

Command API Reference / Input / Output

DescribeInstancePatches

Command API Reference / Input / Output

DescribeInstancePatchStates

Command API Reference / Input / Output

DescribeInstancePatchStatesForPatchGroup

Command API Reference / Input / Output

DescribeInstanceProperties

Command API Reference / Input / Output

DescribeInventoryDeletions

Command API Reference / Input / Output

DescribeMaintenanceWindowExecutions

Command API Reference / Input / Output

DescribeMaintenanceWindowExecutionTaskInvocations

Command API Reference / Input / Output

DescribeMaintenanceWindowExecutionTasks

Command API Reference / Input / Output

DescribeMaintenanceWindows

Command API Reference / Input / Output

DescribeMaintenanceWindowSchedule

Command API Reference / Input / Output

DescribeMaintenanceWindowsForTarget

Command API Reference / Input / Output

DescribeMaintenanceWindowTargets

Command API Reference / Input / Output

DescribeMaintenanceWindowTasks

Command API Reference / Input / Output

DescribeOpsItems

Command API Reference / Input / Output

DescribeParameters

Command API Reference / Input / Output

DescribePatchBaselines

Command API Reference / Input / Output

DescribePatchGroups

Command API Reference / Input / Output

DescribePatchGroupState

Command API Reference / Input / Output

DescribePatchProperties

Command API Reference / Input / Output

DescribeSessions

Command API Reference / Input / Output

DisassociateOpsItemRelatedItem

Command API Reference / Input / Output

GetAccessToken

Command API Reference / Input / Output

GetAutomationExecution

Command API Reference / Input / Output

GetCalendarState

Command API Reference / Input / Output

GetCommandInvocation

Command API Reference / Input / Output

GetConnectionStatus

Command API Reference / Input / Output

GetDefaultPatchBaseline

Command API Reference / Input / Output

GetDeployablePatchSnapshotForInstance

Command API Reference / Input / Output

GetDocument

Command API Reference / Input / Output

GetExecutionPreview

Command API Reference / Input / Output

GetInventory

Command API Reference / Input / Output

GetInventorySchema

Command API Reference / Input / Output

GetMaintenanceWindow

Command API Reference / Input / Output

GetMaintenanceWindowExecution

Command API Reference / Input / Output

GetMaintenanceWindowExecutionTask

Command API Reference / Input / Output

GetMaintenanceWindowExecutionTaskInvocation

Command API Reference / Input / Output

GetMaintenanceWindowTask

Command API Reference / Input / Output

GetOpsItem

Command API Reference / Input / Output

GetOpsMetadata

Command API Reference / Input / Output

GetOpsSummary

Command API Reference / Input / Output

GetParameter

Command API Reference / Input / Output

GetParameterHistory

Command API Reference / Input / Output

GetParameters

Command API Reference / Input / Output

GetParametersByPath

Command API Reference / Input / Output

GetPatchBaseline

Command API Reference / Input / Output

GetPatchBaselineForPatchGroup

Command API Reference / Input / Output

GetResourcePolicies

Command API Reference / Input / Output

GetServiceSetting

Command API Reference / Input / Output

LabelParameterVersion

Command API Reference / Input / Output

ListAssociations

Command API Reference / Input / Output

ListAssociationVersions

Command API Reference / Input / Output

ListCommandInvocations

Command API Reference / Input / Output

ListCommands

Command API Reference / Input / Output

ListComplianceItems

Command API Reference / Input / Output

ListComplianceSummaries

Command API Reference / Input / Output

ListDocumentMetadataHistory

Command API Reference / Input / Output

ListDocuments

Command API Reference / Input / Output

ListDocumentVersions

Command API Reference / Input / Output

ListInventoryEntries

Command API Reference / Input / Output

ListNodes

Command API Reference / Input / Output

ListNodesSummary

Command API Reference / Input / Output

ListOpsItemEvents

Command API Reference / Input / Output

ListOpsItemRelatedItems

Command API Reference / Input / Output

ListOpsMetadata

Command API Reference / Input / Output

ListResourceComplianceSummaries

Command API Reference / Input / Output

ListResourceDataSync

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ModifyDocumentPermission

Command API Reference / Input / Output

PutComplianceItems

Command API Reference / Input / Output

PutInventory

Command API Reference / Input / Output

PutParameter

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

RegisterDefaultPatchBaseline

Command API Reference / Input / Output

RegisterPatchBaselineForPatchGroup

Command API Reference / Input / Output

RegisterTargetWithMaintenanceWindow

Command API Reference / Input / Output

RegisterTaskWithMaintenanceWindow

Command API Reference / Input / Output

RemoveTagsFromResource

Command API Reference / Input / Output

ResetServiceSetting

Command API Reference / Input / Output

ResumeSession

Command API Reference / Input / Output

SendAutomationSignal