public class AWSSimpleSystemsManagementAsyncClient extends AWSSimpleSystemsManagementClient implements AWSSimpleSystemsManagementAsync
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)
Modifier and Type | Field and Description |
---|---|
private static int |
DEFAULT_THREAD_POOL_SIZE |
private java.util.concurrent.ExecutorService |
executorService |
configFactory
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
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,
java.util.concurrent.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,
java.util.concurrent.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,
java.util.concurrent.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,
java.util.concurrent.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.
|
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.Future<CancelCommandResult> |
cancelCommandAsync(CancelCommandRequest request)
Attempts to cancel the command specified by the Command ID.
|
java.util.concurrent.Future<CancelCommandResult> |
cancelCommandAsync(CancelCommandRequest request,
AsyncHandler<CancelCommandRequest,CancelCommandResult> asyncHandler)
Attempts to cancel the command specified by the Command ID.
|
java.util.concurrent.Future<CreateAssociationResult> |
createAssociationAsync(CreateAssociationRequest request)
Associates the specified SSM document with the specified instance.
|
java.util.concurrent.Future<CreateAssociationResult> |
createAssociationAsync(CreateAssociationRequest request,
AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)
Associates the specified SSM document with the specified instance.
|
java.util.concurrent.Future<CreateAssociationBatchResult> |
createAssociationBatchAsync(CreateAssociationBatchRequest request)
Associates the specified SSM document with the specified instances.
|
java.util.concurrent.Future<CreateAssociationBatchResult> |
createAssociationBatchAsync(CreateAssociationBatchRequest request,
AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)
Associates the specified SSM document with the specified instances.
|
java.util.concurrent.Future<CreateDocumentResult> |
createDocumentAsync(CreateDocumentRequest request)
Creates an SSM document.
|
java.util.concurrent.Future<CreateDocumentResult> |
createDocumentAsync(CreateDocumentRequest request,
AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)
Creates an SSM document.
|
java.util.concurrent.Future<DeleteAssociationResult> |
deleteAssociationAsync(DeleteAssociationRequest request)
Disassociates the specified SSM document from the specified instance.
|
java.util.concurrent.Future<DeleteAssociationResult> |
deleteAssociationAsync(DeleteAssociationRequest request,
AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)
Disassociates the specified SSM document from the specified instance.
|
java.util.concurrent.Future<DeleteDocumentResult> |
deleteDocumentAsync(DeleteDocumentRequest request)
Deletes the SSM document and all instance associations to the document.
|
java.util.concurrent.Future<DeleteDocumentResult> |
deleteDocumentAsync(DeleteDocumentRequest request,
AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
Deletes the SSM document and all instance associations to the document.
|
java.util.concurrent.Future<DescribeAssociationResult> |
describeAssociationAsync(DescribeAssociationRequest request)
Describes the associations for the specified SSM document or instance.
|
java.util.concurrent.Future<DescribeAssociationResult> |
describeAssociationAsync(DescribeAssociationRequest request,
AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
Describes the associations for the specified SSM document or instance.
|
java.util.concurrent.Future<DescribeDocumentResult> |
describeDocumentAsync(DescribeDocumentRequest request)
Describes the specified SSM document.
|
java.util.concurrent.Future<DescribeDocumentResult> |
describeDocumentAsync(DescribeDocumentRequest request,
AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
Describes the specified SSM document.
|
java.util.concurrent.Future<DescribeDocumentPermissionResult> |
describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request)
Describes the permissions for an SSM document.
|
java.util.concurrent.Future<DescribeDocumentPermissionResult> |
describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request,
AsyncHandler<DescribeDocumentPermissionRequest,DescribeDocumentPermissionResult> asyncHandler)
Describes the permissions for an SSM document.
|
java.util.concurrent.Future<DescribeInstanceInformationResult> |
describeInstanceInformationAsync(DescribeInstanceInformationRequest request)
Describes one or more of your instances.
|
java.util.concurrent.Future<DescribeInstanceInformationResult> |
describeInstanceInformationAsync(DescribeInstanceInformationRequest request,
AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
Describes one or more of your instances.
|
java.util.concurrent.Future<GetDocumentResult> |
getDocumentAsync(GetDocumentRequest request)
Gets the contents of the specified SSM document.
|
java.util.concurrent.Future<GetDocumentResult> |
getDocumentAsync(GetDocumentRequest request,
AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
Gets the contents of the specified SSM document.
|
java.util.concurrent.ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async
requests.
|
java.util.concurrent.Future<ListAssociationsResult> |
listAssociationsAsync(ListAssociationsRequest request)
Lists the associations for the specified SSM document or instance.
|
java.util.concurrent.Future<ListAssociationsResult> |
listAssociationsAsync(ListAssociationsRequest request,
AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
Lists the associations for the specified SSM document or instance.
|
java.util.concurrent.Future<ListCommandInvocationsResult> |
listCommandInvocationsAsync(ListCommandInvocationsRequest request)
An invocation is copy of a command sent to a specific instance.
|
java.util.concurrent.Future<ListCommandInvocationsResult> |
listCommandInvocationsAsync(ListCommandInvocationsRequest request,
AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)
An invocation is copy of a command sent to a specific instance.
|
java.util.concurrent.Future<ListCommandsResult> |
listCommandsAsync(ListCommandsRequest request)
Lists the commands requested by users of the AWS account.
|
java.util.concurrent.Future<ListCommandsResult> |
listCommandsAsync(ListCommandsRequest request,
AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)
Lists the commands requested by users of the AWS account.
|
java.util.concurrent.Future<ListDocumentsResult> |
listDocumentsAsync()
Simplified method form for invoking the ListDocuments operation.
|
java.util.concurrent.Future<ListDocumentsResult> |
listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Simplified method form for invoking the ListDocuments operation with an
AsyncHandler.
|
java.util.concurrent.Future<ListDocumentsResult> |
listDocumentsAsync(ListDocumentsRequest request)
Describes one or more of your SSM documents.
|
java.util.concurrent.Future<ListDocumentsResult> |
listDocumentsAsync(ListDocumentsRequest request,
AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Describes one or more of your SSM documents.
|
java.util.concurrent.Future<ModifyDocumentPermissionResult> |
modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request)
Share a document publicly or privately.
|
java.util.concurrent.Future<ModifyDocumentPermissionResult> |
modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request,
AsyncHandler<ModifyDocumentPermissionRequest,ModifyDocumentPermissionResult> asyncHandler)
Share a document publicly or privately.
|
java.util.concurrent.Future<SendCommandResult> |
sendCommandAsync(SendCommandRequest request)
Executes commands on one or more remote instances.
|
java.util.concurrent.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.
|
java.util.concurrent.Future<UpdateAssociationStatusResult> |
updateAssociationStatusAsync(UpdateAssociationStatusRequest request)
Updates the status of the SSM document associated with the specified
instance.
|
java.util.concurrent.Future<UpdateAssociationStatusResult> |
updateAssociationStatusAsync(UpdateAssociationStatusRequest request,
AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)
Updates the status of the SSM document associated with the specified
instance.
|
cancelCommand, createAssociation, createAssociationBatch, createDocument, deleteAssociation, deleteDocument, describeAssociation, describeDocument, describeDocumentPermission, describeInstanceInformation, getCachedResponseMetadata, getDocument, listAssociations, listCommandInvocations, listCommands, listDocuments, listDocuments, modifyDocumentPermission, sendCommand, updateAssociationStatus
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelCommand, createAssociation, createAssociationBatch, createDocument, deleteAssociation, deleteDocument, describeAssociation, describeDocument, describeDocumentPermission, describeInstanceInformation, getCachedResponseMetadata, getDocument, listAssociations, listCommandInvocations, listCommands, listDocuments, listDocuments, modifyDocumentPermission, sendCommand, setEndpoint, setRegion, updateAssociationStatus
private static final int DEFAULT_THREAD_POOL_SIZE
private final java.util.concurrent.ExecutorService executorService
public 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).
DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
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, java.util.concurrent.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, java.util.concurrent.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, java.util.concurrent.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, java.util.concurrent.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 java.util.concurrent.ExecutorService getExecutorService()
public java.util.concurrent.Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest request)
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.
cancelCommandAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest request, AsyncHandler<CancelCommandRequest,CancelCommandResult> asyncHandler)
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.
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.public java.util.concurrent.Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request)
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.
createAssociationAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request, AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)
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.
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.public java.util.concurrent.Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request)
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.
createAssociationBatchAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request, AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)
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.
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.public java.util.concurrent.Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request)
AWSSimpleSystemsManagementAsync
Creates 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 AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request, AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Creates 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 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.public java.util.concurrent.Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request)
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.
deleteAssociationAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request, AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)
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.
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.public java.util.concurrent.Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request)
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.
deleteDocumentAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
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.
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.public java.util.concurrent.Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request)
AWSSimpleSystemsManagementAsync
Describes the associations for the specified SSM document or instance.
describeAssociationAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request, AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes the associations for the specified SSM document or instance.
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.public java.util.concurrent.Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request)
AWSSimpleSystemsManagementAsync
Describes the specified SSM document.
describeDocumentAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request, AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes the specified SSM document.
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.public java.util.concurrent.Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request)
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).
describeDocumentPermissionAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request, AsyncHandler<DescribeDocumentPermissionRequest,DescribeDocumentPermissionResult> asyncHandler)
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).
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.public java.util.concurrent.Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request)
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.
describeInstanceInformationAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request, AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
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.
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.public java.util.concurrent.Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request)
AWSSimpleSystemsManagementAsync
Gets the contents of the specified SSM document.
getDocumentAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Gets the contents of the specified SSM document.
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.public java.util.concurrent.Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request)
AWSSimpleSystemsManagementAsync
Lists the associations for the specified SSM document or instance.
listAssociationsAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request, AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the associations for the specified SSM document or instance.
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.public java.util.concurrent.Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest request)
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.
listCommandInvocationsAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest request, AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)
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.
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.public java.util.concurrent.Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest request)
AWSSimpleSystemsManagementAsync
Lists the commands requested by users of the AWS account.
listCommandsAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest request, AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the commands requested by users of the AWS account.
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.public java.util.concurrent.Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request)
AWSSimpleSystemsManagementAsync
Describes one or more of your SSM documents.
listDocumentsAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes one or more of your SSM documents.
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.public java.util.concurrent.Future<ListDocumentsResult> listDocumentsAsync()
listDocumentsAsync
in interface AWSSimpleSystemsManagementAsync
listDocumentsAsync(ListDocumentsRequest)
public java.util.concurrent.Future<ListDocumentsResult> listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
listDocumentsAsync
in interface AWSSimpleSystemsManagementAsync
listDocumentsAsync(ListDocumentsRequest,
com.amazonaws.handlers.AsyncHandler)
public java.util.concurrent.Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request)
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.
modifyDocumentPermissionAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest request, AsyncHandler<ModifyDocumentPermissionRequest,ModifyDocumentPermissionResult> asyncHandler)
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.
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.public java.util.concurrent.Future<SendCommandResult> sendCommandAsync(SendCommandRequest request)
AWSSimpleSystemsManagementAsync
Executes commands on one or more remote instances.
sendCommandAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<SendCommandResult> sendCommandAsync(SendCommandRequest request, AsyncHandler<SendCommandRequest,SendCommandResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Executes commands on one or more remote instances.
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.public java.util.concurrent.Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest request)
AWSSimpleSystemsManagementAsync
Updates the status of the SSM document associated with the specified instance.
updateAssociationStatusAsync
in interface AWSSimpleSystemsManagementAsync
public java.util.concurrent.Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest request, AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Updates the status of the SSM document associated with the specified instance.
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.public void shutdown()
getExecutorService().shutdown()
followed by
getExecutorService().awaitTermination()
prior to calling this
method.shutdown
in interface AWSSimpleSystemsManagement
shutdown
in class AmazonWebServiceClient