ExAws.SSM.Core

Amazon Simple Systems Management Service

Amazon EC2 Simple Systems Manager (SSM) enables you to configure and manage your EC2 instances. You can create a configuration document and then associate it with one or more running instances.

You can use a configuration document to automate the following tasks for your Windows instances:

Note that configuration documents are not supported on Linux instances.

Source

Summary

create_association!(client, input)

Same as create_association/2 but raise on error

create_association(client, input)

CreateAssociation

create_association_batch!(client, input)

Same as create_association_batch/2 but raise on error

create_association_batch(client, input)

CreateAssociationBatch

create_document!(client, input)

Same as create_document/2 but raise on error

create_document(client, input)

CreateDocument

delete_association!(client, input)

Same as delete_association/2 but raise on error

delete_association(client, input)

DeleteAssociation

delete_document!(client, input)

Same as delete_document/2 but raise on error

delete_document(client, input)

DeleteDocument

describe_association!(client, input)

Same as describe_association/2 but raise on error

describe_association(client, input)

DescribeAssociation

describe_document!(client, input)

Same as describe_document/2 but raise on error

describe_document(client, input)

DescribeDocument

get_document!(client, input)

Same as get_document/2 but raise on error

get_document(client, input)

GetDocument

list_associations!(client, input)

Same as list_associations/2 but raise on error

list_associations(client, input)

ListAssociations

list_documents!(client, input)

Same as list_documents/2 but raise on error

list_documents(client, input)

ListDocuments

update_association_status!(client, input)

Same as update_association_status/2 but raise on error

update_association_status(client, input)

UpdateAssociationStatus

Types

list_associations_request :: [association_filter_list: association_filter_list, max_results: max_results, next_token: next_token]

list_associations_result :: [associations: association_list, next_token: next_token]

association :: [instance_id: instance_id, name: document_name]

list_documents_result :: [document_identifiers: document_identifier_list, next_token: next_token]

fault :: binary

instance_id :: binary

create_association_result :: [{:association_description, association_description}]

document_description :: [created_date: date_time, name: document_name, sha1: document_sha1, status: document_status]

status_message :: binary

update_association_status_request :: [association_status: association_status, instance_id: instance_id, name: document_name]

max_results :: integer

document_sha1 :: binary

document_content :: binary

create_document_result :: [{:document_description, document_description}]

document_status :: binary

describe_association_result :: [{:association_description, association_description}]

list_documents_request :: [document_filter_list: document_filter_list, max_results: max_results, next_token: next_token]

invalid_document_content :: [{:message, binary}]

date_time :: integer

document_name :: binary

next_token :: binary

Functions

create_association(client, input)

Specs:

CreateAssociation

Associates the specified configuration document with the specified instance.

When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.

If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.

Source
create_association!(client, input)

Specs:

Same as create_association/2 but raise on error.

Source
create_association_batch(client, input)

Specs:

CreateAssociationBatch

Associates the specified configuration documents with the specified instances.

When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.

If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.

Source
create_association_batch!(client, input)

Specs:

Same as create_association_batch/2 but raise on error.

Source
create_document(client, input)

Specs:

CreateDocument

Creates a configuration document.

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

Source
create_document!(client, input)

Specs:

  • create_document!(client :: ExAws.SSM.t, input :: create_document_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_document/2 but raise on error.

Source
delete_association(client, input)

Specs:

DeleteAssociation

Disassociates the specified configuration document from the specified instance.

When you disassociate a configuration 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 configuration document, you must create a new configuration document with the desired configuration and associate it with the instance.

Source
delete_association!(client, input)

Specs:

Same as delete_association/2 but raise on error.

Source
delete_document(client, input)

Specs:

DeleteDocument

Deletes the specified configuration document.

You must use DeleteAssociation to disassociate all instances that are associated with the configuration document before you can delete it.

Source
delete_document!(client, input)

Specs:

  • delete_document!(client :: ExAws.SSM.t, input :: delete_document_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_document/2 but raise on error.

Source
describe_association(client, input)

Specs:

DescribeAssociation

Describes the associations for the specified configuration document or instance.

Source
describe_association!(client, input)

Specs:

Same as describe_association/2 but raise on error.

Source
describe_document(client, input)

Specs:

DescribeDocument

Describes the specified configuration document.

Source
describe_document!(client, input)

Specs:

Same as describe_document/2 but raise on error.

Source
get_document(client, input)

Specs:

  • get_document(client :: ExAws.SSM.t, input :: get_document_request) :: ExAws.Request.JSON.response_t

GetDocument

Gets the contents of the specified configuration document.

Source
get_document!(client, input)

Specs:

  • get_document!(client :: ExAws.SSM.t, input :: get_document_request) :: ExAws.Request.JSON.success_t | no_return

Same as get_document/2 but raise on error.

Source
list_associations(client, input)

Specs:

ListAssociations

Lists the associations for the specified configuration document or instance.

Source
list_associations!(client, input)

Specs:

Same as list_associations/2 but raise on error.

Source
list_documents(client, input)

Specs:

ListDocuments

Describes one or more of your configuration documents.

Source
list_documents!(client, input)

Specs:

  • list_documents!(client :: ExAws.SSM.t, input :: list_documents_request) :: ExAws.Request.JSON.success_t | no_return

Same as list_documents/2 but raise on error.

Source
update_association_status(client, input)

Specs:

UpdateAssociationStatus

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

Source
update_association_status!(client, input)

Specs:

Same as update_association_status/2 but raise on error.

Source