@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SsmAsyncClient extends SdkClient
builder()
method.
AWS 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 Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the AWS Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide.
For information about other API actions you can perform on 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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
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.
|
default CompletableFuture<CancelMaintenanceWindowExecutionResponse> |
cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have
not already starting running.
|
default CompletableFuture<CancelMaintenanceWindowExecutionResponse> |
cancelMaintenanceWindowExecution(Consumer<CancelMaintenanceWindowExecutionRequest.Builder> cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have
not already starting running.
|
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)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine
(VM) with Systems Manager.
|
default CompletableFuture<CreateActivationResponse> |
createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine
(VM) with Systems Manager.
|
default CompletableFuture<CreateAssociationResponse> |
createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)
A State Manager association defines the state that you want to maintain on your instances.
|
default CompletableFuture<CreateAssociationResponse> |
createAssociation(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your instances.
|
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 (SSM) document.
|
default CompletableFuture<CreateDocumentResponse> |
createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager (SSM) 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<CreateOpsItemResponse> |
createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest)
Creates a new OpsItem.
|
default CompletableFuture<CreateOpsItemResponse> |
createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem.
|
default CompletableFuture<CreateOpsMetadataResponse> |
createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest)
If you create a new application in Application Manager, Systems Manager calls this API action to specify
information about the new application, including the application type.
|
default CompletableFuture<CreateOpsMetadataResponse> |
createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)
If you create a new application in Application Manager, Systems Manager calls this API action to specify
information about the new application, including the application type.
|
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)
A resource data sync helps you view data from multiple sources in a single location.
|
default CompletableFuture<CreateResourceDataSyncResponse> |
createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location.
|
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<DeleteInventoryResponse> |
deleteInventory(Consumer<DeleteInventoryRequest.Builder> deleteInventoryRequest)
Delete a custom inventory type or the data associated with a custom Inventory type.
|
default CompletableFuture<DeleteInventoryResponse> |
deleteInventory(DeleteInventoryRequest deleteInventoryRequest)
Delete a custom inventory type or the data associated with a custom Inventory type.
|
default CompletableFuture<DeleteMaintenanceWindowResponse> |
deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)
Deletes a maintenance window.
|
default CompletableFuture<DeleteMaintenanceWindowResponse> |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a maintenance window.
|
default CompletableFuture<DeleteOpsMetadataResponse> |
deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
|
default CompletableFuture<DeleteOpsMetadataResponse> |
deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
|
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()
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default CompletableFuture<DescribeActivationsResponse> |
describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default CompletableFuture<DescribeActivationsResponse> |
describeActivations(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsPublisher |
describeActivationsPaginator()
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsPublisher |
describeActivationsPaginator(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsPublisher |
describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
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<DescribeAssociationExecutionsResponse> |
describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default CompletableFuture<DescribeAssociationExecutionsResponse> |
describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default DescribeAssociationExecutionsPublisher |
describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default DescribeAssociationExecutionsPublisher |
describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default CompletableFuture<DescribeAssociationExecutionTargetsResponse> |
describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
default CompletableFuture<DescribeAssociationExecutionTargetsResponse> |
describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
default DescribeAssociationExecutionTargetsPublisher |
describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
default DescribeAssociationExecutionTargetsPublisher |
describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
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 DescribeAutomationExecutionsPublisher |
describeAutomationExecutionsPaginator()
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationExecutionsPublisher |
describeAutomationExecutionsPaginator(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationExecutionsPublisher |
describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default CompletableFuture<DescribeAutomationStepExecutionsResponse> |
describeAutomationStepExecutions(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default CompletableFuture<DescribeAutomationStepExecutionsResponse> |
describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default DescribeAutomationStepExecutionsPublisher |
describeAutomationStepExecutionsPaginator(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default DescribeAutomationStepExecutionsPublisher |
describeAutomationStepExecutionsPaginator(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default CompletableFuture<DescribeAvailablePatchesResponse> |
describeAvailablePatches()
Lists all patches eligible to be included in a patch baseline.
|
default CompletableFuture<DescribeAvailablePatchesResponse> |
describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
default CompletableFuture<DescribeAvailablePatchesResponse> |
describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesPublisher |
describeAvailablePatchesPaginator()
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesPublisher |
describeAvailablePatchesPaginator(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesPublisher |
describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to 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 DescribeEffectiveInstanceAssociationsPublisher |
describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default DescribeEffectiveInstanceAssociationsPublisher |
describeEffectiveInstanceAssociationsPaginator(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 DescribeEffectivePatchesForPatchBaselinePublisher |
describeEffectivePatchesForPatchBaselinePaginator(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default DescribeEffectivePatchesForPatchBaselinePublisher |
describeEffectivePatchesForPatchBaselinePaginator(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 DescribeInstanceAssociationsStatusPublisher |
describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default DescribeInstanceAssociationsStatusPublisher |
describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default CompletableFuture<DescribeInstanceInformationResponse> |
describeInstanceInformation()
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default CompletableFuture<DescribeInstanceInformationResponse> |
describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default CompletableFuture<DescribeInstanceInformationResponse> |
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationPublisher |
describeInstanceInformationPaginator()
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationPublisher |
describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationPublisher |
describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
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 DescribeInstancePatchesPublisher |
describeInstancePatchesPaginator(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 DescribeInstancePatchesPublisher |
describeInstancePatchesPaginator(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 DescribeInstancePatchStatesForPatchGroupPublisher |
describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeInstancePatchStatesForPatchGroupPublisher |
describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeInstancePatchStatesPublisher |
describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default DescribeInstancePatchStatesPublisher |
describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default CompletableFuture<DescribeInventoryDeletionsResponse> |
describeInventoryDeletions()
Describes a specific delete inventory operation.
|
default CompletableFuture<DescribeInventoryDeletionsResponse> |
describeInventoryDeletions(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
default CompletableFuture<DescribeInventoryDeletionsResponse> |
describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsPublisher |
describeInventoryDeletionsPaginator()
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsPublisher |
describeInventoryDeletionsPaginator(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsPublisher |
describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
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 DescribeMaintenanceWindowExecutionsPublisher |
describeMaintenanceWindowExecutionsPaginator(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)
Lists the executions of a maintenance window.
|
default DescribeMaintenanceWindowExecutionsPublisher |
describeMaintenanceWindowExecutionsPaginator(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 run 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 run as part of a maintenance
window execution.
|
default DescribeMaintenanceWindowExecutionTaskInvocationsPublisher |
describeMaintenanceWindowExecutionTaskInvocationsPaginator(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
default DescribeMaintenanceWindowExecutionTaskInvocationsPublisher |
describeMaintenanceWindowExecutionTaskInvocationsPaginator(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run 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 run.
|
default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
default DescribeMaintenanceWindowExecutionTasksPublisher |
describeMaintenanceWindowExecutionTasksPaginator(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
default DescribeMaintenanceWindowExecutionTasksPublisher |
describeMaintenanceWindowExecutionTasksPaginator(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
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<DescribeMaintenanceWindowScheduleResponse> |
describeMaintenanceWindowSchedule(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default CompletableFuture<DescribeMaintenanceWindowScheduleResponse> |
describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default DescribeMaintenanceWindowSchedulePublisher |
describeMaintenanceWindowSchedulePaginator(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default DescribeMaintenanceWindowSchedulePublisher |
describeMaintenanceWindowSchedulePaginator(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default CompletableFuture<DescribeMaintenanceWindowsForTargetResponse> |
describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default CompletableFuture<DescribeMaintenanceWindowsForTargetResponse> |
describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default DescribeMaintenanceWindowsForTargetPublisher |
describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default DescribeMaintenanceWindowsForTargetPublisher |
describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default DescribeMaintenanceWindowsPublisher |
describeMaintenanceWindowsPaginator()
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowsPublisher |
describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowsPublisher |
describeMaintenanceWindowsPaginator(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 DescribeMaintenanceWindowTargetsPublisher |
describeMaintenanceWindowTargetsPaginator(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
|
default DescribeMaintenanceWindowTargetsPublisher |
describeMaintenanceWindowTargetsPaginator(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 DescribeMaintenanceWindowTasksPublisher |
describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
|
default DescribeMaintenanceWindowTasksPublisher |
describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
|
default CompletableFuture<DescribeOpsItemsResponse> |
describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
Query a set of OpsItems.
|
default CompletableFuture<DescribeOpsItemsResponse> |
describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems.
|
default DescribeOpsItemsPublisher |
describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
Query a set of OpsItems.
|
default DescribeOpsItemsPublisher |
describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems.
|
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(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
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 DescribePatchBaselinesPublisher |
describePatchBaselinesPaginator()
Lists the patch baselines in your AWS account.
|
default DescribePatchBaselinesPublisher |
describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default DescribePatchBaselinesPublisher |
describePatchBaselinesPaginator(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 DescribePatchGroupsPublisher |
describePatchGroupsPaginator()
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupsPublisher |
describePatchGroupsPaginator(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupsPublisher |
describePatchGroupsPaginator(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<DescribePatchPropertiesResponse> |
describePatchProperties(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default CompletableFuture<DescribePatchPropertiesResponse> |
describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default DescribePatchPropertiesPublisher |
describePatchPropertiesPaginator(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default DescribePatchPropertiesPublisher |
describePatchPropertiesPaginator(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default CompletableFuture<DescribeSessionsResponse> |
describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
default CompletableFuture<DescribeSessionsResponse> |
describeSessions(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
default DescribeSessionsPublisher |
describeSessionsPaginator(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
default DescribeSessionsPublisher |
describeSessionsPaginator(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
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<GetCalendarStateResponse> |
getCalendarState(Consumer<GetCalendarStateRequest.Builder> getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time.
|
default CompletableFuture<GetCalendarStateResponse> |
getCalendarState(GetCalendarStateRequest getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time.
|
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<GetConnectionStatusResponse> |
getConnectionStatus(Consumer<GetConnectionStatusRequest.Builder> getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to
receive Session Manager connections.
|
default CompletableFuture<GetConnectionStatusResponse> |
getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to
receive Session Manager connections.
|
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 GetInventoryPublisher |
getInventoryPaginator()
Query inventory information.
|
default GetInventoryPublisher |
getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
Query inventory information.
|
default GetInventoryPublisher |
getInventoryPaginator(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 GetInventorySchemaPublisher |
getInventorySchemaPaginator()
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
default GetInventorySchemaPublisher |
getInventorySchemaPaginator(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 GetInventorySchemaPublisher |
getInventorySchemaPaginator(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 a maintenance window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionResponse> |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> |
getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> |
getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
|
default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> |
getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
|
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<GetOpsItemResponse> |
getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest)
Get information about an OpsItem by using the ID.
|
default CompletableFuture<GetOpsItemResponse> |
getOpsItem(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID.
|
default CompletableFuture<GetOpsMetadataResponse> |
getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
|
default CompletableFuture<GetOpsMetadataResponse> |
getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
|
default CompletableFuture<GetOpsSummaryResponse> |
getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
default CompletableFuture<GetOpsSummaryResponse> |
getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
default GetOpsSummaryPublisher |
getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
default GetOpsSummaryPublisher |
getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
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)
Retrieves the history of all changes to a parameter.
|
default CompletableFuture<GetParameterHistoryResponse> |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
default GetParameterHistoryPublisher |
getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
default GetParameterHistoryPublisher |
getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
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 information about one or more parameters in a specific hierarchy.
|
default CompletableFuture<GetParametersByPathResponse> |
getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
|
default GetParametersByPathPublisher |
getParametersByPathPaginator(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
|
default GetParametersByPathPublisher |
getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)
Retrieve information about one or more 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<GetServiceSettingResponse> |
getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default CompletableFuture<GetServiceSettingResponse> |
getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default CompletableFuture<LabelParameterVersionResponse> |
labelParameterVersion(Consumer<LabelParameterVersionRequest.Builder> labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter.
|
default CompletableFuture<LabelParameterVersionResponse> |
labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter.
|
default CompletableFuture<ListAssociationsResponse> |
listAssociations()
Returns all State Manager associations in the current AWS account and Region.
|
default CompletableFuture<ListAssociationsResponse> |
listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
default CompletableFuture<ListAssociationsResponse> |
listAssociations(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsPublisher |
listAssociationsPaginator()
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsPublisher |
listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsPublisher |
listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
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 ListAssociationVersionsPublisher |
listAssociationVersionsPaginator(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
default ListAssociationVersionsPublisher |
listAssociationVersionsPaginator(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(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
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(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
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 ListComplianceItemsPublisher |
listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
default ListComplianceItemsPublisher |
listComplianceItemsPaginator(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 ListComplianceSummariesPublisher |
listComplianceSummariesPaginator()
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListComplianceSummariesPublisher |
listComplianceSummariesPaginator(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListComplianceSummariesPublisher |
listComplianceSummariesPaginator(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default CompletableFuture<ListDocumentMetadataHistoryResponse> |
listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of an SSM document.
|
default CompletableFuture<ListDocumentMetadataHistoryResponse> |
listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of an SSM document.
|
default CompletableFuture<ListDocumentsResponse> |
listDocuments()
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default CompletableFuture<ListDocumentsResponse> |
listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default CompletableFuture<ListDocumentsResponse> |
listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsPublisher |
listDocumentsPaginator()
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsPublisher |
listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsPublisher |
listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
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 ListDocumentVersionsPublisher |
listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.
|
default ListDocumentVersionsPublisher |
listDocumentVersionsPaginator(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<ListOpsItemEventsResponse> |
listOpsItemEvents(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default CompletableFuture<ListOpsItemEventsResponse> |
listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default ListOpsItemEventsPublisher |
listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default ListOpsItemEventsPublisher |
listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default CompletableFuture<ListOpsMetadataResponse> |
listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
default CompletableFuture<ListOpsMetadataResponse> |
listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
default ListOpsMetadataPublisher |
listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
default ListOpsMetadataPublisher |
listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
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 ListResourceComplianceSummariesPublisher |
listResourceComplianceSummariesPaginator()
Returns a resource-level summary count.
|
default ListResourceComplianceSummariesPublisher |
listResourceComplianceSummariesPaginator(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
default ListResourceComplianceSummariesPublisher |
listResourceComplianceSummariesPaginator(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 ListResourceDataSyncPublisher |
listResourceDataSyncPaginator()
Lists your resource data sync configurations.
|
default ListResourceDataSyncPublisher |
listResourceDataSyncPaginator(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
default ListResourceDataSyncPublisher |
listResourceDataSyncPaginator(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 a parameter to the system.
|
default CompletableFuture<PutParameterResponse> |
putParameter(PutParameterRequest putParameterRequest)
Add a parameter to the system.
|
default CompletableFuture<RegisterDefaultPatchBaselineResponse> |
registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
|
default CompletableFuture<RegisterDefaultPatchBaselineResponse> |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
|
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 tag keys from the specified resource.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
|
default CompletableFuture<ResetServiceSettingResponse> |
resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default CompletableFuture<ResetServiceSettingResponse> |
resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default CompletableFuture<ResumeSessionResponse> |
resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest)
Reconnects a session to an instance after it has been disconnected.
|
default CompletableFuture<ResumeSessionResponse> |
resumeSession(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to an instance after it has been disconnected.
|
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)
Runs commands on one or more managed instances.
|
default CompletableFuture<SendCommandResponse> |
sendCommand(SendCommandRequest sendCommandRequest)
Runs commands on one or more managed instances.
|
default CompletableFuture<StartAssociationsOnceResponse> |
startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time.
|
default CompletableFuture<StartAssociationsOnceResponse> |
startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time.
|
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<StartChangeRequestExecutionResponse> |
startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest)
Creates a change request for Change Manager.
|
default CompletableFuture<StartChangeRequestExecutionResponse> |
startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
Creates a change request for Change Manager.
|
default CompletableFuture<StartSessionResponse> |
startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session.
|
default CompletableFuture<StartSessionResponse> |
startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session.
|
default CompletableFuture<StopAutomationExecutionResponse> |
stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)
Stop an Automation that is currently running.
|
default CompletableFuture<StopAutomationExecutionResponse> |
stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently running.
|
default CompletableFuture<TerminateSessionResponse> |
terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the
instance.
|
default CompletableFuture<TerminateSessionResponse> |
terminateSession(TerminateSessionRequest terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the
instance.
|
default CompletableFuture<UnlabelParameterVersionResponse> |
unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
|
default CompletableFuture<UnlabelParameterVersionResponse> |
unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
|
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)
Updates one or more values for an SSM document.
|
default CompletableFuture<UpdateDocumentResponse> |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates one or more values for an SSM document.
|
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<UpdateDocumentMetadataResponse> |
updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a document.
|
default CompletableFuture<UpdateDocumentMetadataResponse> |
updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific 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)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or
virtual machines (VM).
|
default CompletableFuture<UpdateManagedInstanceRoleResponse> |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or
virtual machines (VM).
|
default CompletableFuture<UpdateOpsItemResponse> |
updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest)
Edit or change an OpsItem.
|
default CompletableFuture<UpdateOpsItemResponse> |
updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
Edit or change an OpsItem.
|
default CompletableFuture<UpdateOpsMetadataResponse> |
updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest)
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
|
default CompletableFuture<UpdateOpsMetadataResponse> |
updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
|
default CompletableFuture<UpdatePatchBaselineResponse> |
updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
default CompletableFuture<UpdatePatchBaselineResponse> |
updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
default CompletableFuture<UpdateResourceDataSyncResponse> |
updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest)
Update a resource data sync.
|
default CompletableFuture<UpdateResourceDataSyncResponse> |
updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)
Update a resource data sync.
|
default CompletableFuture<UpdateServiceSettingResponse> |
updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default CompletableFuture<UpdateServiceSettingResponse> |
updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default SsmAsyncWaiter |
waiter()
Create an instance of
SsmAsyncWaiter using this client. |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.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 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceRequest
- Targets
parameter includes too many tags. Remove one or
more tags and try the command again.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 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder
avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest
- A Consumer
that will call methods on AddTagsToResourceRequest.Builder
to create a request.Targets
parameter includes too many tags. Remove one or
more tags and try the command again.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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the CancelCommandRequest.Builder
avoiding the need to
create one manually via CancelCommandRequest.builder()
cancelCommandRequest
- A Consumer
that will call methods on CancelCommandRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<CancelMaintenanceWindowExecutionResponse> cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
cancelMaintenanceWindowExecutionRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<CancelMaintenanceWindowExecutionResponse> cancelMaintenanceWindowExecution(Consumer<CancelMaintenanceWindowExecutionRequest.Builder> cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
This is a convenience which creates an instance of the CancelMaintenanceWindowExecutionRequest.Builder
avoiding the need to create one manually via CancelMaintenanceWindowExecutionRequest.builder()
cancelMaintenanceWindowExecutionRequest
- A Consumer
that will call methods on CancelMaintenanceWindowExecutionRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<CreateActivationResponse> createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
createActivationRequest
- default CompletableFuture<CreateActivationResponse> createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
This is a convenience which creates an instance of the CreateActivationRequest.Builder
avoiding the need
to create one manually via CreateActivationRequest.builder()
createActivationRequest
- A Consumer
that will call methods on CreateActivationRequest.Builder
to create a request.default CompletableFuture<CreateAssociationResponse> createAssociation(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
createAssociationRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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)
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
This is a convenience which creates an instance of the CreateAssociationRequest.Builder
avoiding the need
to create one manually via CreateAssociationRequest.builder()
createAssociationRequest
- A Consumer
that will call methods on CreateAssociationRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatchRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
This is a convenience which creates an instance of the CreateAssociationBatchRequest.Builder
avoiding the
need to create one manually via CreateAssociationBatchRequest.builder()
createAssociationBatchRequest
- A Consumer
that will call methods on CreateAssociationBatchRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
createDocumentRequest
- default CompletableFuture<CreateDocumentResponse> createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the CreateDocumentRequest.Builder
avoiding the need to
create one manually via CreateDocumentRequest.builder()
createDocumentRequest
- A Consumer
that will call methods on CreateDocumentRequest.Builder
to create a request.default CompletableFuture<CreateMaintenanceWindowResponse> createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
createMaintenanceWindowRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<CreateMaintenanceWindowResponse> createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
This is a convenience which creates an instance of the CreateMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via CreateMaintenanceWindowRequest.builder()
createMaintenanceWindowRequest
- A Consumer
that will call methods on CreateMaintenanceWindowRequest.Builder
to create a
request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<CreateOpsItemResponse> createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
createOpsItemRequest
- default CompletableFuture<CreateOpsItemResponse> createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest)
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the CreateOpsItemRequest.Builder
avoiding the need to
create one manually via CreateOpsItemRequest.builder()
createOpsItemRequest
- A Consumer
that will call methods on CreateOpsItemRequest.Builder
to create a request.default CompletableFuture<CreateOpsMetadataResponse> createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
createOpsMetadataRequest
- default CompletableFuture<CreateOpsMetadataResponse> createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest)
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
This is a convenience which creates an instance of the CreateOpsMetadataRequest.Builder
avoiding the need
to create one manually via CreateOpsMetadataRequest.builder()
createOpsMetadataRequest
- A Consumer
that will call methods on CreateOpsMetadataRequest.Builder
to create a request.default CompletableFuture<CreatePatchBaselineResponse> createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaselineRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<CreatePatchBaselineResponse> createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
This is a convenience which creates an instance of the CreatePatchBaselineRequest.Builder
avoiding the
need to create one manually via CreatePatchBaselineRequest.builder()
createPatchBaselineRequest
- A Consumer
that will call methods on CreatePatchBaselineRequest.Builder
to create a
request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<CreateResourceDataSyncResponse> createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two
types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring
Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type
can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization
by
using AWS Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager
User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
createResourceDataSyncRequest
- default CompletableFuture<CreateResourceDataSyncResponse> createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two
types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring
Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type
can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization
by
using AWS Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager
User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
This is a convenience which creates an instance of the CreateResourceDataSyncRequest.Builder
avoiding the
need to create one manually via CreateResourceDataSyncRequest.builder()
createResourceDataSyncRequest
- A Consumer
that will call methods on CreateResourceDataSyncRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the DeleteActivationRequest.Builder
avoiding the need
to create one manually via DeleteActivationRequest.builder()
deleteActivationRequest
- A Consumer
that will call methods on DeleteActivationRequest.Builder
to create a request.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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the DeleteAssociationRequest.Builder
avoiding the need
to create one manually via DeleteAssociationRequest.builder()
deleteAssociationRequest
- A Consumer
that will call methods on DeleteAssociationRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the DeleteDocumentRequest.Builder
avoiding the need to
create one manually via DeleteDocumentRequest.builder()
deleteDocumentRequest
- A Consumer
that will call methods on DeleteDocumentRequest.Builder
to create a request.default CompletableFuture<DeleteInventoryResponse> deleteInventory(DeleteInventoryRequest deleteInventoryRequest)
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteInventoryRequest
- default CompletableFuture<DeleteInventoryResponse> deleteInventory(Consumer<DeleteInventoryRequest.Builder> deleteInventoryRequest)
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
This is a convenience which creates an instance of the DeleteInventoryRequest.Builder
avoiding the need
to create one manually via DeleteInventoryRequest.builder()
deleteInventoryRequest
- A Consumer
that will call methods on DeleteInventoryRequest.Builder
to create a request.default CompletableFuture<DeleteMaintenanceWindowResponse> deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a maintenance window.
deleteMaintenanceWindowRequest
- default CompletableFuture<DeleteMaintenanceWindowResponse> deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)
Deletes a maintenance window.
This is a convenience which creates an instance of the DeleteMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via DeleteMaintenanceWindowRequest.builder()
deleteMaintenanceWindowRequest
- A Consumer
that will call methods on DeleteMaintenanceWindowRequest.Builder
to create a
request.default CompletableFuture<DeleteOpsMetadataResponse> deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
deleteOpsMetadataRequest
- default CompletableFuture<DeleteOpsMetadataResponse> deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
This is a convenience which creates an instance of the DeleteOpsMetadataRequest.Builder
avoiding the need
to create one manually via DeleteOpsMetadataRequest.builder()
deleteOpsMetadataRequest
- A Consumer
that will call methods on DeleteOpsMetadataRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the DeleteParameterRequest.Builder
avoiding the need
to create one manually via DeleteParameterRequest.builder()
deleteParameterRequest
- A Consumer
that will call methods on DeleteParameterRequest.Builder
to create a request.default CompletableFuture<DeleteParametersResponse> deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.
deleteParametersRequest
- default CompletableFuture<DeleteParametersResponse> deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)
Delete a list of parameters.
This is a convenience which creates an instance of the DeleteParametersRequest.Builder
avoiding the need
to create one manually via DeleteParametersRequest.builder()
deleteParametersRequest
- A Consumer
that will call methods on DeleteParametersRequest.Builder
to create a request.default CompletableFuture<DeletePatchBaselineResponse> deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
deletePatchBaselineRequest
- default CompletableFuture<DeletePatchBaselineResponse> deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)
Deletes a patch baseline.
This is a convenience which creates an instance of the DeletePatchBaselineRequest.Builder
avoiding the
need to create one manually via DeletePatchBaselineRequest.builder()
deletePatchBaselineRequest
- A Consumer
that will call methods on DeletePatchBaselineRequest.Builder
to create a
request.default CompletableFuture<DeleteResourceDataSyncResponse> deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
deleteResourceDataSyncRequest
- default CompletableFuture<DeleteResourceDataSyncResponse> deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
This is a convenience which creates an instance of the DeleteResourceDataSyncRequest.Builder
avoiding the
need to create one manually via DeleteResourceDataSyncRequest.builder()
deleteResourceDataSyncRequest
- A Consumer
that will call methods on DeleteResourceDataSyncRequest.Builder
to create a
request.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 SSM Agent first.
deregisterManagedInstanceRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 SSM Agent first.
This is a convenience which creates an instance of the DeregisterManagedInstanceRequest.Builder
avoiding
the need to create one manually via DeregisterManagedInstanceRequest.builder()
deregisterManagedInstanceRequest
- A Consumer
that will call methods on DeregisterManagedInstanceRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the
DeregisterPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via
DeregisterPatchBaselineForPatchGroupRequest.builder()
deregisterPatchBaselineForPatchGroupRequest
- A Consumer
that will call methods on DeregisterPatchBaselineForPatchGroupRequest.Builder
to create a request.default CompletableFuture<DeregisterTargetFromMaintenanceWindowResponse> deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindowRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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.
This is a convenience which creates an instance of the
DeregisterTargetFromMaintenanceWindowRequest.Builder
avoiding the need to create one manually via
DeregisterTargetFromMaintenanceWindowRequest.builder()
deregisterTargetFromMaintenanceWindowRequest
- A Consumer
that will call methods on DeregisterTargetFromMaintenanceWindowRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DeregisterTaskFromMaintenanceWindowResponse> deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a maintenance window.
This is a convenience which creates an instance of the DeregisterTaskFromMaintenanceWindowRequest.Builder
avoiding the need to create one manually via DeregisterTaskFromMaintenanceWindowRequest.builder()
deregisterTaskFromMaintenanceWindowRequest
- A Consumer
that will call methods on DeregisterTaskFromMaintenanceWindowRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeActivationsResponse> describeActivations(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
describeActivationsRequest
- default CompletableFuture<DescribeActivationsResponse> describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
This is a convenience which creates an instance of the DescribeActivationsRequest.Builder
avoiding the
need to create one manually via DescribeActivationsRequest.builder()
describeActivationsRequest
- A Consumer
that will call methods on DescribeActivationsRequest.Builder
to create a
request.default CompletableFuture<DescribeActivationsResponse> describeActivations()
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
default DescribeActivationsPublisher describeActivationsPaginator()
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation.
default DescribeActivationsPublisher describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation.
This is a convenience which creates an instance of the DescribeActivationsRequest.Builder
avoiding the
need to create one manually via DescribeActivationsRequest.builder()
describeActivationsRequest
- A Consumer
that will call methods on DescribeActivationsRequest.Builder
to create a
request.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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the DescribeAssociationRequest.Builder
avoiding the
need to create one manually via DescribeAssociationRequest.builder()
describeAssociationRequest
- A Consumer
that will call methods on DescribeAssociationRequest.Builder
to create a
request.$LATEST
parameter to view the latest version of the association.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeAssociationExecutionTargetsResponse> describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
describeAssociationExecutionTargetsRequest
- default CompletableFuture<DescribeAssociationExecutionTargetsResponse> describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
This is a convenience which creates an instance of the DescribeAssociationExecutionTargetsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionTargetsRequest.builder()
describeAssociationExecutionTargetsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionTargetsRequest.Builder
to
create a request.default DescribeAssociationExecutionTargetsPublisher describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
This is a variant of
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
operation.
describeAssociationExecutionTargetsRequest
- default DescribeAssociationExecutionTargetsPublisher describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
This is a variant of
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
operation.
This is a convenience which creates an instance of the DescribeAssociationExecutionTargetsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionTargetsRequest.builder()
describeAssociationExecutionTargetsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionTargetsRequest.Builder
to
create a request.default CompletableFuture<DescribeAssociationExecutionsResponse> describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
describeAssociationExecutionsRequest
- default CompletableFuture<DescribeAssociationExecutionsResponse> describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
This is a convenience which creates an instance of the DescribeAssociationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionsRequest.builder()
describeAssociationExecutionsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionsRequest.Builder
to
create a request.default DescribeAssociationExecutionsPublisher describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
This is a variant of
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
operation.
describeAssociationExecutionsRequest
- default DescribeAssociationExecutionsPublisher describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
This is a variant of
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeAssociationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionsRequest.builder()
describeAssociationExecutionsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionsRequest.Builder
to
create a request.default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest
- default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
This is a convenience which creates an instance of the DescribeAutomationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationExecutionsRequest.builder()
describeAutomationExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationExecutionsRequest.Builder
to create
a request.default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions()
Provides details about all active and terminated Automation executions.
default DescribeAutomationExecutionsPublisher describeAutomationExecutionsPaginator()
Provides details about all active and terminated Automation executions.
This is a variant of
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation.
default DescribeAutomationExecutionsPublisher describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
This is a variant of
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation.
describeAutomationExecutionsRequest
- default DescribeAutomationExecutionsPublisher describeAutomationExecutionsPaginator(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
This is a variant of
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeAutomationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationExecutionsRequest.builder()
describeAutomationExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationExecutionsRequest.Builder
to create
a request.default CompletableFuture<DescribeAutomationStepExecutionsResponse> describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutionsRequest
- default CompletableFuture<DescribeAutomationStepExecutionsResponse> describeAutomationStepExecutions(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
This is a convenience which creates an instance of the DescribeAutomationStepExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationStepExecutionsRequest.builder()
describeAutomationStepExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationStepExecutionsRequest.Builder
to
create a request.default DescribeAutomationStepExecutionsPublisher describeAutomationStepExecutionsPaginator(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
This is a variant of
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
operation.
describeAutomationStepExecutionsRequest
- default DescribeAutomationStepExecutionsPublisher describeAutomationStepExecutionsPaginator(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
This is a variant of
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeAutomationStepExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationStepExecutionsRequest.builder()
describeAutomationStepExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationStepExecutionsRequest.Builder
to
create a request.default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
describeAvailablePatchesRequest
- default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
This is a convenience which creates an instance of the DescribeAvailablePatchesRequest.Builder
avoiding
the need to create one manually via DescribeAvailablePatchesRequest.builder()
describeAvailablePatchesRequest
- A Consumer
that will call methods on DescribeAvailablePatchesRequest.Builder
to create a
request.default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches()
Lists all patches eligible to be included in a patch baseline.
default DescribeAvailablePatchesPublisher describeAvailablePatchesPaginator()
Lists all patches eligible to be included in a patch baseline.
This is a variant of
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation.
default DescribeAvailablePatchesPublisher describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
This is a variant of
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation.
describeAvailablePatchesRequest
- default DescribeAvailablePatchesPublisher describeAvailablePatchesPaginator(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
This is a variant of
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation.
This is a convenience which creates an instance of the DescribeAvailablePatchesRequest.Builder
avoiding
the need to create one manually via DescribeAvailablePatchesRequest.builder()
describeAvailablePatchesRequest
- A Consumer
that will call methods on DescribeAvailablePatchesRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the DescribeDocumentRequest.Builder
avoiding the need
to create one manually via DescribeDocumentRequest.builder()
describeDocumentRequest
- A Consumer
that will call methods on DescribeDocumentRequest.Builder
to create a request.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).
This is a convenience which creates an instance of the DescribeDocumentPermissionRequest.Builder
avoiding
the need to create one manually via DescribeDocumentPermissionRequest.builder()
describeDocumentPermissionRequest
- A Consumer
that will call methods on DescribeDocumentPermissionRequest.Builder
to create a
request.default CompletableFuture<DescribeEffectiveInstanceAssociationsResponse> describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
describeEffectiveInstanceAssociationsRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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).
This is a convenience which creates an instance of the
DescribeEffectiveInstanceAssociationsRequest.Builder
avoiding the need to create one manually via
DescribeEffectiveInstanceAssociationsRequest.builder()
describeEffectiveInstanceAssociationsRequest
- A Consumer
that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeEffectiveInstanceAssociationsPublisher describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
This is a variant of
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
operation.
describeEffectiveInstanceAssociationsRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeEffectiveInstanceAssociationsPublisher describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
This is a variant of
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEffectiveInstanceAssociationsRequest.Builder
avoiding the need to create one manually via
DescribeEffectiveInstanceAssociationsRequest.builder()
describeEffectiveInstanceAssociationsRequest
- A Consumer
that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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.
This is a convenience which creates an instance of the
DescribeEffectivePatchesForPatchBaselineRequest.Builder
avoiding the need to create one manually via
DescribeEffectivePatchesForPatchBaselineRequest.builder()
describeEffectivePatchesForPatchBaselineRequest
- A Consumer
that will call methods on
DescribeEffectivePatchesForPatchBaselineRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeEffectivePatchesForPatchBaselinePublisher describeEffectivePatchesForPatchBaselinePaginator(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.
This is a variant of
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
operation.
describeEffectivePatchesForPatchBaselineRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeEffectivePatchesForPatchBaselinePublisher describeEffectivePatchesForPatchBaselinePaginator(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.
This is a variant of
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
operation.
This is a convenience which creates an instance of the
DescribeEffectivePatchesForPatchBaselineRequest.Builder
avoiding the need to create one manually via
DescribeEffectivePatchesForPatchBaselineRequest.builder()
describeEffectivePatchesForPatchBaselineRequest
- A Consumer
that will call methods on
DescribeEffectivePatchesForPatchBaselineRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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).
This is a convenience which creates an instance of the DescribeInstanceAssociationsStatusRequest.Builder
avoiding the need to create one manually via DescribeInstanceAssociationsStatusRequest.builder()
describeInstanceAssociationsStatusRequest
- A Consumer
that will call methods on DescribeInstanceAssociationsStatusRequest.Builder
to
create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeInstanceAssociationsStatusPublisher describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
This is a variant of
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
operation.
describeInstanceAssociationsStatusRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeInstanceAssociationsStatusPublisher describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
This is a variant of
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
operation.
This is a convenience which creates an instance of the DescribeInstanceAssociationsStatusRequest.Builder
avoiding the need to create one manually via DescribeInstanceAssociationsStatusRequest.builder()
describeInstanceAssociationsStatusRequest
- A Consumer
that will call methods on DescribeInstanceAssociationsStatusRequest.Builder
to
create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
describeInstanceInformationRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
This is a convenience which creates an instance of the DescribeInstanceInformationRequest.Builder
avoiding the need to create one manually via DescribeInstanceInformationRequest.builder()
describeInstanceInformationRequest
- A Consumer
that will call methods on DescribeInstanceInformationRequest.Builder
to create
a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeInstanceInformationPublisher describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation.
This is a convenience which creates an instance of the DescribeInstanceInformationRequest.Builder
avoiding the need to create one manually via DescribeInstanceInformationRequest.builder()
describeInstanceInformationRequest
- A Consumer
that will call methods on DescribeInstanceInformationRequest.Builder
to create
a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the DescribeInstancePatchStatesRequest.Builder
avoiding the need to create one manually via DescribeInstancePatchStatesRequest.builder()
describeInstancePatchStatesRequest
- A Consumer
that will call methods on DescribeInstancePatchStatesRequest.Builder
to create
a request.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.
This is a convenience which creates an instance of the
DescribeInstancePatchStatesForPatchGroupRequest.Builder
avoiding the need to create one manually via
DescribeInstancePatchStatesForPatchGroupRequest.builder()
describeInstancePatchStatesForPatchGroupRequest
- A Consumer
that will call methods on
DescribeInstancePatchStatesForPatchGroupRequest.Builder
to create a request.default DescribeInstancePatchStatesForPatchGroupPublisher describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
This is a variant of
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
operation.
describeInstancePatchStatesForPatchGroupRequest
- default DescribeInstancePatchStatesForPatchGroupPublisher describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
This is a variant of
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
operation.
This is a convenience which creates an instance of the
DescribeInstancePatchStatesForPatchGroupRequest.Builder
avoiding the need to create one manually via
DescribeInstancePatchStatesForPatchGroupRequest.builder()
describeInstancePatchStatesForPatchGroupRequest
- A Consumer
that will call methods on
DescribeInstancePatchStatesForPatchGroupRequest.Builder
to create a request.default DescribeInstancePatchStatesPublisher describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
This is a variant of
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
operation.
describeInstancePatchStatesRequest
- default DescribeInstancePatchStatesPublisher describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
This is a variant of
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
operation.
This is a convenience which creates an instance of the DescribeInstancePatchStatesRequest.Builder
avoiding the need to create one manually via DescribeInstancePatchStatesRequest.builder()
describeInstancePatchStatesRequest
- A Consumer
that will call methods on DescribeInstancePatchStatesRequest.Builder
to create
a request.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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the DescribeInstancePatchesRequest.Builder
avoiding
the need to create one manually via DescribeInstancePatchesRequest.builder()
describeInstancePatchesRequest
- A Consumer
that will call methods on DescribeInstancePatchesRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeInstancePatchesPublisher describeInstancePatchesPaginator(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
This is a variant of
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
operation.
describeInstancePatchesRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default DescribeInstancePatchesPublisher describeInstancePatchesPaginator(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.
This is a variant of
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
operation.
This is a convenience which creates an instance of the DescribeInstancePatchesRequest.Builder
avoiding
the need to create one manually via DescribeInstancePatchesRequest.builder()
describeInstancePatchesRequest
- A Consumer
that will call methods on DescribeInstancePatchesRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<DescribeInventoryDeletionsResponse> describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
describeInventoryDeletionsRequest
- default CompletableFuture<DescribeInventoryDeletionsResponse> describeInventoryDeletions(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
This is a convenience which creates an instance of the DescribeInventoryDeletionsRequest.Builder
avoiding
the need to create one manually via DescribeInventoryDeletionsRequest.builder()
describeInventoryDeletionsRequest
- A Consumer
that will call methods on DescribeInventoryDeletionsRequest.Builder
to create a
request.default CompletableFuture<DescribeInventoryDeletionsResponse> describeInventoryDeletions()
Describes a specific delete inventory operation.
default DescribeInventoryDeletionsPublisher describeInventoryDeletionsPaginator()
Describes a specific delete inventory operation.
This is a variant of
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
operation.
default DescribeInventoryDeletionsPublisher describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
This is a variant of
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
operation.
describeInventoryDeletionsRequest
- default DescribeInventoryDeletionsPublisher describeInventoryDeletionsPaginator(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
This is a variant of
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
operation.
This is a convenience which creates an instance of the DescribeInventoryDeletionsRequest.Builder
avoiding
the need to create one manually via DescribeInventoryDeletionsRequest.builder()
describeInventoryDeletionsRequest
- A Consumer
that will call methods on DescribeInventoryDeletionsRequest.Builder
to create a
request.default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocationsRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> describeMaintenanceWindowExecutionTaskInvocations(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
avoiding the need to create one manually
via DescribeMaintenanceWindowExecutionTaskInvocationsRequest.builder()
describeMaintenanceWindowExecutionTaskInvocationsRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowExecutionTaskInvocationsPublisher describeMaintenanceWindowExecutionTaskInvocationsPaginator(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
This is a variant of
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
operation.
describeMaintenanceWindowExecutionTaskInvocationsRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowExecutionTaskInvocationsPublisher describeMaintenanceWindowExecutionTaskInvocationsPaginator(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
This is a variant of
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
avoiding the need to create one manually
via DescribeMaintenanceWindowExecutionTaskInvocationsRequest.builder()
describeMaintenanceWindowExecutionTaskInvocationsRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasksRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTasksRequest.Builder
avoiding the need to create one manually via
DescribeMaintenanceWindowExecutionTasksRequest.builder()
describeMaintenanceWindowExecutionTasksRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTasksRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowExecutionTasksPublisher describeMaintenanceWindowExecutionTasksPaginator(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
This is a variant of
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
operation.
describeMaintenanceWindowExecutionTasksRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowExecutionTasksPublisher describeMaintenanceWindowExecutionTasksPaginator(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
This is a variant of
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
operation.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTasksRequest.Builder
avoiding the need to create one manually via
DescribeMaintenanceWindowExecutionTasksRequest.builder()
describeMaintenanceWindowExecutionTasksRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTasksRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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.
This is a convenience which creates an instance of the DescribeMaintenanceWindowExecutionsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowExecutionsRequest.builder()
describeMaintenanceWindowExecutionsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowExecutionsRequest.Builder
to
create a request.default DescribeMaintenanceWindowExecutionsPublisher describeMaintenanceWindowExecutionsPaginator(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.
This is a variant of
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
operation.
describeMaintenanceWindowExecutionsRequest
- default DescribeMaintenanceWindowExecutionsPublisher describeMaintenanceWindowExecutionsPaginator(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.
This is a variant of
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowExecutionsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowExecutionsRequest.builder()
describeMaintenanceWindowExecutionsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowExecutionsRequest.Builder
to
create a request.default CompletableFuture<DescribeMaintenanceWindowScheduleResponse> describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowScheduleRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowScheduleResponse> describeMaintenanceWindowSchedule(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
This is a convenience which creates an instance of the DescribeMaintenanceWindowScheduleRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowScheduleRequest.builder()
describeMaintenanceWindowScheduleRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowScheduleRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowSchedulePublisher describeMaintenanceWindowSchedulePaginator(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
This is a variant of
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
operation.
describeMaintenanceWindowScheduleRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowSchedulePublisher describeMaintenanceWindowSchedulePaginator(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
This is a variant of
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowScheduleRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowScheduleRequest.builder()
describeMaintenanceWindowScheduleRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowScheduleRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargetsRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTargetsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTargetsRequest.builder()
describeMaintenanceWindowTargetsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTargetsRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowTargetsPublisher describeMaintenanceWindowTargetsPaginator(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
This is a variant of
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
operation.
describeMaintenanceWindowTargetsRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowTargetsPublisher describeMaintenanceWindowTargetsPaginator(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
This is a variant of
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTargetsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTargetsRequest.builder()
describeMaintenanceWindowTargetsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTargetsRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowTasksResponse> describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
describeMaintenanceWindowTasksRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowTasksResponse> describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTasksRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTasksRequest.builder()
describeMaintenanceWindowTasksRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTasksRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowTasksPublisher describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
This is a variant of
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
operation.
describeMaintenanceWindowTasksRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default DescribeMaintenanceWindowTasksPublisher describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
This is a variant of
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTasksRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTasksRequest.builder()
describeMaintenanceWindowTasksRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTasksRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindowsRequest
- default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsRequest.Builder
avoiding
the need to create one manually via DescribeMaintenanceWindowsRequest.builder()
describeMaintenanceWindowsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsRequest.Builder
to create a
request.default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows()
Retrieves the maintenance windows in an AWS account.
default CompletableFuture<DescribeMaintenanceWindowsForTargetResponse> describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowsForTargetRequest
- default CompletableFuture<DescribeMaintenanceWindowsForTargetResponse> describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsForTargetRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowsForTargetRequest.builder()
describeMaintenanceWindowsForTargetRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsForTargetRequest.Builder
to
create a request.default DescribeMaintenanceWindowsForTargetPublisher describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
This is a variant of
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
operation.
describeMaintenanceWindowsForTargetRequest
- default DescribeMaintenanceWindowsForTargetPublisher describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
This is a variant of
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsForTargetRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowsForTargetRequest.builder()
describeMaintenanceWindowsForTargetRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsForTargetRequest.Builder
to
create a request.default DescribeMaintenanceWindowsPublisher describeMaintenanceWindowsPaginator()
Retrieves the maintenance windows in an AWS account.
This is a variant of
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
operation.
default DescribeMaintenanceWindowsPublisher describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
This is a variant of
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
operation.
describeMaintenanceWindowsRequest
- default DescribeMaintenanceWindowsPublisher describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
This is a variant of
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsRequest.Builder
avoiding
the need to create one manually via DescribeMaintenanceWindowsRequest.builder()
describeMaintenanceWindowsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsRequest.Builder
to create a
request.default CompletableFuture<DescribeOpsItemsResponse> describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
describeOpsItemsRequest
- default CompletableFuture<DescribeOpsItemsResponse> describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the DescribeOpsItemsRequest.Builder
avoiding the need
to create one manually via DescribeOpsItemsRequest.builder()
describeOpsItemsRequest
- A Consumer
that will call methods on DescribeOpsItemsRequest.Builder
to create a request.default DescribeOpsItemsPublisher describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
operation.
describeOpsItemsRequest
- default DescribeOpsItemsPublisher describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
operation.
This is a convenience which creates an instance of the DescribeOpsItemsRequest.Builder
avoiding the need
to create one manually via DescribeOpsItemsRequest.builder()
describeOpsItemsRequest
- A Consumer
that will call methods on DescribeOpsItemsRequest.Builder
to create a request.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(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.
This is a convenience which creates an instance of the DescribeParametersRequest.Builder
avoiding the
need to create one manually via DescribeParametersRequest.builder()
describeParametersRequest
- A Consumer
that will call methods on DescribeParametersRequest.Builder
to create a
request.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 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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(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.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeParametersRequest.Builder
avoiding the
need to create one manually via DescribeParametersRequest.builder()
describeParametersRequest
- A Consumer
that will call methods on DescribeParametersRequest.Builder
to create a
request.default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
describePatchBaselinesRequest
- default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
This is a convenience which creates an instance of the DescribePatchBaselinesRequest.Builder
avoiding the
need to create one manually via DescribePatchBaselinesRequest.builder()
describePatchBaselinesRequest
- A Consumer
that will call methods on DescribePatchBaselinesRequest.Builder
to create a
request.default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines()
Lists the patch baselines in your AWS account.
default DescribePatchBaselinesPublisher describePatchBaselinesPaginator()
Lists the patch baselines in your AWS account.
This is a variant of
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
operation.
default DescribePatchBaselinesPublisher describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
This is a variant of
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
operation.
describePatchBaselinesRequest
- default DescribePatchBaselinesPublisher describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
This is a variant of
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
operation.
This is a convenience which creates an instance of the DescribePatchBaselinesRequest.Builder
avoiding the
need to create one manually via DescribePatchBaselinesRequest.builder()
describePatchBaselinesRequest
- A Consumer
that will call methods on DescribePatchBaselinesRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the DescribePatchGroupStateRequest.Builder
avoiding
the need to create one manually via DescribePatchGroupStateRequest.builder()
describePatchGroupStateRequest
- A Consumer
that will call methods on DescribePatchGroupStateRequest.Builder
to create a
request.default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest
- default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
This is a convenience which creates an instance of the DescribePatchGroupsRequest.Builder
avoiding the
need to create one manually via DescribePatchGroupsRequest.builder()
describePatchGroupsRequest
- A Consumer
that will call methods on DescribePatchGroupsRequest.Builder
to create a
request.default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups()
Lists all patch groups that have been registered with patch baselines.
default DescribePatchGroupsPublisher describePatchGroupsPaginator()
Lists all patch groups that have been registered with patch baselines.
This is a variant of
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
operation.
default DescribePatchGroupsPublisher describePatchGroupsPaginator(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
This is a variant of
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
operation.
describePatchGroupsRequest
- default DescribePatchGroupsPublisher describePatchGroupsPaginator(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
This is a variant of
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribePatchGroupsRequest.Builder
avoiding the
need to create one manually via DescribePatchGroupsRequest.builder()
describePatchGroupsRequest
- A Consumer
that will call methods on DescribePatchGroupsRequest.Builder
to create a
request.default CompletableFuture<DescribePatchPropertiesResponse> describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
describePatchPropertiesRequest
- default CompletableFuture<DescribePatchPropertiesResponse> describePatchProperties(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
This is a convenience which creates an instance of the DescribePatchPropertiesRequest.Builder
avoiding
the need to create one manually via DescribePatchPropertiesRequest.builder()
describePatchPropertiesRequest
- A Consumer
that will call methods on DescribePatchPropertiesRequest.Builder
to create a
request.default DescribePatchPropertiesPublisher describePatchPropertiesPaginator(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
This is a variant of
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
operation.
describePatchPropertiesRequest
- default DescribePatchPropertiesPublisher describePatchPropertiesPaginator(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
This is a variant of
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
operation.
This is a convenience which creates an instance of the DescribePatchPropertiesRequest.Builder
avoiding
the need to create one manually via DescribePatchPropertiesRequest.builder()
describePatchPropertiesRequest
- A Consumer
that will call methods on DescribePatchPropertiesRequest.Builder
to create a
request.default CompletableFuture<DescribeSessionsResponse> describeSessions(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessionsRequest
- default CompletableFuture<DescribeSessionsResponse> describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
This is a convenience which creates an instance of the DescribeSessionsRequest.Builder
avoiding the need
to create one manually via DescribeSessionsRequest.builder()
describeSessionsRequest
- A Consumer
that will call methods on DescribeSessionsRequest.Builder
to create a request.default DescribeSessionsPublisher describeSessionsPaginator(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
operation.
describeSessionsRequest
- default DescribeSessionsPublisher describeSessionsPaginator(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
operation.
This is a convenience which creates an instance of the DescribeSessionsRequest.Builder
avoiding the need
to create one manually via DescribeSessionsRequest.builder()
describeSessionsRequest
- A Consumer
that will call methods on DescribeSessionsRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the GetAutomationExecutionRequest.Builder
avoiding the
need to create one manually via GetAutomationExecutionRequest.builder()
getAutomationExecutionRequest
- A Consumer
that will call methods on GetAutomationExecutionRequest.Builder
to create a
request.default CompletableFuture<GetCalendarStateResponse> getCalendarState(GetCalendarStateRequest getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at a specific time, and returns the next time
that the Change Calendar state will transition. If you do not specify a time, GetCalendarState
assumes the current time. Change Calendar entries have two possible states: OPEN
or
CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
getCalendarStateRequest
- DocumentType
property.default CompletableFuture<GetCalendarStateResponse> getCalendarState(Consumer<GetCalendarStateRequest.Builder> getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at a specific time, and returns the next time
that the Change Calendar state will transition. If you do not specify a time, GetCalendarState
assumes the current time. Change Calendar entries have two possible states: OPEN
or
CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the GetCalendarStateRequest.Builder
avoiding the need
to create one manually via GetCalendarStateRequest.builder()
getCalendarStateRequest
- A Consumer
that will call methods on GetCalendarStateRequest.Builder
to create a request.DocumentType
property.default CompletableFuture<GetCommandInvocationResponse> getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command
execution status on a specific instance, use ListCommandInvocations. To get the command execution status
across instances, use ListCommands.
getCommandInvocationRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command
execution status on a specific instance, use ListCommandInvocations. To get the command execution status
across instances, use ListCommands.
This is a convenience which creates an instance of the GetCommandInvocationRequest.Builder
avoiding the
need to create one manually via GetCommandInvocationRequest.builder()
getCommandInvocationRequest
- A Consumer
that will call methods on GetCommandInvocationRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<GetConnectionStatusResponse> getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatusRequest
- default CompletableFuture<GetConnectionStatusResponse> getConnectionStatus(Consumer<GetConnectionStatusRequest.Builder> getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
This is a convenience which creates an instance of the GetConnectionStatusRequest.Builder
avoiding the
need to create one manually via GetConnectionStatusRequest.builder()
getConnectionStatusRequest
- A Consumer
that will call methods on GetConnectionStatusRequest.Builder
to create a
request.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.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineRequest
- 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.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
This is a convenience which creates an instance of the GetDefaultPatchBaselineRequest.Builder
avoiding
the need to create one manually via GetDefaultPatchBaselineRequest.builder()
getDefaultPatchBaselineRequest
- A Consumer
that will call methods on GetDefaultPatchBaselineRequest.Builder
to create a
request.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.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
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.
This is a convenience which creates an instance of the
GetDeployablePatchSnapshotForInstanceRequest.Builder
avoiding the need to create one manually via
GetDeployablePatchSnapshotForInstanceRequest.builder()
getDeployablePatchSnapshotForInstanceRequest
- A Consumer
that will call methods on GetDeployablePatchSnapshotForInstanceRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the GetDocumentRequest.Builder
avoiding the need to
create one manually via GetDocumentRequest.builder()
getDocumentRequest
- A Consumer
that will call methods on GetDocumentRequest.Builder
to create a request.default CompletableFuture<GetInventoryResponse> getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
getInventoryRequest
- AWS:Application
or
AWS:InstanceInformation
.default CompletableFuture<GetInventoryResponse> getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
Query inventory information.
This is a convenience which creates an instance of the GetInventoryRequest.Builder
avoiding the need to
create one manually via GetInventoryRequest.builder()
getInventoryRequest
- A Consumer
that will call methods on GetInventoryRequest.Builder
to create a request.AWS:Application
or
AWS:InstanceInformation
.default CompletableFuture<GetInventoryResponse> getInventory()
Query inventory information.
AWS:Application
or
AWS:InstanceInformation
.default GetInventoryPublisher getInventoryPaginator()
Query inventory information.
This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetInventoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
operation.
AWS:Application
or
AWS:InstanceInformation
.default GetInventoryPublisher getInventoryPaginator(GetInventoryRequest getInventoryRequest)
Query inventory information.
This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetInventoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
operation.
getInventoryRequest
- AWS:Application
or
AWS:InstanceInformation
.default GetInventoryPublisher getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
Query inventory information.
This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetInventoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
operation.
This is a convenience which creates an instance of the GetInventoryRequest.Builder
avoiding the need to
create one manually via GetInventoryRequest.builder()
getInventoryRequest
- A Consumer
that will call methods on GetInventoryRequest.Builder
to create a request.AWS:Application
or
AWS:InstanceInformation
.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(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.
This is a convenience which creates an instance of the GetInventorySchemaRequest.Builder
avoiding the
need to create one manually via GetInventorySchemaRequest.builder()
getInventorySchemaRequest
- A Consumer
that will call methods on GetInventorySchemaRequest.Builder
to create a
request.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 GetInventorySchemaPublisher getInventorySchemaPaginator()
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
This is a variant of
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
operation.
default GetInventorySchemaPublisher getInventorySchemaPaginator(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.
This is a variant of
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
operation.
getInventorySchemaRequest
- default GetInventorySchemaPublisher getInventorySchemaPaginator(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.
This is a variant of
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
operation.
This is a convenience which creates an instance of the GetInventorySchemaRequest.Builder
avoiding the
need to create one manually via GetInventorySchemaRequest.builder()
getInventorySchemaRequest
- A Consumer
that will call methods on GetInventorySchemaRequest.Builder
to create a
request.default CompletableFuture<GetMaintenanceWindowResponse> getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a maintenance window.
getMaintenanceWindowRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowResponse> getMaintenanceWindow(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest)
Retrieves a maintenance window.
This is a convenience which creates an instance of the GetMaintenanceWindowRequest.Builder
avoiding the
need to create one manually via GetMaintenanceWindowRequest.builder()
getMaintenanceWindowRequest
- A Consumer
that will call methods on GetMaintenanceWindowRequest.Builder
to create a
request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowExecutionResponse> getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowExecutionResponse> getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
This is a convenience which creates an instance of the GetMaintenanceWindowExecutionRequest.Builder
avoiding the need to create one manually via GetMaintenanceWindowExecutionRequest.builder()
getMaintenanceWindowExecutionRequest
- A Consumer
that will call methods on GetMaintenanceWindowExecutionRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
This is a convenience which creates an instance of the GetMaintenanceWindowExecutionTaskRequest.Builder
avoiding the need to create one manually via GetMaintenanceWindowExecutionTaskRequest.builder()
getMaintenanceWindowExecutionTaskRequest
- A Consumer
that will call methods on GetMaintenanceWindowExecutionTaskRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocationRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
This is a convenience which creates an instance of the
GetMaintenanceWindowExecutionTaskInvocationRequest.Builder
avoiding the need to create one manually via
GetMaintenanceWindowExecutionTaskInvocationRequest.builder()
getMaintenanceWindowExecutionTaskInvocationRequest
- A Consumer
that will call methods on
GetMaintenanceWindowExecutionTaskInvocationRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowTaskResponse> getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
getMaintenanceWindowTaskRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetMaintenanceWindowTaskResponse> getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you cannot supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values do not affect the running of your task and can be
ignored.
This is a convenience which creates an instance of the GetMaintenanceWindowTaskRequest.Builder
avoiding
the need to create one manually via GetMaintenanceWindowTaskRequest.builder()
getMaintenanceWindowTaskRequest
- A Consumer
that will call methods on GetMaintenanceWindowTaskRequest.Builder
to create a
request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetOpsItemResponse> getOpsItem(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
getOpsItemRequest
- default CompletableFuture<GetOpsItemResponse> getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest)
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the GetOpsItemRequest.Builder
avoiding the need to
create one manually via GetOpsItemRequest.builder()
getOpsItemRequest
- A Consumer
that will call methods on GetOpsItemRequest.Builder
to create a request.default CompletableFuture<GetOpsMetadataResponse> getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
getOpsMetadataRequest
- default CompletableFuture<GetOpsMetadataResponse> getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
This is a convenience which creates an instance of the GetOpsMetadataRequest.Builder
avoiding the need to
create one manually via GetOpsMetadataRequest.builder()
getOpsMetadataRequest
- A Consumer
that will call methods on GetOpsMetadataRequest.Builder
to create a request.default CompletableFuture<GetOpsSummaryResponse> getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
getOpsSummaryRequest
- AWS:Application
or
AWS:InstanceInformation
.default CompletableFuture<GetOpsSummaryResponse> getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
This is a convenience which creates an instance of the GetOpsSummaryRequest.Builder
avoiding the need to
create one manually via GetOpsSummaryRequest.builder()
getOpsSummaryRequest
- A Consumer
that will call methods on GetOpsSummaryRequest.Builder
to create a request.AWS:Application
or
AWS:InstanceInformation
.default GetOpsSummaryPublisher getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
operation.
getOpsSummaryRequest
- AWS:Application
or
AWS:InstanceInformation
.default GetOpsSummaryPublisher getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
operation.
This is a convenience which creates an instance of the GetOpsSummaryRequest.Builder
avoiding the need to
create one manually via GetOpsSummaryRequest.builder()
getOpsSummaryRequest
- A Consumer
that will call methods on GetOpsSummaryRequest.Builder
to create a request.AWS:Application
or
AWS:InstanceInformation
.default CompletableFuture<GetParameterResponse> getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameterRequest
- default CompletableFuture<GetParameterResponse> getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
This is a convenience which creates an instance of the GetParameterRequest.Builder
avoiding the need to
create one manually via GetParameterRequest.builder()
getParameterRequest
- A Consumer
that will call methods on GetParameterRequest.Builder
to create a request.default CompletableFuture<GetParameterHistoryResponse> getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
getParameterHistoryRequest
- default CompletableFuture<GetParameterHistoryResponse> getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
This is a convenience which creates an instance of the GetParameterHistoryRequest.Builder
avoiding the
need to create one manually via GetParameterHistoryRequest.builder()
getParameterHistoryRequest
- A Consumer
that will call methods on GetParameterHistoryRequest.Builder
to create a
request.default GetParameterHistoryPublisher getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
operation.
getParameterHistoryRequest
- default GetParameterHistoryPublisher getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
operation.
This is a convenience which creates an instance of the GetParameterHistoryRequest.Builder
avoiding the
need to create one manually via GetParameterHistoryRequest.builder()
getParameterHistoryRequest
- A Consumer
that will call methods on GetParameterHistoryRequest.Builder
to create a
request.default CompletableFuture<GetParametersResponse> getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
getParametersRequest
- default CompletableFuture<GetParametersResponse> getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
This is a convenience which creates an instance of the GetParametersRequest.Builder
avoiding the need to
create one manually via GetParametersRequest.builder()
getParametersRequest
- A Consumer
that will call methods on GetParametersRequest.Builder
to create a request.default CompletableFuture<GetParametersByPathResponse> getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
getParametersByPathRequest
- default CompletableFuture<GetParametersByPathResponse> getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a convenience which creates an instance of the GetParametersByPathRequest.Builder
avoiding the
need to create one manually via GetParametersByPathRequest.builder()
getParametersByPathRequest
- A Consumer
that will call methods on GetParametersByPathRequest.Builder
to create a
request.default GetParametersByPathPublisher getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation.
getParametersByPathRequest
- default GetParametersByPathPublisher getParametersByPathPaginator(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation.
This is a convenience which creates an instance of the GetParametersByPathRequest.Builder
avoiding the
need to create one manually via GetParametersByPathRequest.builder()
getParametersByPathRequest
- A Consumer
that will call methods on GetParametersByPathRequest.Builder
to create a
request.default CompletableFuture<GetPatchBaselineResponse> getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
getPatchBaselineRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<GetPatchBaselineResponse> getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest)
Retrieves information about a patch baseline.
This is a convenience which creates an instance of the GetPatchBaselineRequest.Builder
avoiding the need
to create one manually via GetPatchBaselineRequest.builder()
getPatchBaselineRequest
- A Consumer
that will call methods on GetPatchBaselineRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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.
This is a convenience which creates an instance of the GetPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via GetPatchBaselineForPatchGroupRequest.builder()
getPatchBaselineForPatchGroupRequest
- A Consumer
that will call methods on GetPatchBaselineForPatchGroupRequest.Builder
to
create a request.default CompletableFuture<GetServiceSettingResponse> getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
getServiceSettingRequest
- The request body of the GetServiceSetting API action.default CompletableFuture<GetServiceSettingResponse> getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
This is a convenience which creates an instance of the GetServiceSettingRequest.Builder
avoiding the need
to create one manually via GetServiceSettingRequest.builder()
getServiceSettingRequest
- A Consumer
that will call methods on GetServiceSettingRequest.Builder
to create a request.
The request body of the GetServiceSetting API action.default CompletableFuture<LabelParameterVersionResponse> labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
labelParameterVersionRequest
- default CompletableFuture<LabelParameterVersionResponse> labelParameterVersion(Consumer<LabelParameterVersionRequest.Builder> labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
This is a convenience which creates an instance of the LabelParameterVersionRequest.Builder
avoiding the
need to create one manually via LabelParameterVersionRequest.builder()
labelParameterVersionRequest
- A Consumer
that will call methods on LabelParameterVersionRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the ListAssociationVersionsRequest.Builder
avoiding
the need to create one manually via ListAssociationVersionsRequest.builder()
listAssociationVersionsRequest
- A Consumer
that will call methods on ListAssociationVersionsRequest.Builder
to create a
request.default ListAssociationVersionsPublisher listAssociationVersionsPaginator(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
This is a variant of
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
operation.
listAssociationVersionsRequest
- default ListAssociationVersionsPublisher listAssociationVersionsPaginator(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
This is a variant of
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
operation.
This is a convenience which creates an instance of the ListAssociationVersionsRequest.Builder
avoiding
the need to create one manually via ListAssociationVersionsRequest.builder()
listAssociationVersionsRequest
- A Consumer
that will call methods on ListAssociationVersionsRequest.Builder
to create a
request.default CompletableFuture<ListAssociationsResponse> listAssociations(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
listAssociationsRequest
- default CompletableFuture<ListAssociationsResponse> listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
This is a convenience which creates an instance of the ListAssociationsRequest.Builder
avoiding the need
to create one manually via ListAssociationsRequest.builder()
listAssociationsRequest
- A Consumer
that will call methods on ListAssociationsRequest.Builder
to create a request.default CompletableFuture<ListAssociationsResponse> listAssociations()
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
default ListAssociationsPublisher listAssociationsPaginator()
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation.
default ListAssociationsPublisher listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation.
This is a convenience which creates an instance of the ListAssociationsRequest.Builder
avoiding the need
to create one manually via ListAssociationsRequest.builder()
listAssociationsRequest
- A Consumer
that will call methods on ListAssociationsRequest.Builder
to create a request.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 runs 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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
This is a convenience which creates an instance of the ListCommandInvocationsRequest.Builder
avoiding the
need to create one manually via ListCommandInvocationsRequest.builder()
listCommandInvocationsRequest
- A Consumer
that will call methods on ListCommandInvocationsRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 runs 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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 runs 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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 runs 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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default ListCommandInvocationsPublisher listCommandInvocationsPaginator(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 runs 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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation.
This is a convenience which creates an instance of the ListCommandInvocationsRequest.Builder
avoiding the
need to create one manually via ListCommandInvocationsRequest.builder()
listCommandInvocationsRequest
- A Consumer
that will call methods on ListCommandInvocationsRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the ListCommandsRequest.Builder
avoiding the need to
create one manually via ListCommandsRequest.builder()
listCommandsRequest
- A Consumer
that will call methods on ListCommandsRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default ListCommandsPublisher listCommandsPaginator(Consumer<ListCommandsRequest.Builder> 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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation.
This is a convenience which creates an instance of the ListCommandsRequest.Builder
avoiding the need to
create one manually via ListCommandsRequest.builder()
listCommandsRequest
- A Consumer
that will call methods on ListCommandsRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the ListComplianceItemsRequest.Builder
avoiding the
need to create one manually via ListComplianceItemsRequest.builder()
listComplianceItemsRequest
- A Consumer
that will call methods on ListComplianceItemsRequest.Builder
to create a
request.default ListComplianceItemsPublisher listComplianceItemsPaginator(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.
This is a variant of
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
operation.
listComplianceItemsRequest
- default ListComplianceItemsPublisher listComplianceItemsPaginator(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.
This is a variant of
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
operation.
This is a convenience which creates an instance of the ListComplianceItemsRequest.Builder
avoiding the
need to create one manually via ListComplianceItemsRequest.builder()
listComplianceItemsRequest
- A Consumer
that will call methods on ListComplianceItemsRequest.Builder
to create a
request.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(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.
This is a convenience which creates an instance of the ListComplianceSummariesRequest.Builder
avoiding
the need to create one manually via ListComplianceSummariesRequest.builder()
listComplianceSummariesRequest
- A Consumer
that will call methods on ListComplianceSummariesRequest.Builder
to create a
request.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 ListComplianceSummariesPublisher listComplianceSummariesPaginator()
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.
This is a variant of
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
operation.
default ListComplianceSummariesPublisher listComplianceSummariesPaginator(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.
This is a variant of
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
operation.
listComplianceSummariesRequest
- default ListComplianceSummariesPublisher listComplianceSummariesPaginator(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.
This is a variant of
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
operation.
This is a convenience which creates an instance of the ListComplianceSummariesRequest.Builder
avoiding
the need to create one manually via ListComplianceSummariesRequest.builder()
listComplianceSummariesRequest
- A Consumer
that will call methods on ListComplianceSummariesRequest.Builder
to create a
request.default CompletableFuture<ListDocumentMetadataHistoryResponse> listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of an SSM document.
listDocumentMetadataHistoryRequest
- default CompletableFuture<ListDocumentMetadataHistoryResponse> listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of an SSM document.
This is a convenience which creates an instance of the ListDocumentMetadataHistoryRequest.Builder
avoiding the need to create one manually via ListDocumentMetadataHistoryRequest.builder()
listDocumentMetadataHistoryRequest
- A Consumer
that will call methods on ListDocumentMetadataHistoryRequest.Builder
to create
a request.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.
This is a convenience which creates an instance of the ListDocumentVersionsRequest.Builder
avoiding the
need to create one manually via ListDocumentVersionsRequest.builder()
listDocumentVersionsRequest
- A Consumer
that will call methods on ListDocumentVersionsRequest.Builder
to create a
request.default ListDocumentVersionsPublisher listDocumentVersionsPaginator(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
This is a variant of
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
operation.
listDocumentVersionsRequest
- default ListDocumentVersionsPublisher listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.
This is a variant of
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
operation.
This is a convenience which creates an instance of the ListDocumentVersionsRequest.Builder
avoiding the
need to create one manually via ListDocumentVersionsRequest.builder()
listDocumentVersionsRequest
- A Consumer
that will call methods on ListDocumentVersionsRequest.Builder
to create a
request.default CompletableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
listDocumentsRequest
- default CompletableFuture<ListDocumentsResponse> listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
This is a convenience which creates an instance of the ListDocumentsRequest.Builder
avoiding the need to
create one manually via ListDocumentsRequest.builder()
listDocumentsRequest
- A Consumer
that will call methods on ListDocumentsRequest.Builder
to create a request.default CompletableFuture<ListDocumentsResponse> listDocuments()
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
default ListDocumentsPublisher listDocumentsPaginator()
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation.
default ListDocumentsPublisher listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation.
This is a convenience which creates an instance of the ListDocumentsRequest.Builder
avoiding the need to
create one manually via ListDocumentsRequest.builder()
listDocumentsRequest
- A Consumer
that will call methods on ListDocumentsRequest.Builder
to create a request.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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the ListInventoryEntriesRequest.Builder
avoiding the
need to create one manually via ListInventoryEntriesRequest.builder()
listInventoryEntriesRequest
- A Consumer
that will call methods on ListInventoryEntriesRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<ListOpsItemEventsResponse> listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsItemEventsRequest
- default CompletableFuture<ListOpsItemEventsResponse> listOpsItemEvents(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
This is a convenience which creates an instance of the ListOpsItemEventsRequest.Builder
avoiding the need
to create one manually via ListOpsItemEventsRequest.builder()
listOpsItemEventsRequest
- A Consumer
that will call methods on ListOpsItemEventsRequest.Builder
to create a request.default ListOpsItemEventsPublisher listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
This is a variant of
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
operation.
listOpsItemEventsRequest
- default ListOpsItemEventsPublisher listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
This is a variant of
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
operation.
This is a convenience which creates an instance of the ListOpsItemEventsRequest.Builder
avoiding the need
to create one manually via ListOpsItemEventsRequest.builder()
listOpsItemEventsRequest
- A Consumer
that will call methods on ListOpsItemEventsRequest.Builder
to create a request.default CompletableFuture<ListOpsMetadataResponse> listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadataRequest
- default CompletableFuture<ListOpsMetadataResponse> listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
This is a convenience which creates an instance of the ListOpsMetadataRequest.Builder
avoiding the need
to create one manually via ListOpsMetadataRequest.builder()
listOpsMetadataRequest
- A Consumer
that will call methods on ListOpsMetadataRequest.Builder
to create a request.default ListOpsMetadataPublisher listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
operation.
listOpsMetadataRequest
- default ListOpsMetadataPublisher listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
operation.
This is a convenience which creates an instance of the ListOpsMetadataRequest.Builder
avoiding the need
to create one manually via ListOpsMetadataRequest.builder()
listOpsMetadataRequest
- A Consumer
that will call methods on ListOpsMetadataRequest.Builder
to create a request.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(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.
This is a convenience which creates an instance of the ListResourceComplianceSummariesRequest.Builder
avoiding the need to create one manually via ListResourceComplianceSummariesRequest.builder()
listResourceComplianceSummariesRequest
- A Consumer
that will call methods on ListResourceComplianceSummariesRequest.Builder
to
create a request.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 ListResourceComplianceSummariesPublisher listResourceComplianceSummariesPaginator()
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.
This is a variant of
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
operation.
default ListResourceComplianceSummariesPublisher listResourceComplianceSummariesPaginator(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.
This is a variant of
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
operation.
listResourceComplianceSummariesRequest
- default ListResourceComplianceSummariesPublisher listResourceComplianceSummariesPaginator(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.
This is a variant of
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
operation.
This is a convenience which creates an instance of the ListResourceComplianceSummariesRequest.Builder
avoiding the need to create one manually via ListResourceComplianceSummariesRequest.builder()
listResourceComplianceSummariesRequest
- A Consumer
that will call methods on ListResourceComplianceSummariesRequest.Builder
to
create a request.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(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.
This is a convenience which creates an instance of the ListResourceDataSyncRequest.Builder
avoiding the
need to create one manually via ListResourceDataSyncRequest.builder()
listResourceDataSyncRequest
- A Consumer
that will call methods on ListResourceDataSyncRequest.Builder
to create a
request.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 ListResourceDataSyncPublisher listResourceDataSyncPaginator()
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.
This is a variant of
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
operation.
default ListResourceDataSyncPublisher listResourceDataSyncPaginator(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.
This is a variant of
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
operation.
listResourceDataSyncRequest
- default ListResourceDataSyncPublisher listResourceDataSyncPaginator(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.
This is a variant of
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
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 subscribe helper method
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
operation.
This is a convenience which creates an instance of the ListResourceDataSyncRequest.Builder
avoiding the
need to create one manually via ListResourceDataSyncRequest.builder()
listResourceDataSyncRequest
- A Consumer
that will call methods on ListResourceDataSyncRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the ModifyDocumentPermissionRequest.Builder
avoiding
the need to create one manually via ModifyDocumentPermissionRequest.builder()
modifyDocumentPermissionRequest
- A Consumer
that will call methods on ModifyDocumentPermissionRequest.Builder
to create a
request.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.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, critical
.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItemsRequest
- 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.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, critical
.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
This is a convenience which creates an instance of the PutComplianceItemsRequest.Builder
avoiding the
need to create one manually via PutComplianceItemsRequest.builder()
putComplianceItemsRequest
- A Consumer
that will call methods on PutComplianceItemsRequest.Builder
to create a
request.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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the PutInventoryRequest.Builder
avoiding the need to
create one manually via PutInventoryRequest.builder()
putInventoryRequest
- A Consumer
that will call methods on PutInventoryRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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 a parameter to the system.
putParameterRequest
- String
type to a
SecureString
type. You must create a new, unique parameter.
An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the AWS Systems Manager User Guide.
default CompletableFuture<PutParameterResponse> putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest)
Add a parameter to the system.
This is a convenience which creates an instance of the PutParameterRequest.Builder
avoiding the need to
create one manually via PutParameterRequest.builder()
putParameterRequest
- A Consumer
that will call methods on PutParameterRequest.Builder
to create a request.String
type to a
SecureString
type. You must create a new, unique parameter.
An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the AWS Systems Manager User Guide.
default CompletableFuture<RegisterDefaultPatchBaselineResponse> registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID
value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
registerDefaultPatchBaselineRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RegisterDefaultPatchBaselineResponse> registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID
value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
This is a convenience which creates an instance of the RegisterDefaultPatchBaselineRequest.Builder
avoiding the need to create one manually via RegisterDefaultPatchBaselineRequest.builder()
registerDefaultPatchBaselineRequest
- A Consumer
that will call methods on RegisterDefaultPatchBaselineRequest.Builder
to create
a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroupRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
This is a convenience which creates an instance of the RegisterPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via RegisterPatchBaselineForPatchGroupRequest.builder()
registerPatchBaselineForPatchGroupRequest
- A Consumer
that will call methods on RegisterPatchBaselineForPatchGroupRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindowRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest)
Registers a target with a maintenance window.
This is a convenience which creates an instance of the RegisterTargetWithMaintenanceWindowRequest.Builder
avoiding the need to create one manually via RegisterTargetWithMaintenanceWindowRequest.builder()
registerTargetWithMaintenanceWindowRequest
- A Consumer
that will call methods on RegisterTargetWithMaintenanceWindowRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindowRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest)
Adds a new task to a maintenance window.
This is a convenience which creates an instance of the RegisterTaskWithMaintenanceWindowRequest.Builder
avoiding the need to create one manually via RegisterTaskWithMaintenanceWindowRequest.builder()
registerTaskWithMaintenanceWindowRequest
- A Consumer
that will call methods on RegisterTaskWithMaintenanceWindowRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
removeTagsFromResourceRequest
- default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder
avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest
- A Consumer
that will call methods on RemoveTagsFromResourceRequest.Builder
to create a
request.default CompletableFuture<ResetServiceSettingResponse> resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to
change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
resetServiceSettingRequest
- The request body of the ResetServiceSetting API action.default CompletableFuture<ResetServiceSettingResponse> resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to
change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
This is a convenience which creates an instance of the ResetServiceSettingRequest.Builder
avoiding the
need to create one manually via ResetServiceSettingRequest.builder()
resetServiceSettingRequest
- A Consumer
that will call methods on ResetServiceSettingRequest.Builder
to create a
request. The request body of the ResetServiceSetting API action.default CompletableFuture<ResumeSessionResponse> resumeSession(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
resumeSessionRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<ResumeSessionResponse> resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest)
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
This is a convenience which creates an instance of the ResumeSessionRequest.Builder
avoiding the need to
create one manually via ResumeSessionRequest.builder()
resumeSessionRequest
- A Consumer
that will call methods on ResumeSessionRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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.
This is a convenience which creates an instance of the SendAutomationSignalRequest.Builder
avoiding the
need to create one manually via SendAutomationSignalRequest.builder()
sendAutomationSignalRequest
- A Consumer
that will call methods on SendAutomationSignalRequest.Builder
to create a
request.default CompletableFuture<SendCommandResponse> sendCommand(SendCommandRequest sendCommandRequest)
Runs commands on one or more managed instances.
sendCommandRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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)
Runs commands on one or more managed instances.
This is a convenience which creates an instance of the SendCommandRequest.Builder
avoiding the need to
create one manually via SendCommandRequest.builder()
sendCommandRequest
- A Consumer
that will call methods on SendCommandRequest.Builder
to create a request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<StartAssociationsOnceResponse> startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
startAssociationsOnceRequest
- default CompletableFuture<StartAssociationsOnceResponse> startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
This is a convenience which creates an instance of the StartAssociationsOnceRequest.Builder
avoiding the
need to create one manually via StartAssociationsOnceRequest.builder()
startAssociationsOnceRequest
- A Consumer
that will call methods on StartAssociationsOnceRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the StartAutomationExecutionRequest.Builder
avoiding
the need to create one manually via StartAutomationExecutionRequest.builder()
startAutomationExecutionRequest
- A Consumer
that will call methods on StartAutomationExecutionRequest.Builder
to create a
request.default CompletableFuture<StartChangeRequestExecutionResponse> startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
Creates a change request for Change Manager. The runbooks (Automation documents) specified in the change request run only after all required approvals for the change request have been received.
startChangeRequestExecutionRequest
- default CompletableFuture<StartChangeRequestExecutionResponse> startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest)
Creates a change request for Change Manager. The runbooks (Automation documents) specified in the change request run only after all required approvals for the change request have been received.
This is a convenience which creates an instance of the StartChangeRequestExecutionRequest.Builder
avoiding the need to create one manually via StartChangeRequestExecutionRequest.builder()
startChangeRequestExecutionRequest
- A Consumer
that will call methods on StartChangeRequestExecutionRequest.Builder
to create
a request.default CompletableFuture<StartSessionResponse> startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session
is an interactive command that requires the Session Manager plugin to
be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide.
AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
startSessionRequest
- default CompletableFuture<StartSessionResponse> startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session
is an interactive command that requires the Session Manager plugin to
be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide.
AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
This is a convenience which creates an instance of the StartSessionRequest.Builder
avoiding the need to
create one manually via StartSessionRequest.builder()
startSessionRequest
- A Consumer
that will call methods on StartSessionRequest.Builder
to create a request.default CompletableFuture<StopAutomationExecutionResponse> stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently running.
stopAutomationExecutionRequest
- default CompletableFuture<StopAutomationExecutionResponse> stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)
Stop an Automation that is currently running.
This is a convenience which creates an instance of the StopAutomationExecutionRequest.Builder
avoiding
the need to create one manually via StopAutomationExecutionRequest.builder()
stopAutomationExecutionRequest
- A Consumer
that will call methods on StopAutomationExecutionRequest.Builder
to create a
request.default CompletableFuture<TerminateSessionResponse> terminateSession(TerminateSessionRequest terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
terminateSessionRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<TerminateSessionResponse> terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
This is a convenience which creates an instance of the TerminateSessionRequest.Builder
avoiding the need
to create one manually via TerminateSessionRequest.builder()
terminateSessionRequest
- A Consumer
that will call methods on TerminateSessionRequest.Builder
to create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<UnlabelParameterVersionResponse> unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
unlabelParameterVersionRequest
- default CompletableFuture<UnlabelParameterVersionResponse> unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
This is a convenience which creates an instance of the UnlabelParameterVersionRequest.Builder
avoiding
the need to create one manually via UnlabelParameterVersionRequest.builder()
unlabelParameterVersionRequest
- A Consumer
that will call methods on UnlabelParameterVersionRequest.Builder
to create a
request.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.
In order to call this API action, your IAM user account, group, or role must be configured with permission to
call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then
you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
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.
In order to call this API action, your IAM user account, group, or role must be configured with permission to
call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then
you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
This is a convenience which creates an instance of the UpdateAssociationRequest.Builder
avoiding the need
to create one manually via UpdateAssociationRequest.builder()
updateAssociationRequest
- A Consumer
that will call methods on UpdateAssociationRequest.Builder
to create a request.$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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.
This is a convenience which creates an instance of the UpdateAssociationStatusRequest.Builder
avoiding
the need to create one manually via UpdateAssociationStatusRequest.builder()
updateAssociationStatusRequest
- A Consumer
that will call methods on UpdateAssociationStatusRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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)
Updates one or more values for an SSM document.
updateDocumentRequest
- default CompletableFuture<UpdateDocumentResponse> updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
Updates one or more values for an SSM document.
This is a convenience which creates an instance of the UpdateDocumentRequest.Builder
avoiding the need to
create one manually via UpdateDocumentRequest.builder()
updateDocumentRequest
- A Consumer
that will call methods on UpdateDocumentRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the UpdateDocumentDefaultVersionRequest.Builder
avoiding the need to create one manually via UpdateDocumentDefaultVersionRequest.builder()
updateDocumentDefaultVersionRequest
- A Consumer
that will call methods on UpdateDocumentDefaultVersionRequest.Builder
to create
a request.default CompletableFuture<UpdateDocumentMetadataResponse> updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a document.
updateDocumentMetadataRequest
- default CompletableFuture<UpdateDocumentMetadataResponse> updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a document.
This is a convenience which creates an instance of the UpdateDocumentMetadataRequest.Builder
avoiding the
need to create one manually via UpdateDocumentMetadataRequest.builder()
updateDocumentMetadataRequest
- A Consumer
that will call methods on UpdateDocumentMetadataRequest.Builder
to create a
request.default CompletableFuture<UpdateMaintenanceWindowResponse> updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing maintenance window. Only specified parameters are modified.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
updateMaintenanceWindowRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<UpdateMaintenanceWindowResponse> updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest)
Updates an existing maintenance window. Only specified parameters are modified.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
This is a convenience which creates an instance of the UpdateMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via UpdateMaintenanceWindowRequest.builder()
updateMaintenanceWindowRequest
- A Consumer
that will call methods on UpdateMaintenanceWindowRequest.Builder
to create a
request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<UpdateMaintenanceWindowTargetResponse> updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field is not modified.
updateMaintenanceWindowTargetRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<UpdateMaintenanceWindowTargetResponse> updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest)
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field is not modified.
This is a convenience which creates an instance of the UpdateMaintenanceWindowTargetRequest.Builder
avoiding the need to create one manually via UpdateMaintenanceWindowTargetRequest.builder()
updateMaintenanceWindowTargetRequest
- A Consumer
that will call methods on UpdateMaintenanceWindowTargetRequest.Builder
to
create a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
If the value for a parameter in UpdateMaintenanceWindowTask
is null, then the corresponding field is
not modified. 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.
When you update a maintenance window task that has options specified in TaskInvocationParameters
,
you must provide again all the TaskInvocationParameters
values that you want to retain. The values
you do not specify again are removed. For example, suppose that when you registered a Run Command task, you
specified TaskInvocationParameters
values for Comment
, NotificationConfig
,
and OutputS3BucketName
. If you update the maintenance window task and specify only a different
OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
updateMaintenanceWindowTaskRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
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:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
If the value for a parameter in UpdateMaintenanceWindowTask
is null, then the corresponding field is
not modified. 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.
When you update a maintenance window task that has options specified in TaskInvocationParameters
,
you must provide again all the TaskInvocationParameters
values that you want to retain. The values
you do not specify again are removed. For example, suppose that when you registered a Run Command task, you
specified TaskInvocationParameters
values for Comment
, NotificationConfig
,
and OutputS3BucketName
. If you update the maintenance window task and specify only a different
OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
This is a convenience which creates an instance of the UpdateMaintenanceWindowTaskRequest.Builder
avoiding the need to create one manually via UpdateMaintenanceWindowTaskRequest.builder()
updateMaintenanceWindowTaskRequest
- A Consumer
that will call methods on UpdateMaintenanceWindowTaskRequest.Builder
to create
a request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<UpdateManagedInstanceRoleResponse> updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
updateManagedInstanceRoleRequest
- You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
This is a convenience which creates an instance of the UpdateManagedInstanceRoleRequest.Builder
avoiding
the need to create one manually via UpdateManagedInstanceRoleRequest.builder()
updateManagedInstanceRoleRequest
- A Consumer
that will call methods on UpdateManagedInstanceRoleRequest.Builder
to create a
request.You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
default CompletableFuture<UpdateOpsItemResponse> updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
updateOpsItemRequest
- default CompletableFuture<UpdateOpsItemResponse> updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest)
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the UpdateOpsItemRequest.Builder
avoiding the need to
create one manually via UpdateOpsItemRequest.builder()
updateOpsItemRequest
- A Consumer
that will call methods on UpdateOpsItemRequest.Builder
to create a request.default CompletableFuture<UpdateOpsMetadataResponse> updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
updateOpsMetadataRequest
- default CompletableFuture<UpdateOpsMetadataResponse> updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest)
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
This is a convenience which creates an instance of the UpdateOpsMetadataRequest.Builder
avoiding the need
to create one manually via UpdateOpsMetadataRequest.builder()
updateOpsMetadataRequest
- A Consumer
that will call methods on UpdateOpsMetadataRequest.Builder
to create a request.default CompletableFuture<UpdatePatchBaselineResponse> updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
updatePatchBaselineRequest
- For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<UpdatePatchBaselineResponse> updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
This is a convenience which creates an instance of the UpdatePatchBaselineRequest.Builder
avoiding the
need to create one manually via UpdatePatchBaselineRequest.builder()
updatePatchBaselineRequest
- A Consumer
that will call methods on UpdatePatchBaselineRequest.Builder
to create a
request.For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
default CompletableFuture<UpdateResourceDataSyncResponse> updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
This API action only supports a resource data sync that was created with a SyncFromSource SyncType
.
updateResourceDataSyncRequest
- UpdateResourceDataSync
request is being
processed. Wait a few minutes and try again.default CompletableFuture<UpdateResourceDataSyncResponse> updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest)
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
This API action only supports a resource data sync that was created with a SyncFromSource SyncType
.
This is a convenience which creates an instance of the UpdateResourceDataSyncRequest.Builder
avoiding the
need to create one manually via UpdateResourceDataSyncRequest.builder()
updateResourceDataSyncRequest
- A Consumer
that will call methods on UpdateResourceDataSyncRequest.Builder
to create a
request.UpdateResourceDataSync
request is being
processed. Wait a few minutes and try again.default CompletableFuture<UpdateServiceSettingResponse> updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change
the value back to the original value defined by the AWS service team.
Update the service setting for the account.
updateServiceSettingRequest
- The request body of the UpdateServiceSetting API action.default CompletableFuture<UpdateServiceSettingResponse> updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change
the value back to the original value defined by the AWS service team.
Update the service setting for the account.
This is a convenience which creates an instance of the UpdateServiceSettingRequest.Builder
avoiding the
need to create one manually via UpdateServiceSettingRequest.builder()
updateServiceSettingRequest
- A Consumer
that will call methods on UpdateServiceSettingRequest.Builder
to create a
request. The request body of the UpdateServiceSetting API action.default SsmAsyncWaiter waiter()
SsmAsyncWaiter
using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
SsmAsyncWaiter
Copyright © 2021. All rights reserved.