public class AWSSimpleSystemsManagementAsyncClient extends AWSSimpleSystemsManagementClient implements AWSSimpleSystemsManagementAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Simple Systems Manager (SSM) enables you to remotely manage the configuration of your Amazon EC2 instance. Using SSM, you can run scripts or commands using either EC2 Run Command or SSM Config. (SSM Config is currently available only for Windows instances.)
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, or the AWS CLI.
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.
LOGGING_AWS_REQUEST_METRIC| 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.
|
cancelCommand, createAssociation, createAssociationBatch, createDocument, deleteAssociation, deleteDocument, describeAssociation, describeDocument, describeInstanceInformation, getCachedResponseMetadata, getDocument, listAssociations, listCommandInvocations, listCommands, listDocuments, listDocuments, sendCommand, updateAssociationStatusaddRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelCommand, createAssociation, createAssociationBatch, createDocument, deleteAssociation, deleteDocument, describeAssociation, describeDocument, describeInstanceInformation, getCachedResponseMetadata, getDocument, listAssociations, listCommandInvocations, listCommands, listDocuments, listDocuments, sendCommand, setEndpoint, setRegion, updateAssociationStatuspublic AWSSimpleSystemsManagementAsyncClient()
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).
public AWSSimpleSystemsManagementAsyncClient(ClientConfiguration clientConfiguration)
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().
clientConfiguration - The client configuration options controlling how this client
connects to Amazon SSM (ex: proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials)
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).
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.Executors.newFixedThreadPool(int)public AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
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.public AWSSimpleSystemsManagementAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
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.public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
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).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.Executors.newFixedThreadPool(int)public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
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().
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).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
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.public AWSSimpleSystemsManagementAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
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.public ExecutorService getExecutorService()
public Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest request)
AWSSimpleSystemsManagementAsyncAttempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelCommandAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest request, AsyncHandler<CancelCommandRequest,CancelCommandResult> asyncHandler)
AWSSimpleSystemsManagementAsyncAttempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelCommandAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request)
AWSSimpleSystemsManagementAsyncAssociates 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.
createAssociationAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request, AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)
AWSSimpleSystemsManagementAsyncAssociates 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.
createAssociationAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request)
AWSSimpleSystemsManagementAsyncAssociates 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.
createAssociationBatchAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request, AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)
AWSSimpleSystemsManagementAsyncAssociates 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.
createAssociationBatchAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request)
AWSSimpleSystemsManagementAsyncCreates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
createDocumentAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request, AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsyncCreates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
createDocumentAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request)
AWSSimpleSystemsManagementAsyncDisassociates 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.
deleteAssociationAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request, AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)
AWSSimpleSystemsManagementAsyncDisassociates 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.
deleteAssociationAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request)
AWSSimpleSystemsManagementAsyncDeletes 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.
deleteDocumentAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsyncDeletes 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.
deleteDocumentAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request)
AWSSimpleSystemsManagementAsyncDescribes the associations for the specified SSM document or instance.
describeAssociationAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request, AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
AWSSimpleSystemsManagementAsyncDescribes the associations for the specified SSM document or instance.
describeAssociationAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request)
AWSSimpleSystemsManagementAsyncDescribes the specified SSM document.
describeDocumentAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request, AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsyncDescribes the specified SSM document.
describeDocumentAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request)
AWSSimpleSystemsManagementAsyncdescribeInstanceInformationAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request, AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
AWSSimpleSystemsManagementAsyncdescribeInstanceInformationAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request)
AWSSimpleSystemsManagementAsyncGets the contents of the specified SSM document.
getDocumentAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsyncGets the contents of the specified SSM document.
getDocumentAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request)
AWSSimpleSystemsManagementAsyncLists the associations for the specified SSM document or instance.
listAssociationsAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request, AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
AWSSimpleSystemsManagementAsyncLists the associations for the specified SSM document or instance.
listAssociationsAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest request)
AWSSimpleSystemsManagementAsynclistCommandInvocationsAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest request, AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)
AWSSimpleSystemsManagementAsynclistCommandInvocationsAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest request)
AWSSimpleSystemsManagementAsyncLists the commands requested by users of the AWS account.
listCommandsAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest request, AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)
AWSSimpleSystemsManagementAsyncLists the commands requested by users of the AWS account.
listCommandsAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request)
AWSSimpleSystemsManagementAsyncDescribes one or more of your SSM documents.
listDocumentsAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
AWSSimpleSystemsManagementAsyncDescribes one or more of your SSM documents.
listDocumentsAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<ListDocumentsResult> listDocumentsAsync()
listDocumentsAsync in interface AWSSimpleSystemsManagementAsynclistDocumentsAsync(ListDocumentsRequest)public Future<ListDocumentsResult> listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
listDocumentsAsync in interface AWSSimpleSystemsManagementAsynclistDocumentsAsync(ListDocumentsRequest,
com.amazonaws.handlers.AsyncHandler)public Future<SendCommandResult> sendCommandAsync(SendCommandRequest request)
AWSSimpleSystemsManagementAsyncsendCommandAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<SendCommandResult> sendCommandAsync(SendCommandRequest request, AsyncHandler<SendCommandRequest,SendCommandResult> asyncHandler)
AWSSimpleSystemsManagementAsyncsendCommandAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest request)
AWSSimpleSystemsManagementAsyncUpdates the status of the SSM document associated with the specified instance.
updateAssociationStatusAsync in interface AWSSimpleSystemsManagementAsyncpublic Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest request, AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)
AWSSimpleSystemsManagementAsyncUpdates the status of the SSM document associated with the specified instance.
updateAssociationStatusAsync in interface AWSSimpleSystemsManagementAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by
getExecutorService().awaitTermination() prior to calling this
method.shutdown in interface AWSSimpleSystemsManagementshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.