@Generated(value="software.amazon.awssdk:codegen") public interface SSMAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
Amazon EC2 Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the Amazon EC2 Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Systems Manager Prerequisites.
For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.
|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.
|
static SSMAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SSMAsyncClient . |
default CompletableFuture<CancelCommandResponse> |
cancelCommand(CancelCommandRequest cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.
|
default CompletableFuture<CancelCommandResponse> |
cancelCommand(Consumer<CancelCommandRequest.Builder> cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.
|
static SSMAsyncClient |
create()
Create a
SSMAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<CreateActivationResponse> |
createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest)
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using
Run Command.
|
default CompletableFuture<CreateActivationResponse> |
createActivation(CreateActivationRequest createActivationRequest)
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using
Run Command.
|
default CompletableFuture<CreateAssociationResponse> |
createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
default CompletableFuture<CreateAssociationResponse> |
createAssociation(CreateAssociationRequest createAssociationRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
default CompletableFuture<CreateAssociationBatchResponse> |
createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
default CompletableFuture<CreateAssociationBatchResponse> |
createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
default CompletableFuture<CreateDocumentResponse> |
createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)
Creates a Systems Manager document.
|
default CompletableFuture<CreateDocumentResponse> |
createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager document.
|
default CompletableFuture<CreateMaintenanceWindowResponse> |
createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)
Creates a new Maintenance Window.
|
default CompletableFuture<CreateMaintenanceWindowResponse> |
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new Maintenance Window.
|
default CompletableFuture<CreatePatchBaselineResponse> |
createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)
Creates a patch baseline.
|
default CompletableFuture<CreatePatchBaselineResponse> |
createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
|
default CompletableFuture<CreateResourceDataSyncResponse> |
createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)
Creates a resource data sync configuration to a single bucket in Amazon S3.
|
default CompletableFuture<CreateResourceDataSyncResponse> |
createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
Creates a resource data sync configuration to a single bucket in Amazon S3.
|
default CompletableFuture<DeleteActivationResponse> |
deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest)
Deletes an activation.
|
default CompletableFuture<DeleteActivationResponse> |
deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation.
|
default CompletableFuture<DeleteAssociationResponse> |
deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
|
default CompletableFuture<DeleteAssociationResponse> |
deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
|
default CompletableFuture<DeleteDocumentResponse> |
deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
|
default CompletableFuture<DeleteDocumentResponse> |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
|
default CompletableFuture<DeleteMaintenanceWindowResponse> |
deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)
Deletes a Maintenance Window.
|
default CompletableFuture<DeleteMaintenanceWindowResponse> |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a Maintenance Window.
|
default CompletableFuture<DeleteParameterResponse> |
deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest)
Delete a parameter from the system.
|
default CompletableFuture<DeleteParameterResponse> |
deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
|
default CompletableFuture<DeleteParametersResponse> |
deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)
Delete a list of parameters.
|
default CompletableFuture<DeleteParametersResponse> |
deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.
|
default CompletableFuture<DeletePatchBaselineResponse> |
deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)
Deletes a patch baseline.
|
default CompletableFuture<DeletePatchBaselineResponse> |
deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
|
default CompletableFuture<DeleteResourceDataSyncResponse> |
deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration.
|
default CompletableFuture<DeleteResourceDataSyncResponse> |
deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration.
|
default CompletableFuture<DeregisterManagedInstanceResponse> |
deregisterManagedInstance(Consumer<DeregisterManagedInstanceRequest.Builder> deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers.
|
default CompletableFuture<DeregisterManagedInstanceResponse> |
deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers.
|
default CompletableFuture<DeregisterPatchBaselineForPatchGroupResponse> |
deregisterPatchBaselineForPatchGroup(Consumer<DeregisterPatchBaselineForPatchGroupRequest.Builder> deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
|
default CompletableFuture<DeregisterPatchBaselineForPatchGroupResponse> |
deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
|
default CompletableFuture<DeregisterTargetFromMaintenanceWindowResponse> |
deregisterTargetFromMaintenanceWindow(Consumer<DeregisterTargetFromMaintenanceWindowRequest.Builder> deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a Maintenance Window.
|
default CompletableFuture<DeregisterTargetFromMaintenanceWindowResponse> |
deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a Maintenance Window.
|
default CompletableFuture<DeregisterTaskFromMaintenanceWindowResponse> |
deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a Maintenance Window.
|
default CompletableFuture<DeregisterTaskFromMaintenanceWindowResponse> |
deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a Maintenance Window.
|
default CompletableFuture<DescribeActivationsResponse> |
describeActivations()
Details about the activation, including: the date and time the activation was created, the expiration date, the
IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
|
default CompletableFuture<DescribeActivationsResponse> |
describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Details about the activation, including: the date and time the activation was created, the expiration date, the
IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
|
default CompletableFuture<DescribeActivationsResponse> |
describeActivations(DescribeActivationsRequest describeActivationsRequest)
Details about the activation, including: the date and time the activation was created, the expiration date, the
IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
|
default DescribeActivationsPublisher |
describeActivationsPaginator()
Details about the activation, including: the date and time the activation was created, the expiration date, the
IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
|
default DescribeActivationsPublisher |
describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)
Details about the activation, including: the date and time the activation was created, the expiration date, the
IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
|
default CompletableFuture<DescribeAssociationResponse> |
describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest)
Describes the association for the specified target or instance.
|
default CompletableFuture<DescribeAssociationResponse> |
describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or instance.
|
default CompletableFuture<DescribeAutomationExecutionsResponse> |
describeAutomationExecutions()
Provides details about all active and terminated Automation executions.
|
default CompletableFuture<DescribeAutomationExecutionsResponse> |
describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default CompletableFuture<DescribeAutomationExecutionsResponse> |
describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default CompletableFuture<DescribeAvailablePatchesResponse> |
describeAvailablePatches()
Lists all patches that could possibly be included in a patch baseline.
|
default CompletableFuture<DescribeAvailablePatchesResponse> |
describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches that could possibly be included in a patch baseline.
|
default CompletableFuture<DescribeAvailablePatchesResponse> |
describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches that could possibly be included in a patch baseline.
|
default CompletableFuture<DescribeDocumentResponse> |
describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest)
Describes the specified Systems Manager document.
|
default CompletableFuture<DescribeDocumentResponse> |
describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Systems Manager document.
|
default CompletableFuture<DescribeDocumentPermissionResponse> |
describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document.
|
default CompletableFuture<DescribeDocumentPermissionResponse> |
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document.
|
default CompletableFuture<DescribeEffectiveInstanceAssociationsResponse> |
describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default CompletableFuture<DescribeEffectiveInstanceAssociationsResponse> |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default CompletableFuture<DescribeEffectivePatchesForPatchBaselineResponse> |
describeEffectivePatchesForPatchBaseline(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default CompletableFuture<DescribeEffectivePatchesForPatchBaselineResponse> |
describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default CompletableFuture<DescribeInstanceAssociationsStatusResponse> |
describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default CompletableFuture<DescribeInstanceAssociationsStatusResponse> |
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default CompletableFuture<DescribeInstanceInformationResponse> |
describeInstanceInformation()
Describes one or more of your instances.
|
default CompletableFuture<DescribeInstanceInformationResponse> |
describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Describes one or more of your instances.
|
default CompletableFuture<DescribeInstanceInformationResponse> |
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances.
|
default DescribeInstanceInformationPublisher |
describeInstanceInformationPaginator()
Describes one or more of your instances.
|
default DescribeInstanceInformationPublisher |
describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances.
|
default CompletableFuture<DescribeInstancePatchesResponse> |
describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline
being used for the instance.
|
default CompletableFuture<DescribeInstancePatchesResponse> |
describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline
being used for the instance.
|
default CompletableFuture<DescribeInstancePatchStatesResponse> |
describeInstancePatchStates(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default CompletableFuture<DescribeInstancePatchStatesResponse> |
describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default CompletableFuture<DescribeInstancePatchStatesForPatchGroupResponse> |
describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default CompletableFuture<DescribeInstancePatchStatesForPatchGroupResponse> |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default CompletableFuture<DescribeMaintenanceWindowExecutionsResponse> |
describeMaintenanceWindowExecutions(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)
Lists the executions of a Maintenance Window.
|
default CompletableFuture<DescribeMaintenanceWindowExecutionsResponse> |
describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
Lists the executions of a Maintenance Window.
|
default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> |
describeMaintenanceWindowExecutionTaskInvocations(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance
Window execution.
|
default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> |
describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance
Window execution.
|
default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> |
describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
For a given Maintenance Window execution, lists the tasks that were executed.
|
default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given Maintenance Window execution, lists the tasks that were executed.
|
default CompletableFuture<DescribeMaintenanceWindowsResponse> |
describeMaintenanceWindows()
Retrieves the Maintenance Windows in an AWS account.
|
default CompletableFuture<DescribeMaintenanceWindowsResponse> |
describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the Maintenance Windows in an AWS account.
|
default CompletableFuture<DescribeMaintenanceWindowsResponse> |
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the Maintenance Windows in an AWS account.
|
default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> |
describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the Maintenance Window.
|
default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> |
describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the Maintenance Window.
|
default CompletableFuture<DescribeMaintenanceWindowTasksResponse> |
describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
Lists the tasks in a Maintenance Window.
|
default CompletableFuture<DescribeMaintenanceWindowTasksResponse> |
describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a Maintenance Window.
|
default CompletableFuture<DescribeParametersResponse> |
describeParameters()
Get information about a parameter.
|
default CompletableFuture<DescribeParametersResponse> |
describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
Get information about a parameter.
|
default CompletableFuture<DescribeParametersResponse> |
describeParameters(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
|
default DescribeParametersPublisher |
describeParametersPaginator()
Get information about a parameter.
|
default DescribeParametersPublisher |
describeParametersPaginator(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
|
default CompletableFuture<DescribePatchBaselinesResponse> |
describePatchBaselines()
Lists the patch baselines in your AWS account.
|
default CompletableFuture<DescribePatchBaselinesResponse> |
describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default CompletableFuture<DescribePatchBaselinesResponse> |
describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default CompletableFuture<DescribePatchGroupsResponse> |
describePatchGroups()
Lists all patch groups that have been registered with patch baselines.
|
default CompletableFuture<DescribePatchGroupsResponse> |
describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default CompletableFuture<DescribePatchGroupsResponse> |
describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default CompletableFuture<DescribePatchGroupStateResponse> |
describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
|
default CompletableFuture<DescribePatchGroupStateResponse> |
describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
|
default CompletableFuture<GetAutomationExecutionResponse> |
getAutomationExecution(Consumer<GetAutomationExecutionRequest.Builder> getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
|
default CompletableFuture<GetAutomationExecutionResponse> |
getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
|
default CompletableFuture<GetCommandInvocationResponse> |
getCommandInvocation(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
|
default CompletableFuture<GetCommandInvocationResponse> |
getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
|
default CompletableFuture<GetDefaultPatchBaselineResponse> |
getDefaultPatchBaseline()
Retrieves the default patch baseline.
|
default CompletableFuture<GetDefaultPatchBaselineResponse> |
getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest)
Retrieves the default patch baseline.
|
default CompletableFuture<GetDefaultPatchBaselineResponse> |
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline.
|
default CompletableFuture<GetDeployablePatchSnapshotForInstanceResponse> |
getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses.
|
default CompletableFuture<GetDeployablePatchSnapshotForInstanceResponse> |
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses.
|
default CompletableFuture<GetDocumentResponse> |
getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Gets the contents of the specified Systems Manager document.
|
default CompletableFuture<GetDocumentResponse> |
getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Systems Manager document.
|
default CompletableFuture<GetInventoryResponse> |
getInventory()
Query inventory information.
|
default CompletableFuture<GetInventoryResponse> |
getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
Query inventory information.
|
default CompletableFuture<GetInventoryResponse> |
getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
|
default CompletableFuture<GetInventorySchemaResponse> |
getInventorySchema()
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
default CompletableFuture<GetInventorySchemaResponse> |
getInventorySchema(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest)
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
default CompletableFuture<GetInventorySchemaResponse> |
getInventorySchema(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.
|
default CompletableFuture<GetMaintenanceWindowResponse> |
getMaintenanceWindow(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest)
Retrieves a Maintenance Window.
|
default CompletableFuture<GetMaintenanceWindowResponse> |
getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a Maintenance Window.
|
default CompletableFuture<GetMaintenanceWindowExecutionResponse> |
getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionResponse> |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> |
getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> |
getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves a task invocation.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> |
getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves a task invocation.
|
default CompletableFuture<GetMaintenanceWindowTaskResponse> |
getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest)
Lists the tasks in a Maintenance Window.
|
default CompletableFuture<GetMaintenanceWindowTaskResponse> |
getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a Maintenance Window.
|
default CompletableFuture<GetParameterResponse> |
getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)
Get information about a parameter by using the parameter name.
|
default CompletableFuture<GetParameterResponse> |
getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name.
|
default CompletableFuture<GetParameterHistoryResponse> |
getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
default CompletableFuture<GetParameterHistoryResponse> |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
default GetParameterHistoryPublisher |
getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
default CompletableFuture<GetParametersResponse> |
getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)
Get details of a parameter.
|
default CompletableFuture<GetParametersResponse> |
getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter.
|
default CompletableFuture<GetParametersByPathResponse> |
getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
Retrieve parameters in a specific hierarchy.
|
default CompletableFuture<GetParametersByPathResponse> |
getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve parameters in a specific hierarchy.
|
default GetParametersByPathPublisher |
getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)
Retrieve parameters in a specific hierarchy.
|
default CompletableFuture<GetPatchBaselineResponse> |
getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest)
Retrieves information about a patch baseline.
|
default CompletableFuture<GetPatchBaselineResponse> |
getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
|
default CompletableFuture<GetPatchBaselineForPatchGroupResponse> |
getPatchBaselineForPatchGroup(Consumer<GetPatchBaselineForPatchGroupRequest.Builder> getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
|
default CompletableFuture<GetPatchBaselineForPatchGroupResponse> |
getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
|
default CompletableFuture<ListAssociationsResponse> |
listAssociations()
Lists the associations for the specified Systems Manager document or instance.
|
default CompletableFuture<ListAssociationsResponse> |
listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
|
default CompletableFuture<ListAssociationsResponse> |
listAssociations(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
|
default ListAssociationsPublisher |
listAssociationsPaginator()
Lists the associations for the specified Systems Manager document or instance.
|
default ListAssociationsPublisher |
listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
|
default CompletableFuture<ListAssociationVersionsResponse> |
listAssociationVersions(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
default CompletableFuture<ListAssociationVersionsResponse> |
listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
default CompletableFuture<ListCommandInvocationsResponse> |
listCommandInvocations()
An invocation is copy of a command sent to a specific instance.
|
default CompletableFuture<ListCommandInvocationsResponse> |
listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default CompletableFuture<ListCommandInvocationsResponse> |
listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default ListCommandInvocationsPublisher |
listCommandInvocationsPaginator()
An invocation is copy of a command sent to a specific instance.
|
default ListCommandInvocationsPublisher |
listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default CompletableFuture<ListCommandsResponse> |
listCommands()
Lists the commands requested by users of the AWS account.
|
default CompletableFuture<ListCommandsResponse> |
listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default CompletableFuture<ListCommandsResponse> |
listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default ListCommandsPublisher |
listCommandsPaginator()
Lists the commands requested by users of the AWS account.
|
default ListCommandsPublisher |
listCommandsPaginator(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default CompletableFuture<ListComplianceItemsResponse> |
listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
default CompletableFuture<ListComplianceItemsResponse> |
listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
default CompletableFuture<ListComplianceSummariesResponse> |
listComplianceSummaries()
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default CompletableFuture<ListComplianceSummariesResponse> |
listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default CompletableFuture<ListComplianceSummariesResponse> |
listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default CompletableFuture<ListDocumentsResponse> |
listDocuments()
Describes one or more of your Systems Manager documents.
|
default CompletableFuture<ListDocumentsResponse> |
listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Describes one or more of your Systems Manager documents.
|
default CompletableFuture<ListDocumentsResponse> |
listDocuments(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your Systems Manager documents.
|
default ListDocumentsPublisher |
listDocumentsPaginator()
Describes one or more of your Systems Manager documents.
|
default ListDocumentsPublisher |
listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your Systems Manager documents.
|
default CompletableFuture<ListDocumentVersionsResponse> |
listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.
|
default CompletableFuture<ListDocumentVersionsResponse> |
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
default CompletableFuture<ListInventoryEntriesResponse> |
listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
default CompletableFuture<ListInventoryEntriesResponse> |
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
default CompletableFuture<ListResourceComplianceSummariesResponse> |
listResourceComplianceSummaries()
Returns a resource-level summary count.
|
default CompletableFuture<ListResourceComplianceSummariesResponse> |
listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
default CompletableFuture<ListResourceComplianceSummariesResponse> |
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
default CompletableFuture<ListResourceDataSyncResponse> |
listResourceDataSync()
Lists your resource data sync configurations.
|
default CompletableFuture<ListResourceDataSyncResponse> |
listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
default CompletableFuture<ListResourceDataSyncResponse> |
listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
default CompletableFuture<ModifyDocumentPermissionResponse> |
modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately.
|
default CompletableFuture<ModifyDocumentPermissionResponse> |
modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately.
|
default CompletableFuture<PutComplianceItemsResponse> |
putComplianceItems(Consumer<PutComplianceItemsRequest.Builder> putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource.
|
default CompletableFuture<PutComplianceItemsResponse> |
putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource.
|
default CompletableFuture<PutInventoryResponse> |
putInventory(Consumer<PutInventoryRequest.Builder> putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
default CompletableFuture<PutInventoryResponse> |
putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
default CompletableFuture<PutParameterResponse> |
putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest)
Add one or more parameters to the system.
|
default CompletableFuture<PutParameterResponse> |
putParameter(PutParameterRequest putParameterRequest)
Add one or more parameters to the system.
|
default CompletableFuture<RegisterDefaultPatchBaselineResponse> |
registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)
Defines the default patch baseline.
|
default CompletableFuture<RegisterDefaultPatchBaselineResponse> |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline.
|
default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> |
registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
|
default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> |
registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
|
default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> |
registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest)
Registers a target with a Maintenance Window.
|
default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> |
registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a Maintenance Window.
|
default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> |
registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest)
Adds a new task to a Maintenance Window.
|
default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> |
registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a Maintenance Window.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes all tags from the specified resource.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes all tags from the specified resource.
|
default CompletableFuture<SendAutomationSignalResponse> |
sendAutomationSignal(Consumer<SendAutomationSignalRequest.Builder> sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
default CompletableFuture<SendAutomationSignalResponse> |
sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
default CompletableFuture<SendCommandResponse> |
sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
Executes commands on one or more managed instances.
|
default CompletableFuture<SendCommandResponse> |
sendCommand(SendCommandRequest sendCommandRequest)
Executes commands on one or more managed instances.
|
default CompletableFuture<StartAutomationExecutionResponse> |
startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest)
Initiates execution of an Automation document.
|
default CompletableFuture<StartAutomationExecutionResponse> |
startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
|
default CompletableFuture<StopAutomationExecutionResponse> |
stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)
Stop an Automation that is currently executing.
|
default CompletableFuture<StopAutomationExecutionResponse> |
stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently executing.
|
default CompletableFuture<UpdateAssociationResponse> |
updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest)
Updates an association.
|
default CompletableFuture<UpdateAssociationResponse> |
updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association.
|
default CompletableFuture<UpdateAssociationStatusResponse> |
updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
|
default CompletableFuture<UpdateAssociationStatusResponse> |
updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
|
default CompletableFuture<UpdateDocumentResponse> |
updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
The document you want to update.
|
default CompletableFuture<UpdateDocumentResponse> |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
The document you want to update.
|
default CompletableFuture<UpdateDocumentDefaultVersionResponse> |
updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
default CompletableFuture<UpdateDocumentDefaultVersionResponse> |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
default CompletableFuture<UpdateMaintenanceWindowResponse> |
updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest)
Updates an existing Maintenance Window.
|
default CompletableFuture<UpdateMaintenanceWindowResponse> |
updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing Maintenance Window.
|
default CompletableFuture<UpdateMaintenanceWindowTargetResponse> |
updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest)
Modifies the target of an existing Maintenance Window.
|
default CompletableFuture<UpdateMaintenanceWindowTargetResponse> |
updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
Modifies the target of an existing Maintenance Window.
|
default CompletableFuture<UpdateMaintenanceWindowTaskResponse> |
updateMaintenanceWindowTask(Consumer<UpdateMaintenanceWindowTaskRequest.Builder> updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a Maintenance Window.
|
default CompletableFuture<UpdateMaintenanceWindowTaskResponse> |
updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a Maintenance Window.
|
default CompletableFuture<UpdateManagedInstanceRoleResponse> |
updateManagedInstanceRole(Consumer<UpdateManagedInstanceRoleRequest.Builder> updateManagedInstanceRoleRequest)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
|
default CompletableFuture<UpdateManagedInstanceRoleResponse> |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
|
default CompletableFuture<UpdatePatchBaselineResponse> |
updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
default CompletableFuture<UpdatePatchBaselineResponse> |
updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
serviceName
close
static final String SERVICE_NAME
static SSMAsyncClient create()
SSMAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static SSMAsyncClientBuilder builder()
SSMAsyncClient
.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 10 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 Amazon EC2 and are interpreted strictly as a string of characters.
For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
addTagsToResourceRequest
- default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 10 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 Amazon EC2 and are interpreted strictly as a string of characters.
For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
AddTagsToResourceRequest.Builder
avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest
- a Consumer
that will call methods on AddTagsToResourceRequest.Builder
.default CompletableFuture<CancelCommandResponse> cancelCommand(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
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<CancelCommandResponse> cancelCommand(Consumer<CancelCommandRequest.Builder> 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.Builder
avoiding the need to
create one manually via CancelCommandRequest.builder()
cancelCommandRequest
- a Consumer
that will call methods on CancelCommandRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<CreateActivationResponse> createActivation(CreateActivationRequest createActivationRequest)
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.
createActivationRequest
- default CompletableFuture<CreateActivationResponse> createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest)
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.
CreateActivationRequest.Builder
avoiding the need
to create one manually via CreateActivationRequest.builder()
createActivationRequest
- a Consumer
that will call methods on CreateActivationRequest.Builder
.default CompletableFuture<CreateAssociationResponse> createAssociation(CreateAssociationRequest createAssociationRequest)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
createAssociationRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<CreateAssociationResponse> createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
CreateAssociationRequest.Builder
avoiding the need
to create one manually via CreateAssociationRequest.builder()
createAssociationRequest
- a Consumer
that will call methods on CreateAssociationRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<CreateAssociationBatchResponse> createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
createAssociationBatchRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<CreateAssociationBatchResponse> createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
CreateAssociationBatchRequest.Builder
avoiding the
need to create one manually via CreateAssociationBatchRequest.builder()
createAssociationBatchRequest
- a Consumer
that will call methods on CreateAssociationBatchRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<CreateDocumentResponse> createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager document.
After you create a document, you can use CreateAssociation to associate it with one or more running instances.
createDocumentRequest
- default CompletableFuture<CreateDocumentResponse> createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)
Creates a Systems Manager document.
After you create a document, you can use CreateAssociation to associate it with one or more running instances.
CreateDocumentRequest.Builder
avoiding the need to
create one manually via CreateDocumentRequest.builder()
createDocumentRequest
- a Consumer
that will call methods on CreateDocumentRequest.Builder
.default CompletableFuture<CreateMaintenanceWindowResponse> createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new Maintenance Window.
createMaintenanceWindowRequest
- default CompletableFuture<CreateMaintenanceWindowResponse> createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)
Creates a new Maintenance Window.
CreateMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via CreateMaintenanceWindowRequest.builder()
createMaintenanceWindowRequest
- a Consumer
that will call methods on CreateMaintenanceWindowRequest.Builder
.default CompletableFuture<CreatePatchBaselineResponse> createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
createPatchBaselineRequest
- default CompletableFuture<CreatePatchBaselineResponse> createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)
Creates a patch baseline.
CreatePatchBaselineRequest.Builder
avoiding the
need to create one manually via CreatePatchBaselineRequest.builder()
createPatchBaselineRequest
- a Consumer
that will call methods on CreatePatchBaselineRequest.Builder
.default CompletableFuture<CreateResourceDataSyncResponse> createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.
createResourceDataSyncRequest
- default CompletableFuture<CreateResourceDataSyncResponse> createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)
Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.
CreateResourceDataSyncRequest.Builder
avoiding the
need to create one manually via CreateResourceDataSyncRequest.builder()
createResourceDataSyncRequest
- a Consumer
that will call methods on CreateResourceDataSyncRequest.Builder
.default CompletableFuture<DeleteActivationResponse> deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
deleteActivationRequest
- default CompletableFuture<DeleteActivationResponse> deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest)
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
DeleteActivationRequest.Builder
avoiding the need
to create one manually via DeleteActivationRequest.builder()
deleteActivationRequest
- a Consumer
that will call methods on DeleteActivationRequest.Builder
.default CompletableFuture<DeleteAssociationResponse> deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
deleteAssociationRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DeleteAssociationResponse> deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
DeleteAssociationRequest.Builder
avoiding the need
to create one manually via DeleteAssociationRequest.builder()
deleteAssociationRequest
- a Consumer
that will call methods on DeleteAssociationRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DeleteDocumentResponse> deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
deleteDocumentRequest
- default CompletableFuture<DeleteDocumentResponse> deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
DeleteDocumentRequest.Builder
avoiding the need to
create one manually via DeleteDocumentRequest.builder()
deleteDocumentRequest
- a Consumer
that will call methods on DeleteDocumentRequest.Builder
.default CompletableFuture<DeleteMaintenanceWindowResponse> deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a Maintenance Window.
deleteMaintenanceWindowRequest
- default CompletableFuture<DeleteMaintenanceWindowResponse> deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)
Deletes a Maintenance Window.
DeleteMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via DeleteMaintenanceWindowRequest.builder()
deleteMaintenanceWindowRequest
- a Consumer
that will call methods on DeleteMaintenanceWindowRequest.Builder
.default CompletableFuture<DeleteParameterResponse> deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
deleteParameterRequest
- default CompletableFuture<DeleteParameterResponse> deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest)
Delete a parameter from the system.
DeleteParameterRequest.Builder
avoiding the need
to create one manually via DeleteParameterRequest.builder()
deleteParameterRequest
- a Consumer
that will call methods on DeleteParameterRequest.Builder
.default CompletableFuture<DeleteParametersResponse> deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.
deleteParametersRequest
- default CompletableFuture<DeleteParametersResponse> deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)
Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.
DeleteParametersRequest.Builder
avoiding the need
to create one manually via DeleteParametersRequest.builder()
deleteParametersRequest
- a Consumer
that will call methods on DeleteParametersRequest.Builder
.default CompletableFuture<DeletePatchBaselineResponse> deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
deletePatchBaselineRequest
- default CompletableFuture<DeletePatchBaselineResponse> deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)
Deletes a patch baseline.
DeletePatchBaselineRequest.Builder
avoiding the
need to create one manually via DeletePatchBaselineRequest.builder()
deletePatchBaselineRequest
- a Consumer
that will call methods on DeletePatchBaselineRequest.Builder
.default CompletableFuture<DeleteResourceDataSyncResponse> deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.
deleteResourceDataSyncRequest
- default CompletableFuture<DeleteResourceDataSyncResponse> deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.
DeleteResourceDataSyncRequest.Builder
avoiding the
need to create one manually via DeleteResourceDataSyncRequest.builder()
deleteResourceDataSyncRequest
- a Consumer
that will call methods on DeleteResourceDataSyncRequest.Builder
.default CompletableFuture<DeregisterManagedInstanceResponse> deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling the SSM Agent first.
deregisterManagedInstanceRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DeregisterManagedInstanceResponse> deregisterManagedInstance(Consumer<DeregisterManagedInstanceRequest.Builder> deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling the SSM Agent first.
DeregisterManagedInstanceRequest.Builder
avoiding
the need to create one manually via DeregisterManagedInstanceRequest.builder()
deregisterManagedInstanceRequest
- a Consumer
that will call methods on DeregisterManagedInstanceRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DeregisterPatchBaselineForPatchGroupResponse> deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroupRequest
- default CompletableFuture<DeregisterPatchBaselineForPatchGroupResponse> deregisterPatchBaselineForPatchGroup(Consumer<DeregisterPatchBaselineForPatchGroupRequest.Builder> deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
DeregisterPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via
DeregisterPatchBaselineForPatchGroupRequest.builder()
deregisterPatchBaselineForPatchGroupRequest
- a Consumer
that will call methods on DeregisterPatchBaselineForPatchGroupRequest.Builder
.default CompletableFuture<DeregisterTargetFromMaintenanceWindowResponse> deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a Maintenance Window.
deregisterTargetFromMaintenanceWindowRequest
- Safe
option for the
DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.default CompletableFuture<DeregisterTargetFromMaintenanceWindowResponse> deregisterTargetFromMaintenanceWindow(Consumer<DeregisterTargetFromMaintenanceWindowRequest.Builder> deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a Maintenance Window.
DeregisterTargetFromMaintenanceWindowRequest.Builder
avoiding the need to create one manually via
DeregisterTargetFromMaintenanceWindowRequest.builder()
deregisterTargetFromMaintenanceWindowRequest
- a Consumer
that will call methods on DeregisterTargetFromMaintenanceWindowRequest.Builder
.Safe
option for the
DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.default CompletableFuture<DeregisterTaskFromMaintenanceWindowResponse> deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a Maintenance Window.
deregisterTaskFromMaintenanceWindowRequest
- default CompletableFuture<DeregisterTaskFromMaintenanceWindowResponse> deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a Maintenance Window.
DeregisterTaskFromMaintenanceWindowRequest.Builder
avoiding the need to create one manually via DeregisterTaskFromMaintenanceWindowRequest.builder()
deregisterTaskFromMaintenanceWindowRequest
- a Consumer
that will call methods on DeregisterTaskFromMaintenanceWindowRequest.Builder
.default CompletableFuture<DescribeActivationsResponse> describeActivations(DescribeActivationsRequest describeActivationsRequest)
Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
describeActivationsRequest
- default CompletableFuture<DescribeActivationsResponse> describeActivations()
Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
default CompletableFuture<DescribeActivationsResponse> describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
DescribeActivationsRequest.Builder
avoiding the
need to create one manually via DescribeActivationsRequest.builder()
describeActivationsRequest
- a Consumer
that will call methods on DescribeActivationsRequest.Builder
.default DescribeActivationsPublisher describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)
Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
This is a variant of
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation.
describeActivationsRequest
- default DescribeActivationsPublisher describeActivationsPaginator()
Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
This is a variant of
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation.
default CompletableFuture<DescribeAssociationResponse> describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
describeAssociationRequest
- $LATEST
parameter to view the latest version of the association.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeAssociationResponse> describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest)
Describes the association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
DescribeAssociationRequest.Builder
avoiding the
need to create one manually via DescribeAssociationRequest.builder()
describeAssociationRequest
- a Consumer
that will call methods on DescribeAssociationRequest.Builder
.$LATEST
parameter to view the latest version of the association.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest
- default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions()
Provides details about all active and terminated Automation executions.
default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
DescribeAutomationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationExecutionsRequest.builder()
describeAutomationExecutionsRequest
- a Consumer
that will call methods on DescribeAutomationExecutionsRequest.Builder
.default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches that could possibly be included in a patch baseline.
describeAvailablePatchesRequest
- default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches()
Lists all patches that could possibly be included in a patch baseline.
default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches that could possibly be included in a patch baseline.
DescribeAvailablePatchesRequest.Builder
avoiding
the need to create one manually via DescribeAvailablePatchesRequest.builder()
describeAvailablePatchesRequest
- a Consumer
that will call methods on DescribeAvailablePatchesRequest.Builder
.default CompletableFuture<DescribeDocumentResponse> describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Systems Manager document.
describeDocumentRequest
- default CompletableFuture<DescribeDocumentResponse> describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest)
Describes the specified Systems Manager document.
DescribeDocumentRequest.Builder
avoiding the need
to create one manually via DescribeDocumentRequest.builder()
describeDocumentRequest
- a Consumer
that will call methods on DescribeDocumentRequest.Builder
.default CompletableFuture<DescribeDocumentPermissionResponse> describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
describeDocumentPermissionRequest
- default CompletableFuture<DescribeDocumentPermissionResponse> describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
DescribeDocumentPermissionRequest.Builder
avoiding
the need to create one manually via DescribeDocumentPermissionRequest.builder()
describeDocumentPermissionRequest
- a Consumer
that will call methods on DescribeDocumentPermissionRequest.Builder
.default CompletableFuture<DescribeEffectiveInstanceAssociationsResponse> describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
describeEffectiveInstanceAssociationsRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeEffectiveInstanceAssociationsResponse> describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
DescribeEffectiveInstanceAssociationsRequest.Builder
avoiding the need to create one manually via
DescribeEffectiveInstanceAssociationsRequest.builder()
describeEffectiveInstanceAssociationsRequest
- a Consumer
that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeEffectivePatchesForPatchBaselineResponse> describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeEffectivePatchesForPatchBaselineRequest
- default CompletableFuture<DescribeEffectivePatchesForPatchBaselineResponse> describeEffectivePatchesForPatchBaseline(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
DescribeEffectivePatchesForPatchBaselineRequest.Builder
avoiding the need to create one manually via
DescribeEffectivePatchesForPatchBaselineRequest.builder()
describeEffectivePatchesForPatchBaselineRequest
- a Consumer
that will call methods on
DescribeEffectivePatchesForPatchBaselineRequest.Builder
.default CompletableFuture<DescribeInstanceAssociationsStatusResponse> describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
describeInstanceAssociationsStatusRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeInstanceAssociationsStatusResponse> describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
DescribeInstanceAssociationsStatusRequest.Builder
avoiding the need to create one manually via DescribeInstanceAssociationsStatusRequest.builder()
describeInstanceAssociationsStatusRequest
- a Consumer
that will call methods on DescribeInstanceAssociationsStatusRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeInstanceInformationResponse> describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
describeInstanceInformationRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeInstanceInformationResponse> describeInstanceInformation()
Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeInstanceInformationResponse> describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
DescribeInstanceInformationRequest.Builder
avoiding the need to create one manually via DescribeInstanceInformationRequest.builder()
describeInstanceInformationRequest
- a Consumer
that will call methods on DescribeInstanceInformationRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeInstanceInformationPublisher describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
This is a variant of
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation.
describeInstanceInformationRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeInstanceInformationPublisher describeInstanceInformationPaginator()
Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
This is a variant of
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation.
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeInstancePatchStatesResponse> describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStatesRequest
- default CompletableFuture<DescribeInstancePatchStatesResponse> describeInstancePatchStates(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
DescribeInstancePatchStatesRequest.Builder
avoiding the need to create one manually via DescribeInstancePatchStatesRequest.builder()
describeInstancePatchStatesRequest
- a Consumer
that will call methods on DescribeInstancePatchStatesRequest.Builder
.default CompletableFuture<DescribeInstancePatchStatesForPatchGroupResponse> describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
describeInstancePatchStatesForPatchGroupRequest
- default CompletableFuture<DescribeInstancePatchStatesForPatchGroupResponse> describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
DescribeInstancePatchStatesForPatchGroupRequest.Builder
avoiding the need to create one manually via
DescribeInstancePatchStatesForPatchGroupRequest.builder()
describeInstancePatchStatesForPatchGroupRequest
- a Consumer
that will call methods on
DescribeInstancePatchStatesForPatchGroupRequest.Builder
.default CompletableFuture<DescribeInstancePatchesResponse> describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatchesRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeInstancePatchesResponse> describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
DescribeInstancePatchesRequest.Builder
avoiding
the need to create one manually via DescribeInstancePatchesRequest.builder()
describeInstancePatchesRequest
- a Consumer
that will call methods on DescribeInstancePatchesRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.
describeMaintenanceWindowExecutionTaskInvocationsRequest
- default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> describeMaintenanceWindowExecutionTaskInvocations(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
avoiding the need to create one manually
via DescribeMaintenanceWindowExecutionTaskInvocationsRequest.builder()
describeMaintenanceWindowExecutionTaskInvocationsRequest
- a Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
.default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given Maintenance Window execution, lists the tasks that were executed.
describeMaintenanceWindowExecutionTasksRequest
- default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
For a given Maintenance Window execution, lists the tasks that were executed.
DescribeMaintenanceWindowExecutionTasksRequest.Builder
avoiding the need to create one manually via
DescribeMaintenanceWindowExecutionTasksRequest.builder()
describeMaintenanceWindowExecutionTasksRequest
- a Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTasksRequest.Builder
.default CompletableFuture<DescribeMaintenanceWindowExecutionsResponse> describeMaintenanceWindowExecutions(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
- default CompletableFuture<DescribeMaintenanceWindowExecutionsResponse> describeMaintenanceWindowExecutions(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> 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.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowExecutionsRequest.builder()
describeMaintenanceWindowExecutionsRequest
- a Consumer
that will call methods on DescribeMaintenanceWindowExecutionsRequest.Builder
.default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the Maintenance Window.
describeMaintenanceWindowTargetsRequest
- default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the Maintenance Window.
DescribeMaintenanceWindowTargetsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTargetsRequest.builder()
describeMaintenanceWindowTargetsRequest
- a Consumer
that will call methods on DescribeMaintenanceWindowTargetsRequest.Builder
.default CompletableFuture<DescribeMaintenanceWindowTasksResponse> describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a Maintenance Window.
describeMaintenanceWindowTasksRequest
- default CompletableFuture<DescribeMaintenanceWindowTasksResponse> describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
Lists the tasks in a Maintenance Window.
DescribeMaintenanceWindowTasksRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTasksRequest.builder()
describeMaintenanceWindowTasksRequest
- a Consumer
that will call methods on DescribeMaintenanceWindowTasksRequest.Builder
.default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the Maintenance Windows in an AWS account.
describeMaintenanceWindowsRequest
- default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows()
Retrieves the Maintenance Windows in an AWS account.
default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the Maintenance Windows in an AWS account.
DescribeMaintenanceWindowsRequest.Builder
avoiding
the need to create one manually via DescribeMaintenanceWindowsRequest.builder()
describeMaintenanceWindowsRequest
- a Consumer
that will call methods on DescribeMaintenanceWindowsRequest.Builder
.default CompletableFuture<DescribeParametersResponse> describeParameters(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
describeParametersRequest
- default CompletableFuture<DescribeParametersResponse> describeParameters()
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
default CompletableFuture<DescribeParametersResponse> describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
DescribeParametersRequest.Builder
avoiding the
need to create one manually via DescribeParametersRequest.builder()
describeParametersRequest
- a Consumer
that will call methods on DescribeParametersRequest.Builder
.default DescribeParametersPublisher describeParametersPaginator(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a variant of
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation.
describeParametersRequest
- default DescribeParametersPublisher describeParametersPaginator()
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a variant of
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation.
default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
describePatchBaselinesRequest
- default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines()
Lists the patch baselines in your AWS account.
default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
DescribePatchBaselinesRequest.Builder
avoiding the
need to create one manually via DescribePatchBaselinesRequest.builder()
describePatchBaselinesRequest
- a Consumer
that will call methods on DescribePatchBaselinesRequest.Builder
.default CompletableFuture<DescribePatchGroupStateResponse> describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupStateRequest
- default CompletableFuture<DescribePatchGroupStateResponse> describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
DescribePatchGroupStateRequest.Builder
avoiding
the need to create one manually via DescribePatchGroupStateRequest.builder()
describePatchGroupStateRequest
- a Consumer
that will call methods on DescribePatchGroupStateRequest.Builder
.default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest
- default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups()
Lists all patch groups that have been registered with patch baselines.
default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
DescribePatchGroupsRequest.Builder
avoiding the
need to create one manually via DescribePatchGroupsRequest.builder()
describePatchGroupsRequest
- a Consumer
that will call methods on DescribePatchGroupsRequest.Builder
.default CompletableFuture<GetAutomationExecutionResponse> getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
getAutomationExecutionRequest
- default CompletableFuture<GetAutomationExecutionResponse> getAutomationExecution(Consumer<GetAutomationExecutionRequest.Builder> getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
GetAutomationExecutionRequest.Builder
avoiding the
need to create one manually via GetAutomationExecutionRequest.builder()
getAutomationExecutionRequest
- a Consumer
that will call methods on GetAutomationExecutionRequest.Builder
.default CompletableFuture<GetCommandInvocationResponse> getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocationRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<GetCommandInvocationResponse> getCommandInvocation(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocationRequest.Builder
avoiding the
need to create one manually via GetCommandInvocationRequest.builder()
getCommandInvocationRequest
- a Consumer
that will call methods on GetCommandInvocationRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<GetDefaultPatchBaselineResponse> getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
getDefaultPatchBaselineRequest
- default CompletableFuture<GetDefaultPatchBaselineResponse> getDefaultPatchBaseline()
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
default CompletableFuture<GetDefaultPatchBaselineResponse> getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest)
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
GetDefaultPatchBaselineRequest.Builder
avoiding
the need to create one manually via GetDefaultPatchBaselineRequest.builder()
getDefaultPatchBaselineRequest
- a Consumer
that will call methods on GetDefaultPatchBaselineRequest.Builder
.default CompletableFuture<GetDeployablePatchSnapshotForInstanceResponse> getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstanceRequest
- default CompletableFuture<GetDeployablePatchSnapshotForInstanceResponse> getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
GetDeployablePatchSnapshotForInstanceRequest.Builder
avoiding the need to create one manually via
GetDeployablePatchSnapshotForInstanceRequest.builder()
getDeployablePatchSnapshotForInstanceRequest
- a Consumer
that will call methods on GetDeployablePatchSnapshotForInstanceRequest.Builder
.default CompletableFuture<GetDocumentResponse> getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Systems Manager document.
getDocumentRequest
- default CompletableFuture<GetDocumentResponse> getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Gets the contents of the specified Systems Manager document.
GetDocumentRequest.Builder
avoiding the need to
create one manually via GetDocumentRequest.builder()
getDocumentRequest
- a Consumer
that will call methods on GetDocumentRequest.Builder
.default CompletableFuture<GetInventoryResponse> getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
getInventoryRequest
- default CompletableFuture<GetInventoryResponse> getInventory()
Query inventory information.
default CompletableFuture<GetInventoryResponse> getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
Query inventory information.
GetInventoryRequest.Builder
avoiding the need to
create one manually via GetInventoryRequest.builder()
getInventoryRequest
- a Consumer
that will call methods on GetInventoryRequest.Builder
.default CompletableFuture<GetInventorySchemaResponse> getInventorySchema(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
- default CompletableFuture<GetInventorySchemaResponse> getInventorySchema()
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
default CompletableFuture<GetInventorySchemaResponse> getInventorySchema(Consumer<GetInventorySchemaRequest.Builder> 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.Builder
avoiding the
need to create one manually via GetInventorySchemaRequest.builder()
getInventorySchemaRequest
- a Consumer
that will call methods on GetInventorySchemaRequest.Builder
.default CompletableFuture<GetMaintenanceWindowResponse> getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a Maintenance Window.
getMaintenanceWindowRequest
- default CompletableFuture<GetMaintenanceWindowResponse> getMaintenanceWindow(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest)
Retrieves a Maintenance Window.
GetMaintenanceWindowRequest.Builder
avoiding the
need to create one manually via GetMaintenanceWindowRequest.builder()
getMaintenanceWindowRequest
- a Consumer
that will call methods on GetMaintenanceWindowRequest.Builder
.default CompletableFuture<GetMaintenanceWindowExecutionResponse> getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
getMaintenanceWindowExecutionRequest
- default CompletableFuture<GetMaintenanceWindowExecutionResponse> getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
GetMaintenanceWindowExecutionRequest.Builder
avoiding the need to create one manually via GetMaintenanceWindowExecutionRequest.builder()
getMaintenanceWindowExecutionRequest
- a Consumer
that will call methods on GetMaintenanceWindowExecutionRequest.Builder
.default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
getMaintenanceWindowExecutionTaskRequest
- default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
GetMaintenanceWindowExecutionTaskRequest.Builder
avoiding the need to create one manually via GetMaintenanceWindowExecutionTaskRequest.builder()
getMaintenanceWindowExecutionTaskRequest
- a Consumer
that will call methods on GetMaintenanceWindowExecutionTaskRequest.Builder
.default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.
getMaintenanceWindowExecutionTaskInvocationRequest
- default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.
GetMaintenanceWindowExecutionTaskInvocationRequest.Builder
avoiding the need to create one manually via
GetMaintenanceWindowExecutionTaskInvocationRequest.builder()
getMaintenanceWindowExecutionTaskInvocationRequest
- a Consumer
that will call methods on
GetMaintenanceWindowExecutionTaskInvocationRequest.Builder
.default CompletableFuture<GetMaintenanceWindowTaskResponse> getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a Maintenance Window.
getMaintenanceWindowTaskRequest
- default CompletableFuture<GetMaintenanceWindowTaskResponse> getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest)
Lists the tasks in a Maintenance Window.
GetMaintenanceWindowTaskRequest.Builder
avoiding
the need to create one manually via GetMaintenanceWindowTaskRequest.builder()
getMaintenanceWindowTaskRequest
- a Consumer
that will call methods on GetMaintenanceWindowTaskRequest.Builder
.default CompletableFuture<GetParameterResponse> getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name.
getParameterRequest
- default CompletableFuture<GetParameterResponse> getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)
Get information about a parameter by using the parameter name.
GetParameterRequest.Builder
avoiding the need to
create one manually via GetParameterRequest.builder()
getParameterRequest
- a Consumer
that will call methods on GetParameterRequest.Builder
.default CompletableFuture<GetParameterHistoryResponse> getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
getParameterHistoryRequest
- default CompletableFuture<GetParameterHistoryResponse> getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
GetParameterHistoryRequest.Builder
avoiding the
need to create one manually via GetParameterHistoryRequest.builder()
getParameterHistoryRequest
- a Consumer
that will call methods on GetParameterHistoryRequest.Builder
.default GetParameterHistoryPublisher getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
This is a variant of
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
operation.
getParameterHistoryRequest
- default CompletableFuture<GetParametersResponse> getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter.
getParametersRequest
- default CompletableFuture<GetParametersResponse> getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)
Get details of a parameter.
GetParametersRequest.Builder
avoiding the need to
create one manually via GetParametersRequest.builder()
getParametersRequest
- a Consumer
that will call methods on GetParametersRequest.Builder
.default CompletableFuture<GetParametersByPathResponse> getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.
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
- default CompletableFuture<GetParametersByPathResponse> getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.
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.Builder
avoiding the
need to create one manually via GetParametersByPathRequest.builder()
getParametersByPathRequest
- a Consumer
that will call methods on GetParametersByPathRequest.Builder
.default GetParametersByPathPublisher getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)
Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.
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.
This is a variant of
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation.
getParametersByPathRequest
- default CompletableFuture<GetPatchBaselineResponse> getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
getPatchBaselineRequest
- default CompletableFuture<GetPatchBaselineResponse> getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest)
Retrieves information about a patch baseline.
GetPatchBaselineRequest.Builder
avoiding the need
to create one manually via GetPatchBaselineRequest.builder()
getPatchBaselineRequest
- a Consumer
that will call methods on GetPatchBaselineRequest.Builder
.default CompletableFuture<GetPatchBaselineForPatchGroupResponse> getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupRequest
- default CompletableFuture<GetPatchBaselineForPatchGroupResponse> getPatchBaselineForPatchGroup(Consumer<GetPatchBaselineForPatchGroupRequest.Builder> getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
GetPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via GetPatchBaselineForPatchGroupRequest.builder()
getPatchBaselineForPatchGroupRequest
- a Consumer
that will call methods on GetPatchBaselineForPatchGroupRequest.Builder
.default CompletableFuture<ListAssociationVersionsResponse> listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsRequest
- default CompletableFuture<ListAssociationVersionsResponse> listAssociationVersions(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
ListAssociationVersionsRequest.Builder
avoiding
the need to create one manually via ListAssociationVersionsRequest.builder()
listAssociationVersionsRequest
- a Consumer
that will call methods on ListAssociationVersionsRequest.Builder
.default CompletableFuture<ListAssociationsResponse> listAssociations(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
listAssociationsRequest
- default CompletableFuture<ListAssociationsResponse> listAssociations()
Lists the associations for the specified Systems Manager document or instance.
default CompletableFuture<ListAssociationsResponse> listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
ListAssociationsRequest.Builder
avoiding the need
to create one manually via ListAssociationsRequest.builder()
listAssociationsRequest
- a Consumer
that will call methods on ListAssociationsRequest.Builder
.default ListAssociationsPublisher listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation.
listAssociationsRequest
- default ListAssociationsPublisher listAssociationsPaginator()
Lists the associations for the specified Systems Manager document or instance.
This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation.
default CompletableFuture<ListCommandInvocationsResponse> listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
listCommandInvocationsRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListCommandInvocationsResponse> listCommandInvocations()
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListCommandInvocationsResponse> listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
ListCommandInvocationsRequest.Builder
avoiding the
need to create one manually via ListCommandInvocationsRequest.builder()
listCommandInvocationsRequest
- a Consumer
that will call methods on ListCommandInvocationsRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default ListCommandInvocationsPublisher listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
This is a variant of
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation.
listCommandInvocationsRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default ListCommandInvocationsPublisher listCommandInvocationsPaginator()
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
This is a variant of
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation.
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListCommandsResponse> listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
listCommandsRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListCommandsResponse> listCommands()
Lists the commands requested by users of the AWS account.
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListCommandsResponse> listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
Lists the commands requested by users of the AWS account.
ListCommandsRequest.Builder
avoiding the need to
create one manually via ListCommandsRequest.builder()
listCommandsRequest
- a Consumer
that will call methods on ListCommandsRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default ListCommandsPublisher listCommandsPaginator(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation.
listCommandsRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default ListCommandsPublisher listCommandsPaginator()
Lists the commands requested by users of the AWS account.
This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation.
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListComplianceItemsResponse> listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItemsRequest
- default CompletableFuture<ListComplianceItemsResponse> listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
ListComplianceItemsRequest.Builder
avoiding the
need to create one manually via ListComplianceItemsRequest.builder()
listComplianceItemsRequest
- a Consumer
that will call methods on ListComplianceItemsRequest.Builder
.default CompletableFuture<ListComplianceSummariesResponse> listComplianceSummaries(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
- default CompletableFuture<ListComplianceSummariesResponse> listComplianceSummaries()
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.
default CompletableFuture<ListComplianceSummariesResponse> listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> 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.Builder
avoiding
the need to create one manually via ListComplianceSummariesRequest.builder()
listComplianceSummariesRequest
- a Consumer
that will call methods on ListComplianceSummariesRequest.Builder
.default CompletableFuture<ListDocumentVersionsResponse> listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
listDocumentVersionsRequest
- default CompletableFuture<ListDocumentVersionsResponse> listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.
ListDocumentVersionsRequest.Builder
avoiding the
need to create one manually via ListDocumentVersionsRequest.builder()
listDocumentVersionsRequest
- a Consumer
that will call methods on ListDocumentVersionsRequest.Builder
.default CompletableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your Systems Manager documents.
listDocumentsRequest
- default CompletableFuture<ListDocumentsResponse> listDocuments()
Describes one or more of your Systems Manager documents.
default CompletableFuture<ListDocumentsResponse> listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Describes one or more of your Systems Manager documents.
ListDocumentsRequest.Builder
avoiding the need to
create one manually via ListDocumentsRequest.builder()
listDocumentsRequest
- a Consumer
that will call methods on ListDocumentsRequest.Builder
.default ListDocumentsPublisher listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your Systems Manager documents.
This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation.
listDocumentsRequest
- default ListDocumentsPublisher listDocumentsPaginator()
Describes one or more of your Systems Manager documents.
This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation.
default CompletableFuture<ListInventoryEntriesResponse> listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
listInventoryEntriesRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListInventoryEntriesResponse> listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest)
A list of inventory items returned by the request.
ListInventoryEntriesRequest.Builder
avoiding the
need to create one manually via ListInventoryEntriesRequest.builder()
listInventoryEntriesRequest
- a Consumer
that will call methods on ListInventoryEntriesRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListResourceComplianceSummariesResponse> listResourceComplianceSummaries(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
- default CompletableFuture<ListResourceComplianceSummariesResponse> listResourceComplianceSummaries()
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.
default CompletableFuture<ListResourceComplianceSummariesResponse> listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> 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.Builder
avoiding the need to create one manually via ListResourceComplianceSummariesRequest.builder()
listResourceComplianceSummariesRequest
- a Consumer
that will call methods on ListResourceComplianceSummariesRequest.Builder
.default CompletableFuture<ListResourceDataSyncResponse> listResourceDataSync(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
- default CompletableFuture<ListResourceDataSyncResponse> listResourceDataSync()
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.
default CompletableFuture<ListResourceDataSyncResponse> listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> 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.Builder
avoiding the
need to create one manually via ListResourceDataSyncRequest.builder()
listResourceDataSyncRequest
- a Consumer
that will call methods on ListResourceDataSyncRequest.Builder
.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
listTagsForResourceRequest
- default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- a Consumer
that will call methods on ListTagsForResourceRequest.Builder
.default CompletableFuture<ModifyDocumentPermissionResponse> modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermissionRequest
- default CompletableFuture<ModifyDocumentPermissionResponse> modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
ModifyDocumentPermissionRequest.Builder
avoiding
the need to create one manually via ModifyDocumentPermissionRequest.builder()
modifyDocumentPermissionRequest
- a Consumer
that will call methods on ModifyDocumentPermissionRequest.Builder
.default CompletableFuture<PutComplianceItemsResponse> putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource. This action 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.
putComplianceItemsRequest
- default CompletableFuture<PutComplianceItemsResponse> putComplianceItems(Consumer<PutComplianceItemsRequest.Builder> putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource. This action 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.
PutComplianceItemsRequest.Builder
avoiding the
need to create one manually via PutComplianceItemsRequest.builder()
putComplianceItemsRequest
- a Consumer
that will call methods on PutComplianceItemsRequest.Builder
.default CompletableFuture<PutInventoryResponse> putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventoryRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
Context
attribute that you specified for
the InventoryItem
is not allowed for this inventory type. You can only use the
Context
attribute with inventory types like AWS:ComplianceItem
.Context
attribute for InventoryItem
. Verify the keys and values, and try again.default CompletableFuture<PutInventoryResponse> putInventory(Consumer<PutInventoryRequest.Builder> putInventoryRequest)
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
PutInventoryRequest.Builder
avoiding the need to
create one manually via PutInventoryRequest.builder()
putInventoryRequest
- a Consumer
that will call methods on PutInventoryRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
Context
attribute that you specified for
the InventoryItem
is not allowed for this inventory type. You can only use the
Context
attribute with inventory types like AWS:ComplianceItem
.Context
attribute for InventoryItem
. Verify the keys and values, and try again.default CompletableFuture<PutParameterResponse> putParameter(PutParameterRequest putParameterRequest)
Add one or more parameters to the system.
putParameterRequest
- /Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Working with Systems Manager Parameters.
default CompletableFuture<PutParameterResponse> putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest)
Add one or more parameters to the system.
PutParameterRequest.Builder
avoiding the need to
create one manually via PutParameterRequest.builder()
putParameterRequest
- a Consumer
that will call methods on PutParameterRequest.Builder
./Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Working with Systems Manager Parameters.
default CompletableFuture<RegisterDefaultPatchBaselineResponse> registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline.
registerDefaultPatchBaselineRequest
- default CompletableFuture<RegisterDefaultPatchBaselineResponse> registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)
Defines the default patch baseline.
RegisterDefaultPatchBaselineRequest.Builder
avoiding the need to create one manually via RegisterDefaultPatchBaselineRequest.builder()
registerDefaultPatchBaselineRequest
- a Consumer
that will call methods on RegisterDefaultPatchBaselineRequest.Builder
.default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroupRequest
- default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
RegisterPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via RegisterPatchBaselineForPatchGroupRequest.builder()
registerPatchBaselineForPatchGroupRequest
- a Consumer
that will call methods on RegisterPatchBaselineForPatchGroupRequest.Builder
.default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a Maintenance Window.
registerTargetWithMaintenanceWindowRequest
- default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest)
Registers a target with a Maintenance Window.
RegisterTargetWithMaintenanceWindowRequest.Builder
avoiding the need to create one manually via RegisterTargetWithMaintenanceWindowRequest.builder()
registerTargetWithMaintenanceWindowRequest
- a Consumer
that will call methods on RegisterTargetWithMaintenanceWindowRequest.Builder
.default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a Maintenance Window.
registerTaskWithMaintenanceWindowRequest
- default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest)
Adds a new task to a Maintenance Window.
RegisterTaskWithMaintenanceWindowRequest.Builder
avoiding the need to create one manually via RegisterTaskWithMaintenanceWindowRequest.builder()
registerTaskWithMaintenanceWindowRequest
- a Consumer
that will call methods on RegisterTaskWithMaintenanceWindowRequest.Builder
.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes all tags from the specified resource.
removeTagsFromResourceRequest
- default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes all tags from the specified resource.
RemoveTagsFromResourceRequest.Builder
avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest
- a Consumer
that will call methods on RemoveTagsFromResourceRequest.Builder
.default CompletableFuture<SendAutomationSignalResponse> sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignalRequest
- default CompletableFuture<SendAutomationSignalResponse> sendAutomationSignal(Consumer<SendAutomationSignalRequest.Builder> sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
SendAutomationSignalRequest.Builder
avoiding the
need to create one manually via SendAutomationSignalRequest.builder()
sendAutomationSignalRequest
- a Consumer
that will call methods on SendAutomationSignalRequest.Builder
.default CompletableFuture<SendCommandResponse> sendCommand(SendCommandRequest sendCommandRequest)
Executes commands on one or more managed instances.
sendCommandRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<SendCommandResponse> sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
Executes commands on one or more managed instances.
SendCommandRequest.Builder
avoiding the need to
create one manually via SendCommandRequest.builder()
sendCommandRequest
- a Consumer
that will call methods on SendCommandRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<StartAutomationExecutionResponse> startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
startAutomationExecutionRequest
- default CompletableFuture<StartAutomationExecutionResponse> startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest)
Initiates execution of an Automation document.
StartAutomationExecutionRequest.Builder
avoiding
the need to create one manually via StartAutomationExecutionRequest.builder()
startAutomationExecutionRequest
- a Consumer
that will call methods on StartAutomationExecutionRequest.Builder
.default CompletableFuture<StopAutomationExecutionResponse> stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently executing.
stopAutomationExecutionRequest
- default CompletableFuture<StopAutomationExecutionResponse> stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)
Stop an Automation that is currently executing.
StopAutomationExecutionRequest.Builder
avoiding
the need to create one manually via StopAutomationExecutionRequest.builder()
stopAutomationExecutionRequest
- a Consumer
that will call methods on StopAutomationExecutionRequest.Builder
.default CompletableFuture<UpdateAssociationResponse> updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
updateAssociationRequest
- $LATEST
parameter to view the latest version of the association.default CompletableFuture<UpdateAssociationResponse> updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest)
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
UpdateAssociationRequest.Builder
avoiding the need
to create one manually via UpdateAssociationRequest.builder()
updateAssociationRequest
- a Consumer
that will call methods on UpdateAssociationRequest.Builder
.$LATEST
parameter to view the latest version of the association.default CompletableFuture<UpdateAssociationStatusResponse> updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
updateAssociationStatusRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<UpdateAssociationStatusResponse> updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
UpdateAssociationStatusRequest.Builder
avoiding
the need to create one manually via UpdateAssociationStatusRequest.builder()
updateAssociationStatusRequest
- a Consumer
that will call methods on UpdateAssociationStatusRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<UpdateDocumentResponse> updateDocument(UpdateDocumentRequest updateDocumentRequest)
The document you want to update.
updateDocumentRequest
- default CompletableFuture<UpdateDocumentResponse> updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
The document you want to update.
UpdateDocumentRequest.Builder
avoiding the need to
create one manually via UpdateDocumentRequest.builder()
updateDocumentRequest
- a Consumer
that will call methods on UpdateDocumentRequest.Builder
.default CompletableFuture<UpdateDocumentDefaultVersionResponse> updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
updateDocumentDefaultVersionRequest
- default CompletableFuture<UpdateDocumentDefaultVersionResponse> updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest)
Set the default version of a document.
UpdateDocumentDefaultVersionRequest.Builder
avoiding the need to create one manually via UpdateDocumentDefaultVersionRequest.builder()
updateDocumentDefaultVersionRequest
- a Consumer
that will call methods on UpdateDocumentDefaultVersionRequest.Builder
.default CompletableFuture<UpdateMaintenanceWindowResponse> updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing Maintenance Window. Only specified parameters are modified.
updateMaintenanceWindowRequest
- default CompletableFuture<UpdateMaintenanceWindowResponse> updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest)
Updates an existing Maintenance Window. Only specified parameters are modified.
UpdateMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via UpdateMaintenanceWindowRequest.builder()
updateMaintenanceWindowRequest
- a Consumer
that will call methods on UpdateMaintenanceWindowRequest.Builder
.default CompletableFuture<UpdateMaintenanceWindowTargetResponse> updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following:
The target from being an ID target to a Tag target, or a Tag target to an ID target.
IDs for an ID target.
Tags for a Tag target.
Owner.
Name.
Description.
If a parameter is null, then the corresponding field is not modified.
updateMaintenanceWindowTargetRequest
- default CompletableFuture<UpdateMaintenanceWindowTargetResponse> updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest)
Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following:
The target from being an ID target to a Tag target, or a Tag target to an ID target.
IDs for an ID target.
Tags for a Tag target.
Owner.
Name.
Description.
If a parameter is null, then the corresponding field is not modified.
UpdateMaintenanceWindowTargetRequest.Builder
avoiding the need to create one manually via UpdateMaintenanceWindowTargetRequest.builder()
updateMaintenanceWindowTargetRequest
- a Consumer
that will call methods on UpdateMaintenanceWindowTargetRequest.Builder
.default CompletableFuture<UpdateMaintenanceWindowTaskResponse> updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:
Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
Service role ARN.
Task parameters.
Task priority.
Task MaxConcurrency and MaxErrors.
Log location.
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
updateMaintenanceWindowTaskRequest
- default CompletableFuture<UpdateMaintenanceWindowTaskResponse> updateMaintenanceWindowTask(Consumer<UpdateMaintenanceWindowTaskRequest.Builder> updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:
Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
Service role ARN.
Task parameters.
Task priority.
Task MaxConcurrency and MaxErrors.
Log location.
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
UpdateMaintenanceWindowTaskRequest.Builder
avoiding the need to create one manually via UpdateMaintenanceWindowTaskRequest.builder()
updateMaintenanceWindowTaskRequest
- a Consumer
that will call methods on UpdateMaintenanceWindowTaskRequest.Builder
.default CompletableFuture<UpdateManagedInstanceRoleResponse> updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
updateManagedInstanceRoleRequest
- You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<UpdateManagedInstanceRoleResponse> updateManagedInstanceRole(Consumer<UpdateManagedInstanceRoleRequest.Builder> updateManagedInstanceRoleRequest)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
UpdateManagedInstanceRoleRequest.Builder
avoiding
the need to create one manually via UpdateManagedInstanceRoleRequest.builder()
updateManagedInstanceRoleRequest
- a Consumer
that will call methods on UpdateManagedInstanceRoleRequest.Builder
.You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<UpdatePatchBaselineResponse> updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
updatePatchBaselineRequest
- default CompletableFuture<UpdatePatchBaselineResponse> updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
UpdatePatchBaselineRequest.Builder
avoiding the
need to create one manually via UpdatePatchBaselineRequest.builder()
updatePatchBaselineRequest
- a Consumer
that will call methods on UpdatePatchBaselineRequest.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.