aws-elixir v0.4.0 AWS.SSM

Amazon EC2 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 works with managed instances: Amazon EC2 instances and servers or virtual machines (VMs) in your on-premises environment that are configured for Systems Manager.

This references is intended to be used with the EC2 Systems Manager User Guide (Linux) (Windows).

To get started, verify prerequisites and configure managed instances (Linux) (Windows).

Summary

Functions

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances. Tags enable you to categorize your managed instances 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 and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 tags

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

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide

Associates the specified SSM document with the specified instances or targets

Associates the specified SSM document with the specified instances or targets

Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances

Disassociates the specified SSM document from the specified instance

Deletes the SSM document and all instance associations to the document

Delete a parameter from the system

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 the SSM agent first

Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration

Describes the associations for the specified SSM document or instance

Provides details about all active and terminated Automation executions

Lists all patches that could possibly be included in a patch baseline

Describes the specified SSM document

Describes the permissions for an 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 AWS account ID) or publicly (All)

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. You can use this to get information about instances like the operating system platform, the SSM agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error

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

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution

For a given Maintenance Window execution, lists the tasks that were executed

Lists the executions of a Maintenance Window (meaning, information about when the Maintenance Window was scheduled to be active and information about tasks registered and run with the Maintenance Window)

Lists the targets registered with the Maintenance Window

Lists the tasks in a Maintenance Window

Retrieves the Maintenance Windows in an AWS account

Get information about a parameter

Lists the patch baselines in your AWS account

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

Lists all patch groups that have been registered with patch baselines

Get detailed information about a particular Automation execution

Returns detailed information about command execution for an invocation or plugin

Retrieves the default patch baseline

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-ApplyPatchBaseline Systems Manager document

Gets the contents of the specified 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 task executed as part of a Maintenance Window execution

Retrieves the details about a specific task executed as part of a Maintenance Window execution

Query a list of all parameters used by the AWS account

Get a list of parameters used by the AWS account.>

Retrieves information about a patch baseline

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

Lists the associations for the specified SSM document or instance

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 executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution

Lists the commands requested by users of the AWS account

List all versions for a document

Describes one or more of your SSM documents

A list of inventory items returned by the request

Returns a list of the tags assigned to the specified resource

Share a document publicly or privately. If you share a document privately, you must specify the AWS 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

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

Add one or more paramaters to the system

Registers a patch baseline for a patch group

Registers a target with a Maintenance Window

Removes all tags from the specified resource

Executes commands on one or more remote instances

Initiates execution of an Automation document

Stop an Automation that is currently executing

Updates an association. You can only update the document version, schedule, parameters, and Amazon S3 output of an association

Updates the status of the SSM document associated with the specified instance

The document you want to update

Updates an existing Maintenance Window. Only specified parameters are modified

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance

Modifies an existing patch baseline. Fields not specified in the request are left unchanged

Functions

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

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances. Tags enable you to categorize your managed instances 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 and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 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 Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

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

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.

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

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide.

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

Associates the specified SSM document with the specified instances or targets.

When you associate an SSM document with one or more instances using instance IDs or tags, the 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 throws the AssociationAlreadyExists exception.

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

Associates the specified SSM document with the specified instances or targets.

When you associate an SSM document with one or more instances using instance IDs or tags, the 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 throws the AssociationAlreadyExists exception.

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

Creates an SSM document.

After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.

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

Creates a new Maintenance Window.

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

Creates a patch baseline.

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

Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

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

Disassociates the specified SSM document from the specified instance.

When you disassociate an SSM document from an instance, it does not 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.

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

Deletes the SSM document and all instance associations to the document.

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

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

Deletes a Maintenance Window.

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

Delete a parameter from the system.

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

Deletes a patch baseline.

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

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 the SSM agent first.

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

Removes a patch group from a patch baseline.

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

Removes a target from a Maintenance Window.

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

Removes a task from a Maintenance Window.

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

Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.

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

Describes the associations for the specified SSM document or instance.

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

Provides details about all active and terminated Automation executions.

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

Lists all patches that could possibly be included in a patch baseline.

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

Describes the specified SSM document.

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

Describes the permissions for an 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 AWS account ID) or publicly (All).

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

All associations for the instance(s).

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

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

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

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

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

Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

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

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

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

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

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

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

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

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.

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

For a given Maintenance Window execution, lists the tasks that were executed.

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

Lists the executions of a Maintenance Window (meaning, information about when the Maintenance Window was scheduled to be active and information about tasks registered and run with the Maintenance Window).

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

Lists the targets registered with the Maintenance Window.

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

Lists the tasks in a Maintenance Window.

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

Retrieves the Maintenance Windows in an AWS account.

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

Get information about a parameter.

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

Lists the patch baselines in your AWS account.

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

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

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

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

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

Get detailed information about a particular Automation execution.

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

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

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

Retrieves the default patch baseline.

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

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-ApplyPatchBaseline Systems Manager document.

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

Gets the contents of the specified SSM document.

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

Query inventory information.

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

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(client, input, options \\ [])

Retrieves a Maintenance Window.

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

Retrieves details about a specific task executed as part of a Maintenance Window execution.

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

Retrieves the details about a specific task executed as part of a Maintenance Window execution.

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

Query a list of all parameters used by the AWS account.

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

Get a list of parameters used by the AWS account.>

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

Retrieves information about a patch baseline.

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

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

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

Lists the associations for the specified SSM document or instance.

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

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 executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

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

Lists the commands requested by users of the AWS account.

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

List all versions for a document.

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

Describes one or more of your SSM documents.

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

A list of inventory items returned by the request.

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

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

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

Share a document publicly or privately. If you share a document privately, you must specify the AWS 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.

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

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.

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

Add one or more paramaters to the system.

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

Defines the default patch baseline.

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

Registers a patch baseline for a patch group.

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

Registers a target with a Maintenance Window.

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

Adds a new task to a Maintenance Window.

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

Removes all tags from the specified resource.

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

Executes commands on one or more remote instances.

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

Initiates execution of an Automation document.

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

Stop an Automation that is currently executing.

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

Updates an association. You can only update the document version, schedule, parameters, and Amazon S3 output of an association.

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

Updates the status of the SSM document associated with the specified instance.

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

The document you want to update.

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

Set the default version of a document.

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

Updates an existing Maintenance Window. Only specified parameters are modified.

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

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

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

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.