ssm: Amazon Simple Systems Manager (SSM)

Description Usage Arguments Value Service syntax Operations Examples

View source: R/ssm_service.R


AWS Systems Manager

AWS 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 instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.

This reference is intended to be used with the AWS Systems Manager User Guide.

To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide.

For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API requests.


ssm(config = list())



Optional configuration of credentials, endpoint, and/or region.


A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- ssm(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      profile = "string"
    endpoint = "string",
    region = "string"


add_tags_to_resource Adds or overwrites one or more tags for the specified resource
cancel_command Attempts to cancel the command specified by the Command ID
cancel_maintenance_window_execution Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running
create_activation Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager
create_association A State Manager association defines the state that you want to maintain on your instances
create_association_batch Associates the specified Systems Manager document with the specified instances or targets
create_document Creates a Systems Manager (SSM) document
create_maintenance_window Creates a new maintenance window
create_ops_item Creates a new OpsItem
create_ops_metadata If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type
create_patch_baseline Creates a patch baseline
create_resource_data_sync A resource data sync helps you view data from multiple sources in a single location
delete_activation Deletes an activation
delete_association Disassociates the specified Systems Manager document from the specified instance
delete_document Deletes the Systems Manager document and all instance associations to the document
delete_inventory Delete a custom inventory type or the data associated with a custom Inventory type
delete_maintenance_window Deletes a maintenance window
delete_ops_metadata Delete OpsMetadata related to an application
delete_parameter Delete a parameter from the system
delete_parameters Delete a list of parameters
delete_patch_baseline Deletes a patch baseline
delete_resource_data_sync Deletes a Resource Data Sync configuration
deregister_managed_instance Removes the server or virtual machine from the list of registered servers
deregister_patch_baseline_for_patch_group Removes a patch group from a patch baseline
deregister_target_from_maintenance_window Removes a target from a maintenance window
deregister_task_from_maintenance_window Removes a task from a maintenance window
describe_activations Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation
describe_association Describes the association for the specified target or instance
describe_association_executions Use this API action to view all executions for a specific association ID
describe_association_execution_targets Use this API action to view information about a specific execution of a specific association
describe_automation_executions Provides details about all active and terminated Automation executions
describe_automation_step_executions Information about all active and terminated step executions in an Automation workflow
describe_available_patches Lists all patches eligible to be included in a patch baseline
describe_document Describes the specified Systems Manager document
describe_document_permission Describes the permissions for a Systems Manager document
describe_effective_instance_associations All associations for the instance(s)
describe_effective_patches_for_patch_baseline Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline
describe_instance_associations_status The status of the associations for the instance(s)
describe_instance_information Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on
describe_instance_patches Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance
describe_instance_patch_states Retrieves the high-level patch state of one or more instances
describe_instance_patch_states_for_patch_group Retrieves the high-level patch state for the instances in the specified patch group
describe_inventory_deletions Describes a specific delete inventory operation
describe_maintenance_window_executions Lists the executions of a maintenance window
describe_maintenance_window_execution_task_invocations Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution
describe_maintenance_window_execution_tasks For a given maintenance window execution, lists the tasks that were run
describe_maintenance_windows Retrieves the maintenance windows in an AWS account
describe_maintenance_window_schedule Retrieves information about upcoming executions of a maintenance window
describe_maintenance_windows_for_target Retrieves information about the maintenance window targets or tasks that an instance is associated with
describe_maintenance_window_targets Lists the targets registered with the maintenance window
describe_maintenance_window_tasks Lists the tasks in a maintenance window
describe_ops_items Query a set of OpsItems
describe_parameters Get information about a parameter
describe_patch_baselines Lists the patch baselines in your AWS account
describe_patch_groups Lists all patch groups that have been registered with patch baselines
describe_patch_group_state Returns high-level aggregated patch compliance state for a patch group
describe_patch_properties Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches
describe_sessions Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days
get_automation_execution Get detailed information about a particular Automation execution
get_calendar_state Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time
get_command_invocation Returns detailed information about command execution for an invocation or plugin
get_connection_status Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections
get_default_patch_baseline Retrieves the default patch baseline
get_deployable_patch_snapshot_for_instance Retrieves the current snapshot for the patch baseline the instance uses
get_document Gets the contents of the specified Systems Manager document
get_inventory Query inventory information
get_inventory_schema Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type
get_maintenance_window Retrieves a maintenance window
get_maintenance_window_execution Retrieves details about a specific a maintenance window execution
get_maintenance_window_execution_task Retrieves the details about a specific task run as part of a maintenance window execution
get_maintenance_window_execution_task_invocation Retrieves information about a specific task running on a specific target
get_maintenance_window_task Lists the tasks in a maintenance window
get_ops_item Get information about an OpsItem by using the ID
get_ops_metadata View operational metadata related to an application in Application Manager
get_ops_summary View a summary of OpsItems based on specified filters and aggregators
get_parameter Get information about a parameter by using the parameter name
get_parameter_history Retrieves the history of all changes to a parameter
get_parameters Get details of a parameter
get_parameters_by_path Retrieve information about one or more parameters in a specific hierarchy
get_patch_baseline Retrieves information about a patch baseline
get_patch_baseline_for_patch_group Retrieves the patch baseline that should be used for the specified patch group
get_service_setting ServiceSetting is an account-level setting for an AWS service
label_parameter_version A parameter label is a user-defined alias to help you manage different versions of a parameter
list_associations Returns all State Manager associations in the current AWS account and Region
list_association_versions Retrieves all versions of an association for a specific association ID
list_command_invocations An invocation is copy of a command sent to a specific instance
list_commands Lists the commands requested by users of the AWS account
list_compliance_items For a specified resource ID, this API action returns a list of compliance statuses for different resource types
list_compliance_summaries Returns a summary count of compliant and non-compliant resources for a compliance type
list_document_metadata_history Information about approval reviews for a version of an SSM document
list_documents Returns all Systems Manager (SSM) documents in the current AWS account and Region
list_document_versions List all versions for a document
list_inventory_entries A list of inventory items returned by the request
list_ops_item_events Returns a list of all OpsItem events in the current AWS account and Region
list_ops_metadata Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs
list_resource_compliance_summaries Returns a resource-level summary count
list_resource_data_sync Lists your resource data sync configurations
list_tags_for_resource Returns a list of the tags assigned to the specified resource
modify_document_permission Shares a Systems Manager document publicly or privately
put_compliance_items Registers a compliance type and other compliance details on a designated resource
put_inventory Bulk update custom inventory items on one more instance
put_parameter Add a parameter to the system
register_default_patch_baseline Defines the default patch baseline for the relevant operating system
register_patch_baseline_for_patch_group Registers a patch baseline for a patch group
register_target_with_maintenance_window Registers a target with a maintenance window
register_task_with_maintenance_window Adds a new task to a maintenance window
remove_tags_from_resource Removes tag keys from the specified resource
reset_service_setting ServiceSetting is an account-level setting for an AWS service
resume_session Reconnects a session to an instance after it has been disconnected
send_automation_signal Sends a signal to an Automation execution to change the current behavior or status of the execution
send_command Runs commands on one or more managed instances
start_associations_once Use this API action to run an association immediately and only one time
start_automation_execution Initiates execution of an Automation document
start_change_request_execution Creates a change request for Change Manager
start_session Initiates a connection to a target (for example, an instance) for a Session Manager session
stop_automation_execution Stop an Automation that is currently running
terminate_session Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance
update_association Updates an association
update_association_status Updates the status of the Systems Manager document associated with the specified instance
update_document Updates one or more values for an SSM document
update_document_default_version Set the default version of a document
update_document_metadata Updates information related to approval reviews for a specific version of a document
update_maintenance_window Updates an existing maintenance window
update_maintenance_window_target Modifies the target of an existing maintenance window
update_maintenance_window_task Modifies a task assigned to a maintenance window
update_managed_instance_role Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM)
update_ops_item Edit or change an OpsItem
update_ops_metadata Systems Manager calls this API action when you edit OpsMetadata in Application Manager
update_patch_baseline Modifies an existing patch baseline
update_resource_data_sync Update a resource data sync
update_service_setting ServiceSetting is an account-level setting for an AWS service


## Not run: 
svc <- ssm()
  Foo = 123

## End(Not run) documentation built on Aug. 23, 2021, 9:11 a.m.