[ aws ]
ssm¶
Description¶
Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or virtual machine (VM) that has been configured for Systems Manager.
Note
With support for IoT Greengrass core devices, the phrase managed instance has been changed to managed node in most of the Systems Manager documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the term instance .
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide .
To get started, verify prerequisites and configure managed nodes. For more information, see Setting up Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide .
Related resources
For information about how to use a Query API, see Making API requests .
For information about other API operations you can perform on EC2 instances, see the Amazon EC2 API 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 Incident Manager User Guide and the Incident Manager API Reference .
Available Commands¶
- add-tags-to-resource
- associate-ops-item-related-item
- cancel-command
- cancel-maintenance-window-execution
- create-activation
- create-association
- create-association-batch
- create-document
- create-maintenance-window
- create-ops-item
- create-ops-metadata
- create-patch-baseline
- create-resource-data-sync
- delete-activation
- delete-association
- delete-document
- delete-inventory
- delete-maintenance-window
- delete-ops-metadata
- delete-parameter
- delete-parameters
- delete-patch-baseline
- delete-resource-data-sync
- deregister-managed-instance
- deregister-patch-baseline-for-patch-group
- deregister-target-from-maintenance-window
- deregister-task-from-maintenance-window
- describe-activations
- describe-association
- describe-association-execution-targets
- describe-association-executions
- describe-automation-executions
- describe-automation-step-executions
- describe-available-patches
- describe-document
- describe-document-permission
- describe-effective-instance-associations
- describe-effective-patches-for-patch-baseline
- describe-instance-associations-status
- describe-instance-information
- describe-instance-patch-states
- describe-instance-patch-states-for-patch-group
- describe-instance-patches
- describe-inventory-deletions
- describe-maintenance-window-execution-task-invocations
- describe-maintenance-window-execution-tasks
- describe-maintenance-window-executions
- describe-maintenance-window-schedule
- describe-maintenance-window-targets
- describe-maintenance-window-tasks
- describe-maintenance-windows
- describe-maintenance-windows-for-target
- describe-ops-items
- describe-parameters
- describe-patch-baselines
- describe-patch-group-state
- describe-patch-groups
- describe-patch-properties
- describe-sessions
- disassociate-ops-item-related-item
- get-automation-execution
- get-calendar-state
- get-command-invocation
- get-connection-status
- get-default-patch-baseline
- get-deployable-patch-snapshot-for-instance
- get-document
- get-inventory
- get-inventory-schema
- get-maintenance-window
- get-maintenance-window-execution
- get-maintenance-window-execution-task
- get-maintenance-window-execution-task-invocation
- get-maintenance-window-task
- get-ops-item
- get-ops-metadata
- get-ops-summary
- get-parameter
- get-parameter-history
- get-parameters
- get-parameters-by-path
- get-patch-baseline
- get-patch-baseline-for-patch-group
- get-service-setting
- label-parameter-version
- list-association-versions
- list-associations
- list-command-invocations
- list-commands
- list-compliance-items
- list-compliance-summaries
- list-document-metadata-history
- list-document-versions
- list-documents
- list-inventory-entries
- list-ops-item-events
- list-ops-item-related-items
- list-ops-metadata
- list-resource-compliance-summaries
- list-resource-data-sync
- list-tags-for-resource
- modify-document-permission
- put-compliance-items
- put-inventory
- put-parameter
- register-default-patch-baseline
- register-patch-baseline-for-patch-group
- register-target-with-maintenance-window
- register-task-with-maintenance-window
- remove-tags-from-resource
- reset-service-setting
- resume-session
- send-automation-signal
- send-command
- start-associations-once
- start-automation-execution
- start-change-request-execution
- start-session
- stop-automation-execution
- terminate-session
- unlabel-parameter-version
- update-association
- update-association-status
- update-document
- update-document-default-version
- update-document-metadata
- update-maintenance-window
- update-maintenance-window-target
- update-maintenance-window-task
- update-managed-instance-role
- update-ops-item
- update-ops-metadata
- update-patch-baseline
- update-resource-data-sync
- update-service-setting
- wait