AWSSimpleSystemsManagementAsyncClient (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.11.3 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagementClient
  - - com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagementAsyncClient

All Implemented Interfaces:

AWSSimpleSystemsManagement, AWSSimpleSystemsManagementAsync
```
@ThreadSafe
public class AWSSimpleSystemsManagementAsyncClient
extends AWSSimpleSystemsManagementClient
implements AWSSimpleSystemsManagementAsync
```
Interface for accessing Amazon SSM asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler 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)

Field Summary
- Fields inherited from class com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagementClient
  configFactory
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors
Constructor and Description
`AWSSimpleSystemsManagementAsyncClient()` Constructs a new asynchronous client to invoke service methods on Amazon SSM.
`AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials)` Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials.
`AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials, executor service, and client configuration options.
`AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials and executor service.
`AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials provider.
`AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on Amazon SSM using the provided AWS account credentials provider and client configuration options.
`AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials provider, executor service, and client configuration options.
`AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials provider and executor service.
`AWSSimpleSystemsManagementAsyncClient(ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on Amazon SSM.

Method Summary

Methods
Modifier and Type	Method and Description
`Future<CancelCommandResult>`	`cancelCommandAsync(CancelCommandRequest request)` Attempts to cancel the command specified by the Command ID.
`Future<CancelCommandResult>`	`cancelCommandAsync(CancelCommandRequest request, AsyncHandler<CancelCommandRequest,CancelCommandResult> asyncHandler)` Attempts to cancel the command specified by the Command ID.
`Future<CreateAssociationResult>`	`createAssociationAsync(CreateAssociationRequest request)` Associates the specified SSM document with the specified instance.
`Future<CreateAssociationResult>`	`createAssociationAsync(CreateAssociationRequest request, AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)` Associates the specified SSM document with the specified instance.
`Future<CreateAssociationBatchResult>`	`createAssociationBatchAsync(CreateAssociationBatchRequest request)` Associates the specified SSM document with the specified instances.
`Future<CreateAssociationBatchResult>`	`createAssociationBatchAsync(CreateAssociationBatchRequest request, AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)` Associates the specified SSM document with the specified instances.
`Future<CreateDocumentResult>`	`createDocumentAsync(CreateDocumentRequest request)` Creates an SSM document.
`Future<CreateDocumentResult>`	`createDocumentAsync(CreateDocumentRequest request, AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)` Creates an SSM document.
`Future<DeleteAssociationResult>`	`deleteAssociationAsync(DeleteAssociationRequest request)` Disassociates the specified SSM document from the specified instance.
`Future<DeleteAssociationResult>`	`deleteAssociationAsync(DeleteAssociationRequest request, AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)` Disassociates the specified SSM document from the specified instance.
`Future<DeleteDocumentResult>`	`deleteDocumentAsync(DeleteDocumentRequest request)` Deletes the SSM document and all instance associations to the document.
`Future<DeleteDocumentResult>`	`deleteDocumentAsync(DeleteDocumentRequest request, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)` Deletes the SSM document and all instance associations to the document.
`Future<DescribeAssociationResult>`	`describeAssociationAsync(DescribeAssociationRequest request)` Describes the associations for the specified SSM document or instance.
`Future<DescribeAssociationResult>`	`describeAssociationAsync(DescribeAssociationRequest request, AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)` Describes the associations for the specified SSM document or instance.
`Future<DescribeDocumentResult>`	`describeDocumentAsync(DescribeDocumentRequest request)` Describes the specified SSM document.
`Future<DescribeDocumentResult>`	`describeDocumentAsync(DescribeDocumentRequest request, AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)` Describes the specified SSM document.
`Future<DescribeDocumentPermissionResult>`	`describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request)` Describes the permissions for an SSM document.
`Future<DescribeDocumentPermissionResult>`	`describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request, AsyncHandler<DescribeDocumentPermissionRequest,DescribeDocumentPermissionResult> asyncHandler)` Describes the permissions for an SSM document.
`Future<DescribeInstanceInformationResult>`	`describeInstanceInformationAsync(DescribeInstanceInformationRequest request)` Describes one or more of your instances.
`Future<DescribeInstanceInformationResult>`	`describeInstanceInformationAsync(DescribeInstanceInformationRequest request, AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)` Describes one or more of your instances.
`Future<GetDocumentResult>`	`getDocumentAsync(GetDocumentRequest request)` Gets the contents of the specified SSM document.
`Future<GetDocumentResult>`	`getDocumentAsync(GetDocumentRequest request, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)` Gets the contents of the specified SSM document.
`ExecutorService`	`getExecutorService()` Returns the executor service used by this client to execute async requests.
`Future<ListAssociationsResult>`	`listAssociationsAsync(ListAssociationsRequest request)` Lists the associations for the specified SSM document or instance.
`Future<ListAssociationsResult>`	`listAssociationsAsync(ListAssociationsRequest request, AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)` Lists the associations for the specified SSM document or instance.
`Future<ListCommandInvocationsResult>`	`listCommandInvocationsAsync(ListCommandInvocationsRequest request)` An invocation is copy of a command sent to a specific instance.
`Future<ListCommandInvocationsResult>`	`listCommandInvocationsAsync(ListCommandInvocationsRequest request, AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)` An invocation is copy of a command sent to a specific instance.
`Future<ListCommandsResult>`	`listCommandsAsync(ListCommandsRequest request)` Lists the commands requested by users of the AWS account.
`Future<ListCommandsResult>`	`listCommandsAsync(ListCommandsRequest request, AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)` Lists the commands requested by users of the AWS account.
`Future<ListDocumentsResult>`	`listDocumentsAsync()` Simplified method form for invoking the ListDocuments operation.
`Future<ListDocumentsResult>`	`listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)` Simplified method form for invoking the ListDocuments operation with an AsyncHandler.
`Future<ListDocumentsResult>`	`listDocumentsAsync(ListDocumentsRequest request)` Describes one or more of your SSM documents.
`Future<ListDocumentsResult>`	`listDocumentsAsync(ListDocumentsRequest request, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)` Describes one or more of your SSM documents.
`Future<ModifyDocumentPermissionResult>`	`modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request)` Share a document publicly or privately.
`Future<ModifyDocumentPermissionResult>`	`modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request, AsyncHandler<ModifyDocumentPermissionRequest,ModifyDocumentPermissionResult> asyncHandler)` Share a document publicly or privately.
`Future<SendCommandResult>`	`sendCommandAsync(SendCommandRequest request)` Executes commands on one or more remote instances.
`Future<SendCommandResult>`	`sendCommandAsync(SendCommandRequest request, AsyncHandler<SendCommandRequest,SendCommandResult> asyncHandler)` Executes commands on one or more remote instances.
`void`	`shutdown()` Shuts down the client, releasing all managed resources.
`Future<UpdateAssociationStatusResult>`	`updateAssociationStatusAsync(UpdateAssociationStatusRequest request)` Updates the status of the SSM document associated with the specified instance.
`Future<UpdateAssociationStatusResult>`	`updateAssociationStatusAsync(UpdateAssociationStatusRequest request, AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)` Updates the status of the SSM document associated with the specified instance.

Methods inherited from class com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagementClient
cancelCommand, createAssociation, createAssociationBatch, createDocument, deleteAssociation, deleteDocument, describeAssociation, describeDocument, describeDocumentPermission, describeInstanceInformation, getCachedResponseMetadata, getDocument, listAssociations, listCommandInvocations, listCommands, listDocuments, listDocuments, modifyDocumentPermission, sendCommand, updateAssociationStatus

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, updateAssociationStatus

- Constructor Detail
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient()
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
    See Also:
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(ClientConfiguration clientConfiguration)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
    Parameters:
    clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, retry counts, etc).
    See Also:
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials.
    Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    See Also:
    Executors.newFixedThreadPool(int)
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials,
                                     ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials and executor service. Default client settings will be used.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    executorService - The executor service by which all asynchronous requests will be executed.
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials,
                                     ClientConfiguration clientConfiguration,
                                     ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials, executor service, and client configuration options.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    executorService - The executor service by which all asynchronous requests will be executed.
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials provider. Default client settings will be used.
    Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    See Also:
    Executors.newFixedThreadPool(int)
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM using the provided AWS account credentials provider and client configuration options.
    Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    See Also:
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials provider and executor service. Default client settings will be used.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    executorService - The executor service by which all asynchronous requests will be executed.
  - AWSSimpleSystemsManagementAsyncClient
```
public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration,
                                     ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on Amazon SSM using the specified AWS account credentials provider, executor service, and client configuration options.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    executorService - The executor service by which all asynchronous requests will be executed.
- Method Detail
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Returns the executor service used by this client to execute async requests.
    
    Returns:
    The executor service used by this client to execute async requests.
  - cancelCommandAsync
```
public Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    cancelCommandAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the CancelCommand operation returned by the service.
  - cancelCommandAsync
```
public Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest request,
                                             AsyncHandler<CancelCommandRequest,CancelCommandResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    cancelCommandAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    createAssociationAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the CreateAssociation operation returned by the service.
  - createAssociationAsync
```
public Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request,
                                                     AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    createAssociationAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    createAssociationBatchAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the CreateAssociationBatch operation returned by the service.
  - createAssociationBatchAsync
```
public Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request,
                                                               AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    createAssociationBatchAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Creates an SSM document.
    
    After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
    
    Specified by:
    
    createDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the CreateDocument operation returned by the service.
  - createDocumentAsync
```
public Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request,
                                               AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Creates an SSM document.
    
    After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
    
    Specified by:
    
    createDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    deleteAssociationAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the DeleteAssociation operation returned by the service.
  - deleteAssociationAsync
```
public Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request,
                                                     AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    deleteAssociationAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    deleteDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the DeleteDocument operation returned by the service.
  - deleteDocumentAsync
```
public Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request,
                                               AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    deleteDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Describes the associations for the specified SSM document or instance.
    
    Specified by:
    
    describeAssociationAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the DescribeAssociation operation returned by the service.
  - describeAssociationAsync
```
public Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request,
                                                         AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Describes the associations for the specified SSM document or instance.
    
    Specified by:
    
    describeAssociationAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Describes the specified SSM document.
    
    Specified by:
    
    describeDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the DescribeDocument operation returned by the service.
  - describeDocumentAsync
```
public Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request,
                                                   AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Describes the specified SSM document.
    
    Specified by:
    
    describeDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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).
    
    Specified by:
    
    describeDocumentPermissionAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the DescribeDocumentPermission operation returned by the service.
  - describeDocumentPermissionAsync
```
public Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request,
                                                                       AsyncHandler<DescribeDocumentPermissionRequest,DescribeDocumentPermissionResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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).
    
    Specified by:
    
    describeDocumentPermissionAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    describeInstanceInformationAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the DescribeInstanceInformation operation returned by the service.
  - describeInstanceInformationAsync
```
public Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request,
                                                                         AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    describeInstanceInformationAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Gets the contents of the specified SSM document.
    
    Specified by:
    
    getDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the GetDocument operation returned by the service.
  - getDocumentAsync
```
public Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request,
                                         AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Gets the contents of the specified SSM document.
    
    Specified by:
    
    getDocumentAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Lists the associations for the specified SSM document or instance.
    
    Specified by:
    
    listAssociationsAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the ListAssociations operation returned by the service.
  - listAssociationsAsync
```
public Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request,
                                                   AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Lists the associations for the specified SSM document or instance.
    
    Specified by:
    
    listAssociationsAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    listCommandInvocationsAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the ListCommandInvocations operation returned by the service.
  - listCommandInvocationsAsync
```
public Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest request,
                                                               AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    listCommandInvocationsAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Lists the commands requested by users of the AWS account.
    
    Specified by:
    
    listCommandsAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the ListCommands operation returned by the service.
  - listCommandsAsync
```
public Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest request,
                                           AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Lists the commands requested by users of the AWS account.
    
    Specified by:
    
    listCommandsAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Describes one or more of your SSM documents.
    
    Specified by:
    
    listDocumentsAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the ListDocuments operation returned by the service.
  - listDocumentsAsync
```
public Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request,
                                             AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Describes one or more of your SSM documents.
    
    Specified by:
    
    listDocumentsAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<ListDocumentsResult> listDocumentsAsync()
```
    Simplified method form for invoking the ListDocuments operation.
    
    Specified by:
    
    listDocumentsAsync in interface AWSSimpleSystemsManagementAsync
    
    See Also:
    listDocumentsAsync(ListDocumentsRequest)
  - listDocumentsAsync
```
public Future<ListDocumentsResult> listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
```
    Simplified method form for invoking the ListDocuments operation with an AsyncHandler.
    
    Specified by:
    
    listDocumentsAsync in interface AWSSimpleSystemsManagementAsync
    
    See Also:
    listDocumentsAsync(ListDocumentsRequest, com.amazonaws.handlers.AsyncHandler)
  - modifyDocumentPermissionAsync
```
public Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    modifyDocumentPermissionAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the ModifyDocumentPermission operation returned by the service.
  - modifyDocumentPermissionAsync
```
public Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request,
                                                                   AsyncHandler<ModifyDocumentPermissionRequest,ModifyDocumentPermissionResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    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.
    
    Specified by:
    
    modifyDocumentPermissionAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<SendCommandResult> sendCommandAsync(SendCommandRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Executes commands on one or more remote instances.
    
    Specified by:
    
    sendCommandAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the SendCommand operation returned by the service.
  - sendCommandAsync
```
public Future<SendCommandResult> sendCommandAsync(SendCommandRequest request,
                                         AsyncHandler<SendCommandRequest,SendCommandResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Executes commands on one or more remote instances.
    
    Specified by:
    
    sendCommandAsync in interface AWSSimpleSystemsManagementAsync
    
    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
```
public Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest request)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Updates the status of the SSM document associated with the specified instance.
    
    Specified by:
    
    updateAssociationStatusAsync in interface AWSSimpleSystemsManagementAsync
    
    Returns:
    A Java Future containing the result of the UpdateAssociationStatus operation returned by the service.
  - updateAssociationStatusAsync
```
public Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest request,
                                                                 AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)
```
    Description copied from interface: AWSSimpleSystemsManagementAsync
    
    Updates the status of the SSM document associated with the specified instance.
    
    Specified by:
    
    updateAssociationStatusAsync in interface AWSSimpleSystemsManagementAsync
    
    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.
  - shutdown
```
public void shutdown()
```
    Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
    
    Specified by:
    
    shutdown in interface AWSSimpleSystemsManagement
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AWSSimpleSystemsManagementAsyncClient

Field Summary

Fields inherited from class com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagementClient

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagementClient

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement

Constructor Detail

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

AWSSimpleSystemsManagementAsyncClient

Method Detail

getExecutorService

cancelCommandAsync

cancelCommandAsync

createAssociationAsync

createAssociationAsync

createAssociationBatchAsync

createAssociationBatchAsync

createDocumentAsync

createDocumentAsync

deleteAssociationAsync

deleteAssociationAsync

deleteDocumentAsync

deleteDocumentAsync

describeAssociationAsync

describeAssociationAsync

describeDocumentAsync

describeDocumentAsync

describeDocumentPermissionAsync

describeDocumentPermissionAsync

describeInstanceInformationAsync

describeInstanceInformationAsync

getDocumentAsync

getDocumentAsync

listAssociationsAsync

listAssociationsAsync

listCommandInvocationsAsync

listCommandInvocationsAsync

listCommandsAsync

listCommandsAsync

listDocumentsAsync

listDocumentsAsync

listDocumentsAsync

listDocumentsAsync

modifyDocumentPermissionAsync

modifyDocumentPermissionAsync

sendCommandAsync

sendCommandAsync

updateAssociationStatusAsync

updateAssociationStatusAsync

shutdown