Amazon Web Services, Inc.

Amazon Simple Systems Manager (SSM)

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…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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
.

Endpoints 154

  • POSTAdd tags to resource/#X-Amz-Target=AmazonSSM.AddTagsToResourceAdds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes,…
  • POSTAssociate ops item related item/#X-Amz-Target=AmazonSSM.AssociateOpsItemRelatedItemAssociates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem.…
  • POSTCancel command/#X-Amz-Target=AmazonSSM.CancelCommandAttempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
  • POSTCancel maintenance window execution/#X-Amz-Target=AmazonSSM.CancelMaintenanceWindowExecutionStops 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…
  • POSTCreate activation/#X-Amz-Target=AmazonSSM.CreateActivationGenerates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web…
  • POSTCreate association/#X-Amz-Target=AmazonSSM.CreateAssociationA State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus…
  • POSTCreate association batch/#X-Amz-Target=AmazonSSM.CreateAssociationBatchAssociates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets. When you associate a…
  • POSTCreate cloud connector/#X-Amz-Target=AmazonSSM.CreateCloudConnectorCreates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment.
  • POSTCreate document/#X-Amz-Target=AmazonSSM.CreateDocumentCreates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For…
  • POSTCreate maintenance window/#X-Amz-Target=AmazonSSM.CreateMaintenanceWindowCreates a new maintenance window. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins.…
  • POSTCreate ops item/#X-Amz-Target=AmazonSSM.CreateOpsItemCreates 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…
  • POSTCreate ops metadata/#X-Amz-Target=AmazonSSM.CreateOpsMetadataIf you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new…
  • POSTCreate patch baseline/#X-Amz-Target=AmazonSSM.CreatePatchBaselineCreates a patch baseline. For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter .
  • POSTCreate resource data sync/#X-Amz-Target=AmazonSSM.CreateResourceDataSyncA 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…
  • POSTDelete activation/#X-Amz-Target=AmazonSSM.DeleteActivationDeletes 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…
  • POSTDelete association/#X-Amz-Target=AmazonSSM.DeleteAssociationDisassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by…
  • POSTDelete cloud connector/#X-Amz-Target=AmazonSSM.DeleteCloudConnectorDeletes a cloud connector.
  • POSTDelete document/#X-Amz-Target=AmazonSSM.DeleteDocumentDeletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document. Before you delete the document, we…
  • POSTDelete inventory/#X-Amz-Target=AmazonSSM.DeleteInventoryDelete 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…
  • POSTDelete maintenance window/#X-Amz-Target=AmazonSSM.DeleteMaintenanceWindowDeletes a maintenance window.
  • POSTDelete ops item/#X-Amz-Target=AmazonSSM.DeleteOpsItemDelete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem. Note the following important information about this…
  • POSTDelete ops metadata/#X-Amz-Target=AmazonSSM.DeleteOpsMetadataDelete OpsMetadata related to an application.
  • POSTDelete parameter/#X-Amz-Target=AmazonSSM.DeleteParameterDelete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. This operation is…
  • POSTDelete parameters/#X-Amz-Target=AmazonSSM.DeleteParametersDelete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. This operation is authorized…
  • POSTDelete patch baseline/#X-Amz-Target=AmazonSSM.DeletePatchBaselineDeletes a patch baseline.
  • POSTDelete resource data sync/#X-Amz-Target=AmazonSSM.DeleteResourceDataSyncDeletes 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.…
  • POSTDelete resource policy/#X-Amz-Target=AmazonSSM.DeleteResourcePolicyDeletes 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…
  • POSTDeregister default host management configuration/#X-Amz-Target=AmazonSSM.DeregisterDefaultHostManagementConfigurationRemoves the Default Host Management Configuration (DHMC) for an Amazon Web Services account and Amazon Web Services Region. After you deregister DHMC, Amazon…
  • POSTDeregister managed instance/#X-Amz-Target=AmazonSSM.DeregisterManagedInstanceRemoves the server or virtual machine from the list of registered servers. If you want to reregister an on-premises server, edge device, or VM, you must use a…
  • POSTDeregister patch baseline for patch group/#X-Amz-Target=AmazonSSM.DeregisterPatchBaselineForPatchGroupRemoves a patch group from a patch baseline.
  • POSTDeregister target from maintenance window/#X-Amz-Target=AmazonSSM.DeregisterTargetFromMaintenanceWindowRemoves a target from a maintenance window.
  • POSTDeregister task from maintenance window/#X-Amz-Target=AmazonSSM.DeregisterTaskFromMaintenanceWindowRemoves a task from a maintenance window.
  • POSTDescribe activations/#X-Amz-Target=AmazonSSM.DescribeActivationsDescribes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM)…
  • POSTDescribe association/#X-Amz-Target=AmazonSSM.DescribeAssociationDescribes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the…
  • POSTDescribe association execution targets/#X-Amz-Target=AmazonSSM.DescribeAssociationExecutionTargetsViews information about a specific execution of a specific association.
  • POSTDescribe association executions/#X-Amz-Target=AmazonSSM.DescribeAssociationExecutionsViews all executions for a specific association ID.
  • POSTDescribe automation executions/#X-Amz-Target=AmazonSSM.DescribeAutomationExecutionsProvides details about all active and terminated Automation executions.
  • POSTDescribe automation step executions/#X-Amz-Target=AmazonSSM.DescribeAutomationStepExecutionsInformation about all active and terminated step executions in an Automation workflow.
  • POSTDescribe available patches/#X-Amz-Target=AmazonSSM.DescribeAvailablePatchesLists all patches eligible to be included in a patch baseline. Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and…
  • POSTDescribe document/#X-Amz-Target=AmazonSSM.DescribeDocumentDescribes the specified Amazon Web Services Systems Manager document (SSM document).
  • POSTDescribe document permission/#X-Amz-Target=AmazonSSM.DescribeDocumentPermissionDescribes 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…
  • POSTDescribe effective instance associations/#X-Amz-Target=AmazonSSM.DescribeEffectiveInstanceAssociationsAll associations for the managed nodes.
  • POSTDescribe effective patches for patch baseline/#X-Amz-Target=AmazonSSM.DescribeEffectivePatchesForPatchBaselineRetrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
  • POSTDescribe instance associations status/#X-Amz-Target=AmazonSSM.DescribeInstanceAssociationsStatusThe status of the associations for the managed nodes.
  • POSTDescribe instance information/#X-Amz-Target=AmazonSSM.DescribeInstanceInformationProvides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.…
  • POSTDescribe instance patch states/#X-Amz-Target=AmazonSSM.DescribeInstancePatchStatesRetrieves the high-level patch state of one or more managed nodes.
  • POSTDescribe instance patch states for patch group/#X-Amz-Target=AmazonSSM.DescribeInstancePatchStatesForPatchGroupRetrieves the high-level patch state for the managed nodes in the specified patch group.
  • POSTDescribe instance patches/#X-Amz-Target=AmazonSSM.DescribeInstancePatchesRetrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
  • POSTDescribe instance properties/#X-Amz-Target=AmazonSSM.DescribeInstancePropertiesAn API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
  • POSTDescribe inventory deletions/#X-Amz-Target=AmazonSSM.DescribeInventoryDeletionsDescribes a specific delete inventory operation.
  • POSTDescribe maintenance window execution task invocations/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowExecutionTaskInvocationsRetrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
  • POSTDescribe maintenance window execution tasks/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowExecutionTasksFor a given maintenance window execution, lists the tasks that were run.
  • POSTDescribe maintenance window executions/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowExecutionsLists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about…
  • POSTDescribe maintenance window schedule/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowScheduleRetrieves information about upcoming executions of a maintenance window.
  • POSTDescribe maintenance window targets/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowTargetsLists the targets registered with the maintenance window.
  • POSTDescribe maintenance window tasks/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowTasksLists the tasks in a maintenance window. For maintenance window tasks without a specified target, you can't supply values for --max-errors and…
  • POSTDescribe maintenance windows/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowsRetrieves the maintenance windows in an Amazon Web Services account.
  • POSTDescribe maintenance windows for target/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowsForTargetRetrieves information about the maintenance window targets or tasks that a managed node is associated with.
  • POSTDescribe ops items/#X-Amz-Target=AmazonSSM.DescribeOpsItemsQuery 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…
  • POSTDescribe parameters/#X-Amz-Target=AmazonSSM.DescribeParametersLists 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…
  • POSTDescribe patch baselines/#X-Amz-Target=AmazonSSM.DescribePatchBaselinesLists the patch baselines in your Amazon Web Services account.
  • POSTDescribe patch group state/#X-Amz-Target=AmazonSSM.DescribePatchGroupStateReturns high-level aggregated patch compliance state information for a patch group.
  • POSTDescribe patch groups/#X-Amz-Target=AmazonSSM.DescribePatchGroupsLists all patch groups that have been registered with patch baselines.
  • POSTDescribe patch properties/#X-Amz-Target=AmazonSSM.DescribePatchPropertiesLists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can…
  • POSTDescribe sessions/#X-Amz-Target=AmazonSSM.DescribeSessionsRetrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
  • POSTDisassociate ops item related item/#X-Amz-Target=AmazonSSM.DisassociateOpsItemRelatedItemDeletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem.…
  • POSTGet access token/#X-Amz-Target=AmazonSSM.GetAccessTokenReturns a credentials set to be used with just-in-time node access.
  • POSTGet automation execution/#X-Amz-Target=AmazonSSM.GetAutomationExecutionGet detailed information about a particular Automation execution.
  • POSTGet calendar state/#X-Amz-Target=AmazonSSM.GetCalendarStateGets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState…
  • POSTGet cloud connector/#X-Amz-Target=AmazonSSM.GetCloudConnectorReturns detailed information about a cloud connector.
  • POSTGet command invocation/#X-Amz-Target=AmazonSSM.GetCommandInvocationReturns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the…
  • POSTGet connection status/#X-Amz-Target=AmazonSSM.GetConnectionStatusRetrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
  • POSTGet default patch baseline/#X-Amz-Target=AmazonSSM.GetDefaultPatchBaselineRetrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a…
  • POSTGet deployable patch snapshot for instance/#X-Amz-Target=AmazonSSM.GetDeployablePatchSnapshotForInstanceRetrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document…
  • POSTGet document/#X-Amz-Target=AmazonSSM.GetDocumentGets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
  • POSTGet execution preview/#X-Amz-Target=AmazonSSM.GetExecutionPreviewInitiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.
  • POSTGet inventory/#X-Amz-Target=AmazonSSM.GetInventoryQuery inventory information. This includes managed node status, such as Stopped or Terminated .
  • POSTGet inventory schema/#X-Amz-Target=AmazonSSM.GetInventorySchemaReturn a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
  • POSTGet maintenance window/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowRetrieves a maintenance window.
  • POSTGet maintenance window execution/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowExecutionRetrieves details about a specific a maintenance window execution.
  • POSTGet maintenance window execution task/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowExecutionTaskRetrieves the details about a specific task run as part of a maintenance window execution.
  • POSTGet maintenance window execution task invocation/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowExecutionTaskInvocationRetrieves information about a specific task running on a specific target.
  • POSTGet maintenance window task/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowTaskRetrieves the details of a maintenance window task. For maintenance window tasks without a specified target, you can't supply values for --max-errors and…
  • POSTGet ops item/#X-Amz-Target=AmazonSSM.GetOpsItemGet 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…
  • POSTGet ops metadata/#X-Amz-Target=AmazonSSM.GetOpsMetadataView operational metadata related to an application in Application Manager.
  • POSTGet ops summary/#X-Amz-Target=AmazonSSM.GetOpsSummaryView a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems…
  • POSTGet parameter/#X-Amz-Target=AmazonSSM.GetParameterGet information about a single parameter by specifying the parameter name. Parameter names can't contain spaces. The service removes any spaces specified for…
  • POSTGet parameter history/#X-Amz-Target=AmazonSSM.GetParameterHistoryRetrieves the history of all changes to a parameter. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end…
  • POSTGet parameters/#X-Amz-Target=AmazonSSM.GetParametersGet information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter…
  • POSTGet parameters by path/#X-Amz-Target=AmazonSSM.GetParametersByPathRetrieve information about one or more parameters under a specified level in a hierarchy. This operation is authorized against the ssm:GetParametersByPath…
  • POSTGet patch baseline/#X-Amz-Target=AmazonSSM.GetPatchBaselineRetrieves information about a patch baseline.
  • POSTGet patch baseline for patch group/#X-Amz-Target=AmazonSSM.GetPatchBaselineForPatchGroupRetrieves the patch baseline that should be used for the specified patch group.
  • POSTGet resource policies/#X-Amz-Target=AmazonSSM.GetResourcePoliciesReturns an array of the Policy object.
  • POSTGet service setting/#X-Amz-Target=AmazonSSM.GetServiceSettingServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature…
  • POSTLabel parameter version/#X-Amz-Target=AmazonSSM.LabelParameterVersionA 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…
  • POSTList association versions/#X-Amz-Target=AmazonSSM.ListAssociationVersionsRetrieves all versions of an association for a specific association ID.
  • POSTList associations/#X-Amz-Target=AmazonSSM.ListAssociationsReturns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific…
  • POSTList cloud connectors/#X-Amz-Target=AmazonSSM.ListCloudConnectorsReturns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.
  • POSTList command invocations/#X-Amz-Target=AmazonSSM.ListCommandInvocationsAn 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…
  • POSTList commands/#X-Amz-Target=AmazonSSM.ListCommandsLists the commands requested by users of the Amazon Web Services account.
  • POSTList compliance items/#X-Amz-Target=AmazonSSM.ListComplianceItemsFor a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one…
  • POSTList compliance summaries/#X-Amz-Target=AmazonSSM.ListComplianceSummariesReturns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches,…
  • POSTList document metadata history/#X-Amz-Target=AmazonSSM.ListDocumentMetadataHistoryAmazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more…
  • POSTList document versions/#X-Amz-Target=AmazonSSM.ListDocumentVersionsList all versions for a document.
  • POSTList documents/#X-Amz-Target=AmazonSSM.ListDocumentsReturns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this…
  • POSTList inventory entries/#X-Amz-Target=AmazonSSM.ListInventoryEntriesA list of inventory items returned by the request.
  • POSTList nodes/#X-Amz-Target=AmazonSSM.ListNodesTakes in filters and returns a list of managed nodes matching the filter criteria.
  • POSTList nodes summary/#X-Amz-Target=AmazonSSM.ListNodesSummaryGenerates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.
  • POSTList ops item events/#X-Amz-Target=AmazonSSM.ListOpsItemEventsReturns 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…
  • POSTList ops item related items/#X-Amz-Target=AmazonSSM.ListOpsItemRelatedItemsLists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.
  • POSTList ops metadata/#X-Amz-Target=AmazonSSM.ListOpsMetadataAmazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
  • POSTList resource compliance summaries/#X-Amz-Target=AmazonSSM.ListResourceComplianceSummariesReturns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity…
  • POSTList resource data sync/#X-Amz-Target=AmazonSSM.ListResourceDataSyncLists 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…
  • POSTList tags for resource/#X-Amz-Target=AmazonSSM.ListTagsForResourceReturns a list of the tags assigned to the specified resource. For information about the ID format for each supported resource type, see AddTagsToResource .
  • POSTModify document permission/#X-Amz-Target=AmazonSSM.ModifyDocumentPermissionShares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web…
  • POSTPut compliance items/#X-Amz-Target=AmazonSSM.PutComplianceItemsRegisters a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource.…
  • POSTPut inventory/#X-Amz-Target=AmazonSSM.PutInventoryBulk 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…
  • POSTPut parameter/#X-Amz-Target=AmazonSSM.PutParameterCreate or update a parameter in Parameter Store. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can…
  • POSTPut resource policy/#X-Amz-Target=AmazonSSM.PutResourcePolicyCreates 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…
  • POSTRegister default host management configuration/#X-Amz-Target=AmazonSSM.RegisterDefaultHostManagementConfigurationEnables Default Host Management Configuration (DHMC) for the current Amazon Web Services account and Amazon Web Services Region. With DHMC enabled, you don't…
  • POSTRegister default patch baseline/#X-Amz-Target=AmazonSSM.RegisterDefaultPatchBaselineDefines the default patch baseline for the relevant operating system. To reset the Amazon Web Services-predefined patch baseline as the default, specify the…
  • POSTRegister patch baseline for patch group/#X-Amz-Target=AmazonSSM.RegisterPatchBaselineForPatchGroupRegisters a patch baseline for a patch group.
  • POSTRegister target with maintenance window/#X-Amz-Target=AmazonSSM.RegisterTargetWithMaintenanceWindowRegisters a target with a maintenance window.
  • POSTRegister task with maintenance window/#X-Amz-Target=AmazonSSM.RegisterTaskWithMaintenanceWindowAdds a new task to a maintenance window.
  • POSTRemove tags from resource/#X-Amz-Target=AmazonSSM.RemoveTagsFromResourceRemoves tag keys from the specified resource.
  • POSTReset service setting/#X-Amz-Target=AmazonSSM.ResetServiceSettingServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature…
  • POSTResume session/#X-Amz-Target=AmazonSSM.ResumeSessionReconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This…
  • POSTSend automation signal/#X-Amz-Target=AmazonSSM.SendAutomationSignalSends a signal to an Automation execution to change the current behavior or status of the execution.
  • POSTSend command/#X-Amz-Target=AmazonSSM.SendCommandRuns commands on one or more managed nodes.
  • POSTStart access request/#X-Amz-Target=AmazonSSM.StartAccessRequestStarts the workflow for just-in-time node access sessions.
  • POSTStart associations once/#X-Amz-Target=AmazonSSM.StartAssociationsOnceRuns an association immediately and only one time. This operation can be helpful when troubleshooting associations.
  • POSTStart automation execution/#X-Amz-Target=AmazonSSM.StartAutomationExecutionInitiates execution of an Automation runbook.
  • POSTStart change request execution/#X-Amz-Target=AmazonSSM.StartChangeRequestExecutionAmazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more…
  • POSTStart execution preview/#X-Amz-Target=AmazonSSM.StartExecutionPreviewInitiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.
  • POSTStart session/#X-Amz-Target=AmazonSSM.StartSessionInitiates 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…
  • POSTStop automation execution/#X-Amz-Target=AmazonSSM.StopAutomationExecutionStop an Automation that is currently running.
  • POSTTerminate session/#X-Amz-Target=AmazonSSM.TerminateSessionPermanently 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…
  • POSTUnlabel parameter version/#X-Amz-Target=AmazonSSM.UnlabelParameterVersionRemove a label or labels from a parameter. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a…
  • POSTUpdate association/#X-Amz-Target=AmazonSSM.UpdateAssociationUpdates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon…
  • POSTUpdate association status/#X-Amz-Target=AmazonSSM.UpdateAssociationStatusUpdates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node. UpdateAssociationStatus is…
  • POSTUpdate cloud connector/#X-Amz-Target=AmazonSSM.UpdateCloudConnectorUpdates an existing cloud connector with new configuration details.
  • POSTUpdate document/#X-Amz-Target=AmazonSSM.UpdateDocumentUpdates one or more values for an SSM document.
  • POSTUpdate document default version/#X-Amz-Target=AmazonSSM.UpdateDocumentDefaultVersionSet the default version of a document. If you change a document version for a State Manager association, Systems Manager immediately runs the association…
  • POSTUpdate document metadata/#X-Amz-Target=AmazonSSM.UpdateDocumentMetadataAmazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more…
  • POSTUpdate maintenance window/#X-Amz-Target=AmazonSSM.UpdateMaintenanceWindowUpdates an existing maintenance window. Only specified parameters are modified. The value you specify for Duration determines the specific end time for the…
  • POSTUpdate maintenance window target/#X-Amz-Target=AmazonSSM.UpdateMaintenanceWindowTargetModifies the target of an existing maintenance window. You can change the following: Name Description Owner IDs for an ID target Tags for a Tag target From…
  • POSTUpdate maintenance window task/#X-Amz-Target=AmazonSSM.UpdateMaintenanceWindowTaskModifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values: TaskARN . For example, you can…
  • POSTUpdate managed instance role/#X-Amz-Target=AmazonSSM.UpdateManagedInstanceRoleChanges 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…
  • POSTUpdate ops item/#X-Amz-Target=AmazonSSM.UpdateOpsItemEdit 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…
  • POSTUpdate ops metadata/#X-Amz-Target=AmazonSSM.UpdateOpsMetadataAmazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
  • POSTUpdate patch baseline/#X-Amz-Target=AmazonSSM.UpdatePatchBaselineModifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key-value pairs in PatchFilters for…
  • POSTUpdate resource data sync/#X-Amz-Target=AmazonSSM.UpdateResourceDataSyncUpdate 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…
  • POSTUpdate service setting/#X-Amz-Target=AmazonSSM.UpdateServiceSettingServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature…
  • POSTValidate cloud connector/#X-Amz-Target=AmazonSSM.ValidateCloudConnectorValidates the configuration and connectivity of a cloud connector.

API details

Base URL
https://ssm.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
154 operations on 154 pathsPOST 154
Description format
AWS Smithy model, API version 2014-11-06

How to test the Amazon Simple Systems Manager (SSM) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Simple Systems Manager (SSM) collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add tags to resource” (POST /#X-Amz-Target=AmazonSSM.AddTagsToResource), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Simple Systems Manager (SSM)?

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… It is listed under Developer tools and has 154 endpoints.

Who publishes the Amazon Simple Systems Manager (SSM)?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Simple Systems Manager (SSM)?

Requests go to https://ssm.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Simple Systems Manager (SSM)?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Simple Systems Manager (SSM) have?

154 operations on 154 paths (154 POST).

Is forking the Amazon Simple Systems Manager (SSM) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.