R/ssm_service.R

Defines functions service ssm

Documented in ssm

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common new_handlers new_service set_config
NULL

#' Amazon Simple Systems Manager (SSM)
#'
#' @description
#' 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/).
#' 
#' To get started, verify prerequisites and configure managed instances.
#' For more information, see [Setting up AWS Systems
#' Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html)
#' 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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/). For
#' information about how to use a Query API, see [Making API
#' requests](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/making-api-requests.html).
#'
#' @param
#' config
#' Optional configuration of credentials, endpoint, and/or region.
#'
#' @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"
#'   )
#' )
#' ```
#'
#' @examples
#' \dontrun{
#' svc <- ssm()
#' svc$add_tags_to_resource(
#'   Foo = 123
#' )
#' }
#'
#' @section Operations:
#' \tabular{ll}{
#'  \link[=ssm_add_tags_to_resource]{add_tags_to_resource} \tab Adds or overwrites one or more tags for the specified resource\cr
#'  \link[=ssm_cancel_command]{cancel_command} \tab Attempts to cancel the command specified by the Command ID\cr
#'  \link[=ssm_cancel_maintenance_window_execution]{cancel_maintenance_window_execution} \tab Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running\cr
#'  \link[=ssm_create_activation]{create_activation} \tab Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager\cr
#'  \link[=ssm_create_association]{create_association} \tab A State Manager association defines the state that you want to maintain on your instances\cr
#'  \link[=ssm_create_association_batch]{create_association_batch} \tab Associates the specified Systems Manager document with the specified instances or targets\cr
#'  \link[=ssm_create_document]{create_document} \tab Creates a Systems Manager (SSM) document\cr
#'  \link[=ssm_create_maintenance_window]{create_maintenance_window} \tab Creates a new maintenance window\cr
#'  \link[=ssm_create_ops_item]{create_ops_item} \tab Creates a new OpsItem\cr
#'  \link[=ssm_create_ops_metadata]{create_ops_metadata} \tab 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\cr
#'  \link[=ssm_create_patch_baseline]{create_patch_baseline} \tab Creates a patch baseline\cr
#'  \link[=ssm_create_resource_data_sync]{create_resource_data_sync} \tab A resource data sync helps you view data from multiple sources in a single location\cr
#'  \link[=ssm_delete_activation]{delete_activation} \tab Deletes an activation\cr
#'  \link[=ssm_delete_association]{delete_association} \tab Disassociates the specified Systems Manager document from the specified instance\cr
#'  \link[=ssm_delete_document]{delete_document} \tab Deletes the Systems Manager document and all instance associations to the document\cr
#'  \link[=ssm_delete_inventory]{delete_inventory} \tab Delete a custom inventory type or the data associated with a custom Inventory type\cr
#'  \link[=ssm_delete_maintenance_window]{delete_maintenance_window} \tab Deletes a maintenance window\cr
#'  \link[=ssm_delete_ops_metadata]{delete_ops_metadata} \tab Delete OpsMetadata related to an application\cr
#'  \link[=ssm_delete_parameter]{delete_parameter} \tab Delete a parameter from the system\cr
#'  \link[=ssm_delete_parameters]{delete_parameters} \tab Delete a list of parameters\cr
#'  \link[=ssm_delete_patch_baseline]{delete_patch_baseline} \tab Deletes a patch baseline\cr
#'  \link[=ssm_delete_resource_data_sync]{delete_resource_data_sync} \tab Deletes a Resource Data Sync configuration\cr
#'  \link[=ssm_deregister_managed_instance]{deregister_managed_instance} \tab Removes the server or virtual machine from the list of registered servers\cr
#'  \link[=ssm_deregister_patch_baseline_for_patch_group]{deregister_patch_baseline_for_patch_group} \tab Removes a patch group from a patch baseline\cr
#'  \link[=ssm_deregister_target_from_maintenance_window]{deregister_target_from_maintenance_window} \tab Removes a target from a maintenance window\cr
#'  \link[=ssm_deregister_task_from_maintenance_window]{deregister_task_from_maintenance_window} \tab Removes a task from a maintenance window\cr
#'  \link[=ssm_describe_activations]{describe_activations} \tab 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\cr
#'  \link[=ssm_describe_association]{describe_association} \tab Describes the association for the specified target or instance\cr
#'  \link[=ssm_describe_association_executions]{describe_association_executions} \tab Use this API action to view all executions for a specific association ID\cr
#'  \link[=ssm_describe_association_execution_targets]{describe_association_execution_targets} \tab Use this API action to view information about a specific execution of a specific association\cr
#'  \link[=ssm_describe_automation_executions]{describe_automation_executions} \tab Provides details about all active and terminated Automation executions\cr
#'  \link[=ssm_describe_automation_step_executions]{describe_automation_step_executions} \tab Information about all active and terminated step executions in an Automation workflow\cr
#'  \link[=ssm_describe_available_patches]{describe_available_patches} \tab Lists all patches eligible to be included in a patch baseline\cr
#'  \link[=ssm_describe_document]{describe_document} \tab Describes the specified Systems Manager document\cr
#'  \link[=ssm_describe_document_permission]{describe_document_permission} \tab Describes the permissions for a Systems Manager document\cr
#'  \link[=ssm_describe_effective_instance_associations]{describe_effective_instance_associations} \tab All associations for the instance(s)\cr
#'  \link[=ssm_describe_effective_patches_for_patch_baseline]{describe_effective_patches_for_patch_baseline} \tab Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline\cr
#'  \link[=ssm_describe_instance_associations_status]{describe_instance_associations_status} \tab The status of the associations for the instance(s)\cr
#'  \link[=ssm_describe_instance_information]{describe_instance_information} \tab 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\cr
#'  \link[=ssm_describe_instance_patches]{describe_instance_patches} \tab Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance\cr
#'  \link[=ssm_describe_instance_patch_states]{describe_instance_patch_states} \tab Retrieves the high-level patch state of one or more instances\cr
#'  \link[=ssm_describe_instance_patch_states_for_patch_group]{describe_instance_patch_states_for_patch_group} \tab Retrieves the high-level patch state for the instances in the specified patch group\cr
#'  \link[=ssm_describe_inventory_deletions]{describe_inventory_deletions} \tab Describes a specific delete inventory operation\cr
#'  \link[=ssm_describe_maintenance_window_executions]{describe_maintenance_window_executions} \tab Lists the executions of a maintenance window\cr
#'  \link[=ssm_describe_maintenance_window_execution_task_invocations]{describe_maintenance_window_execution_task_invocations} \tab Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution\cr
#'  \link[=ssm_describe_maintenance_window_execution_tasks]{describe_maintenance_window_execution_tasks} \tab For a given maintenance window execution, lists the tasks that were run\cr
#'  \link[=ssm_describe_maintenance_windows]{describe_maintenance_windows} \tab Retrieves the maintenance windows in an AWS account\cr
#'  \link[=ssm_describe_maintenance_window_schedule]{describe_maintenance_window_schedule} \tab Retrieves information about upcoming executions of a maintenance window\cr
#'  \link[=ssm_describe_maintenance_windows_for_target]{describe_maintenance_windows_for_target} \tab Retrieves information about the maintenance window targets or tasks that an instance is associated with\cr
#'  \link[=ssm_describe_maintenance_window_targets]{describe_maintenance_window_targets} \tab Lists the targets registered with the maintenance window\cr
#'  \link[=ssm_describe_maintenance_window_tasks]{describe_maintenance_window_tasks} \tab Lists the tasks in a maintenance window\cr
#'  \link[=ssm_describe_ops_items]{describe_ops_items} \tab Query a set of OpsItems\cr
#'  \link[=ssm_describe_parameters]{describe_parameters} \tab Get information about a parameter\cr
#'  \link[=ssm_describe_patch_baselines]{describe_patch_baselines} \tab Lists the patch baselines in your AWS account\cr
#'  \link[=ssm_describe_patch_groups]{describe_patch_groups} \tab Lists all patch groups that have been registered with patch baselines\cr
#'  \link[=ssm_describe_patch_group_state]{describe_patch_group_state} \tab Returns high-level aggregated patch compliance state for a patch group\cr
#'  \link[=ssm_describe_patch_properties]{describe_patch_properties} \tab Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches\cr
#'  \link[=ssm_describe_sessions]{describe_sessions} \tab Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days\cr
#'  \link[=ssm_get_automation_execution]{get_automation_execution} \tab Get detailed information about a particular Automation execution\cr
#'  \link[=ssm_get_calendar_state]{get_calendar_state} \tab Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time\cr
#'  \link[=ssm_get_command_invocation]{get_command_invocation} \tab Returns detailed information about command execution for an invocation or plugin\cr
#'  \link[=ssm_get_connection_status]{get_connection_status} \tab Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections\cr
#'  \link[=ssm_get_default_patch_baseline]{get_default_patch_baseline} \tab Retrieves the default patch baseline\cr
#'  \link[=ssm_get_deployable_patch_snapshot_for_instance]{get_deployable_patch_snapshot_for_instance} \tab Retrieves the current snapshot for the patch baseline the instance uses\cr
#'  \link[=ssm_get_document]{get_document} \tab Gets the contents of the specified Systems Manager document\cr
#'  \link[=ssm_get_inventory]{get_inventory} \tab Query inventory information\cr
#'  \link[=ssm_get_inventory_schema]{get_inventory_schema} \tab Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type\cr
#'  \link[=ssm_get_maintenance_window]{get_maintenance_window} \tab Retrieves a maintenance window\cr
#'  \link[=ssm_get_maintenance_window_execution]{get_maintenance_window_execution} \tab Retrieves details about a specific a maintenance window execution\cr
#'  \link[=ssm_get_maintenance_window_execution_task]{get_maintenance_window_execution_task} \tab Retrieves the details about a specific task run as part of a maintenance window execution\cr
#'  \link[=ssm_get_maintenance_window_execution_task_invocation]{get_maintenance_window_execution_task_invocation} \tab Retrieves information about a specific task running on a specific target\cr
#'  \link[=ssm_get_maintenance_window_task]{get_maintenance_window_task} \tab Lists the tasks in a maintenance window\cr
#'  \link[=ssm_get_ops_item]{get_ops_item} \tab Get information about an OpsItem by using the ID\cr
#'  \link[=ssm_get_ops_metadata]{get_ops_metadata} \tab View operational metadata related to an application in Application Manager\cr
#'  \link[=ssm_get_ops_summary]{get_ops_summary} \tab View a summary of OpsItems based on specified filters and aggregators\cr
#'  \link[=ssm_get_parameter]{get_parameter} \tab Get information about a parameter by using the parameter name\cr
#'  \link[=ssm_get_parameter_history]{get_parameter_history} \tab Retrieves the history of all changes to a parameter\cr
#'  \link[=ssm_get_parameters]{get_parameters} \tab Get details of a parameter\cr
#'  \link[=ssm_get_parameters_by_path]{get_parameters_by_path} \tab Retrieve information about one or more parameters in a specific hierarchy\cr
#'  \link[=ssm_get_patch_baseline]{get_patch_baseline} \tab Retrieves information about a patch baseline\cr
#'  \link[=ssm_get_patch_baseline_for_patch_group]{get_patch_baseline_for_patch_group} \tab Retrieves the patch baseline that should be used for the specified patch group\cr
#'  \link[=ssm_get_service_setting]{get_service_setting} \tab ServiceSetting is an account-level setting for an AWS service\cr
#'  \link[=ssm_label_parameter_version]{label_parameter_version} \tab A parameter label is a user-defined alias to help you manage different versions of a parameter\cr
#'  \link[=ssm_list_associations]{list_associations} \tab Returns all State Manager associations in the current AWS account and Region\cr
#'  \link[=ssm_list_association_versions]{list_association_versions} \tab Retrieves all versions of an association for a specific association ID\cr
#'  \link[=ssm_list_command_invocations]{list_command_invocations} \tab An invocation is copy of a command sent to a specific instance\cr
#'  \link[=ssm_list_commands]{list_commands} \tab Lists the commands requested by users of the AWS account\cr
#'  \link[=ssm_list_compliance_items]{list_compliance_items} \tab For a specified resource ID, this API action returns a list of compliance statuses for different resource types\cr
#'  \link[=ssm_list_compliance_summaries]{list_compliance_summaries} \tab Returns a summary count of compliant and non-compliant resources for a compliance type\cr
#'  \link[=ssm_list_document_metadata_history]{list_document_metadata_history} \tab Information about approval reviews for a version of an SSM document\cr
#'  \link[=ssm_list_documents]{list_documents} \tab Returns all Systems Manager (SSM) documents in the current AWS account and Region\cr
#'  \link[=ssm_list_document_versions]{list_document_versions} \tab List all versions for a document\cr
#'  \link[=ssm_list_inventory_entries]{list_inventory_entries} \tab A list of inventory items returned by the request\cr
#'  \link[=ssm_list_ops_item_events]{list_ops_item_events} \tab Returns a list of all OpsItem events in the current AWS account and Region\cr
#'  \link[=ssm_list_ops_metadata]{list_ops_metadata} \tab Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs\cr
#'  \link[=ssm_list_resource_compliance_summaries]{list_resource_compliance_summaries} \tab Returns a resource-level summary count\cr
#'  \link[=ssm_list_resource_data_sync]{list_resource_data_sync} \tab Lists your resource data sync configurations\cr
#'  \link[=ssm_list_tags_for_resource]{list_tags_for_resource} \tab Returns a list of the tags assigned to the specified resource\cr
#'  \link[=ssm_modify_document_permission]{modify_document_permission} \tab Shares a Systems Manager document publicly or privately\cr
#'  \link[=ssm_put_compliance_items]{put_compliance_items} \tab Registers a compliance type and other compliance details on a designated resource\cr
#'  \link[=ssm_put_inventory]{put_inventory} \tab Bulk update custom inventory items on one more instance\cr
#'  \link[=ssm_put_parameter]{put_parameter} \tab Add a parameter to the system\cr
#'  \link[=ssm_register_default_patch_baseline]{register_default_patch_baseline} \tab Defines the default patch baseline for the relevant operating system\cr
#'  \link[=ssm_register_patch_baseline_for_patch_group]{register_patch_baseline_for_patch_group} \tab Registers a patch baseline for a patch group\cr
#'  \link[=ssm_register_target_with_maintenance_window]{register_target_with_maintenance_window} \tab Registers a target with a maintenance window\cr
#'  \link[=ssm_register_task_with_maintenance_window]{register_task_with_maintenance_window} \tab Adds a new task to a maintenance window\cr
#'  \link[=ssm_remove_tags_from_resource]{remove_tags_from_resource} \tab Removes tag keys from the specified resource\cr
#'  \link[=ssm_reset_service_setting]{reset_service_setting} \tab ServiceSetting is an account-level setting for an AWS service\cr
#'  \link[=ssm_resume_session]{resume_session} \tab Reconnects a session to an instance after it has been disconnected\cr
#'  \link[=ssm_send_automation_signal]{send_automation_signal} \tab Sends a signal to an Automation execution to change the current behavior or status of the execution\cr
#'  \link[=ssm_send_command]{send_command} \tab Runs commands on one or more managed instances\cr
#'  \link[=ssm_start_associations_once]{start_associations_once} \tab Use this API action to run an association immediately and only one time\cr
#'  \link[=ssm_start_automation_execution]{start_automation_execution} \tab Initiates execution of an Automation document\cr
#'  \link[=ssm_start_change_request_execution]{start_change_request_execution} \tab Creates a change request for Change Manager\cr
#'  \link[=ssm_start_session]{start_session} \tab Initiates a connection to a target (for example, an instance) for a Session Manager session\cr
#'  \link[=ssm_stop_automation_execution]{stop_automation_execution} \tab Stop an Automation that is currently running\cr
#'  \link[=ssm_terminate_session]{terminate_session} \tab Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance\cr
#'  \link[=ssm_update_association]{update_association} \tab Updates an association\cr
#'  \link[=ssm_update_association_status]{update_association_status} \tab Updates the status of the Systems Manager document associated with the specified instance\cr
#'  \link[=ssm_update_document]{update_document} \tab Updates one or more values for an SSM document\cr
#'  \link[=ssm_update_document_default_version]{update_document_default_version} \tab Set the default version of a document\cr
#'  \link[=ssm_update_document_metadata]{update_document_metadata} \tab Updates information related to approval reviews for a specific version of a document\cr
#'  \link[=ssm_update_maintenance_window]{update_maintenance_window} \tab Updates an existing maintenance window\cr
#'  \link[=ssm_update_maintenance_window_target]{update_maintenance_window_target} \tab Modifies the target of an existing maintenance window\cr
#'  \link[=ssm_update_maintenance_window_task]{update_maintenance_window_task} \tab Modifies a task assigned to a maintenance window\cr
#'  \link[=ssm_update_managed_instance_role]{update_managed_instance_role} \tab Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM)\cr
#'  \link[=ssm_update_ops_item]{update_ops_item} \tab Edit or change an OpsItem\cr
#'  \link[=ssm_update_ops_metadata]{update_ops_metadata} \tab Systems Manager calls this API action when you edit OpsMetadata in Application Manager\cr
#'  \link[=ssm_update_patch_baseline]{update_patch_baseline} \tab Modifies an existing patch baseline\cr
#'  \link[=ssm_update_resource_data_sync]{update_resource_data_sync} \tab Update a resource data sync\cr
#'  \link[=ssm_update_service_setting]{update_service_setting} \tab ServiceSetting is an account-level setting for an AWS service
#' }
#'
#' @return
#' 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.
#'
#' @rdname ssm
#' @export
ssm <- function(config = list()) {
  svc <- .ssm$operations
  svc <- set_config(svc, config)
  return(svc)
}

# Private API objects: metadata, handlers, interfaces, etc.
.ssm <- list()

.ssm$operations <- list()

.ssm$metadata <- list(
  service_name = "ssm",
  endpoints = list("*" = list(endpoint = "ssm.{region}.amazonaws.com", global = FALSE), "cn-*" = list(endpoint = "ssm.{region}.amazonaws.com.cn", global = FALSE), "us-iso-*" = list(endpoint = "ssm.{region}.c2s.ic.gov", global = FALSE), "us-isob-*" = list(endpoint = "ssm.{region}.sc2s.sgov.gov", global = FALSE)),
  service_id = "SSM",
  api_version = "2014-11-06",
  signing_name = "ssm",
  json_version = "1.1",
  target_prefix = "AmazonSSM"
)

.ssm$service <- function(config = list()) {
  handlers <- new_handlers("jsonrpc", "v4")
  new_service(.ssm$metadata, handlers, config)
}

Try the paws.management package in your browser

Any scripts or data that you put into this service are public.

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.