public interface AWSSimpleSystemsManagementAsync extends AWSSimpleSystemsManagement
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Simple Systems Manager (SSM) is a set of capabilities that can help you manage your Amazon EC2 instances running on Windows. SSM enables you to run scripts or other common administrative tasks on your instances using either SSM Run Command or SSM Config.
Run Command extends the server administration capabilities of SSM by offering an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents (formerly called configuration documents) to perform the actions listed later in this section, or you can create your own documents. With these document, you can then remotely configure your instances by sending commands using the AWS command line interface (CLI), AWS Tools for Windows PowerShell, or the Commands page in the Amazon EC2 console. Additionally, because Run Command enables you to execute PowerShell commands or scripts, you can administer your instances remotely using PowerShell as though you were logged on locally to the instance. Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands.
SSM Config is a lightweight instance configuration solution. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell.
SSM is currently not supported on Linux instances.
You can use Run Command and SSM Config to do the following:
Join an AWS Directory Service directory (SSM Config and Run Command)
Install, repair, or uninstall software using an MSI package (SSM Config and Run Command)
Install PowerShell modules (SSM Config and Run Command)
Configure CloudWatch Logs to monitor applications and systems (SSM Config and Run Command)
Run PowerShell commands or scripts (Run Command only)
Update the EC2Config service (Run Command only)
Configure Windows Update settings (Run Command only)
SSM documents run with administrative privilege on Windows instances because the EC2Config service runs in the Local System account. If a user has permission to execute any of the pre-defined SSM documents (any document that begins with AWS-*) then that user also has administrator access to the instance. Delegate access to SSM Config and Run Command judiciously. This becomes extremely important if you create your own SSM documents. Amazon Web Services does not provide guidance about how to create secure SSM documents. You create SSM documents and delegate access to Run Command actions at your own risk. As a security best practice, we recommend that you assign access to "AWS-*" documents, especially the AWS-RunPowerShellScript document, to trusted administrators only. You can create low-level SSM documents for low security tasks and delegate access to non-administrators.
cancelCommand, createAssociation, createAssociationBatch, createDocument, deleteAssociation, deleteDocument, describeAssociation, describeDocument, describeInstanceInformation, getCachedResponseMetadata, getDocument, listAssociations, listCommandInvocations, listCommands, listDocuments, listDocuments, sendCommand, setEndpoint, setRegion, shutdown, updateAssociationStatusFuture<CancelCommandResult> cancelCommandAsync(CancelCommandRequest cancelCommandRequest)
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.
cancelCommandRequest - Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest cancelCommandRequest, AsyncHandler<CancelCommandRequest,CancelCommandResult> asyncHandler)
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.
cancelCommandRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest createAssociationRequest)
Associates the specified SSM document with the specified instance.
When you associate an SSM document with an instance, the configuration agent 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.
createAssociationRequest - Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest createAssociationRequest, AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)
Associates the specified SSM document with the specified instance.
When you associate an SSM document with an instance, the configuration agent 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.
createAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified SSM document with the specified instances.
When you associate an SSM document with an instance, the configuration agent 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.
createAssociationBatchRequest - Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest createAssociationBatchRequest, AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)
Associates the specified SSM document with the specified instances.
When you associate an SSM document with an instance, the configuration agent 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.
createAssociationBatchRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest createDocumentRequest)
Creates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
createDocumentRequest - Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest createDocumentRequest, AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)
Creates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
createDocumentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest deleteAssociationRequest)
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.
deleteAssociationRequest - Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest deleteAssociationRequest, AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)
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.
deleteAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest deleteDocumentRequest)
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.
deleteDocumentRequest - Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest deleteDocumentRequest, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
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.
deleteDocumentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest describeAssociationRequest)
Describes the associations for the specified SSM document or instance.
describeAssociationRequest - Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest describeAssociationRequest, AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
Describes the associations for the specified SSM document or instance.
describeAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest describeDocumentRequest)
Describes the specified SSM document.
describeDocumentRequest - Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest describeDocumentRequest, AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
Describes the specified SSM document.
describeDocumentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest describeInstanceInformationRequest)
describeInstanceInformationRequest - Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest describeInstanceInformationRequest, AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
describeInstanceInformationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified SSM document.
getDocumentRequest - Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
Gets the contents of the specified SSM document.
getDocumentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified SSM document or instance.
listAssociationsRequest - Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest listAssociationsRequest, AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
Lists the associations for the specified SSM document or instance.
listAssociationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest listCommandInvocationsRequest)
listCommandInvocationsRequest - Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest listCommandInvocationsRequest, AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)
listCommandInvocationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
listCommandsRequest - Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest listCommandsRequest, AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)
Lists the commands requested by users of the AWS account.
listCommandsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your SSM documents.
listDocumentsRequest - Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Describes one or more of your SSM documents.
listDocumentsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDocumentsResult> listDocumentsAsync()
Future<ListDocumentsResult> listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Future<SendCommandResult> sendCommandAsync(SendCommandRequest sendCommandRequest)
sendCommandRequest - Future<SendCommandResult> sendCommandAsync(SendCommandRequest sendCommandRequest, AsyncHandler<SendCommandRequest,SendCommandResult> asyncHandler)
sendCommandRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the SSM document associated with the specified instance.
updateAssociationStatusRequest - Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest updateAssociationStatusRequest, AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)
Updates the status of the SSM document associated with the specified instance.
updateAssociationStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2015. All rights reserved.