Interface AWSSimpleSystemsManagementAsync
-
- All Superinterfaces:
AWSSimpleSystemsManagement
- All Known Implementing Classes:
AbstractAWSSimpleSystemsManagementAsync
,AWSSimpleSystemsManagementAsyncClient
public interface AWSSimpleSystemsManagementAsync extends AWSSimpleSystemsManagement
Interface for accessing Amazon SSM asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept anAsyncHandler
can be used to receive notification when an asynchronous operation completes.This is the Amazon Simple Systems Manager (SSM) API Reference. SSM enables you to remotely manage the configuration of your Amazon EC2 instance using scripts or commands with either an on-demand solution called SSM Run Command or a lightweight instance configuration solution called SSM Config.
This references is intended to be used with the SSM User Guide for Linux or Windows.
Run Command
Run Command provides an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the Commands page in the Amazon EC2 console, AWS Tools for Windows PowerShell, the AWS CLI, or AWS SDKs.
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. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (Linux or Windows).
SSM Config
SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. 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. For more information, see Managing Windows Instance Configuration.
SSM Config and SSM Run Command include the following pre-defined documents.
Linux
-
AWS-RunShellScript to run shell scripts
-
AWS-UpdateSSMAgent to update the Amazon SSM agent
Windows
-
AWS-JoinDirectoryServiceDomain to join an AWS Directory
-
AWS-RunPowerShellScript to run PowerShell commands or scripts
-
AWS-UpdateEC2Config to update the EC2Config service
-
AWS-ConfigureWindowsUpdate to configure Windows Update settings
-
AWS-InstallApplication to install, repair, or uninstall software using an MSI package
-
AWS-InstallPowerShellModule to install PowerShell modules
-
AWS-ConfigureCloudWatch to configure Amazon CloudWatch Logs to monitor applications and systems
-
AWS-ListWindowsInventory to collect information about an EC2 instance running in Windows.
-
AWS-FindWindowsUpdates to scan an instance and determines which updates are missing.
-
AWS-InstallMissingWindowsUpdates to install missing updates on your EC2 instance.
-
AWS-InstallSpecificWindowsUpdates to install one or more specific updates.
The commands or scripts specified in SSM documents run with administrative privilege on your instances because the Amazon SSM agent runs as root on Linux and the EC2Config service runs in the Local System account on Windows. 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 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 at your own risk. As a security best practice, we recommend that you assign access to "AWS-*" documents, especially the AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document on Windows, to trusted administrators only. You can create SSM documents for specific tasks and delegate access to non-administrators.
For information about creating and sharing SSM documents, see the following topics in the SSM User Guide:
-
Creating SSM Documents and Sharing SSM Documents (Linux)
-
Creating SSM Documents and Sharing SSM Documents (Windows)
-
-
Method Summary
-
Methods inherited from interface com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement
cancelCommand, createAssociation, createAssociationBatch, createDocument, deleteAssociation, deleteDocument, describeAssociation, describeDocument, describeDocumentPermission, describeInstanceInformation, getCachedResponseMetadata, getDocument, listAssociations, listCommandInvocations, listCommands, listDocuments, listDocuments, modifyDocumentPermission, sendCommand, setEndpoint, setRegion, shutdown, updateAssociationStatus
-
-
-
-
Method Detail
-
cancelCommandAsync
Future<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.
- Parameters:
cancelCommandRequest
-- Returns:
- A Java Future containing the result of the CancelCommand operation returned by the service.
-
cancelCommandAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CancelCommand operation returned by the service.
-
createAssociationAsync
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.
- Parameters:
createAssociationRequest
-- Returns:
- A Java Future containing the result of the CreateAssociation operation returned by the service.
-
createAssociationAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CreateAssociation operation returned by the service.
-
createAssociationBatchAsync
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.
- Parameters:
createAssociationBatchRequest
-- Returns:
- A Java Future containing the result of the CreateAssociationBatch operation returned by the service.
-
createAssociationBatchAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CreateAssociationBatch operation returned by the service.
-
createDocumentAsync
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.
- Parameters:
createDocumentRequest
-- Returns:
- A Java Future containing the result of the CreateDocument operation returned by the service.
-
createDocumentAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CreateDocument operation returned by the service.
-
deleteAssociationAsync
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.
- Parameters:
deleteAssociationRequest
-- Returns:
- A Java Future containing the result of the DeleteAssociation operation returned by the service.
-
deleteAssociationAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DeleteAssociation operation returned by the service.
-
deleteDocumentAsync
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.
- Parameters:
deleteDocumentRequest
-- Returns:
- A Java Future containing the result of the DeleteDocument operation returned by the service.
-
deleteDocumentAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DeleteDocument operation returned by the service.
-
describeAssociationAsync
Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest describeAssociationRequest)
Describes the associations for the specified SSM document or instance.
- Parameters:
describeAssociationRequest
-- Returns:
- A Java Future containing the result of the DescribeAssociation operation returned by the service.
-
describeAssociationAsync
Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest describeAssociationRequest, AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
Describes the associations for the specified SSM document or instance.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeAssociation operation returned by the service.
-
describeDocumentAsync
Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest describeDocumentRequest)
Describes the specified SSM document.
- Parameters:
describeDocumentRequest
-- Returns:
- A Java Future containing the result of the DescribeDocument operation returned by the service.
-
describeDocumentAsync
Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest describeDocumentRequest, AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
Describes the specified SSM document.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeDocument operation returned by the service.
-
describeDocumentPermissionAsync
Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
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).
- Parameters:
describeDocumentPermissionRequest
-- Returns:
- A Java Future containing the result of the DescribeDocumentPermission operation returned by the service.
-
describeDocumentPermissionAsync
Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest describeDocumentPermissionRequest, AsyncHandler<DescribeDocumentPermissionRequest,DescribeDocumentPermissionResult> asyncHandler)
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).
- Parameters:
describeDocumentPermissionRequest
-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.- Returns:
- A Java Future containing the result of the DescribeDocumentPermission operation returned by the service.
-
describeInstanceInformationAsync
Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest describeInstanceInformationRequest)
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, 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.
- Parameters:
describeInstanceInformationRequest
-- Returns:
- A Java Future containing the result of the DescribeInstanceInformation operation returned by the service.
-
describeInstanceInformationAsync
Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest describeInstanceInformationRequest, AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
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, 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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeInstanceInformation operation returned by the service.
-
getDocumentAsync
Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified SSM document.
- Parameters:
getDocumentRequest
-- Returns:
- A Java Future containing the result of the GetDocument operation returned by the service.
-
getDocumentAsync
Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
Gets the contents of the specified SSM document.
- Parameters:
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.- Returns:
- A Java Future containing the result of the GetDocument operation returned by the service.
-
listAssociationsAsync
Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified SSM document or instance.
- Parameters:
listAssociationsRequest
-- Returns:
- A Java Future containing the result of the ListAssociations operation returned by the service.
-
listAssociationsAsync
Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest listAssociationsRequest, AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
Lists the associations for the specified SSM document or instance.
- Parameters:
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.- Returns:
- A Java Future containing the result of the ListAssociations operation returned by the service.
-
listCommandInvocationsAsync
Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest listCommandInvocationsRequest)
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.
- Parameters:
listCommandInvocationsRequest
-- Returns:
- A Java Future containing the result of the ListCommandInvocations operation returned by the service.
-
listCommandInvocationsAsync
Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest listCommandInvocationsRequest, AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the ListCommandInvocations operation returned by the service.
-
listCommandsAsync
Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
- Parameters:
listCommandsRequest
-- Returns:
- A Java Future containing the result of the ListCommands operation returned by the service.
-
listCommandsAsync
Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest listCommandsRequest, AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)
Lists the commands requested by users of the AWS account.
- Parameters:
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.- Returns:
- A Java Future containing the result of the ListCommands operation returned by the service.
-
listDocumentsAsync
Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your SSM documents.
- Parameters:
listDocumentsRequest
-- Returns:
- A Java Future containing the result of the ListDocuments operation returned by the service.
-
listDocumentsAsync
Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Describes one or more of your SSM documents.
- Parameters:
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.- Returns:
- A Java Future containing the result of the ListDocuments operation returned by the service.
-
listDocumentsAsync
Future<ListDocumentsResult> listDocumentsAsync()
Simplified method form for invoking the ListDocuments operation.- See Also:
listDocumentsAsync(ListDocumentsRequest)
-
listDocumentsAsync
Future<ListDocumentsResult> listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Simplified method form for invoking the ListDocuments operation with an AsyncHandler.
-
modifyDocumentPermissionAsync
Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
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.
- Parameters:
modifyDocumentPermissionRequest
-- Returns:
- A Java Future containing the result of the ModifyDocumentPermission operation returned by the service.
-
modifyDocumentPermissionAsync
Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest, AsyncHandler<ModifyDocumentPermissionRequest,ModifyDocumentPermissionResult> asyncHandler)
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.
- Parameters:
modifyDocumentPermissionRequest
-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.- Returns:
- A Java Future containing the result of the ModifyDocumentPermission operation returned by the service.
-
sendCommandAsync
Future<SendCommandResult> sendCommandAsync(SendCommandRequest sendCommandRequest)
Executes commands on one or more remote instances.
- Parameters:
sendCommandRequest
-- Returns:
- A Java Future containing the result of the SendCommand operation returned by the service.
-
sendCommandAsync
Future<SendCommandResult> sendCommandAsync(SendCommandRequest sendCommandRequest, AsyncHandler<SendCommandRequest,SendCommandResult> asyncHandler)
Executes commands on one or more remote instances.
- Parameters:
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.- Returns:
- A Java Future containing the result of the SendCommand operation returned by the service.
-
updateAssociationStatusAsync
Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the SSM document associated with the specified instance.
- Parameters:
updateAssociationStatusRequest
-- Returns:
- A Java Future containing the result of the UpdateAssociationStatus operation returned by the service.
-
updateAssociationStatusAsync
Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest updateAssociationStatusRequest, AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)
Updates the status of the SSM document associated with the specified instance.
- Parameters:
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.- Returns:
- A Java Future containing the result of the UpdateAssociationStatus operation returned by the service.
-
-