@aws-sdk/client-ssm
v3.163.0@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 capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
-
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
-
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
-
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .
Installing
To install the 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 ListAssociationsCommand
:
// ES5 example
const { SSMClient, ListAssociationsCommand } = require("@aws-sdk/client-ssm");
// ES6+ example
import { SSMClient, ListAssociationsCommand } from "@aws-sdk/client-ssm";
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.
// a client can be shared by different commands.
const client = new SSMClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListAssociationsCommand(params);
Async/await
We recommend using await operator to wait for the promise returned by send operation as follows:
// 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.
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 * as AWS from "@aws-sdk/client-ssm";
const client = new AWS.SSM({ region: "REGION" });
// async/await.
try {
const data = await client.listAssociations(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listAssociations(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listAssociations(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 {
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
AssociateOpsItemRelatedItem
CancelCommand
CancelMaintenanceWindowExecution
CreateActivation
CreateAssociation
CreateAssociationBatch
CreateDocument
CreateMaintenanceWindow
CreateOpsItem
CreateOpsMetadata
CreatePatchBaseline
CreateResourceDataSync
DeleteActivation
DeleteAssociation
DeleteDocument
DeleteInventory
DeleteMaintenanceWindow
DeleteOpsItem
DeleteOpsMetadata
DeleteParameter
DeleteParameters
DeletePatchBaseline
DeleteResourceDataSync
DeleteResourcePolicy
DeregisterManagedInstance
DeregisterPatchBaselineForPatchGroup
DeregisterTargetFromMaintenanceWindow
DeregisterTaskFromMaintenanceWindow
DescribeActivations
DescribeAssociation
DescribeAssociationExecutions
DescribeAssociationExecutionTargets
DescribeAutomationExecutions
DescribeAutomationStepExecutions
DescribeAvailablePatches
DescribeDocument
DescribeDocumentPermission
DescribeEffectiveInstanceAssociations
DescribeEffectivePatchesForPatchBaseline
DescribeInstanceAssociationsStatus
DescribeInstanceInformation
DescribeInstancePatches
DescribeInstancePatchStates
DescribeInstancePatchStatesForPatchGroup
DescribeInstanceProperties
DescribeInventoryDeletions
DescribeMaintenanceWindowExecutions
DescribeMaintenanceWindowExecutionTaskInvocations
DescribeMaintenanceWindowExecutionTasks
DescribeMaintenanceWindows
DescribeMaintenanceWindowSchedule
DescribeMaintenanceWindowsForTarget
DescribeMaintenanceWindowTargets
DescribeMaintenanceWindowTasks
DescribeOpsItems
DescribeParameters
DescribePatchBaselines
DescribePatchGroups
DescribePatchGroupState
DescribePatchProperties
DescribeSessions
DisassociateOpsItemRelatedItem
GetAutomationExecution
GetCalendarState
GetCommandInvocation
GetConnectionStatus
GetDefaultPatchBaseline
GetDeployablePatchSnapshotForInstance
GetDocument
GetInventory
GetInventorySchema
GetMaintenanceWindow
GetMaintenanceWindowExecution
GetMaintenanceWindowExecutionTask
GetMaintenanceWindowExecutionTaskInvocation
GetMaintenanceWindowTask
GetOpsItem
GetOpsMetadata
GetOpsSummary
GetParameter
GetParameterHistory
GetParameters
GetParametersByPath
GetPatchBaseline
GetPatchBaselineForPatchGroup
GetResourcePolicies
GetServiceSetting
LabelParameterVersion
ListAssociations
ListAssociationVersions
ListCommandInvocations
ListCommands
ListComplianceItems
ListComplianceSummaries
ListDocumentMetadataHistory
ListDocuments
ListDocumentVersions
ListInventoryEntries
ListOpsItemEvents
ListOpsItemRelatedItems
ListOpsMetadata
ListResourceComplianceSummaries
ListResourceDataSync
ListTagsForResource
ModifyDocumentPermission
PutComplianceItems
PutInventory
PutParameter
PutResourcePolicy
RegisterDefaultPatchBaseline
RegisterPatchBaselineForPatchGroup
RegisterTargetWithMaintenanceWindow
RegisterTaskWithMaintenanceWindow
RemoveTagsFromResource
ResetServiceSetting
ResumeSession
SendAutomationSignal
SendCommand
StartAssociationsOnce
StartAutomationExecution
Command API Reference / [Input](https://docs.aws.amazon.com/AWSJ
Metadata
- Apache-2.0
- >=12.0.0
- AWS SDK for JavaScript Team
- released 9/1/2022