AWS.SSM (aws-elixir v0.8.0) View Source

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 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 Amazon Web Services Systems Manager User Guide.

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

Link to this section Summary

Functions

Adds or overwrites one or more tags for the specified resource.

Associates a related resource to a Systems Manager OpsCenter OpsItem.

Attempts to cancel the command specified by the Command ID.

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running.

Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Amazon Web Services Systems Manager.

A State Manager association defines the state that you want to maintain on your instances.

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified instances or targets.

Creates a Amazon Web Services Systems Manager (SSM document).

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.

A resource data sync helps you view data from multiple sources in a single location.

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance.

Deletes the Amazon Web Services Systems Manager document (SSM document) and all instance associations to the document.

Delete a custom inventory type or the data associated with a custom Inventory type.

Delete OpsMetadata related to an application.

Delete a parameter from the system.

Deletes a resource data sync configuration.

Removes the server or virtual machine from the list of registered servers.

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 instances in the activation, and the number of instances registered by using this activation.

Describes the association for the specified target or instance.

Views information about a specific execution of a specific association.

Views all executions for a specific association ID.

Provides details about all active and terminated Automation executions.

Information about all active and terminated step executions in an Automation workflow.

Lists all patches eligible to be included in a patch baseline.

Describes the specified Amazon Web Services Systems Manager document (SSM document).

Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.

The status of the associations for the instance(s).

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.

Retrieves the high-level patch state of one or more instances.

Retrieves the high-level patch state for the instances in the specified patch group.

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

Describes a specific delete inventory operation.

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

For a given maintenance window execution, lists the tasks that were run.

Lists the executions of a maintenance window.

Retrieves information about upcoming executions of a maintenance window.

Lists the targets registered with the maintenance window.

Lists the tasks in a maintenance window.

Retrieves the maintenance windows in an account.

Retrieves information about the maintenance window targets or tasks that an instance is associated with.

Get information about a parameter.

Lists the patch baselines in your account.

Returns high-level aggregated patch compliance state information for a patch group.

Lists all patch groups that have been registered with patch baselines.

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches.

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Deletes the association between an OpsItem and a related resource.

Get detailed information about a particular Automation execution.

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.

Returns detailed information about command execution for an invocation or plugin.

Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.

Retrieves the default patch baseline.

Retrieves the current snapshot for the patch baseline the instance uses.

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

Query inventory information.

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Retrieves details about a specific a maintenance window execution.

Retrieves the details about a specific task run as part of a maintenance window execution.

Retrieves information about a specific task running on a specific target.

Lists the tasks in a maintenance window.

Get information about an OpsItem by using the ID.

View operational metadata related to an application in Application Manager.

View a summary of operations metadata (OpsData) based on specified filters and aggregators.

Get information about a parameter by using the parameter name.

Retrieves the history of all changes to a parameter.

Get details of a parameter.

Retrieve information about one or more parameters in a specific hierarchy.

Retrieves information about a patch baseline.

Retrieves the patch baseline that should be used for the specified patch group.

ServiceSetting is an account-level setting for an Amazon Web Services service.

A parameter label is a user-defined alias to help you manage different versions of a parameter.

Retrieves all versions of an association for a specific association ID.

Returns all State Manager associations in the current account and Region.

An invocation is copy of a command sent to a specific instance.

Lists the commands requested by users of the account.

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.

Returns a summary count of compliant and non-compliant resources for a compliance type.

Information about approval reviews for a version of an SSM document.

List all versions for a document.

Returns all Systems Manager (SSM) documents in the current account and Region.

A list of inventory items returned by the request.

Returns a list of all OpsItem events in the current Region and account.

Lists all related-item resources associated with an OpsItem.

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

Lists your resource data sync configurations.

Returns a list of the tags assigned to the specified resource.

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.

Registers a compliance type and other compliance details on a designated resource.

Bulk update custom inventory items on one more instance.

Add a parameter to the system.

Defines the default patch baseline for the relevant operating system.

Registers a patch baseline for a patch group.

Registers a target with a maintenance window.

Removes tag keys from the specified resource.

ServiceSetting is an account-level setting for an Amazon Web Services service.

Reconnects a session to an instance after it has been disconnected.

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Runs commands on one or more managed instances.

Runs an association immediately and only one time.

Initiates execution of an Automation runbook.

Creates a change request for Change Manager.

Initiates a connection to a target (for example, an instance) for a Session Manager session.

Stop an Automation that is currently running.

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance.

Remove a label or labels from a parameter.

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified instance.

Updates one or more values for an SSM document.

Set the default version of a document.

Updates information related to approval reviews for a specific version of a document.

Updates an existing maintenance window.

Modifies the target of an existing maintenance window.

Modifies a task assigned to a maintenance window.

Changes the Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM).

Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

Modifies an existing patch baseline.

ServiceSetting is an account-level setting for an Amazon Web Services service.

Link to this section Functions

Link to this function

add_tags_to_resource(client, input, options \\ [])

View Source

Adds or overwrites one or more tags for the specified resource.

Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example:

  • Key=Owner,Value=DbAdmin

  • Key=Owner,Value=SysAdmin

  • Key=Owner,Value=Dev

  • Key=Stack,Value=Production

  • Key=Stack,Value=Pre-Production

  • Key=Stack,Value=Test

Each resource can have a maximum of 50 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.

Link to this function

cancel_command(client, input, options \\ [])

View Source

Attempts to cancel the command specified by the Command ID.

There is no guarantee that the command will be terminated and the underlying process stopped.

Link to this function

cancel_maintenance_window_execution(client, input, options \\ [])

View Source

Stops 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 progress will continue to completion.

Link to this function

create_activation(client, input, options \\ [])

View Source

Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Amazon Web Services Systems Manager.

Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.

On-premises servers or VMs that are registered with Systems Manager and Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage with Systems Manager are all called managed instances.

Link to this function

create_association(client, input, options \\ [])

View Source

A State Manager association defines the state that you want to maintain on your instances.

For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.

Link to this function

create_association_batch(client, input, options \\ [])

View Source

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

Link to this function

create_document(client, input, options \\ [])

View Source

Creates a Amazon Web Services Systems Manager (SSM document).

An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

Link to this function

create_maintenance_window(client, input, options \\ [])

View Source

Creates 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. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Link to this function

create_ops_item(client, input, options \\ [])

View Source

Creates a new OpsItem.

You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Link to this function

create_ops_metadata(client, input, options \\ [])

View Source

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.

Link to this function

create_patch_baseline(client, input, options \\ [])

View Source

Creates a patch baseline.

For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Link to this function

create_resource_data_sync(client, input, options \\ [])

View Source

A 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 sync: SyncToDestination and SyncFromSource.

You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple accounts and Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.

By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

Link to this function

delete_activation(client, input, options \\ [])

View Source

Deletes 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 instances. Deleting an activation doesn't de-register managed instances. You must manually de-register managed instances.

Link to this function

delete_association(client, input, options \\ [])

View Source

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance.

When you disassociate a document from an instance, it doesn't change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

Link to this function

delete_document(client, input, options \\ [])

View Source

Deletes the Amazon Web Services Systems Manager document (SSM document) and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Link to this function

delete_inventory(client, input, options \\ [])

View Source

Delete 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 inventory schema.

Link to this function

delete_maintenance_window(client, input, options \\ [])

View Source

Deletes a maintenance window.

Link to this function

delete_ops_metadata(client, input, options \\ [])

View Source

Delete OpsMetadata related to an application.

Link to this function

delete_parameter(client, input, options \\ [])

View Source

Delete a parameter from the system.

Link to this function

delete_parameters(client, input, options \\ [])

View Source

Delete a list of parameters.

Link to this function

delete_patch_baseline(client, input, options \\ [])

View Source

Deletes a patch baseline.

Link to this function

delete_resource_data_sync(client, input, options \\ [])

View Source

Deletes a resource data sync configuration.

After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.

Link to this function

deregister_managed_instance(client, input, options \\ [])

View Source

Removes the server or virtual machine from the list of registered servers.

You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.

Link to this function

deregister_patch_baseline_for_patch_group(client, input, options \\ [])

View Source

Removes a patch group from a patch baseline.

Link to this function

deregister_target_from_maintenance_window(client, input, options \\ [])

View Source

Removes a target from a maintenance window.

Link to this function

deregister_task_from_maintenance_window(client, input, options \\ [])

View Source

Removes a task from a maintenance window.

Link to this function

describe_activations(client, input, options \\ [])

View Source

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 instances in the activation, and the number of instances registered by using this activation.

Link to this function

describe_association(client, input, options \\ [])

View Source

Describes the association for the specified target or instance.

If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and an Amazon Web Services Systems Manager document (SSM document), then you retrieve the association by specifying the document name and the instance ID.

Link to this function

describe_association_execution_targets(client, input, options \\ [])

View Source

Views information about a specific execution of a specific association.

Link to this function

describe_association_executions(client, input, options \\ [])

View Source

Views all executions for a specific association ID.

Link to this function

describe_automation_executions(client, input, options \\ [])

View Source

Provides details about all active and terminated Automation executions.

Link to this function

describe_automation_step_executions(client, input, options \\ [])

View Source

Information about all active and terminated step executions in an Automation workflow.

Link to this function

describe_available_patches(client, input, options \\ [])

View Source

Lists all patches eligible to be included in a patch baseline.

Link to this function

describe_document(client, input, options \\ [])

View Source

Describes the specified Amazon Web Services Systems Manager document (SSM document).

Link to this function

describe_document_permission(client, input, options \\ [])

View Source

Describes 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 shared, it can either be shared privately (by specifying a user's account ID) or publicly (All).

Link to this function

describe_effective_instance_associations(client, input, options \\ [])

View Source

All associations for the instance(s).

Link to this function

describe_effective_patches_for_patch_baseline(client, input, options \\ [])

View Source

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.

Applies to patch baselines for Windows only.

Link to this function

describe_instance_associations_status(client, input, options \\ [])

View Source

The status of the associations for the instance(s).

Link to this function

describe_instance_information(client, input, options \\ [])

View Source

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.

If you specify one or more instance IDs, it returns information for those instances. If you don't specify instance IDs, it returns information for all your instances. If you specify an instance ID that isn't valid or an instance that you don't own, you receive an error.

The IamRole field for this API operation is the Identity and Access Management (IAM) role assigned to on-premises instances. This call doesn't return the IAM role for EC2 instances.

Link to this function

describe_instance_patch_states(client, input, options \\ [])

View Source

Retrieves the high-level patch state of one or more instances.

Link to this function

describe_instance_patch_states_for_patch_group(client, input, options \\ [])

View Source

Retrieves the high-level patch state for the instances in the specified patch group.

Link to this function

describe_instance_patches(client, input, options \\ [])

View Source

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

Link to this function

describe_inventory_deletions(client, input, options \\ [])

View Source

Describes a specific delete inventory operation.

Link to this function

describe_maintenance_window_execution_task_invocations(client, input, options \\ [])

View Source

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

Link to this function

describe_maintenance_window_execution_tasks(client, input, options \\ [])

View Source

For a given maintenance window execution, lists the tasks that were run.

Link to this function

describe_maintenance_window_executions(client, input, options \\ [])

View Source

Lists the executions of a maintenance window.

This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

Link to this function

describe_maintenance_window_schedule(client, input, options \\ [])

View Source

Retrieves information about upcoming executions of a maintenance window.

Link to this function

describe_maintenance_window_targets(client, input, options \\ [])

View Source

Lists the targets registered with the maintenance window.

Link to this function

describe_maintenance_window_tasks(client, input, options \\ [])

View Source

Lists the tasks in a maintenance window.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

Link to this function

describe_maintenance_windows(client, input, options \\ [])

View Source

Retrieves the maintenance windows in an account.

Link to this function

describe_maintenance_windows_for_target(client, input, options \\ [])

View Source

Retrieves information about the maintenance window targets or tasks that an instance is associated with.

Link to this function

describe_ops_items(client, input, options \\ [])

View Source

Query a set of OpsItems.

You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.

Link to this function

describe_parameters(client, input, options \\ [])

View Source

Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Link to this function

describe_patch_baselines(client, input, options \\ [])

View Source

Lists the patch baselines in your account.

Link to this function

describe_patch_group_state(client, input, options \\ [])

View Source

Returns high-level aggregated patch compliance state information for a patch group.

Link to this function

describe_patch_groups(client, input, options \\ [])

View Source

Lists all patch groups that have been registered with patch baselines.

Link to this function

describe_patch_properties(client, input, options \\ [])

View Source

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches.

You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

Definitions

AMAZON_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

AMAZON_LINUX_2

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

CENTOS

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

DEBIAN

Valid properties: PRODUCT | PRIORITY

MACOS

Valid properties: PRODUCT | CLASSIFICATION

ORACLE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

REDHAT_ENTERPRISE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

SUSE

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

UBUNTU

Valid properties: PRODUCT | PRIORITY

WINDOWS

Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY

Link to this function

describe_sessions(client, input, options \\ [])

View Source

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Link to this function

get_automation_execution(client, input, options \\ [])

View Source

Get detailed information about a particular Automation execution.

Link to this function

get_calendar_state(client, input, options \\ [])

View Source

Gets 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 returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Link to this function

get_command_invocation(client, input, options \\ [])

View Source

Returns detailed information about command execution for an invocation or plugin.

GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific instance, use ListCommandInvocations. To get the command execution status across instances, use ListCommands.

Link to this function

get_connection_status(client, input, options \\ [])

View Source

Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.

Link to this function

get_default_patch_baseline(client, input, options \\ [])

View Source

Retrieves the default patch baseline.

Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you don't specify an operating system value, the default patch baseline for Windows is returned.

Link to this function

get_deployable_patch_snapshot_for_instance(client, input, options \\ [])

View Source

Retrieves the current snapshot for the patch baseline the instance uses.

This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local AWS credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target an instance with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.

Link to this function

get_document(client, input, options \\ [])

View Source

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

Link to this function

get_inventory(client, input, options \\ [])

View Source

Query inventory information.

Link to this function

get_inventory_schema(client, input, options \\ [])

View Source

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Link to this function

get_maintenance_window(client, input, options \\ [])

View Source

Retrieves a maintenance window.

Link to this function

get_maintenance_window_execution(client, input, options \\ [])

View Source

Retrieves details about a specific a maintenance window execution.

Link to this function

get_maintenance_window_execution_task(client, input, options \\ [])

View Source

Retrieves the details about a specific task run as part of a maintenance window execution.

Link to this function

get_maintenance_window_execution_task_invocation(client, input, options \\ [])

View Source

Retrieves information about a specific task running on a specific target.

Link to this function

get_maintenance_window_task(client, input, options \\ [])

View Source

Lists the tasks in a maintenance window.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

Link to this function

get_ops_item(client, input, options \\ [])

View Source

Get 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 more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.

Link to this function

get_ops_metadata(client, input, options \\ [])

View Source

View operational metadata related to an application in Application Manager.

Link to this function

get_ops_summary(client, input, options \\ [])

View Source

View a summary of operations metadata (OpsData) based on specified filters and aggregators.

OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

Link to this function

get_parameter(client, input, options \\ [])

View Source

Get information about a parameter by using the parameter name.

Don't confuse this API operation with the GetParameters API operation.

Link to this function

get_parameter_history(client, input, options \\ [])

View Source

Retrieves the history of all changes to a parameter.

Link to this function

get_parameters(client, input, options \\ [])

View Source

Get details of a parameter.

Don't confuse this API operation with the GetParameter API operation.

Link to this function

get_parameters_by_path(client, input, options \\ [])

View Source

Retrieve information about one or more parameters in a specific hierarchy.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Link to this function

get_patch_baseline(client, input, options \\ [])

View Source

Retrieves information about a patch baseline.

Link to this function

get_patch_baseline_for_patch_group(client, input, options \\ [])

View Source

Retrieves the patch baseline that should be used for the specified patch group.

Link to this function

get_service_setting(client, input, options \\ [])

View Source

ServiceSetting 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 of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Query the current service setting for the account.

Link to this function

label_parameter_version(client, input, options \\ [])

View Source

A 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 Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

Parameter labels have the following requirements and restrictions.

  • A version of a parameter can have a maximum of 10 labels.

  • You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

  • You can move a label from one version of a parameter to another.

  • You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

  • If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.

  • A label can have a maximum of 100 characters.

  • Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

  • Labels can't begin with a number, "aws" or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels.

Link to this function

list_association_versions(client, input, options \\ [])

View Source

Retrieves all versions of an association for a specific association ID.

Link to this function

list_associations(client, input, options \\ [])

View Source

Returns all State Manager associations in the current account and Region.

You can limit the results to a specific State Manager association document or instance by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

Link to this function

list_command_invocations(client, input, options \\ [])

View Source

An invocation is copy of a command sent to a specific instance.

A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

Link to this function

list_commands(client, input, options \\ [])

View Source

Lists the commands requested by users of the account.

Link to this function

list_compliance_items(client, input, options \\ [])

View Source

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.

Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

Link to this function

list_compliance_summaries(client, input, options \\ [])

View Source

Returns a summary count of compliant and non-compliant resources for a compliance type.

For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

Link to this function

list_document_metadata_history(client, input, options \\ [])

View Source

Information about approval reviews for a version of an SSM document.

Link to this function

list_document_versions(client, input, options \\ [])

View Source

List all versions for a document.

Link to this function

list_documents(client, input, options \\ [])

View Source

Returns all Systems Manager (SSM) documents in the current account and Region.

You can limit the results of this request by using a filter.

Link to this function

list_inventory_entries(client, input, options \\ [])

View Source

A list of inventory items returned by the request.

Link to this function

list_ops_item_events(client, input, options \\ [])

View Source

Returns a list of all OpsItem events in the current Region and account.

You can limit the results to events associated with specific OpsItems by specifying a filter.

Link to this function

list_ops_metadata(client, input, options \\ [])

View Source

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

Link to this function

list_resource_compliance_summaries(client, input, options \\ [])

View Source

Returns a resource-level summary count.

The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

Link to this function

list_resource_data_sync(client, input, options \\ [])

View Source

Lists 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 sync successfully completed.

The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Returns a list of the tags assigned to the specified resource.

For information about the ID format for each supported resource type, see AddTagsToResource.

Link to this function

modify_document_permission(client, input, options \\ [])

View Source

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.

If you share a document privately, you must specify the Amazon Web Services user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Link to this function

put_compliance_items(client, input, options \\ [])

View Source

Registers a compliance type and other compliance details on a designated resource.

This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

ComplianceType can be one of the following:

  • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

  • ExecutionType: Specify patch, association, or Custom:string.

  • ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.

  • Id: The patch, association, or custom compliance ID.

  • Title: A title.

  • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

  • Severity: A patch severity. For example, critical.

  • DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

  • DocumentVersion: An SSM document version number. For example, 4.

  • Classification: A patch classification. For example, security updates.

  • PatchBaselineId: A patch baseline ID.

  • PatchSeverity: A patch severity. For example, Critical.

  • PatchState: A patch state. For example, InstancesWithFailedPatches.

  • PatchGroup: The name of a patch group.

  • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

Link to this function

put_inventory(client, input, options \\ [])

View Source

Bulk update custom inventory items on one more instance.

The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

Link to this function

put_parameter(client, input, options \\ [])

View Source

Add a parameter to the system.

Link to this function

register_default_patch_baseline(client, input, options \\ [])

View Source

Defines the default patch baseline for the relevant operating system.

To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

Link to this function

register_patch_baseline_for_patch_group(client, input, options \\ [])

View Source

Registers a patch baseline for a patch group.

Link to this function

register_target_with_maintenance_window(client, input, options \\ [])

View Source

Registers a target with a maintenance window.

Link to this function

register_task_with_maintenance_window(client, input, options \\ [])

View Source

Adds a new task to a maintenance window.

Link to this function

remove_tags_from_resource(client, input, options \\ [])

View Source

Removes tag keys from the specified resource.

Link to this function

reset_service_setting(client, input, options \\ [])

View Source

ServiceSetting 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 of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

Link to this function

resume_session(client, input, options \\ [])

View Source

Reconnects a session to an instance after it has been disconnected.

Connections can be resumed for disconnected sessions, but not terminated sessions.

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

Link to this function

send_automation_signal(client, input, options \\ [])

View Source

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Link to this function

send_command(client, input, options \\ [])

View Source

Runs commands on one or more managed instances.

Link to this function

start_associations_once(client, input, options \\ [])

View Source

Runs an association immediately and only one time.

This operation can be helpful when troubleshooting associations.

Link to this function

start_automation_execution(client, input, options \\ [])

View Source

Initiates execution of an Automation runbook.

Link to this function

start_change_request_execution(client, input, options \\ [])

View Source

Creates a change request for Change Manager.

The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.

Link to this function

start_session(client, input, options \\ [])

View Source

Initiates a connection to a target (for example, an instance) for a Session Manager session.

Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

Link to this function

stop_automation_execution(client, input, options \\ [])

View Source

Stop an Automation that is currently running.

Link to this function

terminate_session(client, input, options \\ [])

View Source

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance.

A terminated session isn't be resumed.

Link to this function

unlabel_parameter_version(client, input, options \\ [])

View Source

Remove a label or labels from a parameter.

Link to this function

update_association(client, input, options \\ [])

View Source

Updates an association.

You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output.

In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

When you update an association, the association immediately runs against the specified targets.

Link to this function

update_association_status(client, input, options \\ [])

View Source

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified instance.

Link to this function

update_document(client, input, options \\ [])

View Source

Updates one or more values for an SSM document.

Link to this function

update_document_default_version(client, input, options \\ [])

View Source

Set the default version of a document.

Link to this function

update_document_metadata(client, input, options \\ [])

View Source

Updates information related to approval reviews for a specific version of a document.

Link to this function

update_maintenance_window(client, input, options \\ [])

View Source

Updates an existing maintenance window.

Only specified parameters are modified.

The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Link to this function

update_maintenance_window_target(client, input, options \\ [])

View Source

Modifies 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 any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

If a parameter is null, then the corresponding field isn't modified.

Link to this function

update_maintenance_window_task(client, input, options \\ [])

View Source

Modifies 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 change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

  • ServiceRoleArn

  • TaskInvocationParameters

  • Priority

  • MaxConcurrency

  • MaxErrors

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null.

When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Link to this function

update_managed_instance_role(client, input, options \\ [])

View Source

Changes the Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM).

IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.

Link to this function

update_ops_item(client, input, options \\ [])

View Source

Edit or change an OpsItem.

You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.

Link to this function

update_ops_metadata(client, input, options \\ [])

View Source

Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

Link to this function

update_patch_baseline(client, input, options \\ [])

View Source

Modifies an existing patch baseline.

Fields not specified in the request are left unchanged.

For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Link to this function

update_resource_data_sync(client, input, options \\ [])

View Source

Update 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 create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.

This API operation only supports a resource data sync that was created with a SyncFromSource SyncType.

Link to this function

update_service_setting(client, input, options \\ [])

View Source

ServiceSetting 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 of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Update the service setting for the account.