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:
Join an AWS Directory
Install, repair, or uninstall software using an MSI package
Run PowerShell scripts
- Configure CloudWatch Logs to monitor applications and systems
Note that configuration documents are not supported on Linux instances.
Summary↑
Types ↑
list_associations_request :: [association_filter_list: association_filter_list, max_results: max_results, next_token: next_token]
update_association_status_result :: [{:association_description, association_description}]
list_associations_result :: [associations: association_list, next_token: next_token]
invalid_document :: []
status_unchanged :: []
delete_association_request :: [instance_id: instance_id, name: document_name]
document_filter_key :: binary
association_status :: [additional_info: status_additional_info, date: date_time, message: status_message, name: association_status_name]
association :: [instance_id: instance_id, name: document_name]
list_documents_result :: [document_identifiers: document_identifier_list, next_token: next_token]
fault :: binary
describe_association_request :: [instance_id: instance_id, name: document_name]
instance_id :: binary
delete_document_request :: [{:name, document_name}]
too_many_updates :: []
invalid_next_token :: []
create_association_batch_request :: [{:entries, create_association_batch_request_entries}]
create_association_result :: [{:association_description, association_description}]
describe_document_result :: [{:document, document_description}]
document_description :: [created_date: date_time, name: document_name, sha1: document_sha1, status: document_status]
create_association_batch_request_entry :: [instance_id: instance_id, name: document_name]
document_identifier :: [{:name, document_name}]
document_filter :: [key: document_filter_key, value: document_filter_value]
status_message :: binary
association_filter_key :: binary
update_association_status_request :: [association_status: association_status, instance_id: instance_id, name: document_name]
max_results :: integer
describe_document_request :: [{:name, document_name}]
delete_document_result :: []
document_sha1 :: binary
invalid_instance_id :: []
create_document_request :: [content: document_content, name: document_name]
document_content :: binary
create_document_result :: [{:document_description, document_description}]
internal_server_error :: []
document_filter_value :: binary
batch_error_message :: binary
association_filter :: [key: association_filter_key, value: association_filter_value]
document_status :: binary
document_limit_exceeded :: []
associated_instances :: []
create_association_request :: [instance_id: instance_id, name: document_name]
association_filter_value :: binary
association_description :: [date: date_time, instance_id: instance_id, name: document_name, status: association_status]
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}]
document_already_exists :: []
get_document_result :: [content: document_content, name: document_name]
date_time :: integer
document_name :: binary
association_status_name :: binary
create_association_batch_result :: [failed: failed_create_association_list, successful: association_description_list]
duplicate_instance_id :: []
get_document_request :: [{:name, document_name}]
next_token :: binary
failed_create_association :: [entry: create_association_batch_request_entry, fault: fault, message: batch_error_message]
status_additional_info :: binary
Functions
Specs:
- create_association(client :: ExAws.SSM.t, input :: create_association_request) :: ExAws.Request.JSON.response_t
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.
Specs:
- create_association!(client :: ExAws.SSM.t, input :: create_association_request) :: ExAws.Request.JSON.success_t | no_return
Same as create_association/2
but raise on error.
Specs:
- create_association_batch(client :: ExAws.SSM.t, input :: create_association_batch_request) :: ExAws.Request.JSON.response_t
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.
Specs:
- create_association_batch!(client :: ExAws.SSM.t, input :: create_association_batch_request) :: ExAws.Request.JSON.success_t | no_return
Same as create_association_batch/2
but raise on error.
Specs:
- create_document(client :: ExAws.SSM.t, input :: create_document_request) :: ExAws.Request.JSON.response_t
CreateDocument
Creates a configuration document.
After you create a configuration document, you can use CreateAssociation
to associate it with one or more running instances.
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.
Specs:
- delete_association(client :: ExAws.SSM.t, input :: delete_association_request) :: ExAws.Request.JSON.response_t
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.
Specs:
- delete_association!(client :: ExAws.SSM.t, input :: delete_association_request) :: ExAws.Request.JSON.success_t | no_return
Same as delete_association/2
but raise on error.
Specs:
- delete_document(client :: ExAws.SSM.t, input :: delete_document_request) :: ExAws.Request.JSON.response_t
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.
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.
Specs:
- describe_association(client :: ExAws.SSM.t, input :: describe_association_request) :: ExAws.Request.JSON.response_t
DescribeAssociation
Describes the associations for the specified configuration document or instance.
Specs:
- describe_association!(client :: ExAws.SSM.t, input :: describe_association_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_association/2
but raise on error.
Specs:
- describe_document(client :: ExAws.SSM.t, input :: describe_document_request) :: ExAws.Request.JSON.response_t
DescribeDocument
Describes the specified configuration document.
Specs:
- describe_document!(client :: ExAws.SSM.t, input :: describe_document_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_document/2
but raise on error.
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.
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.
Specs:
- list_associations(client :: ExAws.SSM.t, input :: list_associations_request) :: ExAws.Request.JSON.response_t
ListAssociations
Lists the associations for the specified configuration document or instance.
Specs:
- list_associations!(client :: ExAws.SSM.t, input :: list_associations_request) :: ExAws.Request.JSON.success_t | no_return
Same as list_associations/2
but raise on error.
Specs:
- list_documents(client :: ExAws.SSM.t, input :: list_documents_request) :: ExAws.Request.JSON.response_t
ListDocuments
Describes one or more of your configuration documents.
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.
Specs:
- update_association_status(client :: ExAws.SSM.t, input :: update_association_status_request) :: ExAws.Request.JSON.response_t
UpdateAssociationStatus
Updates the status of the configuration document associated with the specified instance.
Specs:
- update_association_status!(client :: ExAws.SSM.t, input :: update_association_status_request) :: ExAws.Request.JSON.success_t | no_return
Same as update_association_status/2
but raise on error.