@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSimpleSystemsManagementAsync extends AbstractAWSSimpleSystemsManagement implements AWSSimpleSystemsManagementAsync
AWSSimpleSystemsManagementAsync
. Convenient method forms pass through to the
corresponding overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
addTagsToResource, cancelCommand, cancelMaintenanceWindowExecution, createActivation, createAssociation, createAssociationBatch, createDocument, createMaintenanceWindow, createOpsItem, createOpsMetadata, createPatchBaseline, createResourceDataSync, deleteActivation, deleteAssociation, deleteDocument, deleteInventory, deleteMaintenanceWindow, deleteOpsMetadata, deleteParameter, deleteParameters, deletePatchBaseline, deleteResourceDataSync, deregisterManagedInstance, deregisterPatchBaselineForPatchGroup, deregisterTargetFromMaintenanceWindow, deregisterTaskFromMaintenanceWindow, describeActivations, describeAssociation, describeAssociationExecutions, describeAssociationExecutionTargets, describeAutomationExecutions, describeAutomationStepExecutions, describeAvailablePatches, describeDocument, describeDocumentPermission, describeEffectiveInstanceAssociations, describeEffectivePatchesForPatchBaseline, describeInstanceAssociationsStatus, describeInstanceInformation, describeInstancePatches, describeInstancePatchStates, describeInstancePatchStatesForPatchGroup, describeInventoryDeletions, describeMaintenanceWindowExecutions, describeMaintenanceWindowExecutionTaskInvocations, describeMaintenanceWindowExecutionTasks, describeMaintenanceWindows, describeMaintenanceWindowSchedule, describeMaintenanceWindowsForTarget, describeMaintenanceWindowTargets, describeMaintenanceWindowTasks, describeOpsItems, describeParameters, describePatchBaselines, describePatchGroups, describePatchGroupState, describePatchProperties, describeSessions, getAutomationExecution, getCachedResponseMetadata, getCalendarState, getCommandInvocation, getConnectionStatus, getDefaultPatchBaseline, getDeployablePatchSnapshotForInstance, getDocument, getInventory, getInventorySchema, getMaintenanceWindow, getMaintenanceWindowExecution, getMaintenanceWindowExecutionTask, getMaintenanceWindowExecutionTaskInvocation, getMaintenanceWindowTask, getOpsItem, getOpsMetadata, getOpsSummary, getParameter, getParameterHistory, getParameters, getParametersByPath, getPatchBaseline, getPatchBaselineForPatchGroup, getServiceSetting, labelParameterVersion, listAssociations, listAssociationVersions, listCommandInvocations, listCommands, listComplianceItems, listComplianceSummaries, listDocumentMetadataHistory, listDocuments, listDocuments, listDocumentVersions, listInventoryEntries, listOpsItemEvents, listOpsMetadata, listResourceComplianceSummaries, listResourceDataSync, listTagsForResource, modifyDocumentPermission, putComplianceItems, putInventory, putParameter, registerDefaultPatchBaseline, registerPatchBaselineForPatchGroup, registerTargetWithMaintenanceWindow, registerTaskWithMaintenanceWindow, removeTagsFromResource, resetServiceSetting, resumeSession, sendAutomationSignal, sendCommand, setEndpoint, setRegion, shutdown, startAssociationsOnce, startAutomationExecution, startChangeRequestExecution, startSession, stopAutomationExecution, terminateSession, updateAssociation, updateAssociationStatus, updateDocument, updateDocumentDefaultVersion, updateDocumentMetadata, updateMaintenanceWindow, updateMaintenanceWindowTarget, updateMaintenanceWindowTask, updateManagedInstanceRole, updateOpsItem, updateOpsMetadata, updatePatchBaseline, updateResourceDataSync, updateServiceSetting, waiters
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addTagsToResource, cancelCommand, cancelMaintenanceWindowExecution, createActivation, createAssociation, createAssociationBatch, createDocument, createMaintenanceWindow, createOpsItem, createOpsMetadata, createPatchBaseline, createResourceDataSync, deleteActivation, deleteAssociation, deleteDocument, deleteInventory, deleteMaintenanceWindow, deleteOpsMetadata, deleteParameter, deleteParameters, deletePatchBaseline, deleteResourceDataSync, deregisterManagedInstance, deregisterPatchBaselineForPatchGroup, deregisterTargetFromMaintenanceWindow, deregisterTaskFromMaintenanceWindow, describeActivations, describeAssociation, describeAssociationExecutions, describeAssociationExecutionTargets, describeAutomationExecutions, describeAutomationStepExecutions, describeAvailablePatches, describeDocument, describeDocumentPermission, describeEffectiveInstanceAssociations, describeEffectivePatchesForPatchBaseline, describeInstanceAssociationsStatus, describeInstanceInformation, describeInstancePatches, describeInstancePatchStates, describeInstancePatchStatesForPatchGroup, describeInventoryDeletions, describeMaintenanceWindowExecutions, describeMaintenanceWindowExecutionTaskInvocations, describeMaintenanceWindowExecutionTasks, describeMaintenanceWindows, describeMaintenanceWindowSchedule, describeMaintenanceWindowsForTarget, describeMaintenanceWindowTargets, describeMaintenanceWindowTasks, describeOpsItems, describeParameters, describePatchBaselines, describePatchGroups, describePatchGroupState, describePatchProperties, describeSessions, getAutomationExecution, getCachedResponseMetadata, getCalendarState, getCommandInvocation, getConnectionStatus, getDefaultPatchBaseline, getDeployablePatchSnapshotForInstance, getDocument, getInventory, getInventorySchema, getMaintenanceWindow, getMaintenanceWindowExecution, getMaintenanceWindowExecutionTask, getMaintenanceWindowExecutionTaskInvocation, getMaintenanceWindowTask, getOpsItem, getOpsMetadata, getOpsSummary, getParameter, getParameterHistory, getParameters, getParametersByPath, getPatchBaseline, getPatchBaselineForPatchGroup, getServiceSetting, labelParameterVersion, listAssociations, listAssociationVersions, listCommandInvocations, listCommands, listComplianceItems, listComplianceSummaries, listDocumentMetadataHistory, listDocuments, listDocuments, listDocumentVersions, listInventoryEntries, listOpsItemEvents, listOpsMetadata, listResourceComplianceSummaries, listResourceDataSync, listTagsForResource, modifyDocumentPermission, putComplianceItems, putInventory, putParameter, registerDefaultPatchBaseline, registerPatchBaselineForPatchGroup, registerTargetWithMaintenanceWindow, registerTaskWithMaintenanceWindow, removeTagsFromResource, resetServiceSetting, resumeSession, sendAutomationSignal, sendCommand, setEndpoint, setRegion, shutdown, startAssociationsOnce, startAutomationExecution, startChangeRequestExecution, startSession, stopAutomationExecution, terminateSession, updateAssociation, updateAssociationStatus, updateDocument, updateDocumentDefaultVersion, updateDocumentMetadata, updateMaintenanceWindow, updateMaintenanceWindowTarget, updateMaintenanceWindowTask, updateManagedInstanceRole, updateOpsItem, updateOpsMetadata, updatePatchBaseline, updateResourceDataSync, updateServiceSetting, waiters
public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request)
AWSSimpleSystemsManagementAsync
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceAsync
in interface AWSSimpleSystemsManagementAsync
public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceAsync
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 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 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 Future<CancelMaintenanceWindowExecutionResult> cancelMaintenanceWindowExecutionAsync(CancelMaintenanceWindowExecutionRequest request)
AWSSimpleSystemsManagementAsync
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
cancelMaintenanceWindowExecutionAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CancelMaintenanceWindowExecutionResult> cancelMaintenanceWindowExecutionAsync(CancelMaintenanceWindowExecutionRequest request, AsyncHandler<CancelMaintenanceWindowExecutionRequest,CancelMaintenanceWindowExecutionResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
cancelMaintenanceWindowExecutionAsync
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 Future<CreateActivationResult> createActivationAsync(CreateActivationRequest request)
AWSSimpleSystemsManagementAsync
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
createActivationAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateActivationResult> createActivationAsync(CreateActivationRequest request, AsyncHandler<CreateActivationRequest,CreateActivationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
createActivationAsync
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 Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request)
AWSSimpleSystemsManagementAsync
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
createAssociationAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest request, AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
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 Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request)
AWSSimpleSystemsManagementAsync
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running 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 returns the AssociationAlreadyExists exception.
createAssociationBatchAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest request, AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running 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 returns 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 Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request)
AWSSimpleSystemsManagementAsync
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
createDocumentAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest request, AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
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 Future<CreateMaintenanceWindowResult> createMaintenanceWindowAsync(CreateMaintenanceWindowRequest request)
AWSSimpleSystemsManagementAsync
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
createMaintenanceWindowAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateMaintenanceWindowResult> createMaintenanceWindowAsync(CreateMaintenanceWindowRequest request, AsyncHandler<CreateMaintenanceWindowRequest,CreateMaintenanceWindowResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
createMaintenanceWindowAsync
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 Future<CreateOpsItemResult> createOpsItemAsync(CreateOpsItemRequest request)
AWSSimpleSystemsManagementAsync
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
createOpsItemAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateOpsItemResult> createOpsItemAsync(CreateOpsItemRequest request, AsyncHandler<CreateOpsItemRequest,CreateOpsItemResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
createOpsItemAsync
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 Future<CreateOpsMetadataResult> createOpsMetadataAsync(CreateOpsMetadataRequest request)
AWSSimpleSystemsManagementAsync
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
createOpsMetadataAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateOpsMetadataResult> createOpsMetadataAsync(CreateOpsMetadataRequest request, AsyncHandler<CreateOpsMetadataRequest,CreateOpsMetadataResult> asyncHandler)
AWSSimpleSystemsManagementAsync
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
createOpsMetadataAsync
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 Future<CreatePatchBaselineResult> createPatchBaselineAsync(CreatePatchBaselineRequest request)
AWSSimpleSystemsManagementAsync
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaselineAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreatePatchBaselineResult> createPatchBaselineAsync(CreatePatchBaselineRequest request, AsyncHandler<CreatePatchBaselineRequest,CreatePatchBaselineResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaselineAsync
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 Future<CreateResourceDataSyncResult> createResourceDataSyncAsync(CreateResourceDataSyncRequest request)
AWSSimpleSystemsManagementAsync
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two
types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring
Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type
can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization
by
using AWS Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager
User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
createResourceDataSyncAsync
in interface AWSSimpleSystemsManagementAsync
public Future<CreateResourceDataSyncResult> createResourceDataSyncAsync(CreateResourceDataSyncRequest request, AsyncHandler<CreateResourceDataSyncRequest,CreateResourceDataSyncResult> asyncHandler)
AWSSimpleSystemsManagementAsync
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two
types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring
Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type
can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization
by
using AWS Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager
User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
createResourceDataSyncAsync
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 Future<DeleteActivationResult> deleteActivationAsync(DeleteActivationRequest request)
AWSSimpleSystemsManagementAsync
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
deleteActivationAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteActivationResult> deleteActivationAsync(DeleteActivationRequest request, AsyncHandler<DeleteActivationRequest,DeleteActivationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
deleteActivationAsync
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 Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request)
AWSSimpleSystemsManagementAsync
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a 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 Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest request, AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a 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 Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request)
AWSSimpleSystemsManagementAsync
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
deleteDocumentAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the 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 Future<DeleteInventoryResult> deleteInventoryAsync(DeleteInventoryRequest request)
AWSSimpleSystemsManagementAsync
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteInventoryAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteInventoryResult> deleteInventoryAsync(DeleteInventoryRequest request, AsyncHandler<DeleteInventoryRequest,DeleteInventoryResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteInventoryAsync
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 Future<DeleteMaintenanceWindowResult> deleteMaintenanceWindowAsync(DeleteMaintenanceWindowRequest request)
AWSSimpleSystemsManagementAsync
Deletes a maintenance window.
deleteMaintenanceWindowAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteMaintenanceWindowResult> deleteMaintenanceWindowAsync(DeleteMaintenanceWindowRequest request, AsyncHandler<DeleteMaintenanceWindowRequest,DeleteMaintenanceWindowResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Deletes a maintenance window.
deleteMaintenanceWindowAsync
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 Future<DeleteOpsMetadataResult> deleteOpsMetadataAsync(DeleteOpsMetadataRequest request)
AWSSimpleSystemsManagementAsync
Delete OpsMetadata related to an application.
deleteOpsMetadataAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteOpsMetadataResult> deleteOpsMetadataAsync(DeleteOpsMetadataRequest request, AsyncHandler<DeleteOpsMetadataRequest,DeleteOpsMetadataResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Delete OpsMetadata related to an application.
deleteOpsMetadataAsync
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 Future<DeleteParameterResult> deleteParameterAsync(DeleteParameterRequest request)
AWSSimpleSystemsManagementAsync
Delete a parameter from the system.
deleteParameterAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteParameterResult> deleteParameterAsync(DeleteParameterRequest request, AsyncHandler<DeleteParameterRequest,DeleteParameterResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Delete a parameter from the system.
deleteParameterAsync
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 Future<DeleteParametersResult> deleteParametersAsync(DeleteParametersRequest request)
AWSSimpleSystemsManagementAsync
Delete a list of parameters.
deleteParametersAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteParametersResult> deleteParametersAsync(DeleteParametersRequest request, AsyncHandler<DeleteParametersRequest,DeleteParametersResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Delete a list of parameters.
deleteParametersAsync
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 Future<DeletePatchBaselineResult> deletePatchBaselineAsync(DeletePatchBaselineRequest request)
AWSSimpleSystemsManagementAsync
Deletes a patch baseline.
deletePatchBaselineAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeletePatchBaselineResult> deletePatchBaselineAsync(DeletePatchBaselineRequest request, AsyncHandler<DeletePatchBaselineRequest,DeletePatchBaselineResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Deletes a patch baseline.
deletePatchBaselineAsync
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 Future<DeleteResourceDataSyncResult> deleteResourceDataSyncAsync(DeleteResourceDataSyncRequest request)
AWSSimpleSystemsManagementAsync
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
deleteResourceDataSyncAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeleteResourceDataSyncResult> deleteResourceDataSyncAsync(DeleteResourceDataSyncRequest request, AsyncHandler<DeleteResourceDataSyncRequest,DeleteResourceDataSyncResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
deleteResourceDataSyncAsync
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 Future<DeregisterManagedInstanceResult> deregisterManagedInstanceAsync(DeregisterManagedInstanceRequest request)
AWSSimpleSystemsManagementAsync
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstanceAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeregisterManagedInstanceResult> deregisterManagedInstanceAsync(DeregisterManagedInstanceRequest request, AsyncHandler<DeregisterManagedInstanceRequest,DeregisterManagedInstanceResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstanceAsync
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 Future<DeregisterPatchBaselineForPatchGroupResult> deregisterPatchBaselineForPatchGroupAsync(DeregisterPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagementAsync
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroupAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeregisterPatchBaselineForPatchGroupResult> deregisterPatchBaselineForPatchGroupAsync(DeregisterPatchBaselineForPatchGroupRequest request, AsyncHandler<DeregisterPatchBaselineForPatchGroupRequest,DeregisterPatchBaselineForPatchGroupResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroupAsync
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 Future<DeregisterTargetFromMaintenanceWindowResult> deregisterTargetFromMaintenanceWindowAsync(DeregisterTargetFromMaintenanceWindowRequest request)
AWSSimpleSystemsManagementAsync
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindowAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeregisterTargetFromMaintenanceWindowResult> deregisterTargetFromMaintenanceWindowAsync(DeregisterTargetFromMaintenanceWindowRequest request, AsyncHandler<DeregisterTargetFromMaintenanceWindowRequest,DeregisterTargetFromMaintenanceWindowResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindowAsync
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 Future<DeregisterTaskFromMaintenanceWindowResult> deregisterTaskFromMaintenanceWindowAsync(DeregisterTaskFromMaintenanceWindowRequest request)
AWSSimpleSystemsManagementAsync
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindowAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DeregisterTaskFromMaintenanceWindowResult> deregisterTaskFromMaintenanceWindowAsync(DeregisterTaskFromMaintenanceWindowRequest request, AsyncHandler<DeregisterTaskFromMaintenanceWindowRequest,DeregisterTaskFromMaintenanceWindowResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindowAsync
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 Future<DescribeActivationsResult> describeActivationsAsync(DescribeActivationsRequest request)
AWSSimpleSystemsManagementAsync
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
describeActivationsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeActivationsResult> describeActivationsAsync(DescribeActivationsRequest request, AsyncHandler<DescribeActivationsRequest,DescribeActivationsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
describeActivationsAsync
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 Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request)
AWSSimpleSystemsManagementAsync
Describes the association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
describeAssociationAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest request, AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes the association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
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 Future<DescribeAssociationExecutionTargetsResult> describeAssociationExecutionTargetsAsync(DescribeAssociationExecutionTargetsRequest request)
AWSSimpleSystemsManagementAsync
Use this API action to view information about a specific execution of a specific association.
describeAssociationExecutionTargetsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeAssociationExecutionTargetsResult> describeAssociationExecutionTargetsAsync(DescribeAssociationExecutionTargetsRequest request, AsyncHandler<DescribeAssociationExecutionTargetsRequest,DescribeAssociationExecutionTargetsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Use this API action to view information about a specific execution of a specific association.
describeAssociationExecutionTargetsAsync
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 Future<DescribeAssociationExecutionsResult> describeAssociationExecutionsAsync(DescribeAssociationExecutionsRequest request)
AWSSimpleSystemsManagementAsync
Use this API action to view all executions for a specific association ID.
describeAssociationExecutionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeAssociationExecutionsResult> describeAssociationExecutionsAsync(DescribeAssociationExecutionsRequest request, AsyncHandler<DescribeAssociationExecutionsRequest,DescribeAssociationExecutionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Use this API action to view all executions for a specific association ID.
describeAssociationExecutionsAsync
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 Future<DescribeAutomationExecutionsResult> describeAutomationExecutionsAsync(DescribeAutomationExecutionsRequest request)
AWSSimpleSystemsManagementAsync
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeAutomationExecutionsResult> describeAutomationExecutionsAsync(DescribeAutomationExecutionsRequest request, AsyncHandler<DescribeAutomationExecutionsRequest,DescribeAutomationExecutionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsAsync
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 Future<DescribeAutomationStepExecutionsResult> describeAutomationStepExecutionsAsync(DescribeAutomationStepExecutionsRequest request)
AWSSimpleSystemsManagementAsync
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeAutomationStepExecutionsResult> describeAutomationStepExecutionsAsync(DescribeAutomationStepExecutionsRequest request, AsyncHandler<DescribeAutomationStepExecutionsRequest,DescribeAutomationStepExecutionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutionsAsync
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 Future<DescribeAvailablePatchesResult> describeAvailablePatchesAsync(DescribeAvailablePatchesRequest request)
AWSSimpleSystemsManagementAsync
Lists all patches eligible to be included in a patch baseline.
describeAvailablePatchesAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeAvailablePatchesResult> describeAvailablePatchesAsync(DescribeAvailablePatchesRequest request, AsyncHandler<DescribeAvailablePatchesRequest,DescribeAvailablePatchesResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists all patches eligible to be included in a patch baseline.
describeAvailablePatchesAsync
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 Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request)
AWSSimpleSystemsManagementAsync
Describes the specified Systems Manager document.
describeDocumentAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest request, AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes the specified Systems Manager 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 Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request)
AWSSimpleSystemsManagementAsync
Describes the permissions for a Systems Manager 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 Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest request, AsyncHandler<DescribeDocumentPermissionRequest,DescribeDocumentPermissionResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes the permissions for a Systems Manager 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 Future<DescribeEffectiveInstanceAssociationsResult> describeEffectiveInstanceAssociationsAsync(DescribeEffectiveInstanceAssociationsRequest request)
AWSSimpleSystemsManagementAsync
All associations for the instance(s).
describeEffectiveInstanceAssociationsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeEffectiveInstanceAssociationsResult> describeEffectiveInstanceAssociationsAsync(DescribeEffectiveInstanceAssociationsRequest request, AsyncHandler<DescribeEffectiveInstanceAssociationsRequest,DescribeEffectiveInstanceAssociationsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
All associations for the instance(s).
describeEffectiveInstanceAssociationsAsync
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 Future<DescribeEffectivePatchesForPatchBaselineResult> describeEffectivePatchesForPatchBaselineAsync(DescribeEffectivePatchesForPatchBaselineRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeEffectivePatchesForPatchBaselineAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeEffectivePatchesForPatchBaselineResult> describeEffectivePatchesForPatchBaselineAsync(DescribeEffectivePatchesForPatchBaselineRequest request, AsyncHandler<DescribeEffectivePatchesForPatchBaselineRequest,DescribeEffectivePatchesForPatchBaselineResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeEffectivePatchesForPatchBaselineAsync
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 Future<DescribeInstanceAssociationsStatusResult> describeInstanceAssociationsStatusAsync(DescribeInstanceAssociationsStatusRequest request)
AWSSimpleSystemsManagementAsync
The status of the associations for the instance(s).
describeInstanceAssociationsStatusAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeInstanceAssociationsStatusResult> describeInstanceAssociationsStatusAsync(DescribeInstanceAssociationsStatusRequest request, AsyncHandler<DescribeInstanceAssociationsStatusRequest,DescribeInstanceAssociationsStatusResult> asyncHandler)
AWSSimpleSystemsManagementAsync
The status of the associations for the instance(s).
describeInstanceAssociationsStatusAsync
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 Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request)
AWSSimpleSystemsManagementAsync
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
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.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
describeInstanceInformationAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest request, AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
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.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
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 Future<DescribeInstancePatchStatesResult> describeInstancePatchStatesAsync(DescribeInstancePatchStatesRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStatesAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeInstancePatchStatesResult> describeInstancePatchStatesAsync(DescribeInstancePatchStatesRequest request, AsyncHandler<DescribeInstancePatchStatesRequest,DescribeInstancePatchStatesResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStatesAsync
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 Future<DescribeInstancePatchStatesForPatchGroupResult> describeInstancePatchStatesForPatchGroupAsync(DescribeInstancePatchStatesForPatchGroupRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the high-level patch state for the instances in the specified patch group.
describeInstancePatchStatesForPatchGroupAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeInstancePatchStatesForPatchGroupResult> describeInstancePatchStatesForPatchGroupAsync(DescribeInstancePatchStatesForPatchGroupRequest request, AsyncHandler<DescribeInstancePatchStatesForPatchGroupRequest,DescribeInstancePatchStatesForPatchGroupResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the high-level patch state for the instances in the specified patch group.
describeInstancePatchStatesForPatchGroupAsync
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 Future<DescribeInstancePatchesResult> describeInstancePatchesAsync(DescribeInstancePatchesRequest request)
AWSSimpleSystemsManagementAsync
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatchesAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeInstancePatchesResult> describeInstancePatchesAsync(DescribeInstancePatchesRequest request, AsyncHandler<DescribeInstancePatchesRequest,DescribeInstancePatchesResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatchesAsync
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 Future<DescribeInventoryDeletionsResult> describeInventoryDeletionsAsync(DescribeInventoryDeletionsRequest request)
AWSSimpleSystemsManagementAsync
Describes a specific delete inventory operation.
describeInventoryDeletionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeInventoryDeletionsResult> describeInventoryDeletionsAsync(DescribeInventoryDeletionsRequest request, AsyncHandler<DescribeInventoryDeletionsRequest,DescribeInventoryDeletionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Describes a specific delete inventory operation.
describeInventoryDeletionsAsync
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 Future<DescribeMaintenanceWindowExecutionTaskInvocationsResult> describeMaintenanceWindowExecutionTaskInvocationsAsync(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocationsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowExecutionTaskInvocationsResult> describeMaintenanceWindowExecutionTaskInvocationsAsync(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request, AsyncHandler<DescribeMaintenanceWindowExecutionTaskInvocationsRequest,DescribeMaintenanceWindowExecutionTaskInvocationsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocationsAsync
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 Future<DescribeMaintenanceWindowExecutionTasksResult> describeMaintenanceWindowExecutionTasksAsync(DescribeMaintenanceWindowExecutionTasksRequest request)
AWSSimpleSystemsManagementAsync
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasksAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowExecutionTasksResult> describeMaintenanceWindowExecutionTasksAsync(DescribeMaintenanceWindowExecutionTasksRequest request, AsyncHandler<DescribeMaintenanceWindowExecutionTasksRequest,DescribeMaintenanceWindowExecutionTasksResult> asyncHandler)
AWSSimpleSystemsManagementAsync
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasksAsync
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 Future<DescribeMaintenanceWindowExecutionsResult> describeMaintenanceWindowExecutionsAsync(DescribeMaintenanceWindowExecutionsRequest request)
AWSSimpleSystemsManagementAsync
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
describeMaintenanceWindowExecutionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowExecutionsResult> describeMaintenanceWindowExecutionsAsync(DescribeMaintenanceWindowExecutionsRequest request, AsyncHandler<DescribeMaintenanceWindowExecutionsRequest,DescribeMaintenanceWindowExecutionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
describeMaintenanceWindowExecutionsAsync
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 Future<DescribeMaintenanceWindowScheduleResult> describeMaintenanceWindowScheduleAsync(DescribeMaintenanceWindowScheduleRequest request)
AWSSimpleSystemsManagementAsync
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowScheduleAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowScheduleResult> describeMaintenanceWindowScheduleAsync(DescribeMaintenanceWindowScheduleRequest request, AsyncHandler<DescribeMaintenanceWindowScheduleRequest,DescribeMaintenanceWindowScheduleResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowScheduleAsync
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 Future<DescribeMaintenanceWindowTargetsResult> describeMaintenanceWindowTargetsAsync(DescribeMaintenanceWindowTargetsRequest request)
AWSSimpleSystemsManagementAsync
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargetsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowTargetsResult> describeMaintenanceWindowTargetsAsync(DescribeMaintenanceWindowTargetsRequest request, AsyncHandler<DescribeMaintenanceWindowTargetsRequest,DescribeMaintenanceWindowTargetsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargetsAsync
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 Future<DescribeMaintenanceWindowTasksResult> describeMaintenanceWindowTasksAsync(DescribeMaintenanceWindowTasksRequest request)
AWSSimpleSystemsManagementAsync
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
describeMaintenanceWindowTasksAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowTasksResult> describeMaintenanceWindowTasksAsync(DescribeMaintenanceWindowTasksRequest request, AsyncHandler<DescribeMaintenanceWindowTasksRequest,DescribeMaintenanceWindowTasksResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
describeMaintenanceWindowTasksAsync
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 Future<DescribeMaintenanceWindowsResult> describeMaintenanceWindowsAsync(DescribeMaintenanceWindowsRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindowsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowsResult> describeMaintenanceWindowsAsync(DescribeMaintenanceWindowsRequest request, AsyncHandler<DescribeMaintenanceWindowsRequest,DescribeMaintenanceWindowsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindowsAsync
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 Future<DescribeMaintenanceWindowsForTargetResult> describeMaintenanceWindowsForTargetAsync(DescribeMaintenanceWindowsForTargetRequest request)
AWSSimpleSystemsManagementAsync
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowsForTargetAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeMaintenanceWindowsForTargetResult> describeMaintenanceWindowsForTargetAsync(DescribeMaintenanceWindowsForTargetRequest request, AsyncHandler<DescribeMaintenanceWindowsForTargetRequest,DescribeMaintenanceWindowsForTargetResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowsForTargetAsync
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 Future<DescribeOpsItemsResult> describeOpsItemsAsync(DescribeOpsItemsRequest request)
AWSSimpleSystemsManagementAsync
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
describeOpsItemsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeOpsItemsResult> describeOpsItemsAsync(DescribeOpsItemsRequest request, AsyncHandler<DescribeOpsItemsRequest,DescribeOpsItemsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
describeOpsItemsAsync
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 Future<DescribeParametersResult> describeParametersAsync(DescribeParametersRequest request)
AWSSimpleSystemsManagementAsync
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
describeParametersAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeParametersResult> describeParametersAsync(DescribeParametersRequest request, AsyncHandler<DescribeParametersRequest,DescribeParametersResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
describeParametersAsync
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 Future<DescribePatchBaselinesResult> describePatchBaselinesAsync(DescribePatchBaselinesRequest request)
AWSSimpleSystemsManagementAsync
Lists the patch baselines in your AWS account.
describePatchBaselinesAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribePatchBaselinesResult> describePatchBaselinesAsync(DescribePatchBaselinesRequest request, AsyncHandler<DescribePatchBaselinesRequest,DescribePatchBaselinesResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the patch baselines in your AWS account.
describePatchBaselinesAsync
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 Future<DescribePatchGroupStateResult> describePatchGroupStateAsync(DescribePatchGroupStateRequest request)
AWSSimpleSystemsManagementAsync
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupStateAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribePatchGroupStateResult> describePatchGroupStateAsync(DescribePatchGroupStateRequest request, AsyncHandler<DescribePatchGroupStateRequest,DescribePatchGroupStateResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupStateAsync
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 Future<DescribePatchGroupsResult> describePatchGroupsAsync(DescribePatchGroupsRequest request)
AWSSimpleSystemsManagementAsync
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribePatchGroupsResult> describePatchGroupsAsync(DescribePatchGroupsRequest request, AsyncHandler<DescribePatchGroupsRequest,DescribePatchGroupsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsAsync
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 Future<DescribePatchPropertiesResult> describePatchPropertiesAsync(DescribePatchPropertiesRequest request)
AWSSimpleSystemsManagementAsync
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
describePatchPropertiesAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribePatchPropertiesResult> describePatchPropertiesAsync(DescribePatchPropertiesRequest request, AsyncHandler<DescribePatchPropertiesRequest,DescribePatchPropertiesResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
describePatchPropertiesAsync
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 Future<DescribeSessionsResult> describeSessionsAsync(DescribeSessionsRequest request)
AWSSimpleSystemsManagementAsync
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<DescribeSessionsResult> describeSessionsAsync(DescribeSessionsRequest request, AsyncHandler<DescribeSessionsRequest,DescribeSessionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessionsAsync
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 Future<GetAutomationExecutionResult> getAutomationExecutionAsync(GetAutomationExecutionRequest request)
AWSSimpleSystemsManagementAsync
Get detailed information about a particular Automation execution.
getAutomationExecutionAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetAutomationExecutionResult> getAutomationExecutionAsync(GetAutomationExecutionRequest request, AsyncHandler<GetAutomationExecutionRequest,GetAutomationExecutionResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Get detailed information about a particular Automation execution.
getAutomationExecutionAsync
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 Future<GetCalendarStateResult> getCalendarStateAsync(GetCalendarStateRequest request)
AWSSimpleSystemsManagementAsync
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at a specific time, and returns the next time
that the Change Calendar state will transition. If you do not specify a time, GetCalendarState
assumes the current time. Change Calendar entries have two possible states: OPEN
or
CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
getCalendarStateAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetCalendarStateResult> getCalendarStateAsync(GetCalendarStateRequest request, AsyncHandler<GetCalendarStateRequest,GetCalendarStateResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at a specific time, and returns the next time
that the Change Calendar state will transition. If you do not specify a time, GetCalendarState
assumes the current time. Change Calendar entries have two possible states: OPEN
or
CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
getCalendarStateAsync
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 Future<GetCommandInvocationResult> getCommandInvocationAsync(GetCommandInvocationRequest request)
AWSSimpleSystemsManagementAsync
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocationAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetCommandInvocationResult> getCommandInvocationAsync(GetCommandInvocationRequest request, AsyncHandler<GetCommandInvocationRequest,GetCommandInvocationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocationAsync
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 Future<GetConnectionStatusResult> getConnectionStatusAsync(GetConnectionStatusRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatusAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetConnectionStatusResult> getConnectionStatusAsync(GetConnectionStatusRequest request, AsyncHandler<GetConnectionStatusRequest,GetConnectionStatusResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatusAsync
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 Future<GetDefaultPatchBaselineResult> getDefaultPatchBaselineAsync(GetDefaultPatchBaselineRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetDefaultPatchBaselineResult> getDefaultPatchBaselineAsync(GetDefaultPatchBaselineRequest request, AsyncHandler<GetDefaultPatchBaselineRequest,GetDefaultPatchBaselineResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineAsync
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 Future<GetDeployablePatchSnapshotForInstanceResult> getDeployablePatchSnapshotForInstanceAsync(GetDeployablePatchSnapshotForInstanceRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstanceAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetDeployablePatchSnapshotForInstanceResult> getDeployablePatchSnapshotForInstanceAsync(GetDeployablePatchSnapshotForInstanceRequest request, AsyncHandler<GetDeployablePatchSnapshotForInstanceRequest,GetDeployablePatchSnapshotForInstanceResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstanceAsync
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 Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request)
AWSSimpleSystemsManagementAsync
Gets the contents of the specified Systems Manager document.
getDocumentAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Gets the contents of the specified Systems Manager 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 Future<GetInventoryResult> getInventoryAsync(GetInventoryRequest request)
AWSSimpleSystemsManagementAsync
Query inventory information.
getInventoryAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetInventoryResult> getInventoryAsync(GetInventoryRequest request, AsyncHandler<GetInventoryRequest,GetInventoryResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Query inventory information.
getInventoryAsync
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 Future<GetInventorySchemaResult> getInventorySchemaAsync(GetInventorySchemaRequest request)
AWSSimpleSystemsManagementAsync
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchemaAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetInventorySchemaResult> getInventorySchemaAsync(GetInventorySchemaRequest request, AsyncHandler<GetInventorySchemaRequest,GetInventorySchemaResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchemaAsync
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 Future<GetMaintenanceWindowResult> getMaintenanceWindowAsync(GetMaintenanceWindowRequest request)
AWSSimpleSystemsManagementAsync
Retrieves a maintenance window.
getMaintenanceWindowAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetMaintenanceWindowResult> getMaintenanceWindowAsync(GetMaintenanceWindowRequest request, AsyncHandler<GetMaintenanceWindowRequest,GetMaintenanceWindowResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves a maintenance window.
getMaintenanceWindowAsync
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 Future<GetMaintenanceWindowExecutionResult> getMaintenanceWindowExecutionAsync(GetMaintenanceWindowExecutionRequest request)
AWSSimpleSystemsManagementAsync
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetMaintenanceWindowExecutionResult> getMaintenanceWindowExecutionAsync(GetMaintenanceWindowExecutionRequest request, AsyncHandler<GetMaintenanceWindowExecutionRequest,GetMaintenanceWindowExecutionResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionAsync
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 Future<GetMaintenanceWindowExecutionTaskResult> getMaintenanceWindowExecutionTaskAsync(GetMaintenanceWindowExecutionTaskRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetMaintenanceWindowExecutionTaskResult> getMaintenanceWindowExecutionTaskAsync(GetMaintenanceWindowExecutionTaskRequest request, AsyncHandler<GetMaintenanceWindowExecutionTaskRequest,GetMaintenanceWindowExecutionTaskResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskAsync
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 Future<GetMaintenanceWindowExecutionTaskInvocationResult> getMaintenanceWindowExecutionTaskInvocationAsync(GetMaintenanceWindowExecutionTaskInvocationRequest request)
AWSSimpleSystemsManagementAsync
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocationAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetMaintenanceWindowExecutionTaskInvocationResult> getMaintenanceWindowExecutionTaskInvocationAsync(GetMaintenanceWindowExecutionTaskInvocationRequest request, AsyncHandler<GetMaintenanceWindowExecutionTaskInvocationRequest,GetMaintenanceWindowExecutionTaskInvocationResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocationAsync
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 Future<GetMaintenanceWindowTaskResult> getMaintenanceWindowTaskAsync(GetMaintenanceWindowTaskRequest request)
AWSSimpleSystemsManagementAsync
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
getMaintenanceWindowTaskAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetMaintenanceWindowTaskResult> getMaintenanceWindowTaskAsync(GetMaintenanceWindowTaskRequest request, AsyncHandler<GetMaintenanceWindowTaskRequest,GetMaintenanceWindowTaskResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
getMaintenanceWindowTaskAsync
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 Future<GetOpsItemResult> getOpsItemAsync(GetOpsItemRequest request)
AWSSimpleSystemsManagementAsync
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
getOpsItemAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetOpsItemResult> getOpsItemAsync(GetOpsItemRequest request, AsyncHandler<GetOpsItemRequest,GetOpsItemResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
getOpsItemAsync
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 Future<GetOpsMetadataResult> getOpsMetadataAsync(GetOpsMetadataRequest request)
AWSSimpleSystemsManagementAsync
View operational metadata related to an application in Application Manager.
getOpsMetadataAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetOpsMetadataResult> getOpsMetadataAsync(GetOpsMetadataRequest request, AsyncHandler<GetOpsMetadataRequest,GetOpsMetadataResult> asyncHandler)
AWSSimpleSystemsManagementAsync
View operational metadata related to an application in Application Manager.
getOpsMetadataAsync
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 Future<GetOpsSummaryResult> getOpsSummaryAsync(GetOpsSummaryRequest request)
AWSSimpleSystemsManagementAsync
View a summary of OpsItems based on specified filters and aggregators.
getOpsSummaryAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetOpsSummaryResult> getOpsSummaryAsync(GetOpsSummaryRequest request, AsyncHandler<GetOpsSummaryRequest,GetOpsSummaryResult> asyncHandler)
AWSSimpleSystemsManagementAsync
View a summary of OpsItems based on specified filters and aggregators.
getOpsSummaryAsync
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 Future<GetParameterResult> getParameterAsync(GetParameterRequest request)
AWSSimpleSystemsManagementAsync
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameterAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetParameterResult> getParameterAsync(GetParameterRequest request, AsyncHandler<GetParameterRequest,GetParameterResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameterAsync
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 Future<GetParameterHistoryResult> getParameterHistoryAsync(GetParameterHistoryRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the history of all changes to a parameter.
getParameterHistoryAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetParameterHistoryResult> getParameterHistoryAsync(GetParameterHistoryRequest request, AsyncHandler<GetParameterHistoryRequest,GetParameterHistoryResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the history of all changes to a parameter.
getParameterHistoryAsync
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 Future<GetParametersResult> getParametersAsync(GetParametersRequest request)
AWSSimpleSystemsManagementAsync
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
getParametersAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetParametersResult> getParametersAsync(GetParametersRequest request, AsyncHandler<GetParametersRequest,GetParametersResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
getParametersAsync
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 Future<GetParametersByPathResult> getParametersByPathAsync(GetParametersByPathRequest request)
AWSSimpleSystemsManagementAsync
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
getParametersByPathAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetParametersByPathResult> getParametersByPathAsync(GetParametersByPathRequest request, AsyncHandler<GetParametersByPathRequest,GetParametersByPathResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
getParametersByPathAsync
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 Future<GetPatchBaselineResult> getPatchBaselineAsync(GetPatchBaselineRequest request)
AWSSimpleSystemsManagementAsync
Retrieves information about a patch baseline.
getPatchBaselineAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetPatchBaselineResult> getPatchBaselineAsync(GetPatchBaselineRequest request, AsyncHandler<GetPatchBaselineRequest,GetPatchBaselineResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves information about a patch baseline.
getPatchBaselineAsync
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 Future<GetPatchBaselineForPatchGroupResult> getPatchBaselineForPatchGroupAsync(GetPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagementAsync
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupAsync
in interface AWSSimpleSystemsManagementAsync
public Future<GetPatchBaselineForPatchGroupResult> getPatchBaselineForPatchGroupAsync(GetPatchBaselineForPatchGroupRequest request, AsyncHandler<GetPatchBaselineForPatchGroupRequest,GetPatchBaselineForPatchGroupResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupAsync
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 Future<GetServiceSettingResult> getServiceSettingAsync(GetServiceSettingRequest request)
AWSSimpleSystemsManagementAsync
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
getServiceSettingAsync
in interface AWSSimpleSystemsManagementAsync
request
- The request body of the GetServiceSetting API action.public Future<GetServiceSettingResult> getServiceSettingAsync(GetServiceSettingRequest request, AsyncHandler<GetServiceSettingRequest,GetServiceSettingResult> asyncHandler)
AWSSimpleSystemsManagementAsync
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
getServiceSettingAsync
in interface AWSSimpleSystemsManagementAsync
request
- The request body of the GetServiceSetting API action.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 Future<LabelParameterVersionResult> labelParameterVersionAsync(LabelParameterVersionRequest request)
AWSSimpleSystemsManagementAsync
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
labelParameterVersionAsync
in interface AWSSimpleSystemsManagementAsync
public Future<LabelParameterVersionResult> labelParameterVersionAsync(LabelParameterVersionRequest request, AsyncHandler<LabelParameterVersionRequest,LabelParameterVersionResult> asyncHandler)
AWSSimpleSystemsManagementAsync
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
labelParameterVersionAsync
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 Future<ListAssociationVersionsResult> listAssociationVersionsAsync(ListAssociationVersionsRequest request)
AWSSimpleSystemsManagementAsync
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListAssociationVersionsResult> listAssociationVersionsAsync(ListAssociationVersionsRequest request, AsyncHandler<ListAssociationVersionsRequest,ListAssociationVersionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsAsync
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 Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request)
AWSSimpleSystemsManagementAsync
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
listAssociationsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest request, AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
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 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 runs 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 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 runs 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 Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest request)
AWSSimpleSystemsManagementAsync
Lists the commands requested by users of the AWS account.
listCommandsAsync
in interface AWSSimpleSystemsManagementAsync
public 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 Future<ListComplianceItemsResult> listComplianceItemsAsync(ListComplianceItemsRequest request)
AWSSimpleSystemsManagementAsync
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItemsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListComplianceItemsResult> listComplianceItemsAsync(ListComplianceItemsRequest request, AsyncHandler<ListComplianceItemsRequest,ListComplianceItemsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItemsAsync
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 Future<ListComplianceSummariesResult> listComplianceSummariesAsync(ListComplianceSummariesRequest request)
AWSSimpleSystemsManagementAsync
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
listComplianceSummariesAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListComplianceSummariesResult> listComplianceSummariesAsync(ListComplianceSummariesRequest request, AsyncHandler<ListComplianceSummariesRequest,ListComplianceSummariesResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
listComplianceSummariesAsync
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 Future<ListDocumentMetadataHistoryResult> listDocumentMetadataHistoryAsync(ListDocumentMetadataHistoryRequest request)
AWSSimpleSystemsManagementAsync
Information about approval reviews for a version of an SSM document.
listDocumentMetadataHistoryAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListDocumentMetadataHistoryResult> listDocumentMetadataHistoryAsync(ListDocumentMetadataHistoryRequest request, AsyncHandler<ListDocumentMetadataHistoryRequest,ListDocumentMetadataHistoryResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Information about approval reviews for a version of an SSM document.
listDocumentMetadataHistoryAsync
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 Future<ListDocumentVersionsResult> listDocumentVersionsAsync(ListDocumentVersionsRequest request)
AWSSimpleSystemsManagementAsync
List all versions for a document.
listDocumentVersionsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListDocumentVersionsResult> listDocumentVersionsAsync(ListDocumentVersionsRequest request, AsyncHandler<ListDocumentVersionsRequest,ListDocumentVersionsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
List all versions for a document.
listDocumentVersionsAsync
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 Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request)
AWSSimpleSystemsManagementAsync
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
listDocumentsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
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 Future<ListDocumentsResult> listDocumentsAsync()
listDocumentsAsync
in interface AWSSimpleSystemsManagementAsync
listDocumentsAsync(ListDocumentsRequest)
public Future<ListDocumentsResult> listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
listDocumentsAsync
in interface AWSSimpleSystemsManagementAsync
listDocumentsAsync(ListDocumentsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListInventoryEntriesResult> listInventoryEntriesAsync(ListInventoryEntriesRequest request)
AWSSimpleSystemsManagementAsync
A list of inventory items returned by the request.
listInventoryEntriesAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListInventoryEntriesResult> listInventoryEntriesAsync(ListInventoryEntriesRequest request, AsyncHandler<ListInventoryEntriesRequest,ListInventoryEntriesResult> asyncHandler)
AWSSimpleSystemsManagementAsync
A list of inventory items returned by the request.
listInventoryEntriesAsync
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 Future<ListOpsItemEventsResult> listOpsItemEventsAsync(ListOpsItemEventsRequest request)
AWSSimpleSystemsManagementAsync
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsItemEventsAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListOpsItemEventsResult> listOpsItemEventsAsync(ListOpsItemEventsRequest request, AsyncHandler<ListOpsItemEventsRequest,ListOpsItemEventsResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsItemEventsAsync
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 Future<ListOpsMetadataResult> listOpsMetadataAsync(ListOpsMetadataRequest request)
AWSSimpleSystemsManagementAsync
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadataAsync
in interface AWSSimpleSystemsManagementAsync
public Future<ListOpsMetadataResult> listOpsMetadataAsync(ListOpsMetadataRequest request, AsyncHandler<ListOpsMetadataRequest,ListOpsMetadataResult> asyncHandler)
AWSSimpleSystemsManagementAsync
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadataAsync
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 Future<ListResourceComplianceSummariesResult> listResourceComplianceSummariesAsync(ListResourceComplianceSummariesRequest request)