@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSimpleSystemsManagementAsync extends AWSSimpleSystemsManagement
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSimpleSystemsManagementAsync
instead.
Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
Related resources
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .
ENDPOINT_PREFIX
addTagsToResource, associateOpsItemRelatedItem, cancelCommand, cancelMaintenanceWindowExecution, createActivation, createAssociation, createAssociationBatch, createDocument, createMaintenanceWindow, createOpsItem, createOpsMetadata, createPatchBaseline, createResourceDataSync, deleteActivation, deleteAssociation, deleteDocument, deleteInventory, deleteMaintenanceWindow, deleteOpsItem, deleteOpsMetadata, deleteParameter, deleteParameters, deletePatchBaseline, deleteResourceDataSync, deleteResourcePolicy, deregisterManagedInstance, deregisterPatchBaselineForPatchGroup, deregisterTargetFromMaintenanceWindow, deregisterTaskFromMaintenanceWindow, describeActivations, describeAssociation, describeAssociationExecutions, describeAssociationExecutionTargets, describeAutomationExecutions, describeAutomationStepExecutions, describeAvailablePatches, describeDocument, describeDocumentPermission, describeEffectiveInstanceAssociations, describeEffectivePatchesForPatchBaseline, describeInstanceAssociationsStatus, describeInstanceInformation, describeInstancePatches, describeInstancePatchStates, describeInstancePatchStatesForPatchGroup, describeInstanceProperties, describeInventoryDeletions, describeMaintenanceWindowExecutions, describeMaintenanceWindowExecutionTaskInvocations, describeMaintenanceWindowExecutionTasks, describeMaintenanceWindows, describeMaintenanceWindowSchedule, describeMaintenanceWindowsForTarget, describeMaintenanceWindowTargets, describeMaintenanceWindowTasks, describeOpsItems, describeParameters, describePatchBaselines, describePatchGroups, describePatchGroupState, describePatchProperties, describeSessions, disassociateOpsItemRelatedItem, getAutomationExecution, getCachedResponseMetadata, getCalendarState, getCommandInvocation, getConnectionStatus, getDefaultPatchBaseline, getDeployablePatchSnapshotForInstance, getDocument, getInventory, getInventorySchema, getMaintenanceWindow, getMaintenanceWindowExecution, getMaintenanceWindowExecutionTask, getMaintenanceWindowExecutionTaskInvocation, getMaintenanceWindowTask, getOpsItem, getOpsMetadata, getOpsSummary, getParameter, getParameterHistory, getParameters, getParametersByPath, getPatchBaseline, getPatchBaselineForPatchGroup, getResourcePolicies, getServiceSetting, labelParameterVersion, listAssociations, listAssociationVersions, listCommandInvocations, listCommands, listComplianceItems, listComplianceSummaries, listDocumentMetadataHistory, listDocuments, listDocuments, listDocumentVersions, listInventoryEntries, listOpsItemEvents, listOpsItemRelatedItems, listOpsMetadata, listResourceComplianceSummaries, listResourceDataSync, listTagsForResource, modifyDocumentPermission, putComplianceItems, putInventory, putParameter, putResourcePolicy, registerDefaultPatchBaseline, registerPatchBaselineForPatchGroup, registerTargetWithMaintenanceWindow, registerTaskWithMaintenanceWindow, removeTagsFromResource, resetServiceSetting, resumeSession, sendAutomationSignal, sendCommand, setEndpoint, setRegion, shutdown, startAssociationsOnce, startAutomationExecution, startChangeRequestExecution, startSession, stopAutomationExecution, terminateSession, unlabelParameterVersion, updateAssociation, updateAssociationStatus, updateDocument, updateDocumentDefaultVersion, updateDocumentMetadata, updateMaintenanceWindow, updateMaintenanceWindowTarget, updateMaintenanceWindowTask, updateManagedInstanceRole, updateOpsItem, updateOpsMetadata, updatePatchBaseline, updateResourceDataSync, updateServiceSetting, waiters
Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, 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 nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 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 Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceRequest
- Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, 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 nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 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 Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceRequest
- 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.Future<AssociateOpsItemRelatedItemResult> associateOpsItemRelatedItemAsync(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest)
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
associateOpsItemRelatedItemRequest
- Future<AssociateOpsItemRelatedItemResult> associateOpsItemRelatedItemAsync(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest, AsyncHandler<AssociateOpsItemRelatedItemRequest,AssociateOpsItemRelatedItemResult> asyncHandler)
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
associateOpsItemRelatedItemRequest
- 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.Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest cancelCommandRequest)
Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelCommandRequest
- Future<CancelCommandResult> cancelCommandAsync(CancelCommandRequest cancelCommandRequest, AsyncHandler<CancelCommandRequest,CancelCommandResult> asyncHandler)
Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelCommandRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelMaintenanceWindowExecutionResult> cancelMaintenanceWindowExecutionAsync(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.
cancelMaintenanceWindowExecutionRequest
- Future<CancelMaintenanceWindowExecutionResult> cancelMaintenanceWindowExecutionAsync(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest, AsyncHandler<CancelMaintenanceWindowExecutionRequest,CancelMaintenanceWindowExecutionResult> asyncHandler)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.
cancelMaintenanceWindowExecutionRequest
- 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.Future<CreateActivationResult> createActivationAsync(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services 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 machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
createActivationRequest
- Future<CreateActivationResult> createActivationAsync(CreateActivationRequest createActivationRequest, AsyncHandler<CreateActivationRequest,CreateActivationResult> asyncHandler)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services 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 machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
createActivationRequest
- 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.Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, 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 Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes 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 isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
createAssociationRequest
- Future<CreateAssociationResult> createAssociationAsync(CreateAssociationRequest createAssociationRequest, AsyncHandler<CreateAssociationRequest,CreateAssociationResult> asyncHandler)
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, 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 Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes 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 isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
createAssociationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.
If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatchRequest
- Future<CreateAssociationBatchResult> createAssociationBatchAsync(CreateAssociationBatchRequest createAssociationBatchRequest, AsyncHandler<CreateAssociationBatchRequest,CreateAssociationBatchResult> asyncHandler)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.
If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatchRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest createDocumentRequest)
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
createDocumentRequest
- Future<CreateDocumentResult> createDocumentAsync(CreateDocumentRequest createDocumentRequest, AsyncHandler<CreateDocumentRequest,CreateDocumentResult> asyncHandler)
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
createDocumentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateMaintenanceWindowResult> createMaintenanceWindowAsync(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
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.
createMaintenanceWindowRequest
- Future<CreateMaintenanceWindowResult> createMaintenanceWindowAsync(CreateMaintenanceWindowRequest createMaintenanceWindowRequest, AsyncHandler<CreateMaintenanceWindowRequest,CreateMaintenanceWindowResult> asyncHandler)
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.
createMaintenanceWindowRequest
- 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.Future<CreateOpsItemResult> createOpsItemAsync(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
createOpsItemRequest
- Future<CreateOpsItemResult> createOpsItemAsync(CreateOpsItemRequest createOpsItemRequest, AsyncHandler<CreateOpsItemRequest,CreateOpsItemResult> asyncHandler)
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
createOpsItemRequest
- 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.Future<CreateOpsMetadataResult> createOpsMetadataAsync(CreateOpsMetadataRequest createOpsMetadataRequest)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
createOpsMetadataRequest
- Future<CreateOpsMetadataResult> createOpsMetadataAsync(CreateOpsMetadataRequest createOpsMetadataRequest, AsyncHandler<CreateOpsMetadataRequest,CreateOpsMetadataResult> asyncHandler)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
createOpsMetadataRequest
- 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.Future<CreatePatchBaselineResult> createPatchBaselineAsync(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
For information about valid key-value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaselineRequest
- Future<CreatePatchBaselineResult> createPatchBaselineAsync(CreatePatchBaselineRequest createPatchBaselineRequest, AsyncHandler<CreatePatchBaselineRequest,CreatePatchBaselineResult> asyncHandler)
Creates a patch baseline.
For information about valid key-value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaselineRequest
- 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.Future<CreateResourceDataSyncResult> createResourceDataSyncAsync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services 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 Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3)
bucket. For more information, see Configuring
resource data sync for Inventory in the Amazon Web Services 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 Amazon Web Services Regions to a single Amazon
S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon
Web Services Regions or EntireOrganization
by using Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services
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 isn't 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.
createResourceDataSyncRequest
- Future<CreateResourceDataSyncResult> createResourceDataSyncAsync(CreateResourceDataSyncRequest createResourceDataSyncRequest, AsyncHandler<CreateResourceDataSyncRequest,CreateResourceDataSyncResult> asyncHandler)
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services 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 Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3)
bucket. For more information, see Configuring
resource data sync for Inventory in the Amazon Web Services 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 Amazon Web Services Regions to a single Amazon
S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon
Web Services Regions or EntireOrganization
by using Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services
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 isn't 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.
createResourceDataSyncRequest
- 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.Future<DeleteActivationResult> deleteActivationAsync(DeleteActivationRequest deleteActivationRequest)
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
deleteActivationRequest
- Future<DeleteActivationResult> deleteActivationAsync(DeleteActivationRequest deleteActivationRequest, AsyncHandler<DeleteActivationRequest,DeleteActivationResult> asyncHandler)
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
deleteActivationRequest
- 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.Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified
managed node. If you created the association by using the Targets
parameter, then you must delete
the association by using the association ID.
When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
deleteAssociationRequest
- Future<DeleteAssociationResult> deleteAssociationAsync(DeleteAssociationRequest deleteAssociationRequest, AsyncHandler<DeleteAssociationRequest,DeleteAssociationResult> asyncHandler)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified
managed node. If you created the association by using the Targets
parameter, then you must delete
the association by using the association ID.
When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
deleteAssociationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
deleteDocumentRequest
- Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest deleteDocumentRequest, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
deleteDocumentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteInventoryResult> deleteInventoryAsync(DeleteInventoryRequest deleteInventoryRequest)
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.
deleteInventoryRequest
- Future<DeleteInventoryResult> deleteInventoryAsync(DeleteInventoryRequest deleteInventoryRequest, AsyncHandler<DeleteInventoryRequest,DeleteInventoryResult> asyncHandler)
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.
deleteInventoryRequest
- 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.Future<DeleteMaintenanceWindowResult> deleteMaintenanceWindowAsync(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a maintenance window.
deleteMaintenanceWindowRequest
- Future<DeleteMaintenanceWindowResult> deleteMaintenanceWindowAsync(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest, AsyncHandler<DeleteMaintenanceWindowRequest,DeleteMaintenanceWindowResult> asyncHandler)
Deletes a maintenance window.
deleteMaintenanceWindowRequest
- 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.Future<DeleteOpsItemResult> deleteOpsItemAsync(DeleteOpsItemRequest deleteOpsItemRequest)
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Note the following important information about this operation.
Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.
This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.
This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.
This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.
deleteOpsItemRequest
- Future<DeleteOpsItemResult> deleteOpsItemAsync(DeleteOpsItemRequest deleteOpsItemRequest, AsyncHandler<DeleteOpsItemRequest,DeleteOpsItemResult> asyncHandler)
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Note the following important information about this operation.
Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.
This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.
This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.
This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.
deleteOpsItemRequest
- 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.Future<DeleteOpsMetadataResult> deleteOpsMetadataAsync(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
deleteOpsMetadataRequest
- Future<DeleteOpsMetadataResult> deleteOpsMetadataAsync(DeleteOpsMetadataRequest deleteOpsMetadataRequest, AsyncHandler<DeleteOpsMetadataRequest,DeleteOpsMetadataResult> asyncHandler)
Delete OpsMetadata related to an application.
deleteOpsMetadataRequest
- 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.Future<DeleteParameterResult> deleteParameterAsync(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParameterRequest
- Future<DeleteParameterResult> deleteParameterAsync(DeleteParameterRequest deleteParameterRequest, AsyncHandler<DeleteParameterRequest,DeleteParameterResult> asyncHandler)
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParameterRequest
- 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.Future<DeleteParametersResult> deleteParametersAsync(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParametersRequest
- Future<DeleteParametersResult> deleteParametersAsync(DeleteParametersRequest deleteParametersRequest, AsyncHandler<DeleteParametersRequest,DeleteParametersResult> asyncHandler)
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParametersRequest
- 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.Future<DeletePatchBaselineResult> deletePatchBaselineAsync(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
deletePatchBaselineRequest
- Future<DeletePatchBaselineResult> deletePatchBaselineAsync(DeletePatchBaselineRequest deletePatchBaselineRequest, AsyncHandler<DeletePatchBaselineRequest,DeletePatchBaselineResult> asyncHandler)
Deletes a patch baseline.
deletePatchBaselineRequest
- 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.Future<DeleteResourceDataSyncResult> deleteResourceDataSyncAsync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
deleteResourceDataSyncRequest
- Future<DeleteResourceDataSyncResult> deleteResourceDataSyncAsync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest, AsyncHandler<DeleteResourceDataSyncRequest,DeleteResourceDataSyncResult> asyncHandler)
Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
deleteResourceDataSyncRequest
- 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.Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
OpsItemGroup
- The resource policy for OpsItemGroup
enables Amazon Web Services
accounts to view and interact with OpsCenter operational work items (OpsItems).
Parameter
- The resource policy is used to share a parameter with other accounts using Resource
Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
deleteResourcePolicyRequest
- Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest, AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
OpsItemGroup
- The resource policy for OpsItemGroup
enables Amazon Web Services
accounts to view and interact with OpsCenter operational work items (OpsItems).
Parameter
- The resource policy is used to share a parameter with other accounts using Resource
Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
deleteResourcePolicyRequest
- 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.Future<DeregisterManagedInstanceResult> deregisterManagedInstanceAsync(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstanceRequest
- Future<DeregisterManagedInstanceResult> deregisterManagedInstanceAsync(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest, AsyncHandler<DeregisterManagedInstanceRequest,DeregisterManagedInstanceResult> asyncHandler)
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstanceRequest
- 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.Future<DeregisterPatchBaselineForPatchGroupResult> deregisterPatchBaselineForPatchGroupAsync(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroupRequest
- Future<DeregisterPatchBaselineForPatchGroupResult> deregisterPatchBaselineForPatchGroupAsync(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest, AsyncHandler<DeregisterPatchBaselineForPatchGroupRequest,DeregisterPatchBaselineForPatchGroupResult> asyncHandler)
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroupRequest
- 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.Future<DeregisterTargetFromMaintenanceWindowResult> deregisterTargetFromMaintenanceWindowAsync(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindowRequest
- Future<DeregisterTargetFromMaintenanceWindowResult> deregisterTargetFromMaintenanceWindowAsync(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest, AsyncHandler<DeregisterTargetFromMaintenanceWindowRequest,DeregisterTargetFromMaintenanceWindowResult> asyncHandler)
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindowRequest
- 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.Future<DeregisterTaskFromMaintenanceWindowResult> deregisterTaskFromMaintenanceWindowAsync(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindowRequest
- Future<DeregisterTaskFromMaintenanceWindowResult> deregisterTaskFromMaintenanceWindowAsync(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest, AsyncHandler<DeregisterTaskFromMaintenanceWindowRequest,DeregisterTaskFromMaintenanceWindowResult> asyncHandler)
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindowRequest
- 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.Future<DescribeActivationsResult> describeActivationsAsync(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
describeActivationsRequest
- Future<DescribeActivationsResult> describeActivationsAsync(DescribeActivationsRequest describeActivationsRequest, AsyncHandler<DescribeActivationsRequest,DescribeActivationsResult> asyncHandler)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
describeActivationsRequest
- 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.Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or managed node. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID.
describeAssociationRequest
- Future<DescribeAssociationResult> describeAssociationAsync(DescribeAssociationRequest describeAssociationRequest, AsyncHandler<DescribeAssociationRequest,DescribeAssociationResult> asyncHandler)
Describes the association for the specified target or managed node. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID.
describeAssociationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAssociationExecutionTargetsResult> describeAssociationExecutionTargetsAsync(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Views information about a specific execution of a specific association.
describeAssociationExecutionTargetsRequest
- Future<DescribeAssociationExecutionTargetsResult> describeAssociationExecutionTargetsAsync(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest, AsyncHandler<DescribeAssociationExecutionTargetsRequest,DescribeAssociationExecutionTargetsResult> asyncHandler)
Views information about a specific execution of a specific association.
describeAssociationExecutionTargetsRequest
- 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.Future<DescribeAssociationExecutionsResult> describeAssociationExecutionsAsync(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Views all executions for a specific association ID.
describeAssociationExecutionsRequest
- Future<DescribeAssociationExecutionsResult> describeAssociationExecutionsAsync(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest, AsyncHandler<DescribeAssociationExecutionsRequest,DescribeAssociationExecutionsResult> asyncHandler)
Views all executions for a specific association ID.
describeAssociationExecutionsRequest
- 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.Future<DescribeAutomationExecutionsResult> describeAutomationExecutionsAsync(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest
- Future<DescribeAutomationExecutionsResult> describeAutomationExecutionsAsync(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest, AsyncHandler<DescribeAutomationExecutionsRequest,DescribeAutomationExecutionsResult> asyncHandler)
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest
- 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.Future<DescribeAutomationStepExecutionsResult> describeAutomationStepExecutionsAsync(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutionsRequest
- Future<DescribeAutomationStepExecutionsResult> describeAutomationStepExecutionsAsync(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest, AsyncHandler<DescribeAutomationStepExecutionsRequest,DescribeAutomationStepExecutionsResult> asyncHandler)
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutionsRequest
- 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.Future<DescribeAvailablePatchesResult> describeAvailablePatchesAsync(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
Currently, DescribeAvailablePatches
supports only the Amazon Linux 1, Amazon Linux 2, and Windows
Server operating systems.
describeAvailablePatchesRequest
- Future<DescribeAvailablePatchesResult> describeAvailablePatchesAsync(DescribeAvailablePatchesRequest describeAvailablePatchesRequest, AsyncHandler<DescribeAvailablePatchesRequest,DescribeAvailablePatchesResult> asyncHandler)
Lists all patches eligible to be included in a patch baseline.
Currently, DescribeAvailablePatches
supports only the Amazon Linux 1, Amazon Linux 2, and Windows
Server operating systems.
describeAvailablePatchesRequest
- 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.Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Amazon Web Services Systems Manager document (SSM document).
describeDocumentRequest
- Future<DescribeDocumentResult> describeDocumentAsync(DescribeDocumentRequest describeDocumentRequest, AsyncHandler<DescribeDocumentRequest,DescribeDocumentResult> asyncHandler)
Describes the specified Amazon Web Services Systems Manager document (SSM document).
describeDocumentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
describeDocumentPermissionRequest
- Future<DescribeDocumentPermissionResult> describeDocumentPermissionAsync(DescribeDocumentPermissionRequest describeDocumentPermissionRequest, AsyncHandler<DescribeDocumentPermissionRequest,DescribeDocumentPermissionResult> asyncHandler)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
describeDocumentPermissionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEffectiveInstanceAssociationsResult> describeEffectiveInstanceAssociationsAsync(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the managed nodes.
describeEffectiveInstanceAssociationsRequest
- Future<DescribeEffectiveInstanceAssociationsResult> describeEffectiveInstanceAssociationsAsync(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest, AsyncHandler<DescribeEffectiveInstanceAssociationsRequest,DescribeEffectiveInstanceAssociationsResult> asyncHandler)
All associations for the managed nodes.
describeEffectiveInstanceAssociationsRequest
- 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.Future<DescribeEffectivePatchesForPatchBaselineResult> describeEffectivePatchesForPatchBaselineAsync(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
describeEffectivePatchesForPatchBaselineRequest
- Future<DescribeEffectivePatchesForPatchBaselineResult> describeEffectivePatchesForPatchBaselineAsync(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest, AsyncHandler<DescribeEffectivePatchesForPatchBaselineRequest,DescribeEffectivePatchesForPatchBaselineResult> asyncHandler)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
describeEffectivePatchesForPatchBaselineRequest
- 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.Future<DescribeInstanceAssociationsStatusResult> describeInstanceAssociationsStatusAsync(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the managed nodes.
describeInstanceAssociationsStatusRequest
- Future<DescribeInstanceAssociationsStatusResult> describeInstanceAssociationsStatusAsync(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest, AsyncHandler<DescribeInstanceAssociationsStatusRequest,DescribeInstanceAssociationsStatusResult> asyncHandler)
The status of the associations for the managed nodes.
describeInstanceAssociationsStatusRequest
- 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.Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The IamRole
field returned for this API operation is the Identity and Access Management (IAM) role
assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.
describeInstanceInformationRequest
- Future<DescribeInstanceInformationResult> describeInstanceInformationAsync(DescribeInstanceInformationRequest describeInstanceInformationRequest, AsyncHandler<DescribeInstanceInformationRequest,DescribeInstanceInformationResult> asyncHandler)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The IamRole
field returned for this API operation is the Identity and Access Management (IAM) role
assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.
describeInstanceInformationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeInstancePatchStatesResult> describeInstancePatchStatesAsync(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more managed nodes.
describeInstancePatchStatesRequest
- Future<DescribeInstancePatchStatesResult> describeInstancePatchStatesAsync(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest, AsyncHandler<DescribeInstancePatchStatesRequest,DescribeInstancePatchStatesResult> asyncHandler)
Retrieves the high-level patch state of one or more managed nodes.
describeInstancePatchStatesRequest
- 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.Future<DescribeInstancePatchStatesForPatchGroupResult> describeInstancePatchStatesForPatchGroupAsync(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the managed nodes in the specified patch group.
describeInstancePatchStatesForPatchGroupRequest
- Future<DescribeInstancePatchStatesForPatchGroupResult> describeInstancePatchStatesForPatchGroupAsync(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest, AsyncHandler<DescribeInstancePatchStatesForPatchGroupRequest,DescribeInstancePatchStatesForPatchGroupResult> asyncHandler)
Retrieves the high-level patch state for the managed nodes in the specified patch group.
describeInstancePatchStatesForPatchGroupRequest
- 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.Future<DescribeInstancePatchesResult> describeInstancePatchesAsync(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
describeInstancePatchesRequest
- Future<DescribeInstancePatchesResult> describeInstancePatchesAsync(DescribeInstancePatchesRequest describeInstancePatchesRequest, AsyncHandler<DescribeInstancePatchesRequest,DescribeInstancePatchesResult> asyncHandler)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
describeInstancePatchesRequest
- 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.Future<DescribeInstancePropertiesResult> describeInstancePropertiesAsync(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
describeInstancePropertiesRequest
- Future<DescribeInstancePropertiesResult> describeInstancePropertiesAsync(DescribeInstancePropertiesRequest describeInstancePropertiesRequest, AsyncHandler<DescribeInstancePropertiesRequest,DescribeInstancePropertiesResult> asyncHandler)
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
describeInstancePropertiesRequest
- 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.Future<DescribeInventoryDeletionsResult> describeInventoryDeletionsAsync(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
describeInventoryDeletionsRequest
- Future<DescribeInventoryDeletionsResult> describeInventoryDeletionsAsync(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest, AsyncHandler<DescribeInventoryDeletionsRequest,DescribeInventoryDeletionsResult> asyncHandler)
Describes a specific delete inventory operation.
describeInventoryDeletionsRequest
- 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.Future<DescribeMaintenanceWindowExecutionTaskInvocationsResult> describeMaintenanceWindowExecutionTaskInvocationsAsync(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocationsRequest
- Future<DescribeMaintenanceWindowExecutionTaskInvocationsResult> describeMaintenanceWindowExecutionTaskInvocationsAsync(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest, AsyncHandler<DescribeMaintenanceWindowExecutionTaskInvocationsRequest,DescribeMaintenanceWindowExecutionTaskInvocationsResult> asyncHandler)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocationsRequest
- 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.Future<DescribeMaintenanceWindowExecutionTasksResult> describeMaintenanceWindowExecutionTasksAsync(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasksRequest
- Future<DescribeMaintenanceWindowExecutionTasksResult> describeMaintenanceWindowExecutionTasksAsync(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest, AsyncHandler<DescribeMaintenanceWindowExecutionTasksRequest,DescribeMaintenanceWindowExecutionTasksResult> asyncHandler)
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasksRequest
- 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.Future<DescribeMaintenanceWindowExecutionsResult> describeMaintenanceWindowExecutionsAsync(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
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.
describeMaintenanceWindowExecutionsRequest
- Future<DescribeMaintenanceWindowExecutionsResult> describeMaintenanceWindowExecutionsAsync(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest, AsyncHandler<DescribeMaintenanceWindowExecutionsRequest,DescribeMaintenanceWindowExecutionsResult> asyncHandler)
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.
describeMaintenanceWindowExecutionsRequest
- 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.Future<DescribeMaintenanceWindowScheduleResult> describeMaintenanceWindowScheduleAsync(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowScheduleRequest
- Future<DescribeMaintenanceWindowScheduleResult> describeMaintenanceWindowScheduleAsync(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest, AsyncHandler<DescribeMaintenanceWindowScheduleRequest,DescribeMaintenanceWindowScheduleResult> asyncHandler)
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowScheduleRequest
- 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.Future<DescribeMaintenanceWindowTargetsResult> describeMaintenanceWindowTargetsAsync(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargetsRequest
- Future<DescribeMaintenanceWindowTargetsResult> describeMaintenanceWindowTargetsAsync(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest, AsyncHandler<DescribeMaintenanceWindowTargetsRequest,DescribeMaintenanceWindowTargetsResult> asyncHandler)
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargetsRequest
- 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.Future<DescribeMaintenanceWindowTasksResult> describeMaintenanceWindowTasksAsync(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't 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 don't affect the running of your task and can be
ignored.
describeMaintenanceWindowTasksRequest
- Future<DescribeMaintenanceWindowTasksResult> describeMaintenanceWindowTasksAsync(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest, AsyncHandler<DescribeMaintenanceWindowTasksRequest,DescribeMaintenanceWindowTasksResult> asyncHandler)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't 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 don't affect the running of your task and can be
ignored.
describeMaintenanceWindowTasksRequest
- 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.Future<DescribeMaintenanceWindowsResult> describeMaintenanceWindowsAsync(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an Amazon Web Services account.
describeMaintenanceWindowsRequest
- Future<DescribeMaintenanceWindowsResult> describeMaintenanceWindowsAsync(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest, AsyncHandler<DescribeMaintenanceWindowsRequest,DescribeMaintenanceWindowsResult> asyncHandler)
Retrieves the maintenance windows in an Amazon Web Services account.
describeMaintenanceWindowsRequest
- 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.Future<DescribeMaintenanceWindowsForTargetResult> describeMaintenanceWindowsForTargetAsync(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
describeMaintenanceWindowsForTargetRequest
- Future<DescribeMaintenanceWindowsForTargetResult> describeMaintenanceWindowsForTargetAsync(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest, AsyncHandler<DescribeMaintenanceWindowsForTargetRequest,DescribeMaintenanceWindowsForTargetResult> asyncHandler)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
describeMaintenanceWindowsForTargetRequest
- 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.Future<DescribeOpsItemsResult> describeOpsItemsAsync(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
describeOpsItemsRequest
- Future<DescribeOpsItemsResult> describeOpsItemsAsync(DescribeOpsItemsRequest describeOpsItemsRequest, AsyncHandler<DescribeOpsItemsRequest,DescribeOpsItemsResult> asyncHandler)
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
describeOpsItemsRequest
- 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.Future<DescribeParametersResult> describeParametersAsync(DescribeParametersRequest describeParametersRequest)
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
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.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, DescribeParameters
retrieves whatever the
original key alias was referencing.
describeParametersRequest
- Future<DescribeParametersResult> describeParametersAsync(DescribeParametersRequest describeParametersRequest, AsyncHandler<DescribeParametersRequest,DescribeParametersResult> asyncHandler)
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
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.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, DescribeParameters
retrieves whatever the
original key alias was referencing.
describeParametersRequest
- 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.Future<DescribePatchBaselinesResult> describePatchBaselinesAsync(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your Amazon Web Services account.
describePatchBaselinesRequest
- Future<DescribePatchBaselinesResult> describePatchBaselinesAsync(DescribePatchBaselinesRequest describePatchBaselinesRequest, AsyncHandler<DescribePatchBaselinesRequest,DescribePatchBaselinesResult> asyncHandler)
Lists the patch baselines in your Amazon Web Services account.
describePatchBaselinesRequest
- 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.Future<DescribePatchGroupStateResult> describePatchGroupStateAsync(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state information for a patch group.
describePatchGroupStateRequest
- Future<DescribePatchGroupStateResult> describePatchGroupStateAsync(DescribePatchGroupStateRequest describePatchGroupStateRequest, AsyncHandler<DescribePatchGroupStateRequest,DescribePatchGroupStateResult> asyncHandler)
Returns high-level aggregated patch compliance state information for a patch group.
describePatchGroupStateRequest
- 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.Future<DescribePatchGroupsResult> describePatchGroupsAsync(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest
- Future<DescribePatchGroupsResult> describePatchGroupsAsync(DescribePatchGroupsRequest describePatchGroupsRequest, AsyncHandler<DescribePatchGroupsRequest,DescribePatchGroupsResult> asyncHandler)
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest
- 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.Future<DescribePatchPropertiesResult> describePatchPropertiesAsync(DescribePatchPropertiesRequest describePatchPropertiesRequest)
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 operations 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
describePatchPropertiesRequest
- Future<DescribePatchPropertiesResult> describePatchPropertiesAsync(DescribePatchPropertiesRequest describePatchPropertiesRequest, AsyncHandler<DescribePatchPropertiesRequest,DescribePatchPropertiesResult> asyncHandler)
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 operations 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
describePatchPropertiesRequest
- 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.Future<DescribeSessionsResult> describeSessionsAsync(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessionsRequest
- Future<DescribeSessionsResult> describeSessionsAsync(DescribeSessionsRequest describeSessionsRequest, AsyncHandler<DescribeSessionsRequest,DescribeSessionsResult> asyncHandler)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessionsRequest
- 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.Future<DisassociateOpsItemRelatedItemResult> disassociateOpsItemRelatedItemAsync(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest)
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
disassociateOpsItemRelatedItemRequest
- Future<DisassociateOpsItemRelatedItemResult> disassociateOpsItemRelatedItemAsync(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest, AsyncHandler<DisassociateOpsItemRelatedItemRequest,DisassociateOpsItemRelatedItemResult> asyncHandler)
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
disassociateOpsItemRelatedItemRequest
- 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.Future<GetAutomationExecutionResult> getAutomationExecutionAsync(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
getAutomationExecutionRequest
- Future<GetAutomationExecutionResult> getAutomationExecutionAsync(GetAutomationExecutionRequest getAutomationExecutionRequest, AsyncHandler<GetAutomationExecutionRequest,GetAutomationExecutionResult> asyncHandler)
Get detailed information about a particular Automation execution.
getAutomationExecutionRequest
- 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.Future<GetCalendarStateResult> getCalendarStateAsync(GetCalendarStateRequest getCalendarStateRequest)
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
If you specify a time, GetCalendarState
returns the state of the calendar at that specific time, and
returns the next time that the change calendar state will transition. If you don't specify a time,
GetCalendarState
uses 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 Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
getCalendarStateRequest
- Future<GetCalendarStateResult> getCalendarStateAsync(GetCalendarStateRequest getCalendarStateRequest, AsyncHandler<GetCalendarStateRequest,GetCalendarStateResult> asyncHandler)
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
If you specify a time, GetCalendarState
returns the state of the calendar at that specific time, and
returns the next time that the change calendar state will transition. If you don't specify a time,
GetCalendarState
uses 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 Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
getCalendarStateRequest
- 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.Future<GetCommandInvocationResult> getCommandInvocationAsync(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command
execution status on a specific managed node, use ListCommandInvocations. To get the command execution
status across managed nodes, use ListCommands.
getCommandInvocationRequest
- Future<GetCommandInvocationResult> getCommandInvocationAsync(GetCommandInvocationRequest getCommandInvocationRequest, AsyncHandler<GetCommandInvocationRequest,GetCommandInvocationResult> asyncHandler)
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command
execution status on a specific managed node, use ListCommandInvocations. To get the command execution
status across managed nodes, use ListCommands.
getCommandInvocationRequest
- 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.Future<GetConnectionStatusResult> getConnectionStatusAsync(GetConnectionStatusRequest getConnectionStatusRequest)
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatusRequest
- Future<GetConnectionStatusResult> getConnectionStatusAsync(GetConnectionStatusRequest getConnectionStatusRequest, AsyncHandler<GetConnectionStatusRequest,GetConnectionStatusResult> asyncHandler)
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatusRequest
- 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.Future<GetDefaultPatchBaselineResult> getDefaultPatchBaselineAsync(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineRequest
- Future<GetDefaultPatchBaselineResult> getDefaultPatchBaselineAsync(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest, AsyncHandler<GetDefaultPatchBaselineRequest,GetDefaultPatchBaselineResult> asyncHandler)
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineRequest
- 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.Future<GetDeployablePatchSnapshotForInstanceResult> getDeployablePatchSnapshotForInstanceAsync(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the
AWS-RunPatchBaseline
Systems Manager document (SSM document).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your
local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the
Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems
Manager, with an SSM document that enables you to target a managed node with a script or command. For example,
run the command using the AWS-RunShellScript
document or the AWS-RunPowerShellScript
document.
getDeployablePatchSnapshotForInstanceRequest
- Future<GetDeployablePatchSnapshotForInstanceResult> getDeployablePatchSnapshotForInstanceAsync(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest, AsyncHandler<GetDeployablePatchSnapshotForInstanceRequest,GetDeployablePatchSnapshotForInstanceResult> asyncHandler)
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the
AWS-RunPatchBaseline
Systems Manager document (SSM document).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your
local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the
Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems
Manager, with an SSM document that enables you to target a managed node with a script or command. For example,
run the command using the AWS-RunShellScript
document or the AWS-RunPowerShellScript
document.
getDeployablePatchSnapshotForInstanceRequest
- 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.Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
getDocumentRequest
- Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
getDocumentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetInventoryResult> getInventoryAsync(GetInventoryRequest getInventoryRequest)
Query inventory information. This includes managed node status, such as Stopped
or
Terminated
.
getInventoryRequest
- Future<GetInventoryResult> getInventoryAsync(GetInventoryRequest getInventoryRequest, AsyncHandler<GetInventoryRequest,GetInventoryResult> asyncHandler)
Query inventory information. This includes managed node status, such as Stopped
or
Terminated
.
getInventoryRequest
- 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.Future<GetInventorySchemaResult> getInventorySchemaAsync(GetInventorySchemaRequest getInventorySchemaRequest)
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchemaRequest
- Future<GetInventorySchemaResult> getInventorySchemaAsync(GetInventorySchemaRequest getInventorySchemaRequest, AsyncHandler<GetInventorySchemaRequest,GetInventorySchemaResult> asyncHandler)
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchemaRequest
- 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.Future<GetMaintenanceWindowResult> getMaintenanceWindowAsync(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a maintenance window.
getMaintenanceWindowRequest
- Future<GetMaintenanceWindowResult> getMaintenanceWindowAsync(GetMaintenanceWindowRequest getMaintenanceWindowRequest, AsyncHandler<GetMaintenanceWindowRequest,GetMaintenanceWindowResult> asyncHandler)
Retrieves a maintenance window.
getMaintenanceWindowRequest
- 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.Future<GetMaintenanceWindowExecutionResult> getMaintenanceWindowExecutionAsync(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionRequest
- Future<GetMaintenanceWindowExecutionResult> getMaintenanceWindowExecutionAsync(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest, AsyncHandler<GetMaintenanceWindowExecutionRequest,GetMaintenanceWindowExecutionResult> asyncHandler)
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionRequest
- 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.Future<GetMaintenanceWindowExecutionTaskResult> getMaintenanceWindowExecutionTaskAsync(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskRequest
- Future<GetMaintenanceWindowExecutionTaskResult> getMaintenanceWindowExecutionTaskAsync(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest, AsyncHandler<GetMaintenanceWindowExecutionTaskRequest,GetMaintenanceWindowExecutionTaskResult> asyncHandler)
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskRequest
- 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.Future<GetMaintenanceWindowExecutionTaskInvocationResult> getMaintenanceWindowExecutionTaskInvocationAsync(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocationRequest
- Future<GetMaintenanceWindowExecutionTaskInvocationResult> getMaintenanceWindowExecutionTaskInvocationAsync(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest, AsyncHandler<GetMaintenanceWindowExecutionTaskInvocationRequest,GetMaintenanceWindowExecutionTaskInvocationResult> asyncHandler)
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocationRequest
- 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.Future<GetMaintenanceWindowTaskResult> getMaintenanceWindowTaskAsync(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't 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 don't affect the running of your task and can be
ignored.
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
getMaintenanceWindowTaskRequest
- Future<GetMaintenanceWindowTaskResult> getMaintenanceWindowTaskAsync(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest, AsyncHandler<GetMaintenanceWindowTaskRequest,GetMaintenanceWindowTaskResult> asyncHandler)
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't 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 don't affect the running of your task and can be
ignored.
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
getMaintenanceWindowTaskRequest
- 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.Future<GetOpsItemResult> getOpsItemAsync(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
getOpsItemRequest
- Future<GetOpsItemResult> getOpsItemAsync(GetOpsItemRequest getOpsItemRequest, AsyncHandler<GetOpsItemRequest,GetOpsItemResult> asyncHandler)
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
getOpsItemRequest
- 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.Future<GetOpsMetadataResult> getOpsMetadataAsync(GetOpsMetadataRequest getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
getOpsMetadataRequest
- Future<GetOpsMetadataResult> getOpsMetadataAsync(GetOpsMetadataRequest getOpsMetadataRequest, AsyncHandler<GetOpsMetadataRequest,GetOpsMetadataResult> asyncHandler)
View operational metadata related to an application in Application Manager.
getOpsMetadataRequest
- 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.Future<GetOpsSummaryResult> getOpsSummaryAsync(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
getOpsSummaryRequest
- Future<GetOpsSummaryResult> getOpsSummaryAsync(GetOpsSummaryRequest getOpsSummaryRequest, AsyncHandler<GetOpsSummaryRequest,GetOpsSummaryResult> asyncHandler)
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
getOpsSummaryRequest
- 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.Future<GetParameterResult> getParameterAsync(GetParameterRequest getParameterRequest)
Get information about a single parameter by specifying the parameter name.
To get information about more than one parameter at a time, use the GetParameters operation.
getParameterRequest
- Future<GetParameterResult> getParameterAsync(GetParameterRequest getParameterRequest, AsyncHandler<GetParameterRequest,GetParameterResult> asyncHandler)
Get information about a single parameter by specifying the parameter name.
To get information about more than one parameter at a time, use the GetParameters operation.
getParameterRequest
- 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.Future<GetParameterHistoryResult> getParameterHistoryAsync(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, GetParameterHistory
retrieves whatever the
original key alias was referencing.
getParameterHistoryRequest
- Future<GetParameterHistoryResult> getParameterHistoryAsync(GetParameterHistoryRequest getParameterHistoryRequest, AsyncHandler<GetParameterHistoryRequest,GetParameterHistoryResult> asyncHandler)
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, GetParameterHistory
retrieves whatever the
original key alias was referencing.
getParameterHistoryRequest
- 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.Future<GetParametersResult> getParametersAsync(GetParametersRequest getParametersRequest)
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
getParametersRequest
- Future<GetParametersResult> getParametersAsync(GetParametersRequest getParametersRequest, AsyncHandler<GetParametersRequest,GetParametersResult> asyncHandler)
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
getParametersRequest
- 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.Future<GetParametersByPathResult> getParametersByPathAsync(GetParametersByPathRequest getParametersByPathRequest)
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.
getParametersByPathRequest
- Future<GetParametersByPathResult> getParametersByPathAsync(GetParametersByPathRequest getParametersByPathRequest, AsyncHandler<GetParametersByPathRequest,GetParametersByPathResult> asyncHandler)
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.
getParametersByPathRequest
- 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.Future<GetPatchBaselineResult> getPatchBaselineAsync(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
getPatchBaselineRequest
- Future<GetPatchBaselineResult> getPatchBaselineAsync(GetPatchBaselineRequest getPatchBaselineRequest, AsyncHandler<GetPatchBaselineRequest,GetPatchBaselineResult> asyncHandler)
Retrieves information about a patch baseline.
getPatchBaselineRequest
- 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.Future<GetPatchBaselineForPatchGroupResult> getPatchBaselineForPatchGroupAsync(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupRequest
- Future<GetPatchBaselineForPatchGroupResult> getPatchBaselineForPatchGroupAsync(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest, AsyncHandler<GetPatchBaselineForPatchGroupRequest,GetPatchBaselineForPatchGroupResult> asyncHandler)
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupRequest
- 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.Future<GetResourcePoliciesResult> getResourcePoliciesAsync(GetResourcePoliciesRequest getResourcePoliciesRequest)
Returns an array of the Policy
object.
getResourcePoliciesRequest
- Future<GetResourcePoliciesResult> getResourcePoliciesAsync(GetResourcePoliciesRequest getResourcePoliciesRequest, AsyncHandler<GetResourcePoliciesRequest,GetResourcePoliciesResult> asyncHandler)
Returns an array of the Policy
object.
getResourcePoliciesRequest
- 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.Future<GetServiceSettingResult> getServiceSettingAsync(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the Amazon Web Services service team.
Query the current service setting for the Amazon Web Services account.
getServiceSettingRequest
- The request body of the GetServiceSetting API operation.Future<GetServiceSettingResult> getServiceSettingAsync(GetServiceSettingRequest getServiceSettingRequest, AsyncHandler<GetServiceSettingRequest,GetServiceSettingResult> asyncHandler)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the Amazon Web Services service team.
Query the current service setting for the Amazon Web Services account.
getServiceSettingRequest
- The request body of the GetServiceSetting API operation.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.Future<LabelParameterVersionResult> labelParameterVersionAsync(LabelParameterVersionRequest labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services 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.
If you no longer want to use a parameter label, then you can either delete it or 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 isn't associated with a parameter and the system displays it in the
list of InvalidLabels.
labelParameterVersionRequest
- Future<LabelParameterVersionResult> labelParameterVersionAsync(LabelParameterVersionRequest labelParameterVersionRequest, AsyncHandler<LabelParameterVersionRequest,LabelParameterVersionResult> asyncHandler)
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services 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.
If you no longer want to use a parameter label, then you can either delete it or 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 isn't associated with a parameter and the system displays it in the
list of InvalidLabels.
labelParameterVersionRequest
- 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.Future<ListAssociationVersionsResult> listAssociationVersionsAsync(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsRequest
- Future<ListAssociationVersionsResult> listAssociationVersionsAsync(ListAssociationVersionsRequest listAssociationVersionsRequest, AsyncHandler<ListAssociationVersionsRequest,ListAssociationVersionsResult> asyncHandler)
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsRequest
- 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.Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
listAssociationsRequest
- Future<ListAssociationsResult> listAssociationsAsync(ListAssociationsRequest listAssociationsRequest, AsyncHandler<ListAssociationsRequest,ListAssociationsResult> asyncHandler)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
listAssociationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed
nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand
against three managed nodes, then a command invocation is created for each requested managed node ID.
ListCommandInvocations
provide status about command execution.
listCommandInvocationsRequest
- Future<ListCommandInvocationsResult> listCommandInvocationsAsync(ListCommandInvocationsRequest listCommandInvocationsRequest, AsyncHandler<ListCommandInvocationsRequest,ListCommandInvocationsResult> asyncHandler)
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed
nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand
against three managed nodes, then a command invocation is created for each requested managed node ID.
ListCommandInvocations
provide status about command execution.
listCommandInvocationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the Amazon Web Services account.
listCommandsRequest
- Future<ListCommandsResult> listCommandsAsync(ListCommandsRequest listCommandsRequest, AsyncHandler<ListCommandsRequest,ListCommandsResult> asyncHandler)
Lists the commands requested by users of the Amazon Web Services account.
listCommandsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListComplianceItemsResult> listComplianceItemsAsync(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API operation 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.
listComplianceItemsRequest
- Future<ListComplianceItemsResult> listComplianceItemsAsync(ListComplianceItemsRequest listComplianceItemsRequest, AsyncHandler<ListComplianceItemsRequest,ListComplianceItemsResult> asyncHandler)
For a specified resource ID, this API operation 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.
listComplianceItemsRequest
- 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.Future<ListComplianceSummariesResult> listComplianceSummariesAsync(ListComplianceSummariesRequest listComplianceSummariesRequest)
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.
listComplianceSummariesRequest
- Future<ListComplianceSummariesResult> listComplianceSummariesAsync(ListComplianceSummariesRequest listComplianceSummariesRequest, AsyncHandler<ListComplianceSummariesRequest,ListComplianceSummariesResult> asyncHandler)
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.
listComplianceSummariesRequest
- 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.Future<ListDocumentMetadataHistoryResult> listDocumentMetadataHistoryAsync(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of a change template in Change Manager.
listDocumentMetadataHistoryRequest
- Future<ListDocumentMetadataHistoryResult> listDocumentMetadataHistoryAsync(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest, AsyncHandler<ListDocumentMetadataHistoryRequest,ListDocumentMetadataHistoryResult> asyncHandler)
Information about approval reviews for a version of a change template in Change Manager.
listDocumentMetadataHistoryRequest
- 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.Future<ListDocumentVersionsResult> listDocumentVersionsAsync(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
listDocumentVersionsRequest
- Future<ListDocumentVersionsResult> listDocumentVersionsAsync(ListDocumentVersionsRequest listDocumentVersionsRequest, AsyncHandler<ListDocumentVersionsRequest,ListDocumentVersionsResult> asyncHandler)
List all versions for a document.
listDocumentVersionsRequest
- 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.Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
listDocumentsRequest
- Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
listDocumentsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDocumentsResult> listDocumentsAsync()
listDocumentsAsync(ListDocumentsRequest)
Future<ListDocumentsResult> listDocumentsAsync(AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
Future<ListInventoryEntriesResult> listInventoryEntriesAsync(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
listInventoryEntriesRequest
- Future<ListInventoryEntriesResult> listInventoryEntriesAsync(ListInventoryEntriesRequest listInventoryEntriesRequest, AsyncHandler<ListInventoryEntriesRequest,ListInventoryEntriesResult> asyncHandler)
A list of inventory items returned by the request.
listInventoryEntriesRequest
- 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.Future<ListOpsItemEventsResult> listOpsItemEventsAsync(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsItemEventsRequest
- Future<ListOpsItemEventsResult> listOpsItemEventsAsync(ListOpsItemEventsRequest listOpsItemEventsRequest, AsyncHandler<ListOpsItemEventsRequest,ListOpsItemEventsResult> asyncHandler)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsItemEventsRequest
- 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.Future<ListOpsItemRelatedItemsResult> listOpsItemRelatedItemsAsync(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
listOpsItemRelatedItemsRequest
- Future<ListOpsItemRelatedItemsResult> listOpsItemRelatedItemsAsync(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest, AsyncHandler<ListOpsItemRelatedItemsRequest,ListOpsItemRelatedItemsResult> asyncHandler)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
listOpsItemRelatedItemsRequest
- 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.Future<ListOpsMetadataResult> listOpsMetadataAsync(ListOpsMetadataRequest listOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadataRequest
- Future<ListOpsMetadataResult> listOpsMetadataAsync(ListOpsMetadataRequest listOpsMetadataRequest, AsyncHandler<ListOpsMetadataRequest,ListOpsMetadataResult> asyncHandler)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadataRequest
- 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.Future<ListResourceComplianceSummariesResult> listResourceComplianceSummariesAsync(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
listResourceComplianceSummariesRequest
- Future<ListResourceComplianceSummariesResult> listResourceComplianceSummariesAsync(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest, AsyncHandler<ListResourceComplianceSummariesRequest,ListResourceComplianceSummariesResult> asyncHandler)
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
listResourceComplianceSummariesRequest
- 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.Future<ListResourceDataSyncResult> listResourceDataSyncAsync(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
listResourceDataSyncRequest
- Future<ListResourceDataSyncResult> listResourceDataSyncAsync(ListResourceDataSyncRequest listResourceDataSyncRequest, AsyncHandler<ListResourceDataSyncRequest,ListResourceDataSyncResult> asyncHandler)
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
listResourceDataSyncRequest
- 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
listTagsForResourceRequest
- 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.Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermissionRequest
- Future<ModifyDocumentPermissionResult> modifyDocumentPermissionAsync(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest, AsyncHandler<ModifyDocumentPermissionRequest,ModifyDocumentPermissionResult> asyncHandler)
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermissionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutComplianceItemsResult> putComplianceItemsAsync(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, Critical
.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline
.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify
the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItemsRequest
- Future<PutComplianceItemsResult> putComplianceItemsAsync(PutComplianceItemsRequest putComplianceItemsRequest, AsyncHandler<PutComplianceItemsRequest,PutComplianceItemsResult> asyncHandler)
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, Critical
.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline
.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify
the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItemsRequest
- 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.Future<PutInventoryResult> putInventoryAsync(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventoryRequest
- Future<PutInventoryResult> putInventoryAsync(PutInventoryRequest putInventoryRequest, AsyncHandler<PutInventoryRequest,PutInventoryResult> asyncHandler)
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventoryRequest
- 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.Future<PutParameterResult> putParameterAsync(PutParameterRequest putParameterRequest)
Add a parameter to the system.
putParameterRequest
- Future<PutParameterResult> putParameterAsync(PutParameterRequest putParameterRequest, AsyncHandler<PutParameterRequest,PutParameterResult> asyncHandler)
Add a parameter to the system.
putParameterRequest
- 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.Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
OpsItemGroup
- The resource policy for OpsItemGroup
enables Amazon Web Services
accounts to view and interact with OpsCenter operational work items (OpsItems).
Parameter
- The resource policy is used to share a parameter with other accounts using Resource
Access Manager (RAM).
To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.
To share a SecureString
parameter, it must be encrypted with a customer managed key, and you must
share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared.
Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed
key instead. For KMS key definitions, see KMS concepts in the Key
Management Service Developer Guide.
While you can share a parameter using the Systems Manager PutResourcePolicy
operation, we recommend
using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy
requires the
extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the
Systems Manager DescribeParameters API operation using the --shared
option.
For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide
putResourcePolicyRequest
- Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest, AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
OpsItemGroup
- The resource policy for OpsItemGroup
enables Amazon Web Services
accounts to view and interact with OpsCenter operational work items (OpsItems).
Parameter
- The resource policy is used to share a parameter with other accounts using Resource
Access Manager (RAM).
To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.
To share a SecureString
parameter, it must be encrypted with a customer managed key, and you must
share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared.
Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed
key instead. For KMS key definitions, see KMS concepts in the Key
Management Service Developer Guide.
While you can share a parameter using the Systems Manager PutResourcePolicy
operation, we recommend
using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy
requires the
extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the
Systems Manager DescribeParameters API operation using the --shared
option.
For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide
putResourcePolicyRequest
- 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.Future<RegisterDefaultPatchBaselineResult> registerDefaultPatchBaselineAsync(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon
Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
registerDefaultPatchBaselineRequest
- Future<RegisterDefaultPatchBaselineResult> registerDefaultPatchBaselineAsync(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest, AsyncHandler<RegisterDefaultPatchBaselineRequest,RegisterDefaultPatchBaselineResult> asyncHandler)
Defines the default patch baseline for the relevant operating system.
To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon
Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
registerDefaultPatchBaselineRequest
- 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.Future<RegisterPatchBaselineForPatchGroupResult> registerPatchBaselineForPatchGroupAsync(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroupRequest
- Future<RegisterPatchBaselineForPatchGroupResult> registerPatchBaselineForPatchGroupAsync(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest, AsyncHandler<RegisterPatchBaselineForPatchGroupRequest,RegisterPatchBaselineForPatchGroupResult> asyncHandler)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroupRequest
- 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.Future<RegisterTargetWithMaintenanceWindowResult> registerTargetWithMaintenanceWindowAsync(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindowRequest
- Future<RegisterTargetWithMaintenanceWindowResult> registerTargetWithMaintenanceWindowAsync(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest, AsyncHandler<RegisterTargetWithMaintenanceWindowRequest,RegisterTargetWithMaintenanceWindowResult> asyncHandler)
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindowRequest
- 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.Future<RegisterTaskWithMaintenanceWindowResult> registerTaskWithMaintenanceWindowAsync(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindowRequest
- Future<RegisterTaskWithMaintenanceWindowResult> registerTaskWithMaintenanceWindowAsync(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest, AsyncHandler<RegisterTaskWithMaintenanceWindowRequest,RegisterTaskWithMaintenanceWindowResult> asyncHandler)
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindowRequest
- 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.Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
removeTagsFromResourceRequest
- Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
Removes tag keys from the specified resource.
removeTagsFromResourceRequest
- 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.Future<ResetServiceSettingResult> resetServiceSettingAsync(ResetServiceSettingRequest resetServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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
GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API
operation to change the default setting.
Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
resetServiceSettingRequest
- The request body of the ResetServiceSetting API operation.Future<ResetServiceSettingResult> resetServiceSettingAsync(ResetServiceSettingRequest resetServiceSettingRequest, AsyncHandler<ResetServiceSettingRequest,ResetServiceSettingResult> asyncHandler)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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
GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API
operation to change the default setting.
Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
resetServiceSettingRequest
- The request body of the ResetServiceSetting API operation.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.Future<ResumeSessionResult> resumeSessionAsync(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.
resumeSessionRequest
- Future<ResumeSessionResult> resumeSessionAsync(ResumeSessionRequest resumeSessionRequest, AsyncHandler<ResumeSessionRequest,ResumeSessionResult> asyncHandler)
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.
resumeSessionRequest
- 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.Future<SendAutomationSignalResult> sendAutomationSignalAsync(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignalRequest
- Future<SendAutomationSignalResult> sendAutomationSignalAsync(SendAutomationSignalRequest sendAutomationSignalRequest, AsyncHandler<SendAutomationSignalRequest,SendAutomationSignalResult> asyncHandler)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignalRequest
- 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.Future<SendCommandResult> sendCommandAsync(SendCommandRequest sendCommandRequest)
Runs commands on one or more managed nodes.
sendCommandRequest
- Future<SendCommandResult> sendCommandAsync(SendCommandRequest sendCommandRequest, AsyncHandler<SendCommandRequest,SendCommandResult> asyncHandler)
Runs commands on one or more managed nodes.
sendCommandRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartAssociationsOnceResult> startAssociationsOnceAsync(StartAssociationsOnceRequest startAssociationsOnceRequest)
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
startAssociationsOnceRequest
- Future<StartAssociationsOnceResult> startAssociationsOnceAsync(StartAssociationsOnceRequest startAssociationsOnceRequest, AsyncHandler<StartAssociationsOnceRequest,StartAssociationsOnceResult> asyncHandler)
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
startAssociationsOnceRequest
- 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.Future<StartAutomationExecutionResult> startAutomationExecutionAsync(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation runbook.
startAutomationExecutionRequest
- Future<StartAutomationExecutionResult> startAutomationExecutionAsync(StartAutomationExecutionRequest startAutomationExecutionRequest, AsyncHandler<StartAutomationExecutionRequest,StartAutomationExecutionResult> asyncHandler)
Initiates execution of an Automation runbook.
startAutomationExecutionRequest
- 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.Future<StartChangeRequestExecutionResult> startChangeRequestExecutionAsync(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
startChangeRequestExecutionRequest
- Future<StartChangeRequestExecutionResult> startChangeRequestExecutionAsync(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest, AsyncHandler<StartChangeRequestExecutionRequest,StartChangeRequestExecutionResult> asyncHandler)
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
startChangeRequestExecutionRequest
- 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.Future<StartSessionResult> startSessionAsync(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Amazon Web Services CLI usage: start-session
is an interactive command that requires the Session
Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems
Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
startSessionRequest
- Future<StartSessionResult> startSessionAsync(StartSessionRequest startSessionRequest, AsyncHandler<StartSessionRequest,StartSessionResult> asyncHandler)
Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Amazon Web Services CLI usage: start-session
is an interactive command that requires the Session
Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems
Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
startSessionRequest
- 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.Future<StopAutomationExecutionResult> stopAutomationExecutionAsync(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently running.
stopAutomationExecutionRequest
- Future<StopAutomationExecutionResult> stopAutomationExecutionAsync(StopAutomationExecutionRequest stopAutomationExecutionRequest, AsyncHandler<StopAutomationExecutionRequest,StopAutomationExecutionResult> asyncHandler)
Stop an Automation that is currently running.
stopAutomationExecutionRequest
- 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.Future<TerminateSessionResult> terminateSessionAsync(TerminateSessionRequest terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
terminateSessionRequest
- Future<TerminateSessionResult> terminateSessionAsync(TerminateSessionRequest terminateSessionRequest, AsyncHandler<TerminateSessionRequest,TerminateSessionResult> asyncHandler)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
terminateSessionRequest
- 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.Future<UnlabelParameterVersionResult> unlabelParameterVersionAsync(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
unlabelParameterVersionRequest
- Future<UnlabelParameterVersionResult> unlabelParameterVersionAsync(UnlabelParameterVersionRequest unlabelParameterVersionRequest, AsyncHandler<UnlabelParameterVersionRequest,UnlabelParameterVersionResult> asyncHandler)
Remove a label or labels from a parameter.
unlabelParameterVersionRequest
- 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.Future<UpdateAssociationResult> updateAssociationAsync(UpdateAssociationRequest updateAssociationRequest)
Updates an association. You can update the association name and version, the document version, schedule,
parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation
,
the system removes all optional parameters from the request and overwrites the association with null values for
those parameters. This is by design. You must specify all optional parameters in the call, even if you are not
changing the parameters. This includes the Name
parameter. Before calling this API action, we
recommend that you call the DescribeAssociation API operation and make a note of all optional parameters
required for your UpdateAssociation
call.
In order to call this API operation, a user, group, or role must be granted permission to call the
DescribeAssociation API operation. If you don't have permission to call DescribeAssociation
,
then you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the
ApplyOnlyAtCronInterval
parameter to run the association during the next schedule run.
updateAssociationRequest
- Future<UpdateAssociationResult> updateAssociationAsync(UpdateAssociationRequest updateAssociationRequest, AsyncHandler<UpdateAssociationRequest,UpdateAssociationResult> asyncHandler)
Updates an association. You can update the association name and version, the document version, schedule,
parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation
,
the system removes all optional parameters from the request and overwrites the association with null values for
those parameters. This is by design. You must specify all optional parameters in the call, even if you are not
changing the parameters. This includes the Name
parameter. Before calling this API action, we
recommend that you call the DescribeAssociation API operation and make a note of all optional parameters
required for your UpdateAssociation
call.
In order to call this API operation, a user, group, or role must be granted permission to call the
DescribeAssociation API operation. If you don't have permission to call DescribeAssociation
,
then you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the
ApplyOnlyAtCronInterval
parameter to run the association during the next schedule run.
updateAssociationRequest
- 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.Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus
is primarily used by the Amazon Web Services Systems Manager Agent (SSM
Agent) to report status updates about your associations and is only used for associations created with the
InstanceId
legacy parameter.
updateAssociationStatusRequest
- Future<UpdateAssociationStatusResult> updateAssociationStatusAsync(UpdateAssociationStatusRequest updateAssociationStatusRequest, AsyncHandler<UpdateAssociationStatusRequest,UpdateAssociationStatusResult> asyncHandler)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus
is primarily used by the Amazon Web Services Systems Manager Agent (SSM
Agent) to report status updates about your associations and is only used for associations created with the
InstanceId
legacy parameter.
updateAssociationStatusRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDocumentResult> updateDocumentAsync(UpdateDocumentRequest updateDocumentRequest)
Updates one or more values for an SSM document.
updateDocumentRequest
- Future<UpdateDocumentResult> updateDocumentAsync(UpdateDocumentRequest updateDocumentRequest, AsyncHandler<UpdateDocumentRequest,UpdateDocumentResult> asyncHandler)
Updates one or more values for an SSM document.
updateDocumentRequest
- 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.