- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SSMClient
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 .
Installation
npm install @aws-sdk/client-ssm
yarn add @aws-sdk/client-ssm
pnpm add @aws-sdk/client-ssm
SSMClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AddTagsToResourceCommand | Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide. |
AssociateOpsItemRelatedItemCommand | Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager. |
CancelCommandCommand | Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. |
CancelMaintenanceWindowExecutionCommand | Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion. |
CreateActivationCommand | Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide. Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes. |
CreateAssociationBatchCommand | Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets. When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified. If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception. |
CreateAssociationCommand | A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. |
CreateDocumentCommand | Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide. |
CreateMaintenanceWindowCommand | Creates a new maintenance window. The value you specify for |
CreateOpsItemCommand | Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide. |
CreateOpsMetadataCommand | If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type. |
CreatePatchBaselineCommand | Creates a patch baseline. For information about valid key-value pairs in |
CreateResourceDataSyncCommand | A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: You can configure Systems Manager Inventory to use the You can configure Systems Manager Explorer to use the A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync. By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. |
DeleteActivationCommand | Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes. |
DeleteAssociationCommand | Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node. |
DeleteDocumentCommand | Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document. |
DeleteInventoryCommand | Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema. |
DeleteMaintenanceWindowCommand | Deletes a maintenance window. |
DeleteOpsItemCommand | Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem. Note the following important information about this operation.
|
DeleteOpsMetadataCommand | Delete OpsMetadata related to an application. |
DeleteParameterCommand | Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. |
DeleteParametersCommand | Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. |
DeletePatchBaselineCommand | Deletes a patch baseline. |
DeleteResourceDataSyncCommand | Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data. |
DeleteResourcePolicyCommand | Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
|
DeregisterManagedInstanceCommand | Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first. |
DeregisterPatchBaselineForPatchGroupCommand | Removes a patch group from a patch baseline. |
DeregisterTargetFromMaintenanceWindowCommand | Removes a target from a maintenance window. |
DeregisterTaskFromMaintenanceWindowCommand | Removes a task from a maintenance window. |
DescribeActivationsCommand | Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation. |
DescribeAssociationCommand | Describes the association for the specified target or managed node. If you created the association by using the |
DescribeAssociationExecutionTargetsCommand | Views information about a specific execution of a specific association. |
DescribeAssociationExecutionsCommand | Views all executions for a specific association ID. |
DescribeAutomationExecutionsCommand | Provides details about all active and terminated Automation executions. |
DescribeAutomationStepExecutionsCommand | Information about all active and terminated step executions in an Automation workflow. |
DescribeAvailablePatchesCommand | Lists all patches eligible to be included in a patch baseline. Currently, |
DescribeDocumentCommand | Describes the specified Amazon Web Services Systems Manager document (SSM document). |
DescribeDocumentPermissionCommand | Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All). |
DescribeEffectiveInstanceAssociationsCommand | All associations for the managed nodes. |
DescribeEffectivePatchesForPatchBaselineCommand | Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only. |
DescribeInstanceAssociationsStatusCommand | The status of the associations for the managed nodes. |
DescribeInstanceInformationCommand | Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated. If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error. The |
DescribeInstancePatchStatesCommand | Retrieves the high-level patch state of one or more managed nodes. |
DescribeInstancePatchStatesForPatchGroupCommand | Retrieves the high-level patch state for the managed nodes in the specified patch group. |
DescribeInstancePatchesCommand | Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node. |
DescribeInstancePropertiesCommand | An API operation used by the Systems Manager console to display information about Systems Manager managed nodes. |
DescribeInventoryDeletionsCommand | Describes a specific delete inventory operation. |
DescribeMaintenanceWindowExecutionTaskInvocationsCommand | Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution. |
DescribeMaintenanceWindowExecutionTasksCommand | For a given maintenance window execution, lists the tasks that were run. |
DescribeMaintenanceWindowExecutionsCommand | Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window. |
DescribeMaintenanceWindowScheduleCommand | Retrieves information about upcoming executions of a maintenance window. |
DescribeMaintenanceWindowTargetsCommand | Lists the targets registered with the maintenance window. |
DescribeMaintenanceWindowTasksCommand | Lists the tasks in a maintenance window. For maintenance window tasks without a specified target, you can't supply values for |
DescribeMaintenanceWindowsCommand | Retrieves the maintenance windows in an Amazon Web Services account. |
DescribeMaintenanceWindowsForTargetCommand | Retrieves information about the maintenance window targets or tasks that a managed node is associated with. |
DescribeOpsItemsCommand | Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide. |
DescribeParametersCommand | Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option. Request results are returned on a best-effort basis. If you specify If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, |
DescribePatchBaselinesCommand | Lists the patch baselines in your Amazon Web Services account. |
DescribePatchGroupStateCommand | Returns high-level aggregated patch compliance state information for a patch group. |
DescribePatchGroupsCommand | Lists all patch groups that have been registered with patch baselines. |
DescribePatchPropertiesCommand | Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines. The following section lists the properties that can be used in filters for each major operating system type:
|
DescribeSessionsCommand | Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days. |
DisassociateOpsItemRelatedItemCommand | Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager. |
GetAutomationExecutionCommand | Get detailed information about a particular Automation execution. |
GetCalendarStateCommand | Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, If you specify more than one calendar in a request, the command returns the status of For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide. |
GetCommandInvocationCommand | Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command. |
GetConnectionStatusCommand | Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections. |
GetDefaultPatchBaselineCommand | Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you don't specify an operating system value, the default patch baseline for Windows is returned. |
GetDeployablePatchSnapshotForInstanceCommand | Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the |
GetDocumentCommand | Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document). |
GetExecutionPreviewCommand | Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources. |
GetInventoryCommand | Query inventory information. This includes managed node status, such as |
GetInventorySchemaCommand | Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type. |
GetMaintenanceWindowCommand | Retrieves a maintenance window. |
GetMaintenanceWindowExecutionCommand | Retrieves details about a specific a maintenance window execution. |
GetMaintenanceWindowExecutionTaskCommand | Retrieves the details about a specific task run as part of a maintenance window execution. |
GetMaintenanceWindowExecutionTaskInvocationCommand | Retrieves information about a specific task running on a specific target. |
GetMaintenanceWindowTaskCommand | Retrieves the details of a maintenance window task. For maintenance window tasks without a specified target, you can't supply values for To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command. |
GetOpsItemCommand | Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide. |
GetOpsMetadataCommand | View operational metadata related to an application in Application Manager. |
GetOpsSummaryCommand | View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer. |
GetParameterCommand | Get information about a single parameter by specifying the parameter name. To get information about more than one parameter at a time, use the GetParameters operation. |
GetParameterHistoryCommand | Retrieves the history of all changes to a parameter. If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, |
GetParametersByPathCommand | Retrieve information about one or more parameters in a specific hierarchy. Request results are returned on a best-effort basis. If you specify |
GetParametersCommand | Get information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter operation instead. |
GetPatchBaselineCommand | Retrieves information about a patch baseline. |
GetPatchBaselineForPatchGroupCommand | Retrieves the patch baseline that should be used for the specified patch group. |
GetResourcePoliciesCommand | Returns an array of the |
GetServiceSettingCommand | Services map a Query the current service setting for the Amazon Web Services account. |
LabelParameterVersionCommand | A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions.
|
ListAssociationVersionsCommand | Retrieves all versions of an association for a specific association ID. |
ListAssociationsCommand | Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager. |
ListCommandInvocationsCommand | An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs |
ListCommandsCommand | Lists the commands requested by users of the Amazon Web Services account. |
ListComplianceItemsCommand | For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter. |
ListComplianceSummariesCommand | Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify. |
ListDocumentMetadataHistoryCommand | Information about approval reviews for a version of a change template in Change Manager. |
ListDocumentVersionsCommand | List all versions for a document. |
ListDocumentsCommand | Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter. |
ListInventoryEntriesCommand | A list of inventory items returned by the request. |
ListNodesCommand | Takes in filters and returns a list of managed nodes matching the filter criteria. |
ListNodesSummaryCommand | Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify. |
ListOpsItemEventsCommand | Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter. |
ListOpsItemRelatedItemsCommand | Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager. |
ListOpsMetadataCommand | Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs. |
ListResourceComplianceSummariesCommand | Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify. |
ListResourceDataSyncCommand | Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to |
ListTagsForResourceCommand | Returns a list of the tags assigned to the specified resource. For information about the ID format for each supported resource type, see AddTagsToResource. |
ModifyDocumentPermissionCommand | Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID. |
PutComplianceItemsCommand | Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following:
|
PutInventoryCommand | Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist. |
PutParameterCommand | Add a parameter to the system. |
PutResourcePolicyCommand | Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
|
RegisterDefaultPatchBaselineCommand | Defines the default patch baseline for the relevant operating system. To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify |
RegisterPatchBaselineForPatchGroupCommand | Registers a patch baseline for a patch group. |
RegisterTargetWithMaintenanceWindowCommand | Registers a target with a maintenance window. |
RegisterTaskWithMaintenanceWindowCommand | Adds a new task to a maintenance window. |
RemoveTagsFromResourceCommand | Removes tag keys from the specified resource. |
ResetServiceSettingCommand | Services map a Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team. |
ResumeSessionCommand | Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use. |
SendAutomationSignalCommand | Sends a signal to an Automation execution to change the current behavior or status of the execution. |
SendCommandCommand | Runs commands on one or more managed nodes. |
StartAssociationsOnceCommand | Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations. |
StartAutomationExecutionCommand | Initiates execution of an Automation runbook. |
StartChangeRequestExecutionCommand | Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received. |
StartExecutionPreviewCommand | Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources. |
StartSessionCommand | Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. Amazon Web Services CLI usage: Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines. |
StopAutomationExecutionCommand | Stop an Automation that is currently running. |
TerminateSessionCommand | Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed. |
UnlabelParameterVersionCommand | Remove a label or labels from a parameter. |
UpdateAssociationCommand | Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. If you don't have permission to call When you update an association, the association immediately runs against the specified targets. You can add the |
UpdateAssociationStatusCommand | Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node. |
UpdateDocumentCommand | Updates one or more values for an SSM document. |
UpdateDocumentDefaultVersionCommand | Set the default version of a document. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the |
UpdateDocumentMetadataCommand | Updates information related to approval reviews for a specific version of a change template in Change Manager. |
UpdateMaintenanceWindowCommand | Updates an existing maintenance window. Only specified parameters are modified. The value you specify for |
UpdateMaintenanceWindowTargetCommand | Modifies the target of an existing maintenance window. You can change the following:
If a parameter is null, then the corresponding field isn't modified. |
UpdateMaintenanceWindowTaskCommand | Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide. If the value for a parameter in When you update a maintenance window task that has options specified in |
UpdateManagedInstanceRoleCommand | Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation. |
UpdateOpsItemCommand | Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide. |
UpdateOpsMetadataCommand | Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager. |
UpdatePatchBaselineCommand | Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key-value pairs in |
UpdateResourceDataSyncCommand | Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the This API operation only supports a resource data sync that was created with a SyncFromSource |
UpdateServiceSettingCommand | Services map a Update the service setting for the account. |
SSMClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SSMClientConfig