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 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 SystemsManager Automation runbook reference .
For information about AppConfig, a tool in Systems Manager, see the AppConfigUser Guide and the AppConfigAPI Reference .
For information about Incident Manager, a tool in Systems Manager, see the SystemsManager Incident Manager User Guide and the SystemsManager Incident Manager API Reference .
ssm(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config: Optional configuration of credentials, endpoint, and/or region.
credentials :
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint : The complete URL to use for the constructed client.
region : The AWS Region used in instantiating the client.
close_connection : Immediately close all HTTP connections.
timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials: Optional credentials shorthand for the config parameter
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint: Optional shorthand for complete URL to use for the constructed client.
region: Optional shorthand for AWS Region used in instantiating the client.
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.
svc <- ssm(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_tags_to_resource | Adds or overwrites one or more tags for the specified resource |
| associate_ops_item_related_item | Associates a related item to a Systems Manager OpsCenter OpsItem |
| 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 haven't already starting running |
| create_activation | 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 |
| create_association | A State Manager association defines the state that you want to maintain on your managed nodes |
| create_association_batch | Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets |
| create_document | Creates a Amazon Web Services 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, Amazon Web Services Systems Manager calls this API operation 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 Amazon Web Services Systems Manager document (SSM document) from the specified managed node |
| delete_document | Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node 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_item | Delete an OpsItem |
| 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 |
| delete_resource_policy | Deletes a Systems Manager resource policy |
| 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation |
| describe_association | Describes the association for the specified target or managed node |
| describe_association_executions | Views all executions for a specific association ID |
| describe_association_execution_targets | Views 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 Amazon Web Services Systems Manager document (SSM document) |
| describe_document_permission | Describes the permissions for a Amazon Web Services Systems Manager document (SSM document) |
| describe_effective_instance_associations | All associations for the managed nodes |
| 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 managed nodes |
| describe_instance_information | Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address |
| describe_instance_patches | Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node |
| describe_instance_patch_states | Retrieves the high-level patch state of one or more managed nodes |
| describe_instance_patch_states_for_patch_group | Retrieves the high-level patch state for the managed nodes in the specified patch group |
| describe_instance_properties | An API operation used by the Systems Manager console to display information about Systems Manager managed nodes |
| 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 Amazon Web Services 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 a managed node 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 | Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option |
| describe_patch_baselines | Lists the patch baselines in your Amazon Web Services 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 information 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 |
| disassociate_ops_item_related_item | Deletes the association between an OpsItem and a related item |
| get_automation_execution | Get detailed information about a particular Automation execution |
| get_calendar_state | Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a 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 a managed node 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 managed node uses |
| get_document | Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document) |
| get_execution_preview | Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources |
| 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 | Retrieves the details of a maintenance window task |
| 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 operations metadata (OpsData) based on specified filters and aggregators |
| get_parameter | Get information about a single parameter by specifying the parameter name |
| get_parameter_history | Retrieves the history of all changes to a parameter |
| get_parameters | Get information about one or more parameters by specifying multiple parameter names |
| get_parameters_by_path | Retrieve information about one or more parameters under a specified level in a 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_resource_policies | Returns an array of the Policy object |
| get_service_setting | ServiceSetting is an account-level setting for an Amazon Web Services 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 Amazon Web Services account and Amazon Web Services 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 managed node |
| list_commands | Lists the commands requested by users of the Amazon Web Services account |
| list_compliance_items | For a specified resource ID, this API operation 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 a change template in Change Manager |
| list_documents | Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region |
| list_document_versions | List all versions for a document |
| list_inventory_entries | A list of inventory items returned by the request |
| list_nodes | Takes in filters and returns a list of managed nodes matching the filter criteria |
| list_nodes_summary | Generates a summary of managed instance/node metadata based on the filters and aggregators you specify |
| list_ops_item_events | Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account |
| list_ops_item_related_items | Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem |
| list_ops_metadata | Amazon Web Services Systems Manager calls this API operation 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 Amazon Web Services Systems Manager document (SSM 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 or more managed nodes |
| put_parameter | Add a parameter to the system |
| put_resource_policy | Creates or updates a Systems Manager resource policy |
| 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 Amazon Web Services service |
| resume_session | Reconnects a session to a managed node 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 nodes |
| start_associations_once | Runs an association immediately and only one time |
| start_automation_execution | Initiates execution of an Automation runbook |
| start_change_request_execution | Creates a change request for Change Manager |
| start_execution_preview | Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources |
| start_session | Initiates a connection to a target (for example, a managed node) 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 managed node |
| unlabel_parameter_version | Remove a label or labels from a parameter |
| update_association | Updates an association |
| update_association_status | Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node |
| 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 change template in Change Manager |
| 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 Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM) |
| update_ops_item | Edit or change an OpsItem |
| update_ops_metadata | Amazon Web Services Systems Manager calls this API operation 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 Amazon Web Services service |
## Not run: svc <- ssm() svc$add_tags_to_resource( Foo = 123 ) ## End(Not run)
Useful links