Interface SsmClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SsmClient
extends AwsClient

Service client for accessing Amazon SSM. This can be created using the static builder() method.

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

Related resources

• For information about each of the tools that comprise Systems Manager, see Using Systems Manager tools in the Amazon Web Services Systems Manager User Guide.

• For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the Systems Manager Automation Runbook Reference .

• For information about AppConfig, a tool in Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .

• For information about Incident Manager, a tool in Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddTagsToResourceResponse	addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)	Adds or overwrites one or more tags for the specified resource.
default AddTagsToResourceResponse	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)	Adds or overwrites one or more tags for the specified resource.
default AssociateOpsItemRelatedItemResponse	associateOpsItemRelatedItem(Consumer<AssociateOpsItemRelatedItemRequest.Builder> associateOpsItemRelatedItemRequest)	Associates a related item to a Systems Manager OpsCenter OpsItem.
default AssociateOpsItemRelatedItemResponse	associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest)	Associates a related item to a Systems Manager OpsCenter OpsItem.
static SsmClientBuilder	builder()	Create a builder that can be used to configure and create a SsmClient.
default CancelCommandResponse	cancelCommand(Consumer<CancelCommandRequest.Builder> cancelCommandRequest)	Attempts to cancel the command specified by the Command ID.
default CancelCommandResponse	cancelCommand(CancelCommandRequest cancelCommandRequest)	Attempts to cancel the command specified by the Command ID.
default CancelMaintenanceWindowExecutionResponse	cancelMaintenanceWindowExecution(Consumer<CancelMaintenanceWindowExecutionRequest.Builder> cancelMaintenanceWindowExecutionRequest)	Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running.
default CancelMaintenanceWindowExecutionResponse	cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)	Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running.
static SsmClient	create()	Create a SsmClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateActivationResponse	createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest)	Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.
default CreateActivationResponse	createActivation(CreateActivationRequest createActivationRequest)	Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.
default CreateAssociationResponse	createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)	A State Manager association defines the state that you want to maintain on your managed nodes.
default CreateAssociationResponse	createAssociation(CreateAssociationRequest createAssociationRequest)	A State Manager association defines the state that you want to maintain on your managed nodes.
default CreateAssociationBatchResponse	createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest)	Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
default CreateAssociationBatchResponse	createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)	Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
default CreateDocumentResponse	createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)	Creates a Amazon Web Services Systems Manager (SSM document).
default CreateDocumentResponse	createDocument(CreateDocumentRequest createDocumentRequest)	Creates a Amazon Web Services Systems Manager (SSM document).
default CreateMaintenanceWindowResponse	createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)	Creates a new maintenance window.
default CreateMaintenanceWindowResponse	createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)	Creates a new maintenance window.
default CreateOpsItemResponse	createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest)	Creates a new OpsItem.
default CreateOpsItemResponse	createOpsItem(CreateOpsItemRequest createOpsItemRequest)	Creates a new OpsItem.
default CreateOpsMetadataResponse	createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest)	If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
default CreateOpsMetadataResponse	createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)	If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
default CreatePatchBaselineResponse	createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)	Creates a patch baseline.
default CreatePatchBaselineResponse	createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)	Creates a patch baseline.
default CreateResourceDataSyncResponse	createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)	A resource data sync helps you view data from multiple sources in a single location.
default CreateResourceDataSyncResponse	createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)	A resource data sync helps you view data from multiple sources in a single location.
default DeleteActivationResponse	deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest)	Deletes an activation.
default DeleteActivationResponse	deleteActivation(DeleteActivationRequest deleteActivationRequest)	Deletes an activation.
default DeleteAssociationResponse	deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)	Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
default DeleteAssociationResponse	deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)	Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
default DeleteDocumentResponse	deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)	Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
default DeleteDocumentResponse	deleteDocument(DeleteDocumentRequest deleteDocumentRequest)	Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
default DeleteInventoryResponse	deleteInventory(Consumer<DeleteInventoryRequest.Builder> deleteInventoryRequest)	Delete a custom inventory type or the data associated with a custom Inventory type.
default DeleteInventoryResponse	deleteInventory(DeleteInventoryRequest deleteInventoryRequest)	Delete a custom inventory type or the data associated with a custom Inventory type.
default DeleteMaintenanceWindowResponse	deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)	Deletes a maintenance window.
default DeleteMaintenanceWindowResponse	deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)	Deletes a maintenance window.
default DeleteOpsItemResponse	deleteOpsItem(Consumer<DeleteOpsItemRequest.Builder> deleteOpsItemRequest)	Delete an OpsItem.
default DeleteOpsItemResponse	deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest)	Delete an OpsItem.
default DeleteOpsMetadataResponse	deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest)	Delete OpsMetadata related to an application.
default DeleteOpsMetadataResponse	deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)	Delete OpsMetadata related to an application.
default DeleteParameterResponse	deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest)	Delete a parameter from the system.
default DeleteParameterResponse	deleteParameter(DeleteParameterRequest deleteParameterRequest)	Delete a parameter from the system.
default DeleteParametersResponse	deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)	Delete a list of parameters.
default DeleteParametersResponse	deleteParameters(DeleteParametersRequest deleteParametersRequest)	Delete a list of parameters.
default DeletePatchBaselineResponse	deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)	Deletes a patch baseline.
default DeletePatchBaselineResponse	deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)	Deletes a patch baseline.
default DeleteResourceDataSyncResponse	deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)	Deletes a resource data sync configuration.
default DeleteResourceDataSyncResponse	deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)	Deletes a resource data sync configuration.
default DeleteResourcePolicyResponse	deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)	Deletes a Systems Manager resource policy.
default DeleteResourcePolicyResponse	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)	Deletes a Systems Manager resource policy.
default DeregisterManagedInstanceResponse	deregisterManagedInstance(Consumer<DeregisterManagedInstanceRequest.Builder> deregisterManagedInstanceRequest)	Removes the server or virtual machine from the list of registered servers.
default DeregisterManagedInstanceResponse	deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)	Removes the server or virtual machine from the list of registered servers.
default DeregisterPatchBaselineForPatchGroupResponse	deregisterPatchBaselineForPatchGroup(Consumer<DeregisterPatchBaselineForPatchGroupRequest.Builder> deregisterPatchBaselineForPatchGroupRequest)	Removes a patch group from a patch baseline.
default DeregisterPatchBaselineForPatchGroupResponse	deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)	Removes a patch group from a patch baseline.
default DeregisterTargetFromMaintenanceWindowResponse	deregisterTargetFromMaintenanceWindow(Consumer<DeregisterTargetFromMaintenanceWindowRequest.Builder> deregisterTargetFromMaintenanceWindowRequest)	Removes a target from a maintenance window.
default DeregisterTargetFromMaintenanceWindowResponse	deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)	Removes a target from a maintenance window.
default DeregisterTaskFromMaintenanceWindowResponse	deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest)	Removes a task from a maintenance window.
default DeregisterTaskFromMaintenanceWindowResponse	deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)	Removes a task from a maintenance window.
default DescribeActivationsResponse	describeActivations()	Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
default 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
default DescribeActivationsResponse	describeActivations(DescribeActivationsRequest describeActivationsRequest)	Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
default DescribeActivationsIterable	describeActivationsPaginator()	This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation.
default DescribeActivationsIterable	describeActivationsPaginator(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)	This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation.
default DescribeActivationsIterable	describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)	This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation.
default DescribeAssociationResponse	describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest)	Describes the association for the specified target or managed node.
default DescribeAssociationResponse	describeAssociation(DescribeAssociationRequest describeAssociationRequest)	Describes the association for the specified target or managed node.
default DescribeAssociationExecutionsResponse	describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)	Views all executions for a specific association ID.
default DescribeAssociationExecutionsResponse	describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)	Views all executions for a specific association ID.
default DescribeAssociationExecutionsIterable	describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)	This is a variant of describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation.
default DescribeAssociationExecutionsIterable	describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)	This is a variant of describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation.
default DescribeAssociationExecutionTargetsResponse	describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)	Views information about a specific execution of a specific association.
default DescribeAssociationExecutionTargetsResponse	describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)	Views information about a specific execution of a specific association.
default DescribeAssociationExecutionTargetsIterable	describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)	This is a variant of describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation.
default DescribeAssociationExecutionTargetsIterable	describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)	This is a variant of describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation.
default DescribeAutomationExecutionsResponse	describeAutomationExecutions()	Provides details about all active and terminated Automation executions.
default DescribeAutomationExecutionsResponse	describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)	Provides details about all active and terminated Automation executions.
default DescribeAutomationExecutionsResponse	describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)	Provides details about all active and terminated Automation executions.
default DescribeAutomationExecutionsIterable	describeAutomationExecutionsPaginator()	This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation.
default DescribeAutomationExecutionsIterable	describeAutomationExecutionsPaginator(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)	This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation.
default DescribeAutomationExecutionsIterable	describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)	This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation.
default DescribeAutomationStepExecutionsResponse	describeAutomationStepExecutions(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)	Information about all active and terminated step executions in an Automation workflow.
default DescribeAutomationStepExecutionsResponse	describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)	Information about all active and terminated step executions in an Automation workflow.
default DescribeAutomationStepExecutionsIterable	describeAutomationStepExecutionsPaginator(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)	This is a variant of describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation.
default DescribeAutomationStepExecutionsIterable	describeAutomationStepExecutionsPaginator(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)	This is a variant of describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation.
default DescribeAvailablePatchesResponse	describeAvailablePatches()	Lists all patches eligible to be included in a patch baseline.
default DescribeAvailablePatchesResponse	describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)	Lists all patches eligible to be included in a patch baseline.
default DescribeAvailablePatchesResponse	describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)	Lists all patches eligible to be included in a patch baseline.
default DescribeAvailablePatchesIterable	describeAvailablePatchesPaginator()	This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation.
default DescribeAvailablePatchesIterable	describeAvailablePatchesPaginator(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)	This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation.
default DescribeAvailablePatchesIterable	describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)	This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation.
default DescribeDocumentResponse	describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest)	Describes the specified Amazon Web Services Systems Manager document (SSM document).
default DescribeDocumentResponse	describeDocument(DescribeDocumentRequest describeDocumentRequest)	Describes the specified Amazon Web Services Systems Manager document (SSM document).
default DescribeDocumentPermissionResponse	describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest)	Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).
default DescribeDocumentPermissionResponse	describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)	Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).
default DescribeEffectiveInstanceAssociationsResponse	describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)	All associations for the managed nodes.
default DescribeEffectiveInstanceAssociationsResponse	describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)	All associations for the managed nodes.
default DescribeEffectiveInstanceAssociationsIterable	describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)	This is a variant of describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation.
default DescribeEffectiveInstanceAssociationsIterable	describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)	This is a variant of describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation.
default DescribeEffectivePatchesForPatchBaselineResponse	describeEffectivePatchesForPatchBaseline(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)	Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
default DescribeEffectivePatchesForPatchBaselineResponse	describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)	Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
default DescribeEffectivePatchesForPatchBaselineIterable	describeEffectivePatchesForPatchBaselinePaginator(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)	This is a variant of describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation.
default DescribeEffectivePatchesForPatchBaselineIterable	describeEffectivePatchesForPatchBaselinePaginator(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)	This is a variant of describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation.
default DescribeInstanceAssociationsStatusResponse	describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)	The status of the associations for the managed nodes.
default DescribeInstanceAssociationsStatusResponse	describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)	The status of the associations for the managed nodes.
default DescribeInstanceAssociationsStatusIterable	describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)	This is a variant of describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation.
default DescribeInstanceAssociationsStatusIterable	describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)	This is a variant of describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation.
default DescribeInstanceInformationResponse	describeInstanceInformation()	Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.
default DescribeInstanceInformationResponse	describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)	Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.
default DescribeInstanceInformationResponse	describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)	Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.
default DescribeInstanceInformationIterable	describeInstanceInformationPaginator()	This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation.
default DescribeInstanceInformationIterable	describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)	This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation.
default DescribeInstanceInformationIterable	describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)	This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation.
default DescribeInstancePatchesResponse	describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)	Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
default DescribeInstancePatchesResponse	describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)	Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
default DescribeInstancePatchesIterable	describeInstancePatchesPaginator(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)	This is a variant of describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation.
default DescribeInstancePatchesIterable	describeInstancePatchesPaginator(DescribeInstancePatchesRequest describeInstancePatchesRequest)	This is a variant of describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation.
default DescribeInstancePatchStatesResponse	describeInstancePatchStates(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)	Retrieves the high-level patch state of one or more managed nodes.
default DescribeInstancePatchStatesResponse	describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)	Retrieves the high-level patch state of one or more managed nodes.
default DescribeInstancePatchStatesForPatchGroupResponse	describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)	Retrieves the high-level patch state for the managed nodes in the specified patch group.
default DescribeInstancePatchStatesForPatchGroupResponse	describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)	Retrieves the high-level patch state for the managed nodes in the specified patch group.
default DescribeInstancePatchStatesForPatchGroupIterable	describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)	This is a variant of describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation.
default DescribeInstancePatchStatesForPatchGroupIterable	describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)	This is a variant of describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation.
default DescribeInstancePatchStatesIterable	describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)	This is a variant of describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation.
default DescribeInstancePatchStatesIterable	describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)	This is a variant of describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation.
default DescribeInstancePropertiesResponse	describeInstanceProperties(Consumer<DescribeInstancePropertiesRequest.Builder> describeInstancePropertiesRequest)	An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
default DescribeInstancePropertiesResponse	describeInstanceProperties(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)	An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
default DescribeInstancePropertiesIterable	describeInstancePropertiesPaginator(Consumer<DescribeInstancePropertiesRequest.Builder> describeInstancePropertiesRequest)	This is a variant of describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation.
default DescribeInstancePropertiesIterable	describeInstancePropertiesPaginator(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)	This is a variant of describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation.
default DescribeInventoryDeletionsResponse	describeInventoryDeletions()	Describes a specific delete inventory operation.
default DescribeInventoryDeletionsResponse	describeInventoryDeletions(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)	Describes a specific delete inventory operation.
default DescribeInventoryDeletionsResponse	describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)	Describes a specific delete inventory operation.
default DescribeInventoryDeletionsIterable	describeInventoryDeletionsPaginator()	This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation.
default DescribeInventoryDeletionsIterable	describeInventoryDeletionsPaginator(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)	This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation.
default DescribeInventoryDeletionsIterable	describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)	This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation.
default DescribeMaintenanceWindowExecutionsResponse	describeMaintenanceWindowExecutions(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)	Lists the executions of a maintenance window.
default DescribeMaintenanceWindowExecutionsResponse	describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)	Lists the executions of a maintenance window.
default DescribeMaintenanceWindowExecutionsIterable	describeMaintenanceWindowExecutionsPaginator(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)	This is a variant of describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation.
default DescribeMaintenanceWindowExecutionsIterable	describeMaintenanceWindowExecutionsPaginator(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)	This is a variant of describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation.
default 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 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 DescribeMaintenanceWindowExecutionTaskInvocationsIterable	describeMaintenanceWindowExecutionTaskInvocationsPaginator(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)	This is a variant of describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation.
default DescribeMaintenanceWindowExecutionTaskInvocationsIterable	describeMaintenanceWindowExecutionTaskInvocationsPaginator(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)	This is a variant of describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation.
default DescribeMaintenanceWindowExecutionTasksResponse	describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)	For a given maintenance window execution, lists the tasks that were run.
default DescribeMaintenanceWindowExecutionTasksResponse	describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)	For a given maintenance window execution, lists the tasks that were run.
default DescribeMaintenanceWindowExecutionTasksIterable	describeMaintenanceWindowExecutionTasksPaginator(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)	This is a variant of describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation.
default DescribeMaintenanceWindowExecutionTasksIterable	describeMaintenanceWindowExecutionTasksPaginator(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)	This is a variant of describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation.
default DescribeMaintenanceWindowsResponse	describeMaintenanceWindows()	Retrieves the maintenance windows in an Amazon Web Services account.
default DescribeMaintenanceWindowsResponse	describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)	Retrieves the maintenance windows in an Amazon Web Services account.
default DescribeMaintenanceWindowsResponse	describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)	Retrieves the maintenance windows in an Amazon Web Services account.
default DescribeMaintenanceWindowScheduleResponse	describeMaintenanceWindowSchedule(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)	Retrieves information about upcoming executions of a maintenance window.
default DescribeMaintenanceWindowScheduleResponse	describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)	Retrieves information about upcoming executions of a maintenance window.
default DescribeMaintenanceWindowScheduleIterable	describeMaintenanceWindowSchedulePaginator(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)	This is a variant of describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation.
default DescribeMaintenanceWindowScheduleIterable	describeMaintenanceWindowSchedulePaginator(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)	This is a variant of describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation.
default DescribeMaintenanceWindowsForTargetResponse	describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)	Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
default DescribeMaintenanceWindowsForTargetResponse	describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)	Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
default DescribeMaintenanceWindowsForTargetIterable	describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)	This is a variant of describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation.
default DescribeMaintenanceWindowsForTargetIterable	describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)	This is a variant of describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation.
default DescribeMaintenanceWindowsIterable	describeMaintenanceWindowsPaginator()	This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation.
default DescribeMaintenanceWindowsIterable	describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)	This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation.
default DescribeMaintenanceWindowsIterable	describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)	This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation.
default DescribeMaintenanceWindowTargetsResponse	describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)	Lists the targets registered with the maintenance window.
default DescribeMaintenanceWindowTargetsResponse	describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)	Lists the targets registered with the maintenance window.
default DescribeMaintenanceWindowTargetsIterable	describeMaintenanceWindowTargetsPaginator(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)	This is a variant of describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation.
default DescribeMaintenanceWindowTargetsIterable	describeMaintenanceWindowTargetsPaginator(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)	This is a variant of describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation.
default DescribeMaintenanceWindowTasksResponse	describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)	Lists the tasks in a maintenance window.
default DescribeMaintenanceWindowTasksResponse	describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)	Lists the tasks in a maintenance window.
default DescribeMaintenanceWindowTasksIterable	describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)	This is a variant of describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation.
default DescribeMaintenanceWindowTasksIterable	describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)	This is a variant of describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation.
default DescribeOpsItemsResponse	describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)	Query a set of OpsItems.
default DescribeOpsItemsResponse	describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)	Query a set of OpsItems.
default DescribeOpsItemsIterable	describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)	This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation.
default DescribeOpsItemsIterable	describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest)	This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation.
default DescribeParametersResponse	describeParameters()	Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
default DescribeParametersResponse	describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)	Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
default DescribeParametersResponse	describeParameters(DescribeParametersRequest describeParametersRequest)	Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
default DescribeParametersIterable	describeParametersPaginator()	This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation.
default DescribeParametersIterable	describeParametersPaginator(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)	This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation.
default DescribeParametersIterable	describeParametersPaginator(DescribeParametersRequest describeParametersRequest)	This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation.
default DescribePatchBaselinesResponse	describePatchBaselines()	Lists the patch baselines in your Amazon Web Services account.
default DescribePatchBaselinesResponse	describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)	Lists the patch baselines in your Amazon Web Services account.
default DescribePatchBaselinesResponse	describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)	Lists the patch baselines in your Amazon Web Services account.
default DescribePatchBaselinesIterable	describePatchBaselinesPaginator()	This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation.
default DescribePatchBaselinesIterable	describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)	This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation.
default DescribePatchBaselinesIterable	describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest)	This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation.
default DescribePatchGroupsResponse	describePatchGroups()	Lists all patch groups that have been registered with patch baselines.
default DescribePatchGroupsResponse	describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)	Lists all patch groups that have been registered with patch baselines.
default DescribePatchGroupsResponse	describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)	Lists all patch groups that have been registered with patch baselines.
default DescribePatchGroupsIterable	describePatchGroupsPaginator()	This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation.
default DescribePatchGroupsIterable	describePatchGroupsPaginator(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)	This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation.
default DescribePatchGroupsIterable	describePatchGroupsPaginator(DescribePatchGroupsRequest describePatchGroupsRequest)	This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation.
default DescribePatchGroupStateResponse	describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest)	Returns high-level aggregated patch compliance state information for a patch group.
default DescribePatchGroupStateResponse	describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)	Returns high-level aggregated patch compliance state information for a patch group.
default 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 DescribePatchPropertiesResponse	describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)	Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches.
default DescribePatchPropertiesIterable	describePatchPropertiesPaginator(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)	This is a variant of describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation.
default DescribePatchPropertiesIterable	describePatchPropertiesPaginator(DescribePatchPropertiesRequest describePatchPropertiesRequest)	This is a variant of describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation.
default 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 DescribeSessionsResponse	describeSessions(DescribeSessionsRequest describeSessionsRequest)	Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
default DescribeSessionsIterable	describeSessionsPaginator(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)	This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation.
default DescribeSessionsIterable	describeSessionsPaginator(DescribeSessionsRequest describeSessionsRequest)	This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation.
default DisassociateOpsItemRelatedItemResponse	disassociateOpsItemRelatedItem(Consumer<DisassociateOpsItemRelatedItemRequest.Builder> disassociateOpsItemRelatedItemRequest)	Deletes the association between an OpsItem and a related item.
default DisassociateOpsItemRelatedItemResponse	disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest)	Deletes the association between an OpsItem and a related item.
default GetAccessTokenResponse	getAccessToken(Consumer<GetAccessTokenRequest.Builder> getAccessTokenRequest)	Returns a credentials set to be used with just-in-time node access.
default GetAccessTokenResponse	getAccessToken(GetAccessTokenRequest getAccessTokenRequest)	Returns a credentials set to be used with just-in-time node access.
default GetAutomationExecutionResponse	getAutomationExecution(Consumer<GetAutomationExecutionRequest.Builder> getAutomationExecutionRequest)	Get detailed information about a particular Automation execution.
default GetAutomationExecutionResponse	getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)	Get detailed information about a particular Automation execution.
default GetCalendarStateResponse	getCalendarState(Consumer<GetCalendarStateRequest.Builder> getCalendarStateRequest)	Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
default GetCalendarStateResponse	getCalendarState(GetCalendarStateRequest getCalendarStateRequest)	Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
default GetCommandInvocationResponse	getCommandInvocation(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest)	Returns detailed information about command execution for an invocation or plugin.
default GetCommandInvocationResponse	getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)	Returns detailed information about command execution for an invocation or plugin.
default GetConnectionStatusResponse	getConnectionStatus(Consumer<GetConnectionStatusRequest.Builder> getConnectionStatusRequest)	Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
default GetConnectionStatusResponse	getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)	Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
default GetDefaultPatchBaselineResponse	getDefaultPatchBaseline()	Retrieves the default patch baseline.
default GetDefaultPatchBaselineResponse	getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest)	Retrieves the default patch baseline.
default GetDefaultPatchBaselineResponse	getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)	Retrieves the default patch baseline.
default GetDeployablePatchSnapshotForInstanceResponse	getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest)	Retrieves the current snapshot for the patch baseline the managed node uses.
default GetDeployablePatchSnapshotForInstanceResponse	getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)	Retrieves the current snapshot for the patch baseline the managed node uses.
default GetDocumentResponse	getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)	Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
default GetDocumentResponse	getDocument(GetDocumentRequest getDocumentRequest)	Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
default GetExecutionPreviewResponse	getExecutionPreview(Consumer<GetExecutionPreviewRequest.Builder> getExecutionPreviewRequest)	Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.
default GetExecutionPreviewResponse	getExecutionPreview(GetExecutionPreviewRequest getExecutionPreviewRequest)	Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.
default GetInventoryResponse	getInventory()	Query inventory information.
default GetInventoryResponse	getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest)	Query inventory information.
default GetInventoryResponse	getInventory(GetInventoryRequest getInventoryRequest)	Query inventory information.
default GetInventoryIterable	getInventoryPaginator()	This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation.
default GetInventoryIterable	getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest)	This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation.
default GetInventoryIterable	getInventoryPaginator(GetInventoryRequest getInventoryRequest)	This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation.
default 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 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 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 GetInventorySchemaIterable	getInventorySchemaPaginator()	This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation.
default GetInventorySchemaIterable	getInventorySchemaPaginator(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest)	This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation.
default GetInventorySchemaIterable	getInventorySchemaPaginator(GetInventorySchemaRequest getInventorySchemaRequest)	This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation.
default GetMaintenanceWindowResponse	getMaintenanceWindow(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest)	Retrieves a maintenance window.
default GetMaintenanceWindowResponse	getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)	Retrieves a maintenance window.
default GetMaintenanceWindowExecutionResponse	getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest)	Retrieves details about a specific a maintenance window execution.
default GetMaintenanceWindowExecutionResponse	getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)	Retrieves details about a specific a maintenance window execution.
default GetMaintenanceWindowExecutionTaskResponse	getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)	Retrieves the details about a specific task run as part of a maintenance window execution.
default GetMaintenanceWindowExecutionTaskResponse	getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)	Retrieves the details about a specific task run as part of a maintenance window execution.
default GetMaintenanceWindowExecutionTaskInvocationResponse	getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)	Retrieves information about a specific task running on a specific target.
default GetMaintenanceWindowExecutionTaskInvocationResponse	getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)	Retrieves information about a specific task running on a specific target.
default GetMaintenanceWindowTaskResponse	getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest)	Retrieves the details of a maintenance window task.
default GetMaintenanceWindowTaskResponse	getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)	Retrieves the details of a maintenance window task.
default GetOpsItemResponse	getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest)	Get information about an OpsItem by using the ID.
default GetOpsItemResponse	getOpsItem(GetOpsItemRequest getOpsItemRequest)	Get information about an OpsItem by using the ID.
default GetOpsMetadataResponse	getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest)	View operational metadata related to an application in Application Manager.
default GetOpsMetadataResponse	getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)	View operational metadata related to an application in Application Manager.
default GetOpsSummaryResponse	getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)	View a summary of operations metadata (OpsData) based on specified filters and aggregators.
default GetOpsSummaryResponse	getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)	View a summary of operations metadata (OpsData) based on specified filters and aggregators.
default GetOpsSummaryIterable	getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)	This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation.
default GetOpsSummaryIterable	getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest)	This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation.
default GetParameterResponse	getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)	Get information about a single parameter by specifying the parameter name.
default GetParameterResponse	getParameter(GetParameterRequest getParameterRequest)	Get information about a single parameter by specifying the parameter name.
default GetParameterHistoryResponse	getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)	Retrieves the history of all changes to a parameter.
default GetParameterHistoryResponse	getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)	Retrieves the history of all changes to a parameter.
default GetParameterHistoryIterable	getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)	This is a variant of getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation.
default GetParameterHistoryIterable	getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)	This is a variant of getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation.
default GetParametersResponse	getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)	Get information about one or more parameters by specifying multiple parameter names.
default GetParametersResponse	getParameters(GetParametersRequest getParametersRequest)	Get information about one or more parameters by specifying multiple parameter names.
default GetParametersByPathResponse	getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)	Retrieve information about one or more parameters under a specified level in a hierarchy.
default GetParametersByPathResponse	getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)	Retrieve information about one or more parameters under a specified level in a hierarchy.
default GetParametersByPathIterable	getParametersByPathPaginator(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)	This is a variant of getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation.
default GetParametersByPathIterable	getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)	This is a variant of getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation.
default GetPatchBaselineResponse	getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest)	Retrieves information about a patch baseline.
default GetPatchBaselineResponse	getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)	Retrieves information about a patch baseline.
default GetPatchBaselineForPatchGroupResponse	getPatchBaselineForPatchGroup(Consumer<GetPatchBaselineForPatchGroupRequest.Builder> getPatchBaselineForPatchGroupRequest)	Retrieves the patch baseline that should be used for the specified patch group.
default GetPatchBaselineForPatchGroupResponse	getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)	Retrieves the patch baseline that should be used for the specified patch group.
default GetResourcePoliciesResponse	getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)	Returns an array of the Policy object.
default GetResourcePoliciesResponse	getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)	Returns an array of the Policy object.
default GetResourcePoliciesIterable	getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)	This is a variant of getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation.
default GetResourcePoliciesIterable	getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest)	This is a variant of getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation.
default GetServiceSettingResponse	getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest)	ServiceSetting is an account-level setting for an Amazon Web Services service.
default GetServiceSettingResponse	getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)	ServiceSetting is an account-level setting for an Amazon Web Services service.
default LabelParameterVersionResponse	labelParameterVersion(Consumer<LabelParameterVersionRequest.Builder> labelParameterVersionRequest)	A parameter label is a user-defined alias to help you manage different versions of a parameter.
default LabelParameterVersionResponse	labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)	A parameter label is a user-defined alias to help you manage different versions of a parameter.
default ListAssociationsResponse	listAssociations()	Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
default ListAssociationsResponse	listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)	Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
default ListAssociationsResponse	listAssociations(ListAssociationsRequest listAssociationsRequest)	Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
default ListAssociationsIterable	listAssociationsPaginator()	This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation.
default ListAssociationsIterable	listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)	This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation.
default ListAssociationsIterable	listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)	This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation.
default ListAssociationVersionsResponse	listAssociationVersions(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)	Retrieves all versions of an association for a specific association ID.
default ListAssociationVersionsResponse	listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)	Retrieves all versions of an association for a specific association ID.
default ListAssociationVersionsIterable	listAssociationVersionsPaginator(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)	This is a variant of listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation.
default ListAssociationVersionsIterable	listAssociationVersionsPaginator(ListAssociationVersionsRequest listAssociationVersionsRequest)	This is a variant of listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation.
default ListCommandInvocationsResponse	listCommandInvocations()	An invocation is copy of a command sent to a specific managed node.
default ListCommandInvocationsResponse	listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)	An invocation is copy of a command sent to a specific managed node.
default ListCommandInvocationsResponse	listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)	An invocation is copy of a command sent to a specific managed node.
default ListCommandInvocationsIterable	listCommandInvocationsPaginator()	This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation.
default ListCommandInvocationsIterable	listCommandInvocationsPaginator(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)	This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation.
default ListCommandInvocationsIterable	listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest)	This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation.
default ListCommandsResponse	listCommands()	Lists the commands requested by users of the Amazon Web Services account.
default ListCommandsResponse	listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest)	Lists the commands requested by users of the Amazon Web Services account.
default ListCommandsResponse	listCommands(ListCommandsRequest listCommandsRequest)	Lists the commands requested by users of the Amazon Web Services account.
default ListCommandsIterable	listCommandsPaginator()	This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation.
default ListCommandsIterable	listCommandsPaginator(Consumer<ListCommandsRequest.Builder> listCommandsRequest)	This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation.
default ListCommandsIterable	listCommandsPaginator(ListCommandsRequest listCommandsRequest)	This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation.
default ListComplianceItemsResponse	listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)	For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.
default ListComplianceItemsResponse	listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)	For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.
default ListComplianceItemsIterable	listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)	This is a variant of listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation.
default ListComplianceItemsIterable	listComplianceItemsPaginator(ListComplianceItemsRequest listComplianceItemsRequest)	This is a variant of listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation.
default ListComplianceSummariesResponse	listComplianceSummaries()	Returns a summary count of compliant and non-compliant resources for a compliance type.
default ListComplianceSummariesResponse	listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)	Returns a summary count of compliant and non-compliant resources for a compliance type.
default ListComplianceSummariesResponse	listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)	Returns a summary count of compliant and non-compliant resources for a compliance type.
default ListComplianceSummariesIterable	listComplianceSummariesPaginator()	This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation.
default ListComplianceSummariesIterable	listComplianceSummariesPaginator(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)	This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation.
default ListComplianceSummariesIterable	listComplianceSummariesPaginator(ListComplianceSummariesRequest listComplianceSummariesRequest)	This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation.
default ListDocumentMetadataHistoryResponse	listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest)	Information about approval reviews for a version of a change template in Change Manager.
default ListDocumentMetadataHistoryResponse	listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)	Information about approval reviews for a version of a change template in Change Manager.
default ListDocumentsResponse	listDocuments()	Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.
default ListDocumentsResponse	listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)	Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.
default ListDocumentsResponse	listDocuments(ListDocumentsRequest listDocumentsRequest)	Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.
default ListDocumentsIterable	listDocumentsPaginator()	This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation.
default ListDocumentsIterable	listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)	This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation.
default ListDocumentsIterable	listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)	This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation.
default ListDocumentVersionsResponse	listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)	List all versions for a document.
default ListDocumentVersionsResponse	listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)	List all versions for a document.
default ListDocumentVersionsIterable	listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)	This is a variant of listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation.
default ListDocumentVersionsIterable	listDocumentVersionsPaginator(ListDocumentVersionsRequest listDocumentVersionsRequest)	This is a variant of listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation.
default ListInventoryEntriesResponse	listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest)	A list of inventory items returned by the request.
default ListInventoryEntriesResponse	listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)	A list of inventory items returned by the request.
default ListNodesResponse	listNodes(Consumer<ListNodesRequest.Builder> listNodesRequest)	Takes in filters and returns a list of managed nodes matching the filter criteria.
default ListNodesResponse	listNodes(ListNodesRequest listNodesRequest)	Takes in filters and returns a list of managed nodes matching the filter criteria.
default ListNodesIterable	listNodesPaginator(Consumer<ListNodesRequest.Builder> listNodesRequest)	This is a variant of listNodes(software.amazon.awssdk.services.ssm.model.ListNodesRequest) operation.
default ListNodesIterable	listNodesPaginator(ListNodesRequest listNodesRequest)	This is a variant of listNodes(software.amazon.awssdk.services.ssm.model.ListNodesRequest) operation.
default ListNodesSummaryResponse	listNodesSummary(Consumer<ListNodesSummaryRequest.Builder> listNodesSummaryRequest)	Generates a summary of managed instance/node metadata based on the filters and aggregators you specify.
default ListNodesSummaryResponse	listNodesSummary(ListNodesSummaryRequest listNodesSummaryRequest)	Generates a summary of managed instance/node metadata based on the filters and aggregators you specify.
default ListNodesSummaryIterable	listNodesSummaryPaginator(Consumer<ListNodesSummaryRequest.Builder> listNodesSummaryRequest)	This is a variant of listNodesSummary(software.amazon.awssdk.services.ssm.model.ListNodesSummaryRequest) operation.
default ListNodesSummaryIterable	listNodesSummaryPaginator(ListNodesSummaryRequest listNodesSummaryRequest)	This is a variant of listNodesSummary(software.amazon.awssdk.services.ssm.model.ListNodesSummaryRequest) operation.
default ListOpsItemEventsResponse	listOpsItemEvents(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)	Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.
default ListOpsItemEventsResponse	listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)	Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.
default ListOpsItemEventsIterable	listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)	This is a variant of listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation.
default ListOpsItemEventsIterable	listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest)	This is a variant of listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation.
default ListOpsItemRelatedItemsResponse	listOpsItemRelatedItems(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)	Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
default ListOpsItemRelatedItemsResponse	listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)	Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
default ListOpsItemRelatedItemsIterable	listOpsItemRelatedItemsPaginator(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)	This is a variant of listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation.
default ListOpsItemRelatedItemsIterable	listOpsItemRelatedItemsPaginator(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)	This is a variant of listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation.
default ListOpsMetadataResponse	listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)	Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
default ListOpsMetadataResponse	listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)	Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
default ListOpsMetadataIterable	listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)	This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation.
default ListOpsMetadataIterable	listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest)	This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation.
default ListResourceComplianceSummariesResponse	listResourceComplianceSummaries()	Returns a resource-level summary count.
default ListResourceComplianceSummariesResponse	listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)	Returns a resource-level summary count.
default ListResourceComplianceSummariesResponse	listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)	Returns a resource-level summary count.
default ListResourceComplianceSummariesIterable	listResourceComplianceSummariesPaginator()	This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation.
default ListResourceComplianceSummariesIterable	listResourceComplianceSummariesPaginator(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)	This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation.
default ListResourceComplianceSummariesIterable	listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)	This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation.
default ListResourceDataSyncResponse	listResourceDataSync()	Lists your resource data sync configurations.
default ListResourceDataSyncResponse	listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)	Lists your resource data sync configurations.
default ListResourceDataSyncResponse	listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)	Lists your resource data sync configurations.
default ListResourceDataSyncIterable	listResourceDataSyncPaginator()	This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation.
default ListResourceDataSyncIterable	listResourceDataSyncPaginator(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)	This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation.
default ListResourceDataSyncIterable	listResourceDataSyncPaginator(ListResourceDataSyncRequest listResourceDataSyncRequest)	This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of the tags assigned to the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of the tags assigned to the specified resource.
default ModifyDocumentPermissionResponse	modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest)	Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.
default ModifyDocumentPermissionResponse	modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)	Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.
default PutComplianceItemsResponse	putComplianceItems(Consumer<PutComplianceItemsRequest.Builder> putComplianceItemsRequest)	Registers a compliance type and other compliance details on a designated resource.
default PutComplianceItemsResponse	putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)	Registers a compliance type and other compliance details on a designated resource.
default PutInventoryResponse	putInventory(Consumer<PutInventoryRequest.Builder> putInventoryRequest)	Bulk update custom inventory items on one or more managed nodes.
default PutInventoryResponse	putInventory(PutInventoryRequest putInventoryRequest)	Bulk update custom inventory items on one or more managed nodes.
default PutParameterResponse	putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest)	Create or update a parameter in Parameter Store.
default PutParameterResponse	putParameter(PutParameterRequest putParameterRequest)	Create or update a parameter in Parameter Store.
default PutResourcePolicyResponse	putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)	Creates or updates a Systems Manager resource policy.
default PutResourcePolicyResponse	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)	Creates or updates a Systems Manager resource policy.
default RegisterDefaultPatchBaselineResponse	registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)	Defines the default patch baseline for the relevant operating system.
default RegisterDefaultPatchBaselineResponse	registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)	Defines the default patch baseline for the relevant operating system.
default RegisterPatchBaselineForPatchGroupResponse	registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest)	Registers a patch baseline for a patch group.
default RegisterPatchBaselineForPatchGroupResponse	registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)	Registers a patch baseline for a patch group.
default RegisterTargetWithMaintenanceWindowResponse	registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest)	Registers a target with a maintenance window.
default RegisterTargetWithMaintenanceWindowResponse	registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)	Registers a target with a maintenance window.
default RegisterTaskWithMaintenanceWindowResponse	registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest)	Adds a new task to a maintenance window.
default RegisterTaskWithMaintenanceWindowResponse	registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)	Adds a new task to a maintenance window.
default RemoveTagsFromResourceResponse	removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)	Removes tag keys from the specified resource.
default RemoveTagsFromResourceResponse	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)	Removes tag keys from the specified resource.
default ResetServiceSettingResponse	resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest)	ServiceSetting is an account-level setting for an Amazon Web Services service.
default ResetServiceSettingResponse	resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)	ServiceSetting is an account-level setting for an Amazon Web Services service.
default ResumeSessionResponse	resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest)	Reconnects a session to a managed node after it has been disconnected.
default ResumeSessionResponse	resumeSession(ResumeSessionRequest resumeSessionRequest)	Reconnects a session to a managed node after it has been disconnected.
default SendAutomationSignalResponse	sendAutomationSignal(Consumer<SendAutomationSignalRequest.Builder> sendAutomationSignalRequest)	Sends a signal to an Automation execution to change the current behavior or status of the execution.
default SendAutomationSignalResponse	sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)	Sends a signal to an Automation execution to change the current behavior or status of the execution.
default SendCommandResponse	sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)	Runs commands on one or more managed nodes.
default SendCommandResponse	sendCommand(SendCommandRequest sendCommandRequest)	Runs commands on one or more managed nodes.
default SsmServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartAccessRequestResponse	startAccessRequest(Consumer<StartAccessRequestRequest.Builder> startAccessRequestRequest)	Starts the workflow for just-in-time node access sessions.
default StartAccessRequestResponse	startAccessRequest(StartAccessRequestRequest startAccessRequestRequest)	Starts the workflow for just-in-time node access sessions.
default StartAssociationsOnceResponse	startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest)	Runs an association immediately and only one time.
default StartAssociationsOnceResponse	startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)	Runs an association immediately and only one time.
default StartAutomationExecutionResponse	startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest)	Initiates execution of an Automation runbook.
default StartAutomationExecutionResponse	startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)	Initiates execution of an Automation runbook.
default StartChangeRequestExecutionResponse	startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest)	Creates a change request for Change Manager.
default StartChangeRequestExecutionResponse	startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)	Creates a change request for Change Manager.
default StartExecutionPreviewResponse	startExecutionPreview(Consumer<StartExecutionPreviewRequest.Builder> startExecutionPreviewRequest)	Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.
default StartExecutionPreviewResponse	startExecutionPreview(StartExecutionPreviewRequest startExecutionPreviewRequest)	Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.
default StartSessionResponse	startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)	Initiates a connection to a target (for example, a managed node) for a Session Manager session.
default StartSessionResponse	startSession(StartSessionRequest startSessionRequest)	Initiates a connection to a target (for example, a managed node) for a Session Manager session.
default StopAutomationExecutionResponse	stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)	Stop an Automation that is currently running.
default StopAutomationExecutionResponse	stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)	Stop an Automation that is currently running.
default 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 managed node.
default TerminateSessionResponse	terminateSession(TerminateSessionRequest terminateSessionRequest)	Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node.
default UnlabelParameterVersionResponse	unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest)	Remove a label or labels from a parameter.
default UnlabelParameterVersionResponse	unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)	Remove a label or labels from a parameter.
default UpdateAssociationResponse	updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest)	Updates an association.
default UpdateAssociationResponse	updateAssociation(UpdateAssociationRequest updateAssociationRequest)	Updates an association.
default UpdateAssociationStatusResponse	updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest)	Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
default UpdateAssociationStatusResponse	updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)	Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
default UpdateDocumentResponse	updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)	Updates one or more values for an SSM document.
default UpdateDocumentResponse	updateDocument(UpdateDocumentRequest updateDocumentRequest)	Updates one or more values for an SSM document.
default UpdateDocumentDefaultVersionResponse	updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest)	Set the default version of a document.
default UpdateDocumentDefaultVersionResponse	updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)	Set the default version of a document.
default UpdateDocumentMetadataResponse	updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest)	Updates information related to approval reviews for a specific version of a change template in Change Manager.
default UpdateDocumentMetadataResponse	updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)	Updates information related to approval reviews for a specific version of a change template in Change Manager.
default UpdateMaintenanceWindowResponse	updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest)	Updates an existing maintenance window.
default UpdateMaintenanceWindowResponse	updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)	Updates an existing maintenance window.
default UpdateMaintenanceWindowTargetResponse	updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest)	Modifies the target of an existing maintenance window.
default UpdateMaintenanceWindowTargetResponse	updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)	Modifies the target of an existing maintenance window.
default UpdateMaintenanceWindowTaskResponse	updateMaintenanceWindowTask(Consumer<UpdateMaintenanceWindowTaskRequest.Builder> updateMaintenanceWindowTaskRequest)	Modifies a task assigned to a maintenance window.
default UpdateMaintenanceWindowTaskResponse	updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)	Modifies a task assigned to a maintenance window.
default UpdateManagedInstanceRoleResponse	updateManagedInstanceRole(Consumer<UpdateManagedInstanceRoleRequest.Builder> updateManagedInstanceRoleRequest)	Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM).
default UpdateManagedInstanceRoleResponse	updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)	Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM).
default UpdateOpsItemResponse	updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest)	Edit or change an OpsItem.
default UpdateOpsItemResponse	updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)	Edit or change an OpsItem.
default UpdateOpsMetadataResponse	updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest)	Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
default UpdateOpsMetadataResponse	updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)	Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
default UpdatePatchBaselineResponse	updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)	Modifies an existing patch baseline.
default UpdatePatchBaselineResponse	updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)	Modifies an existing patch baseline.
default UpdateResourceDataSyncResponse	updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest)	Update a resource data sync.
default UpdateResourceDataSyncResponse	updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)	Update a resource data sync.
default UpdateServiceSettingResponse	updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest)	ServiceSetting is an account-level setting for an Amazon Web Services service.
default UpdateServiceSettingResponse	updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)	ServiceSetting is an account-level setting for an Amazon Web Services service.
default SsmWaiter	waiter()	Create an instance of SsmWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

addTagsToResource

default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
                                             throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
TooManyTagsErrorException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:

• Key=Owner,Value=DbAdmin

• Key=Owner,Value=SysAdmin

• Key=Owner,Value=Dev

• Key=Stack,Value=Production

• Key=Stack,Value=Pre-Production

• Key=Stack,Value=Test

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

Parameters:

addTagsToResourceRequest -

Returns:

Result of the AddTagsToResource operation returned by the service.

See Also:

• AWS API Documentation

addTagsToResource

default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
                                             throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
TooManyTagsErrorException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:

• Key=Owner,Value=DbAdmin

• Key=Owner,Value=SysAdmin

• Key=Owner,Value=Dev

• Key=Stack,Value=Production

• Key=Stack,Value=Pre-Production

• Key=Stack,Value=Test

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need to create one manually via AddTagsToResourceRequest.builder()

Parameters:

addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceRequest.Builder to create a request.

Returns:

Result of the AddTagsToResource operation returned by the service.

See Also:

• AWS API Documentation

associateOpsItemRelatedItem

default AssociateOpsItemRelatedItemResponse associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest)
                                                                 throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
OpsItemRelatedItemAlreadyExistsException,
OpsItemConflictException,
AwsServiceException,
SdkClientException,
SsmException

Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in Amazon Web Services Systems Manager.

Parameters:

associateOpsItemRelatedItemRequest -

Returns:

Result of the AssociateOpsItemRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

associateOpsItemRelatedItem

default AssociateOpsItemRelatedItemResponse associateOpsItemRelatedItem(Consumer<AssociateOpsItemRelatedItemRequest.Builder> associateOpsItemRelatedItemRequest)
                                                                 throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
OpsItemRelatedItemAlreadyExistsException,
OpsItemConflictException,
AwsServiceException,
SdkClientException,
SsmException

Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in Amazon Web Services Systems Manager.

This is a convenience which creates an instance of the AssociateOpsItemRelatedItemRequest.Builder avoiding the need to create one manually via AssociateOpsItemRelatedItemRequest.builder()

Parameters:

associateOpsItemRelatedItemRequest - A Consumer that will call methods on AssociateOpsItemRelatedItemRequest.Builder to create a request.

Returns:

Result of the AssociateOpsItemRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

cancelCommand

default CancelCommandResponse cancelCommand(CancelCommandRequest cancelCommandRequest)
                                     throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
DuplicateInstanceIdException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

cancelCommandRequest -

Returns:

Result of the CancelCommand operation returned by the service.

See Also:

• AWS API Documentation

cancelCommand

default CancelCommandResponse cancelCommand(Consumer<CancelCommandRequest.Builder> cancelCommandRequest)
                                     throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
DuplicateInstanceIdException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

cancelCommandRequest - A Consumer that will call methods on CancelCommandRequest.Builder to create a request.

Returns:

Result of the CancelCommand operation returned by the service.

See Also:

• AWS API Documentation

cancelMaintenanceWindowExecution

default CancelMaintenanceWindowExecutionResponse cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
                                                                           throws InternalServerErrorException,
DoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.

Parameters:

cancelMaintenanceWindowExecutionRequest -

Returns:

Result of the CancelMaintenanceWindowExecution operation returned by the service.

See Also:

• AWS API Documentation

cancelMaintenanceWindowExecution

default CancelMaintenanceWindowExecutionResponse cancelMaintenanceWindowExecution(Consumer<CancelMaintenanceWindowExecutionRequest.Builder> cancelMaintenanceWindowExecutionRequest)
                                                                           throws InternalServerErrorException,
DoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.

This is a convenience which creates an instance of the CancelMaintenanceWindowExecutionRequest.Builder avoiding the need to create one manually via CancelMaintenanceWindowExecutionRequest.builder()

Parameters:

cancelMaintenanceWindowExecutionRequest - A Consumer that will call methods on CancelMaintenanceWindowExecutionRequest.Builder to create a request.

Returns:

Result of the CancelMaintenanceWindowExecution operation returned by the service.

See Also:

• AWS API Documentation

createActivation

default CreateActivationResponse createActivation(CreateActivationRequest createActivationRequest)
                                           throws InvalidParametersException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

Parameters:

createActivationRequest -

Returns:

Result of the CreateActivation operation returned by the service.

See Also:

• AWS API Documentation

createActivation

default CreateActivationResponse createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest)
                                           throws InvalidParametersException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

This is a convenience which creates an instance of the CreateActivationRequest.Builder avoiding the need to create one manually via CreateActivationRequest.builder()

Parameters:

createActivationRequest - A Consumer that will call methods on CreateActivationRequest.Builder to create a request.

Returns:

Result of the CreateActivation operation returned by the service.

See Also:

• AWS API Documentation

createAssociation

default CreateAssociationResponse createAssociation(CreateAssociationRequest createAssociationRequest)
                                             throws AssociationAlreadyExistsException,
AssociationLimitExceededException,
InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidInstanceIdException,
UnsupportedPlatformTypeException,
InvalidOutputLocationException,
InvalidParametersException,
InvalidTargetException,
InvalidScheduleException,
InvalidTargetMapsException,
InvalidTagException,
AwsServiceException,
SdkClientException,
SsmException

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a tool in Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.

Parameters:

createAssociationRequest -

Returns:

Result of the CreateAssociation operation returned by the service.

See Also:

• AWS API Documentation

createAssociation

default CreateAssociationResponse createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)
                                             throws AssociationAlreadyExistsException,
AssociationLimitExceededException,
InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidInstanceIdException,
UnsupportedPlatformTypeException,
InvalidOutputLocationException,
InvalidParametersException,
InvalidTargetException,
InvalidScheduleException,
InvalidTargetMapsException,
InvalidTagException,
AwsServiceException,
SdkClientException,
SsmException

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a tool in Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.

This is a convenience which creates an instance of the CreateAssociationRequest.Builder avoiding the need to create one manually via CreateAssociationRequest.builder()

Parameters:

createAssociationRequest - A Consumer that will call methods on CreateAssociationRequest.Builder to create a request.

Returns:

Result of the CreateAssociation operation returned by the service.

See Also:

• AWS API Documentation

createAssociationBatch

default CreateAssociationBatchResponse createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
                                                       throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidInstanceIdException,
InvalidParametersException,
DuplicateInstanceIdException,
AssociationLimitExceededException,
UnsupportedPlatformTypeException,
InvalidOutputLocationException,
InvalidTargetException,
InvalidScheduleException,
InvalidTargetMapsException,
AwsServiceException,
SdkClientException,
SsmException

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.

When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.

If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.

Parameters:

createAssociationBatchRequest -

Returns:

Result of the CreateAssociationBatch operation returned by the service.

See Also:

• AWS API Documentation

createAssociationBatch

default CreateAssociationBatchResponse createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest)
                                                       throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidInstanceIdException,
InvalidParametersException,
DuplicateInstanceIdException,
AssociationLimitExceededException,
UnsupportedPlatformTypeException,
InvalidOutputLocationException,
InvalidTargetException,
InvalidScheduleException,
InvalidTargetMapsException,
AwsServiceException,
SdkClientException,
SsmException

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.

When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.

If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.

This is a convenience which creates an instance of the CreateAssociationBatchRequest.Builder avoiding the need to create one manually via CreateAssociationBatchRequest.builder()

Parameters:

createAssociationBatchRequest - A Consumer that will call methods on CreateAssociationBatchRequest.Builder to create a request.

Returns:

Result of the CreateAssociationBatch operation returned by the service.

See Also:

• AWS API Documentation

createDocument

default CreateDocumentResponse createDocument(CreateDocumentRequest createDocumentRequest)
                                       throws DocumentAlreadyExistsException,
MaxDocumentSizeExceededException,
InternalServerErrorException,
InvalidDocumentContentException,
DocumentLimitExceededException,
InvalidDocumentSchemaVersionException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

Parameters:

createDocumentRequest -

Returns:

Result of the CreateDocument operation returned by the service.

See Also:

• AWS API Documentation

createDocument

default CreateDocumentResponse createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)
                                       throws DocumentAlreadyExistsException,
MaxDocumentSizeExceededException,
InternalServerErrorException,
InvalidDocumentContentException,
DocumentLimitExceededException,
InvalidDocumentSchemaVersionException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

This is a convenience which creates an instance of the CreateDocumentRequest.Builder avoiding the need to create one manually via CreateDocumentRequest.builder()

Parameters:

createDocumentRequest - A Consumer that will call methods on CreateDocumentRequest.Builder to create a request.

Returns:

Result of the CreateDocument operation returned by the service.

See Also:

• AWS API Documentation

createMaintenanceWindow

default CreateMaintenanceWindowResponse createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
                                                         throws IdempotentParameterMismatchException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

createMaintenanceWindowRequest -

Returns:

Result of the CreateMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

createMaintenanceWindow

default CreateMaintenanceWindowResponse createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)
                                                         throws IdempotentParameterMismatchException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

createMaintenanceWindowRequest - A Consumer that will call methods on CreateMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the CreateMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

createOpsItem

default CreateOpsItemResponse createOpsItem(CreateOpsItemRequest createOpsItemRequest)
                                     throws InternalServerErrorException,
OpsItemAlreadyExistsException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
OpsItemAccessDeniedException,
AwsServiceException,
SdkClientException,
SsmException

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Parameters:

createOpsItemRequest -

Returns:

Result of the CreateOpsItem operation returned by the service.

See Also:

• AWS API Documentation

createOpsItem

default CreateOpsItemResponse createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest)
                                     throws InternalServerErrorException,
OpsItemAlreadyExistsException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
OpsItemAccessDeniedException,
AwsServiceException,
SdkClientException,
SsmException

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

This is a convenience which creates an instance of the CreateOpsItemRequest.Builder avoiding the need to create one manually via CreateOpsItemRequest.builder()

Parameters:

createOpsItemRequest - A Consumer that will call methods on CreateOpsItemRequest.Builder to create a request.

Returns:

Result of the CreateOpsItem operation returned by the service.

See Also:

• AWS API Documentation

createOpsMetadata

default CreateOpsMetadataResponse createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)
                                             throws OpsMetadataAlreadyExistsException,
OpsMetadataTooManyUpdatesException,
OpsMetadataInvalidArgumentException,
OpsMetadataLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.

Parameters:

createOpsMetadataRequest -

Returns:

Result of the CreateOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

createOpsMetadata

default CreateOpsMetadataResponse createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest)
                                             throws OpsMetadataAlreadyExistsException,
OpsMetadataTooManyUpdatesException,
OpsMetadataInvalidArgumentException,
OpsMetadataLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.

This is a convenience which creates an instance of the CreateOpsMetadataRequest.Builder avoiding the need to create one manually via CreateOpsMetadataRequest.builder()

Parameters:

createOpsMetadataRequest - A Consumer that will call methods on CreateOpsMetadataRequest.Builder to create a request.

Returns:

Result of the CreateOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

createPatchBaseline

default CreatePatchBaselineResponse createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
                                                 throws IdempotentParameterMismatchException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Creates a patch baseline.

For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Parameters:

createPatchBaselineRequest -

Returns:

Result of the CreatePatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

createPatchBaseline

default CreatePatchBaselineResponse createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)
                                                 throws IdempotentParameterMismatchException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Creates a patch baseline.

For information about valid key-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()

Parameters:

createPatchBaselineRequest - A Consumer that will call methods on CreatePatchBaselineRequest.Builder to create a request.

Returns:

Result of the CreatePatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

createResourceDataSync

default CreateResourceDataSyncResponse createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
                                                       throws InternalServerErrorException,
ResourceDataSyncCountExceededException,
ResourceDataSyncAlreadyExistsException,
ResourceDataSyncInvalidConfigurationException,
AwsServiceException,
SdkClientException,
SsmException

A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.

You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Creating a resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.

By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

Parameters:

createResourceDataSyncRequest -

Returns:

Result of the CreateResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

createResourceDataSync

default CreateResourceDataSyncResponse createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)
                                                       throws InternalServerErrorException,
ResourceDataSyncCountExceededException,
ResourceDataSyncAlreadyExistsException,
ResourceDataSyncInvalidConfigurationException,
AwsServiceException,
SdkClientException,
SsmException

A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.

You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Creating a resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.

By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

This is a convenience which creates an instance of the CreateResourceDataSyncRequest.Builder avoiding the need to create one manually via CreateResourceDataSyncRequest.builder()

Parameters:

createResourceDataSyncRequest - A Consumer that will call methods on CreateResourceDataSyncRequest.Builder to create a request.

Returns:

Result of the CreateResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

deleteActivation

default DeleteActivationResponse deleteActivation(DeleteActivationRequest deleteActivationRequest)
                                           throws InvalidActivationIdException,
InvalidActivationException,
InternalServerErrorException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.

Parameters:

deleteActivationRequest -

Returns:

Result of the DeleteActivation operation returned by the service.

See Also:

• AWS API Documentation

deleteActivation

default DeleteActivationResponse deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest)
                                           throws InvalidActivationIdException,
InvalidActivationException,
InternalServerErrorException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.

This is a convenience which creates an instance of the DeleteActivationRequest.Builder avoiding the need to create one manually via DeleteActivationRequest.builder()

Parameters:

deleteActivationRequest - A Consumer that will call methods on DeleteActivationRequest.Builder to create a request.

Returns:

Result of the DeleteActivation operation returned by the service.

See Also:

• AWS API Documentation

deleteAssociation

default DeleteAssociationResponse deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
                                             throws AssociationDoesNotExistException,
InternalServerErrorException,
InvalidDocumentException,
InvalidInstanceIdException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID.

When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.

Parameters:

deleteAssociationRequest -

Returns:

Result of the DeleteAssociation operation returned by the service.

See Also:

• AWS API Documentation

deleteAssociation

default DeleteAssociationResponse deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)
                                             throws AssociationDoesNotExistException,
InternalServerErrorException,
InvalidDocumentException,
InvalidInstanceIdException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID.

When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.

This is a convenience which creates an instance of the DeleteAssociationRequest.Builder avoiding the need to create one manually via DeleteAssociationRequest.builder()

Parameters:

deleteAssociationRequest - A Consumer that will call methods on DeleteAssociationRequest.Builder to create a request.

Returns:

Result of the DeleteAssociation operation returned by the service.

See Also:

• AWS API Documentation

deleteDocument

default DeleteDocumentResponse deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
                                       throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentOperationException,
AssociatedInstancesException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.

Parameters:

deleteDocumentRequest -

Returns:

Result of the DeleteDocument operation returned by the service.

See Also:

• AWS API Documentation

deleteDocument

default DeleteDocumentResponse deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
                                       throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentOperationException,
AssociatedInstancesException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.

This is a convenience which creates an instance of the DeleteDocumentRequest.Builder avoiding the need to create one manually via DeleteDocumentRequest.builder()

Parameters:

deleteDocumentRequest - A Consumer that will call methods on DeleteDocumentRequest.Builder to create a request.

Returns:

Result of the DeleteDocument operation returned by the service.

See Also:

• AWS API Documentation

deleteInventory

default DeleteInventoryResponse deleteInventory(DeleteInventoryRequest deleteInventoryRequest)
                                         throws InternalServerErrorException,
InvalidTypeNameException,
InvalidOptionException,
InvalidDeleteInventoryParametersException,
InvalidInventoryRequestException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

deleteInventoryRequest -

Returns:

Result of the DeleteInventory operation returned by the service.

See Also:

• AWS API Documentation

deleteInventory

default DeleteInventoryResponse deleteInventory(Consumer<DeleteInventoryRequest.Builder> deleteInventoryRequest)
                                         throws InternalServerErrorException,
InvalidTypeNameException,
InvalidOptionException,
InvalidDeleteInventoryParametersException,
InvalidInventoryRequestException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

deleteInventoryRequest - A Consumer that will call methods on DeleteInventoryRequest.Builder to create a request.

Returns:

Result of the DeleteInventory operation returned by the service.

See Also:

• AWS API Documentation

deleteMaintenanceWindow

default DeleteMaintenanceWindowResponse deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
                                                         throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Deletes a maintenance window.

Parameters:

deleteMaintenanceWindowRequest -

Returns:

Result of the DeleteMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

deleteMaintenanceWindow

default DeleteMaintenanceWindowResponse deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)
                                                         throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

deleteMaintenanceWindowRequest - A Consumer that will call methods on DeleteMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the DeleteMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

deleteOpsItem

default DeleteOpsItemResponse deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest)
                                     throws InternalServerErrorException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.

Note the following important information about this operation.

• Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.

• This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.

• This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.

• This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.

Parameters:

deleteOpsItemRequest -

Returns:

Result of the DeleteOpsItem operation returned by the service.

See Also:

• AWS API Documentation

deleteOpsItem

default DeleteOpsItemResponse deleteOpsItem(Consumer<DeleteOpsItemRequest.Builder> deleteOpsItemRequest)
                                     throws InternalServerErrorException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.

Note the following important information about this operation.

• Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.

• This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.

• This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.

• This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.

This is a convenience which creates an instance of the DeleteOpsItemRequest.Builder avoiding the need to create one manually via DeleteOpsItemRequest.builder()

Parameters:

deleteOpsItemRequest - A Consumer that will call methods on DeleteOpsItemRequest.Builder to create a request.

Returns:

Result of the DeleteOpsItem operation returned by the service.

See Also:

• AWS API Documentation

deleteOpsMetadata

default DeleteOpsMetadataResponse deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
                                             throws OpsMetadataNotFoundException,
OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Delete OpsMetadata related to an application.

Parameters:

deleteOpsMetadataRequest -

Returns:

Result of the DeleteOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

deleteOpsMetadata

default DeleteOpsMetadataResponse deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest)
                                             throws OpsMetadataNotFoundException,
OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

deleteOpsMetadataRequest - A Consumer that will call methods on DeleteOpsMetadataRequest.Builder to create a request.

Returns:

Result of the DeleteOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

deleteParameter

default DeleteParameterResponse deleteParameter(DeleteParameterRequest deleteParameterRequest)
                                         throws InternalServerErrorException,
ParameterNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Parameters:

deleteParameterRequest -

Returns:

Result of the DeleteParameter operation returned by the service.

See Also:

• AWS API Documentation

deleteParameter

default DeleteParameterResponse deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest)
                                         throws InternalServerErrorException,
ParameterNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

This is a convenience which creates an instance of the DeleteParameterRequest.Builder avoiding the need to create one manually via DeleteParameterRequest.builder()

Parameters:

deleteParameterRequest - A Consumer that will call methods on DeleteParameterRequest.Builder to create a request.

Returns:

Result of the DeleteParameter operation returned by the service.

See Also:

• AWS API Documentation

deleteParameters

default DeleteParametersResponse deleteParameters(DeleteParametersRequest deleteParametersRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Parameters:

deleteParametersRequest -

Returns:

Result of the DeleteParameters operation returned by the service.

See Also:

• AWS API Documentation

deleteParameters

default DeleteParametersResponse deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

This is a convenience which creates an instance of the DeleteParametersRequest.Builder avoiding the need to create one manually via DeleteParametersRequest.builder()

Parameters:

deleteParametersRequest - A Consumer that will call methods on DeleteParametersRequest.Builder to create a request.

Returns:

Result of the DeleteParameters operation returned by the service.

See Also:

• AWS API Documentation

deletePatchBaseline

default DeletePatchBaselineResponse deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
                                                 throws ResourceInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Deletes a patch baseline.

Parameters:

deletePatchBaselineRequest -

Returns:

Result of the DeletePatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

deletePatchBaseline

default DeletePatchBaselineResponse deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)
                                                 throws ResourceInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

deletePatchBaselineRequest - A Consumer that will call methods on DeletePatchBaselineRequest.Builder to create a request.

Returns:

Result of the DeletePatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

deleteResourceDataSync

default DeleteResourceDataSyncResponse deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
                                                       throws InternalServerErrorException,
ResourceDataSyncNotFoundException,
ResourceDataSyncInvalidConfigurationException,
AwsServiceException,
SdkClientException,
SsmException

Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.

Parameters:

deleteResourceDataSyncRequest -

Returns:

Result of the DeleteResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

deleteResourceDataSync

default DeleteResourceDataSyncResponse deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)
                                                       throws InternalServerErrorException,
ResourceDataSyncNotFoundException,
ResourceDataSyncInvalidConfigurationException,
AwsServiceException,
SdkClientException,
SsmException

Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.

This is a convenience which creates an instance of the DeleteResourceDataSyncRequest.Builder avoiding the need to create one manually via DeleteResourceDataSyncRequest.builder()

Parameters:

deleteResourceDataSyncRequest - A Consumer that will call methods on DeleteResourceDataSyncRequest.Builder to create a request.

Returns:

Result of the DeleteResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
                                                   throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourcePolicyConflictException,
ResourceNotFoundException,
MalformedResourcePolicyDocumentException,
ResourcePolicyNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

• OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

• Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

Parameters:

deleteResourcePolicyRequest -

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
                                                   throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourcePolicyConflictException,
ResourceNotFoundException,
MalformedResourcePolicyDocumentException,
ResourcePolicyNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

• OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

• Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

Parameters:

deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

deregisterManagedInstance

default DeregisterManagedInstanceResponse deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
                                                             throws InvalidInstanceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Removes the server or virtual machine from the list of registered servers.

If you want to reregister an on-premises server, edge device, or VM, you must use a different Activation Code and Activation ID than used to register the machine previously. The Activation Code and Activation ID must not have already been used on the maximum number of activations specified when they were created. For more information, see Deregistering managed nodes in a hybrid and multicloud environment in the Amazon Web Services Systems Manager User Guide.

Parameters:

deregisterManagedInstanceRequest -

Returns:

Result of the DeregisterManagedInstance operation returned by the service.

See Also:

• AWS API Documentation

deregisterManagedInstance

default DeregisterManagedInstanceResponse deregisterManagedInstance(Consumer<DeregisterManagedInstanceRequest.Builder> deregisterManagedInstanceRequest)
                                                             throws InvalidInstanceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Removes the server or virtual machine from the list of registered servers.

If you want to reregister an on-premises server, edge device, or VM, you must use a different Activation Code and Activation ID than used to register the machine previously. The Activation Code and Activation ID must not have already been used on the maximum number of activations specified when they were created. For more information, see Deregistering managed nodes in a hybrid and multicloud environment in the Amazon Web Services Systems Manager User Guide.

This is a convenience which creates an instance of the DeregisterManagedInstanceRequest.Builder avoiding the need to create one manually via DeregisterManagedInstanceRequest.builder()

Parameters:

deregisterManagedInstanceRequest - A Consumer that will call methods on DeregisterManagedInstanceRequest.Builder to create a request.

Returns:

Result of the DeregisterManagedInstance operation returned by the service.

See Also:

• AWS API Documentation

deregisterPatchBaselineForPatchGroup

default DeregisterPatchBaselineForPatchGroupResponse deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
                                                                                   throws InvalidResourceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Removes a patch group from a patch baseline.

Parameters:

deregisterPatchBaselineForPatchGroupRequest -

Returns:

Result of the DeregisterPatchBaselineForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

deregisterPatchBaselineForPatchGroup

default DeregisterPatchBaselineForPatchGroupResponse deregisterPatchBaselineForPatchGroup(Consumer<DeregisterPatchBaselineForPatchGroupRequest.Builder> deregisterPatchBaselineForPatchGroupRequest)
                                                                                   throws InvalidResourceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

deregisterPatchBaselineForPatchGroupRequest - A Consumer that will call methods on DeregisterPatchBaselineForPatchGroupRequest.Builder to create a request.

Returns:

Result of the DeregisterPatchBaselineForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

deregisterTargetFromMaintenanceWindow

default DeregisterTargetFromMaintenanceWindowResponse deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
                                                                                     throws DoesNotExistException,
InternalServerErrorException,
TargetInUseException,
AwsServiceException,
SdkClientException,
SsmException

Removes a target from a maintenance window.

Parameters:

deregisterTargetFromMaintenanceWindowRequest -

Returns:

Result of the DeregisterTargetFromMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

deregisterTargetFromMaintenanceWindow

default DeregisterTargetFromMaintenanceWindowResponse deregisterTargetFromMaintenanceWindow(Consumer<DeregisterTargetFromMaintenanceWindowRequest.Builder> deregisterTargetFromMaintenanceWindowRequest)
                                                                                     throws DoesNotExistException,
InternalServerErrorException,
TargetInUseException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

deregisterTargetFromMaintenanceWindowRequest - A Consumer that will call methods on DeregisterTargetFromMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the DeregisterTargetFromMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

deregisterTaskFromMaintenanceWindow

default DeregisterTaskFromMaintenanceWindowResponse deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
                                                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Removes a task from a maintenance window.

Parameters:

deregisterTaskFromMaintenanceWindowRequest -

Returns:

Result of the DeregisterTaskFromMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

deregisterTaskFromMaintenanceWindow

default DeregisterTaskFromMaintenanceWindowResponse deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest)
                                                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

deregisterTaskFromMaintenanceWindowRequest - A Consumer that will call methods on DeregisterTaskFromMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the DeregisterTaskFromMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

describeActivations

default DescribeActivationsResponse describeActivations(DescribeActivationsRequest describeActivationsRequest)
                                                 throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.

Parameters:

describeActivationsRequest -

Returns:

Result of the DescribeActivations operation returned by the service.

See Also:

• AWS API Documentation

describeActivations

default DescribeActivationsResponse describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
                                                 throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.

This is a convenience which creates an instance of the DescribeActivationsRequest.Builder avoiding the need to create one manually via DescribeActivationsRequest.builder()

Parameters:

describeActivationsRequest - A Consumer that will call methods on DescribeActivationsRequest.Builder to create a request.

Returns:

Result of the DescribeActivations operation returned by the service.

See Also:

• AWS API Documentation

describeActivations

default DescribeActivationsResponse describeActivations()
                                                 throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.

Returns:

Result of the DescribeActivations operation returned by the service.

See Also:

• describeActivations(DescribeActivationsRequest)
• AWS API Documentation

describeActivationsPaginator

default DescribeActivationsIterable describeActivationsPaginator()
                                                          throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client
             .describeActivationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeActivationsPaginator(DescribeActivationsRequest)
• AWS API Documentation

describeActivationsPaginator

default DescribeActivationsIterable describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)
                                                          throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client
             .describeActivationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeActivationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeActivationsPaginator

default DescribeActivationsIterable describeActivationsPaginator(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
                                                          throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client
             .describeActivationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeActivationsRequest - A Consumer that will call methods on DescribeActivationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAssociation

default DescribeAssociationResponse describeAssociation(DescribeAssociationRequest describeAssociationRequest)
                                                 throws AssociationDoesNotExistException,
InvalidAssociationVersionException,
InternalServerErrorException,
InvalidDocumentException,
InvalidInstanceIdException,
AwsServiceException,
SdkClientException,
SsmException

Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.

Parameters:

describeAssociationRequest -

Returns:

Result of the DescribeAssociation operation returned by the service.

See Also:

• AWS API Documentation

describeAssociation

default DescribeAssociationResponse describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest)
                                                 throws AssociationDoesNotExistException,
InvalidAssociationVersionException,
InternalServerErrorException,
InvalidDocumentException,
InvalidInstanceIdException,
AwsServiceException,
SdkClientException,
SsmException

Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.

This is a convenience which creates an instance of the DescribeAssociationRequest.Builder avoiding the need to create one manually via DescribeAssociationRequest.builder()

Parameters:

describeAssociationRequest - A Consumer that will call methods on DescribeAssociationRequest.Builder to create a request.

Returns:

Result of the DescribeAssociation operation returned by the service.

See Also:

• AWS API Documentation

describeAssociationExecutionTargets

default DescribeAssociationExecutionTargetsResponse describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
                                                                                 throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AssociationExecutionDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Views information about a specific execution of a specific association.

Parameters:

describeAssociationExecutionTargetsRequest -

Returns:

Result of the DescribeAssociationExecutionTargets operation returned by the service.

See Also:

• AWS API Documentation

describeAssociationExecutionTargets

default DescribeAssociationExecutionTargetsResponse describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
                                                                                 throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AssociationExecutionDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Views 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()

Parameters:

describeAssociationExecutionTargetsRequest - A Consumer that will call methods on DescribeAssociationExecutionTargetsRequest.Builder to create a request.

Returns:

Result of the DescribeAssociationExecutionTargets operation returned by the service.

See Also:

• AWS API Documentation

describeAssociationExecutionTargetsPaginator

default DescribeAssociationExecutionTargetsIterable describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
                                                                                          throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AssociationExecutionDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client
             .describeAssociationExecutionTargetsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeAssociationExecutionTargetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAssociationExecutionTargetsPaginator

default DescribeAssociationExecutionTargetsIterable describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
                                                                                          throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AssociationExecutionDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client
             .describeAssociationExecutionTargetsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeAssociationExecutionTargetsRequest - A Consumer that will call methods on DescribeAssociationExecutionTargetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAssociationExecutions

default DescribeAssociationExecutionsResponse describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
                                                                     throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Views all executions for a specific association ID.

Parameters:

describeAssociationExecutionsRequest -

Returns:

Result of the DescribeAssociationExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeAssociationExecutions

default DescribeAssociationExecutionsResponse describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
                                                                     throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Views 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()

Parameters:

describeAssociationExecutionsRequest - A Consumer that will call methods on DescribeAssociationExecutionsRequest.Builder to create a request.

Returns:

Result of the DescribeAssociationExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeAssociationExecutionsPaginator

default DescribeAssociationExecutionsIterable describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
                                                                              throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client
             .describeAssociationExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeAssociationExecutionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAssociationExecutionsPaginator

default DescribeAssociationExecutionsIterable describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
                                                                              throws InternalServerErrorException,
AssociationDoesNotExistException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client
             .describeAssociationExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeAssociationExecutionsRequest - A Consumer that will call methods on DescribeAssociationExecutionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAutomationExecutions

default DescribeAutomationExecutionsResponse describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
                                                                   throws InvalidFilterKeyException,
InvalidFilterValueException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Provides details about all active and terminated Automation executions.

Parameters:

describeAutomationExecutionsRequest -

Returns:

Result of the DescribeAutomationExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeAutomationExecutions

default DescribeAutomationExecutionsResponse describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
                                                                   throws InvalidFilterKeyException,
InvalidFilterValueException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeAutomationExecutionsRequest - A Consumer that will call methods on DescribeAutomationExecutionsRequest.Builder to create a request.

Returns:

Result of the DescribeAutomationExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeAutomationExecutions

default DescribeAutomationExecutionsResponse describeAutomationExecutions()
                                                                   throws InvalidFilterKeyException,
InvalidFilterValueException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Provides details about all active and terminated Automation executions.

Returns:

Result of the DescribeAutomationExecutions operation returned by the service.

See Also:

• describeAutomationExecutions(DescribeAutomationExecutionsRequest)
• AWS API Documentation

describeAutomationExecutionsPaginator

default DescribeAutomationExecutionsIterable describeAutomationExecutionsPaginator()
                                                                            throws InvalidFilterKeyException,
InvalidFilterValueException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client
             .describeAutomationExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest)
• AWS API Documentation

describeAutomationExecutionsPaginator

default DescribeAutomationExecutionsIterable describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
                                                                            throws InvalidFilterKeyException,
InvalidFilterValueException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client
             .describeAutomationExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeAutomationExecutionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAutomationExecutionsPaginator

default DescribeAutomationExecutionsIterable describeAutomationExecutionsPaginator(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
                                                                            throws InvalidFilterKeyException,
InvalidFilterValueException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client
             .describeAutomationExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeAutomationExecutionsRequest - A Consumer that will call methods on DescribeAutomationExecutionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAutomationStepExecutions

default DescribeAutomationStepExecutionsResponse describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
                                                                           throws AutomationExecutionNotFoundException,
InvalidNextTokenException,
InvalidFilterKeyException,
InvalidFilterValueException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Information about all active and terminated step executions in an Automation workflow.

Parameters:

describeAutomationStepExecutionsRequest -

Returns:

Result of the DescribeAutomationStepExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeAutomationStepExecutions

default DescribeAutomationStepExecutionsResponse describeAutomationStepExecutions(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
                                                                           throws AutomationExecutionNotFoundException,
InvalidNextTokenException,
InvalidFilterKeyException,
InvalidFilterValueException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeAutomationStepExecutionsRequest - A Consumer that will call methods on DescribeAutomationStepExecutionsRequest.Builder to create a request.

Returns:

Result of the DescribeAutomationStepExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeAutomationStepExecutionsPaginator

default DescribeAutomationStepExecutionsIterable describeAutomationStepExecutionsPaginator(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
                                                                                    throws AutomationExecutionNotFoundException,
InvalidNextTokenException,
InvalidFilterKeyException,
InvalidFilterValueException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client
             .describeAutomationStepExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeAutomationStepExecutionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAutomationStepExecutionsPaginator

default DescribeAutomationStepExecutionsIterable describeAutomationStepExecutionsPaginator(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
                                                                                    throws AutomationExecutionNotFoundException,
InvalidNextTokenException,
InvalidFilterKeyException,
InvalidFilterValueException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client
             .describeAutomationStepExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeAutomationStepExecutionsRequest - A Consumer that will call methods on DescribeAutomationStepExecutionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAvailablePatches

default DescribeAvailablePatchesResponse describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
                                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists all patches eligible to be included in a patch baseline.

Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.

Parameters:

describeAvailablePatchesRequest -

Returns:

Result of the DescribeAvailablePatches operation returned by the service.

See Also:

• AWS API Documentation

describeAvailablePatches

default DescribeAvailablePatchesResponse describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
                                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists all patches eligible to be included in a patch baseline.

Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.

This is a convenience which creates an instance of the DescribeAvailablePatchesRequest.Builder avoiding the need to create one manually via DescribeAvailablePatchesRequest.builder()

Parameters:

describeAvailablePatchesRequest - A Consumer that will call methods on DescribeAvailablePatchesRequest.Builder to create a request.

Returns:

Result of the DescribeAvailablePatches operation returned by the service.

See Also:

• AWS API Documentation

describeAvailablePatches

default DescribeAvailablePatchesResponse describeAvailablePatches()
                                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists all patches eligible to be included in a patch baseline.

Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.

Returns:

Result of the DescribeAvailablePatches operation returned by the service.

See Also:

• describeAvailablePatches(DescribeAvailablePatchesRequest)
• AWS API Documentation

describeAvailablePatchesPaginator

default DescribeAvailablePatchesIterable describeAvailablePatchesPaginator()
                                                                    throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client
             .describeAvailablePatchesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest)
• AWS API Documentation

describeAvailablePatchesPaginator

default DescribeAvailablePatchesIterable describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
                                                                    throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client
             .describeAvailablePatchesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeAvailablePatchesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAvailablePatchesPaginator

default DescribeAvailablePatchesIterable describeAvailablePatchesPaginator(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
                                                                    throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client
             .describeAvailablePatchesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeAvailablePatchesRequest - A Consumer that will call methods on DescribeAvailablePatchesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeDocument

default DescribeDocumentResponse describeDocument(DescribeDocumentRequest describeDocumentRequest)
                                           throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
AwsServiceException,
SdkClientException,
SsmException

Describes the specified Amazon Web Services Systems Manager document (SSM document).

Parameters:

describeDocumentRequest -

Returns:

Result of the DescribeDocument operation returned by the service.

See Also:

• AWS API Documentation

describeDocument

default DescribeDocumentResponse describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest)
                                           throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
AwsServiceException,
SdkClientException,
SsmException

Describes the specified Amazon Web Services Systems Manager document (SSM document).

This is a convenience which creates an instance of the DescribeDocumentRequest.Builder avoiding the need to create one manually via DescribeDocumentRequest.builder()

Parameters:

describeDocumentRequest - A Consumer that will call methods on DescribeDocumentRequest.Builder to create a request.

Returns:

Result of the DescribeDocument operation returned by the service.

See Also:

• AWS API Documentation

describeDocumentPermission

default DescribeDocumentPermissionResponse describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
                                                               throws InternalServerErrorException,
InvalidDocumentException,
InvalidNextTokenException,
InvalidPermissionTypeException,
InvalidDocumentOperationException,
AwsServiceException,
SdkClientException,
SsmException

Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).

Parameters:

describeDocumentPermissionRequest -

Returns:

Result of the DescribeDocumentPermission operation returned by the service.

See Also:

• AWS API Documentation

describeDocumentPermission

default DescribeDocumentPermissionResponse describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest)
                                                               throws InternalServerErrorException,
InvalidDocumentException,
InvalidNextTokenException,
InvalidPermissionTypeException,
InvalidDocumentOperationException,
AwsServiceException,
SdkClientException,
SsmException

Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).

This is a convenience which creates an instance of the DescribeDocumentPermissionRequest.Builder avoiding the need to create one manually via DescribeDocumentPermissionRequest.builder()

Parameters:

describeDocumentPermissionRequest - A Consumer that will call methods on DescribeDocumentPermissionRequest.Builder to create a request.

Returns:

Result of the DescribeDocumentPermission operation returned by the service.

See Also:

• AWS API Documentation

describeEffectiveInstanceAssociations

default DescribeEffectiveInstanceAssociationsResponse describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
                                                                                     throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

All associations for the managed nodes.

Parameters:

describeEffectiveInstanceAssociationsRequest -

Returns:

Result of the DescribeEffectiveInstanceAssociations operation returned by the service.

See Also:

• AWS API Documentation

describeEffectiveInstanceAssociations

default DescribeEffectiveInstanceAssociationsResponse describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
                                                                                     throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

All associations for the managed nodes.

This is a convenience which creates an instance of the DescribeEffectiveInstanceAssociationsRequest.Builder avoiding the need to create one manually via DescribeEffectiveInstanceAssociationsRequest.builder()

Parameters:

describeEffectiveInstanceAssociationsRequest - A Consumer that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder to create a request.

Returns:

Result of the DescribeEffectiveInstanceAssociations operation returned by the service.

See Also:

• AWS API Documentation

describeEffectiveInstanceAssociationsPaginator

default DescribeEffectiveInstanceAssociationsIterable describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
                                                                                              throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client
             .describeEffectiveInstanceAssociationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeEffectiveInstanceAssociationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeEffectiveInstanceAssociationsPaginator

default DescribeEffectiveInstanceAssociationsIterable describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
                                                                                              throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client
             .describeEffectiveInstanceAssociationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeEffectiveInstanceAssociationsRequest - A Consumer that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeEffectivePatchesForPatchBaseline

default DescribeEffectivePatchesForPatchBaselineResponse describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
                                                                                           throws InvalidResourceIdException,
DoesNotExistException,
UnsupportedOperatingSystemException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.

Parameters:

describeEffectivePatchesForPatchBaselineRequest -

Returns:

Result of the DescribeEffectivePatchesForPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

describeEffectivePatchesForPatchBaseline

default DescribeEffectivePatchesForPatchBaselineResponse describeEffectivePatchesForPatchBaseline(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)
                                                                                           throws InvalidResourceIdException,
DoesNotExistException,
UnsupportedOperatingSystemException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.

This is a convenience which creates an instance of the DescribeEffectivePatchesForPatchBaselineRequest.Builder avoiding the need to create one manually via DescribeEffectivePatchesForPatchBaselineRequest.builder()

Parameters:

describeEffectivePatchesForPatchBaselineRequest - A Consumer that will call methods on DescribeEffectivePatchesForPatchBaselineRequest.Builder to create a request.

Returns:

Result of the DescribeEffectivePatchesForPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

describeEffectivePatchesForPatchBaselinePaginator

default DescribeEffectivePatchesForPatchBaselineIterable describeEffectivePatchesForPatchBaselinePaginator(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
                                                                                                    throws InvalidResourceIdException,
DoesNotExistException,
UnsupportedOperatingSystemException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client
             .describeEffectivePatchesForPatchBaselinePaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeEffectivePatchesForPatchBaselineRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeEffectivePatchesForPatchBaselinePaginator

default DescribeEffectivePatchesForPatchBaselineIterable describeEffectivePatchesForPatchBaselinePaginator(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)
                                                                                                    throws InvalidResourceIdException,
DoesNotExistException,
UnsupportedOperatingSystemException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client
             .describeEffectivePatchesForPatchBaselinePaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeEffectivePatchesForPatchBaselineRequest - A Consumer that will call methods on DescribeEffectivePatchesForPatchBaselineRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstanceAssociationsStatus

default DescribeInstanceAssociationsStatusResponse describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
                                                                               throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

The status of the associations for the managed nodes.

Parameters:

describeInstanceAssociationsStatusRequest -

Returns:

Result of the DescribeInstanceAssociationsStatus operation returned by the service.

See Also:

• AWS API Documentation

describeInstanceAssociationsStatus

default DescribeInstanceAssociationsStatusResponse describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
                                                                               throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

The status of the associations for the managed nodes.

This is a convenience which creates an instance of the DescribeInstanceAssociationsStatusRequest.Builder avoiding the need to create one manually via DescribeInstanceAssociationsStatusRequest.builder()

Parameters:

describeInstanceAssociationsStatusRequest - A Consumer that will call methods on DescribeInstanceAssociationsStatusRequest.Builder to create a request.

Returns:

Result of the DescribeInstanceAssociationsStatus operation returned by the service.

See Also:

• AWS API Documentation

describeInstanceAssociationsStatusPaginator

default DescribeInstanceAssociationsStatusIterable describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
                                                                                        throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client
             .describeInstanceAssociationsStatusPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeInstanceAssociationsStatusRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstanceAssociationsStatusPaginator

default DescribeInstanceAssociationsStatusIterable describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
                                                                                        throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client
             .describeInstanceAssociationsStatusPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeInstanceAssociationsStatusRequest - A Consumer that will call methods on DescribeInstanceAssociationsStatusRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstanceInformation

default DescribeInstanceInformationResponse describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
                                                                 throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
InvalidInstanceInformationFilterValueException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.

If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.

The IamRole field returned for this API operation is the role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.

Parameters:

describeInstanceInformationRequest -

Returns:

Result of the DescribeInstanceInformation operation returned by the service.

See Also:

• AWS API Documentation

describeInstanceInformation

default DescribeInstanceInformationResponse describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
                                                                 throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
InvalidInstanceInformationFilterValueException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.

If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.

The IamRole field returned for this API operation is the role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.

This is a convenience which creates an instance of the DescribeInstanceInformationRequest.Builder avoiding the need to create one manually via DescribeInstanceInformationRequest.builder()

Parameters:

describeInstanceInformationRequest - A Consumer that will call methods on DescribeInstanceInformationRequest.Builder to create a request.

Returns:

Result of the DescribeInstanceInformation operation returned by the service.

See Also:

• AWS API Documentation

describeInstanceInformation

default DescribeInstanceInformationResponse describeInstanceInformation()
                                                                 throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
InvalidInstanceInformationFilterValueException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.

If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.

The IamRole field returned for this API operation is the role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.

Returns:

Result of the DescribeInstanceInformation operation returned by the service.

See Also:

• describeInstanceInformation(DescribeInstanceInformationRequest)
• AWS API Documentation

describeInstanceInformationPaginator

default DescribeInstanceInformationIterable describeInstanceInformationPaginator()
                                                                          throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
InvalidInstanceInformationFilterValueException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client
             .describeInstanceInformationPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeInstanceInformationPaginator(DescribeInstanceInformationRequest)
• AWS API Documentation

describeInstanceInformationPaginator

default DescribeInstanceInformationIterable describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)
                                                                          throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
InvalidInstanceInformationFilterValueException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client
             .describeInstanceInformationPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeInstanceInformationRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstanceInformationPaginator

default DescribeInstanceInformationIterable describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
                                                                          throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidNextTokenException,
InvalidInstanceInformationFilterValueException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client
             .describeInstanceInformationPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeInstanceInformationRequest - A Consumer that will call methods on DescribeInstanceInformationRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstancePatchStates

default DescribeInstancePatchStatesResponse describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
                                                                 throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the high-level patch state of one or more managed nodes.

Parameters:

describeInstancePatchStatesRequest -

Returns:

Result of the DescribeInstancePatchStates operation returned by the service.

See Also:

• AWS API Documentation

describeInstancePatchStates

default DescribeInstancePatchStatesResponse describeInstancePatchStates(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
                                                                 throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the high-level patch state of one or more managed nodes.

This is a convenience which creates an instance of the DescribeInstancePatchStatesRequest.Builder avoiding the need to create one manually via DescribeInstancePatchStatesRequest.builder()

Parameters:

describeInstancePatchStatesRequest - A Consumer that will call methods on DescribeInstancePatchStatesRequest.Builder to create a request.

Returns:

Result of the DescribeInstancePatchStates operation returned by the service.

See Also:

• AWS API Documentation

describeInstancePatchStatesPaginator

default DescribeInstancePatchStatesIterable describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
                                                                          throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client
             .describeInstancePatchStatesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeInstancePatchStatesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstancePatchStatesPaginator

default DescribeInstancePatchStatesIterable describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
                                                                          throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client
             .describeInstancePatchStatesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeInstancePatchStatesRequest - A Consumer that will call methods on DescribeInstancePatchStatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstancePatchStatesForPatchGroup

default DescribeInstancePatchStatesForPatchGroupResponse describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
                                                                                           throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the high-level patch state for the managed nodes in the specified patch group.

Parameters:

describeInstancePatchStatesForPatchGroupRequest -

Returns:

Result of the DescribeInstancePatchStatesForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

describeInstancePatchStatesForPatchGroup

default DescribeInstancePatchStatesForPatchGroupResponse describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
                                                                                           throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the high-level patch state for the managed nodes 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()

Parameters:

describeInstancePatchStatesForPatchGroupRequest - A Consumer that will call methods on DescribeInstancePatchStatesForPatchGroupRequest.Builder to create a request.

Returns:

Result of the DescribeInstancePatchStatesForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

describeInstancePatchStatesForPatchGroupPaginator

default DescribeInstancePatchStatesForPatchGroupIterable describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
                                                                                                    throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client
             .describeInstancePatchStatesForPatchGroupPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeInstancePatchStatesForPatchGroupRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstancePatchStatesForPatchGroupPaginator

default DescribeInstancePatchStatesForPatchGroupIterable describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
                                                                                                    throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client
             .describeInstancePatchStatesForPatchGroupPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeInstancePatchStatesForPatchGroupRequest - A Consumer that will call methods on DescribeInstancePatchStatesForPatchGroupRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstancePatches

default DescribeInstancePatchesResponse describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
                                                         throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.

Parameters:

describeInstancePatchesRequest -

Returns:

Result of the DescribeInstancePatches operation returned by the service.

See Also:

• AWS API Documentation

describeInstancePatches

default DescribeInstancePatchesResponse describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
                                                         throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.

This is a convenience which creates an instance of the DescribeInstancePatchesRequest.Builder avoiding the need to create one manually via DescribeInstancePatchesRequest.builder()

Parameters:

describeInstancePatchesRequest - A Consumer that will call methods on DescribeInstancePatchesRequest.Builder to create a request.

Returns:

Result of the DescribeInstancePatches operation returned by the service.

See Also:

• AWS API Documentation

describeInstancePatchesPaginator

default DescribeInstancePatchesIterable describeInstancePatchesPaginator(DescribeInstancePatchesRequest describeInstancePatchesRequest)
                                                                  throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client
             .describeInstancePatchesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeInstancePatchesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstancePatchesPaginator

default DescribeInstancePatchesIterable describeInstancePatchesPaginator(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
                                                                  throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client
             .describeInstancePatchesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeInstancePatchesRequest - A Consumer that will call methods on DescribeInstancePatchesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstanceProperties

default DescribeInstancePropertiesResponse describeInstanceProperties(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)
                                                               throws InvalidNextTokenException,
InvalidFilterKeyException,
InvalidInstanceIdException,
InvalidActivationIdException,
InvalidInstancePropertyFilterValueException,
InternalServerErrorException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

Parameters:

describeInstancePropertiesRequest -

Returns:

Result of the DescribeInstanceProperties operation returned by the service.

See Also:

• AWS API Documentation

describeInstanceProperties

default DescribeInstancePropertiesResponse describeInstanceProperties(Consumer<DescribeInstancePropertiesRequest.Builder> describeInstancePropertiesRequest)
                                                               throws InvalidNextTokenException,
InvalidFilterKeyException,
InvalidInstanceIdException,
InvalidActivationIdException,
InvalidInstancePropertyFilterValueException,
InternalServerErrorException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

This is a convenience which creates an instance of the DescribeInstancePropertiesRequest.Builder avoiding the need to create one manually via DescribeInstancePropertiesRequest.builder()

Parameters:

describeInstancePropertiesRequest - A Consumer that will call methods on DescribeInstancePropertiesRequest.Builder to create a request.

Returns:

Result of the DescribeInstanceProperties operation returned by the service.

See Also:

• AWS API Documentation

describeInstancePropertiesPaginator

default DescribeInstancePropertiesIterable describeInstancePropertiesPaginator(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)
                                                                        throws InvalidNextTokenException,
InvalidFilterKeyException,
InvalidInstanceIdException,
InvalidActivationIdException,
InvalidInstancePropertyFilterValueException,
InternalServerErrorException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesIterable responses = client.describeInstancePropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesIterable responses = client
             .describeInstancePropertiesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesIterable responses = client.describeInstancePropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation.

Parameters:

describeInstancePropertiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInstancePropertiesPaginator

default DescribeInstancePropertiesIterable describeInstancePropertiesPaginator(Consumer<DescribeInstancePropertiesRequest.Builder> describeInstancePropertiesRequest)
                                                                        throws InvalidNextTokenException,
InvalidFilterKeyException,
InvalidInstanceIdException,
InvalidActivationIdException,
InvalidInstancePropertyFilterValueException,
InternalServerErrorException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesIterable responses = client.describeInstancePropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesIterable responses = client
             .describeInstancePropertiesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesIterable responses = client.describeInstancePropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation.

This is a convenience which creates an instance of the DescribeInstancePropertiesRequest.Builder avoiding the need to create one manually via DescribeInstancePropertiesRequest.builder()

Parameters:

describeInstancePropertiesRequest - A Consumer that will call methods on DescribeInstancePropertiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInventoryDeletions

default DescribeInventoryDeletionsResponse describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
                                                               throws InternalServerErrorException,
InvalidDeletionIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Describes a specific delete inventory operation.

Parameters:

describeInventoryDeletionsRequest -

Returns:

Result of the DescribeInventoryDeletions operation returned by the service.

See Also:

• AWS API Documentation

describeInventoryDeletions

default DescribeInventoryDeletionsResponse describeInventoryDeletions(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
                                                               throws InternalServerErrorException,
InvalidDeletionIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeInventoryDeletionsRequest - A Consumer that will call methods on DescribeInventoryDeletionsRequest.Builder to create a request.

Returns:

Result of the DescribeInventoryDeletions operation returned by the service.

See Also:

• AWS API Documentation

describeInventoryDeletions

default DescribeInventoryDeletionsResponse describeInventoryDeletions()
                                                               throws InternalServerErrorException,
InvalidDeletionIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Describes a specific delete inventory operation.

Returns:

Result of the DescribeInventoryDeletions operation returned by the service.

See Also:

• describeInventoryDeletions(DescribeInventoryDeletionsRequest)
• AWS API Documentation

describeInventoryDeletionsPaginator

default DescribeInventoryDeletionsIterable describeInventoryDeletionsPaginator()
                                                                        throws InternalServerErrorException,
InvalidDeletionIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client
             .describeInventoryDeletionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest)
• AWS API Documentation

describeInventoryDeletionsPaginator

default DescribeInventoryDeletionsIterable describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
                                                                        throws InternalServerErrorException,
InvalidDeletionIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client
             .describeInventoryDeletionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeInventoryDeletionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeInventoryDeletionsPaginator

default DescribeInventoryDeletionsIterable describeInventoryDeletionsPaginator(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
                                                                        throws InternalServerErrorException,
InvalidDeletionIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client
             .describeInventoryDeletionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeInventoryDeletionsRequest - A Consumer that will call methods on DescribeInventoryDeletionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTaskInvocations

default DescribeMaintenanceWindowExecutionTaskInvocationsResponse describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
                                                                                                             throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

Parameters:

describeMaintenanceWindowExecutionTaskInvocationsRequest -

Returns:

Result of the DescribeMaintenanceWindowExecutionTaskInvocations operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTaskInvocations

default DescribeMaintenanceWindowExecutionTaskInvocationsResponse describeMaintenanceWindowExecutionTaskInvocations(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
                                                                                                             throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeMaintenanceWindowExecutionTaskInvocationsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindowExecutionTaskInvocations operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTaskInvocationsPaginator

default DescribeMaintenanceWindowExecutionTaskInvocationsIterable describeMaintenanceWindowExecutionTaskInvocationsPaginator(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
                                                                                                                      throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client
             .describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowExecutionTaskInvocationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTaskInvocationsPaginator

default DescribeMaintenanceWindowExecutionTaskInvocationsIterable describeMaintenanceWindowExecutionTaskInvocationsPaginator(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
                                                                                                                      throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client
             .describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowExecutionTaskInvocationsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTasks

default DescribeMaintenanceWindowExecutionTasksResponse describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
                                                                                         throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

For a given maintenance window execution, lists the tasks that were run.

Parameters:

describeMaintenanceWindowExecutionTasksRequest -

Returns:

Result of the DescribeMaintenanceWindowExecutionTasks operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTasks

default DescribeMaintenanceWindowExecutionTasksResponse describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
                                                                                         throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeMaintenanceWindowExecutionTasksRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTasksRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindowExecutionTasks operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTasksPaginator

default DescribeMaintenanceWindowExecutionTasksIterable describeMaintenanceWindowExecutionTasksPaginator(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
                                                                                                  throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client
             .describeMaintenanceWindowExecutionTasksPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowExecutionTasksRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionTasksPaginator

default DescribeMaintenanceWindowExecutionTasksIterable describeMaintenanceWindowExecutionTasksPaginator(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
                                                                                                  throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client
             .describeMaintenanceWindowExecutionTasksPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowExecutionTasksRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTasksRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutions

default DescribeMaintenanceWindowExecutionsResponse describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
                                                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

describeMaintenanceWindowExecutionsRequest -

Returns:

Result of the DescribeMaintenanceWindowExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutions

default DescribeMaintenanceWindowExecutionsResponse describeMaintenanceWindowExecutions(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)
                                                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeMaintenanceWindowExecutionsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionsRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindowExecutions operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionsPaginator

default DescribeMaintenanceWindowExecutionsIterable describeMaintenanceWindowExecutionsPaginator(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
                                                                                          throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client
             .describeMaintenanceWindowExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowExecutionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowExecutionsPaginator

default DescribeMaintenanceWindowExecutionsIterable describeMaintenanceWindowExecutionsPaginator(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)
                                                                                          throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client
             .describeMaintenanceWindowExecutionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowExecutionsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowSchedule

default DescribeMaintenanceWindowScheduleResponse describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
                                                                             throws InternalServerErrorException,
DoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves information about upcoming executions of a maintenance window.

Parameters:

describeMaintenanceWindowScheduleRequest -

Returns:

Result of the DescribeMaintenanceWindowSchedule operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowSchedule

default DescribeMaintenanceWindowScheduleResponse describeMaintenanceWindowSchedule(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
                                                                             throws InternalServerErrorException,
DoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeMaintenanceWindowScheduleRequest - A Consumer that will call methods on DescribeMaintenanceWindowScheduleRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindowSchedule operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowSchedulePaginator

default DescribeMaintenanceWindowScheduleIterable describeMaintenanceWindowSchedulePaginator(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
                                                                                      throws InternalServerErrorException,
DoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client
             .describeMaintenanceWindowSchedulePaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowScheduleRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowSchedulePaginator

default DescribeMaintenanceWindowScheduleIterable describeMaintenanceWindowSchedulePaginator(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
                                                                                      throws InternalServerErrorException,
DoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client
             .describeMaintenanceWindowSchedulePaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowScheduleRequest - A Consumer that will call methods on DescribeMaintenanceWindowScheduleRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowTargets

default DescribeMaintenanceWindowTargetsResponse describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
                                                                           throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the targets registered with the maintenance window.

Parameters:

describeMaintenanceWindowTargetsRequest -

Returns:

Result of the DescribeMaintenanceWindowTargets operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowTargets

default DescribeMaintenanceWindowTargetsResponse describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
                                                                           throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeMaintenanceWindowTargetsRequest - A Consumer that will call methods on DescribeMaintenanceWindowTargetsRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindowTargets operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowTargetsPaginator

default DescribeMaintenanceWindowTargetsIterable describeMaintenanceWindowTargetsPaginator(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
                                                                                    throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client
             .describeMaintenanceWindowTargetsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowTargetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowTargetsPaginator

default DescribeMaintenanceWindowTargetsIterable describeMaintenanceWindowTargetsPaginator(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
                                                                                    throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client
             .describeMaintenanceWindowTargetsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowTargetsRequest - A Consumer that will call methods on DescribeMaintenanceWindowTargetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowTasks

default DescribeMaintenanceWindowTasksResponse describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
                                                                       throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the tasks in a maintenance window.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

Parameters:

describeMaintenanceWindowTasksRequest -

Returns:

Result of the DescribeMaintenanceWindowTasks operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowTasks

default DescribeMaintenanceWindowTasksResponse describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
                                                                       throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the tasks in a maintenance window.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

This is a convenience which creates an instance of the DescribeMaintenanceWindowTasksRequest.Builder avoiding the need to create one manually via DescribeMaintenanceWindowTasksRequest.builder()

Parameters:

describeMaintenanceWindowTasksRequest - A Consumer that will call methods on DescribeMaintenanceWindowTasksRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindowTasks operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowTasksPaginator

default DescribeMaintenanceWindowTasksIterable describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
                                                                                throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client
             .describeMaintenanceWindowTasksPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowTasksRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowTasksPaginator

default DescribeMaintenanceWindowTasksIterable describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
                                                                                throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client
             .describeMaintenanceWindowTasksPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowTasksRequest - A Consumer that will call methods on DescribeMaintenanceWindowTasksRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindows

default DescribeMaintenanceWindowsResponse describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
                                                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the maintenance windows in an Amazon Web Services account.

Parameters:

describeMaintenanceWindowsRequest -

Returns:

Result of the DescribeMaintenanceWindows operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindows

default DescribeMaintenanceWindowsResponse describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
                                                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the maintenance windows in an Amazon Web Services account.

This is a convenience which creates an instance of the DescribeMaintenanceWindowsRequest.Builder avoiding the need to create one manually via DescribeMaintenanceWindowsRequest.builder()

Parameters:

describeMaintenanceWindowsRequest - A Consumer that will call methods on DescribeMaintenanceWindowsRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindows operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindows

default DescribeMaintenanceWindowsResponse describeMaintenanceWindows()
                                                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the maintenance windows in an Amazon Web Services account.

Returns:

Result of the DescribeMaintenanceWindows operation returned by the service.

See Also:

• describeMaintenanceWindows(DescribeMaintenanceWindowsRequest)
• AWS API Documentation

describeMaintenanceWindowsPaginator

default DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator()
                                                                        throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client
             .describeMaintenanceWindowsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest)
• AWS API Documentation

describeMaintenanceWindowsPaginator

default DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
                                                                        throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client
             .describeMaintenanceWindowsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowsPaginator

default DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
                                                                        throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client
             .describeMaintenanceWindowsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowsRequest - A Consumer that will call methods on DescribeMaintenanceWindowsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowsForTarget

default DescribeMaintenanceWindowsForTargetResponse describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
                                                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves information about the maintenance window targets or tasks that a managed node is associated with.

Parameters:

describeMaintenanceWindowsForTargetRequest -

Returns:

Result of the DescribeMaintenanceWindowsForTarget operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowsForTarget

default DescribeMaintenanceWindowsForTargetResponse describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
                                                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves information about the maintenance window targets or tasks that a managed node 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()

Parameters:

describeMaintenanceWindowsForTargetRequest - A Consumer that will call methods on DescribeMaintenanceWindowsForTargetRequest.Builder to create a request.

Returns:

Result of the DescribeMaintenanceWindowsForTarget operation returned by the service.

See Also:

• AWS API Documentation

describeMaintenanceWindowsForTargetPaginator

default DescribeMaintenanceWindowsForTargetIterable describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
                                                                                          throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client
             .describeMaintenanceWindowsForTargetPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeMaintenanceWindowsForTargetRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMaintenanceWindowsForTargetPaginator

default DescribeMaintenanceWindowsForTargetIterable describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
                                                                                          throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client
             .describeMaintenanceWindowsForTargetPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeMaintenanceWindowsForTargetRequest - A Consumer that will call methods on DescribeMaintenanceWindowsForTargetRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeOpsItems

default DescribeOpsItemsResponse describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Parameters:

describeOpsItemsRequest -

Returns:

Result of the DescribeOpsItems operation returned by the service.

See Also:

• AWS API Documentation

describeOpsItems

default DescribeOpsItemsResponse describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

This is a convenience which creates an instance of the DescribeOpsItemsRequest.Builder avoiding the need to create one manually via DescribeOpsItemsRequest.builder()

Parameters:

describeOpsItemsRequest - A Consumer that will call methods on DescribeOpsItemsRequest.Builder to create a request.

Returns:

Result of the DescribeOpsItems operation returned by the service.

See Also:

• AWS API Documentation

describeOpsItemsPaginator

default DescribeOpsItemsIterable describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest)
                                                    throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeOpsItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeOpsItemsPaginator

default DescribeOpsItemsIterable describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
                                                    throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeOpsItemsRequest - A Consumer that will call methods on DescribeOpsItemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeParameters

default DescribeParametersResponse describeParameters(DescribeParametersRequest describeParametersRequest)
                                               throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.

Parameters:

describeParametersRequest -

Returns:

Result of the DescribeParameters operation returned by the service.

See Also:

• AWS API Documentation

describeParameters

default DescribeParametersResponse describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
                                               throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.

This is a convenience which creates an instance of the DescribeParametersRequest.Builder avoiding the need to create one manually via DescribeParametersRequest.builder()

Parameters:

describeParametersRequest - A Consumer that will call methods on DescribeParametersRequest.Builder to create a request.

Returns:

Result of the DescribeParameters operation returned by the service.

See Also:

• AWS API Documentation

describeParameters

default DescribeParametersResponse describeParameters()
                                               throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.

Returns:

Result of the DescribeParameters operation returned by the service.

See Also:

• describeParameters(DescribeParametersRequest)
• AWS API Documentation

describeParametersPaginator

default DescribeParametersIterable describeParametersPaginator()
                                                        throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client
             .describeParametersPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeParametersPaginator(DescribeParametersRequest)
• AWS API Documentation

describeParametersPaginator

default DescribeParametersIterable describeParametersPaginator(DescribeParametersRequest describeParametersRequest)
                                                        throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client
             .describeParametersPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeParametersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeParametersPaginator

default DescribeParametersIterable describeParametersPaginator(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
                                                        throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client
             .describeParametersPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeParametersRequest - A Consumer that will call methods on DescribeParametersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describePatchBaselines

default DescribePatchBaselinesResponse describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
                                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the patch baselines in your Amazon Web Services account.

Parameters:

describePatchBaselinesRequest -

Returns:

Result of the DescribePatchBaselines operation returned by the service.

See Also:

• AWS API Documentation

describePatchBaselines

default DescribePatchBaselinesResponse describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
                                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the patch baselines in your Amazon Web Services account.

This is a convenience which creates an instance of the DescribePatchBaselinesRequest.Builder avoiding the need to create one manually via DescribePatchBaselinesRequest.builder()

Parameters:

describePatchBaselinesRequest - A Consumer that will call methods on DescribePatchBaselinesRequest.Builder to create a request.

Returns:

Result of the DescribePatchBaselines operation returned by the service.

See Also:

• AWS API Documentation

describePatchBaselines

default DescribePatchBaselinesResponse describePatchBaselines()
                                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the patch baselines in your Amazon Web Services account.

Returns:

Result of the DescribePatchBaselines operation returned by the service.

See Also:

• describePatchBaselines(DescribePatchBaselinesRequest)
• AWS API Documentation

describePatchBaselinesPaginator

default DescribePatchBaselinesIterable describePatchBaselinesPaginator()
                                                                throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client
             .describePatchBaselinesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describePatchBaselinesPaginator(DescribePatchBaselinesRequest)
• AWS API Documentation

describePatchBaselinesPaginator

default DescribePatchBaselinesIterable describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest)
                                                                throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client
             .describePatchBaselinesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describePatchBaselinesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describePatchBaselinesPaginator

default DescribePatchBaselinesIterable describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
                                                                throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client
             .describePatchBaselinesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describePatchBaselinesRequest - A Consumer that will call methods on DescribePatchBaselinesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describePatchGroupState

default DescribePatchGroupStateResponse describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
                                                         throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Returns high-level aggregated patch compliance state information for a patch group.

Parameters:

describePatchGroupStateRequest -

Returns:

Result of the DescribePatchGroupState operation returned by the service.

See Also:

• AWS API Documentation

describePatchGroupState

default DescribePatchGroupStateResponse describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest)
                                                         throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Returns high-level aggregated patch compliance state information 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()

Parameters:

describePatchGroupStateRequest - A Consumer that will call methods on DescribePatchGroupStateRequest.Builder to create a request.

Returns:

Result of the DescribePatchGroupState operation returned by the service.

See Also:

• AWS API Documentation

describePatchGroups

default DescribePatchGroupsResponse describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists all patch groups that have been registered with patch baselines.

Parameters:

describePatchGroupsRequest -

Returns:

Result of the DescribePatchGroups operation returned by the service.

See Also:

• AWS API Documentation

describePatchGroups

default DescribePatchGroupsResponse describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describePatchGroupsRequest - A Consumer that will call methods on DescribePatchGroupsRequest.Builder to create a request.

Returns:

Result of the DescribePatchGroups operation returned by the service.

See Also:

• AWS API Documentation

describePatchGroups

default DescribePatchGroupsResponse describePatchGroups()
                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists all patch groups that have been registered with patch baselines.

Returns:

Result of the DescribePatchGroups operation returned by the service.

See Also:

• describePatchGroups(DescribePatchGroupsRequest)
• AWS API Documentation

describePatchGroupsPaginator

default DescribePatchGroupsIterable describePatchGroupsPaginator()
                                                          throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client
             .describePatchGroupsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describePatchGroupsPaginator(DescribePatchGroupsRequest)
• AWS API Documentation

describePatchGroupsPaginator

default DescribePatchGroupsIterable describePatchGroupsPaginator(DescribePatchGroupsRequest describePatchGroupsRequest)
                                                          throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client
             .describePatchGroupsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describePatchGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describePatchGroupsPaginator

default DescribePatchGroupsIterable describePatchGroupsPaginator(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
                                                          throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client
             .describePatchGroupsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describePatchGroupsRequest - A Consumer that will call methods on DescribePatchGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describePatchProperties

default DescribePatchPropertiesResponse describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)
                                                         throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

AMAZON_LINUX_2

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

AMAZON_LINUX_2023

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

CENTOS

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

DEBIAN

Valid properties: PRODUCT | PRIORITY

MACOS

Valid properties: PRODUCT | CLASSIFICATION

ORACLE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

REDHAT_ENTERPRISE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

SUSE

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

UBUNTU

Valid properties: PRODUCT | PRIORITY

WINDOWS

Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY

Parameters:

describePatchPropertiesRequest -

Returns:

Result of the DescribePatchProperties operation returned by the service.

See Also:

• AWS API Documentation

describePatchProperties

default DescribePatchPropertiesResponse describePatchProperties(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
                                                         throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

AMAZON_LINUX_2

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

AMAZON_LINUX_2023

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

CENTOS

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

DEBIAN

Valid properties: PRODUCT | PRIORITY

MACOS

Valid properties: PRODUCT | CLASSIFICATION

ORACLE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

REDHAT_ENTERPRISE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

SUSE

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

UBUNTU

Valid properties: PRODUCT | PRIORITY

WINDOWS

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()

Parameters:

describePatchPropertiesRequest - A Consumer that will call methods on DescribePatchPropertiesRequest.Builder to create a request.

Returns:

Result of the DescribePatchProperties operation returned by the service.

See Also:

• AWS API Documentation

describePatchPropertiesPaginator

default DescribePatchPropertiesIterable describePatchPropertiesPaginator(DescribePatchPropertiesRequest describePatchPropertiesRequest)
                                                                  throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client
             .describePatchPropertiesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describePatchPropertiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describePatchPropertiesPaginator

default DescribePatchPropertiesIterable describePatchPropertiesPaginator(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
                                                                  throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client
             .describePatchPropertiesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describePatchPropertiesRequest - A Consumer that will call methods on DescribePatchPropertiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeSessions

default DescribeSessionsResponse describeSessions(DescribeSessionsRequest describeSessionsRequest)
                                           throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Parameters:

describeSessionsRequest -

Returns:

Result of the DescribeSessions operation returned by the service.

See Also:

• AWS API Documentation

describeSessions

default DescribeSessionsResponse describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
                                           throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

describeSessionsRequest - A Consumer that will call methods on DescribeSessionsRequest.Builder to create a request.

Returns:

Result of the DescribeSessions operation returned by the service.

See Also:

• AWS API Documentation

describeSessionsPaginator

default DescribeSessionsIterable describeSessionsPaginator(DescribeSessionsRequest describeSessionsRequest)
                                                    throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

describeSessionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeSessionsPaginator

default DescribeSessionsIterable describeSessionsPaginator(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
                                                    throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

describeSessionsRequest - A Consumer that will call methods on DescribeSessionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

disassociateOpsItemRelatedItem

default DisassociateOpsItemRelatedItemResponse disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest)
                                                                       throws InternalServerErrorException,
OpsItemRelatedItemAssociationNotFoundException,
OpsItemNotFoundException,
OpsItemInvalidParameterException,
OpsItemConflictException,
AwsServiceException,
SdkClientException,
SsmException

Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.

Parameters:

disassociateOpsItemRelatedItemRequest -

Returns:

Result of the DisassociateOpsItemRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

disassociateOpsItemRelatedItem

default DisassociateOpsItemRelatedItemResponse disassociateOpsItemRelatedItem(Consumer<DisassociateOpsItemRelatedItemRequest.Builder> disassociateOpsItemRelatedItemRequest)
                                                                       throws InternalServerErrorException,
OpsItemRelatedItemAssociationNotFoundException,
OpsItemNotFoundException,
OpsItemInvalidParameterException,
OpsItemConflictException,
AwsServiceException,
SdkClientException,
SsmException

Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.

This is a convenience which creates an instance of the DisassociateOpsItemRelatedItemRequest.Builder avoiding the need to create one manually via DisassociateOpsItemRelatedItemRequest.builder()

Parameters:

disassociateOpsItemRelatedItemRequest - A Consumer that will call methods on DisassociateOpsItemRelatedItemRequest.Builder to create a request.

Returns:

Result of the DisassociateOpsItemRelatedItem operation returned by the service.

See Also:

• AWS API Documentation

getAccessToken

default GetAccessTokenResponse getAccessToken(GetAccessTokenRequest getAccessTokenRequest)
                                       throws InternalServerErrorException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmException

Returns a credentials set to be used with just-in-time node access.

Parameters:

getAccessTokenRequest -

Returns:

Result of the GetAccessToken operation returned by the service.

See Also:

• AWS API Documentation

getAccessToken

default GetAccessTokenResponse getAccessToken(Consumer<GetAccessTokenRequest.Builder> getAccessTokenRequest)
                                       throws InternalServerErrorException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmException

Returns a credentials set to be used with just-in-time node access.

This is a convenience which creates an instance of the GetAccessTokenRequest.Builder avoiding the need to create one manually via GetAccessTokenRequest.builder()

Parameters:

getAccessTokenRequest - A Consumer that will call methods on GetAccessTokenRequest.Builder to create a request.

Returns:

Result of the GetAccessToken operation returned by the service.

See Also:

• AWS API Documentation

getAutomationExecution

default GetAutomationExecutionResponse getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
                                                       throws AutomationExecutionNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Get detailed information about a particular Automation execution.

Parameters:

getAutomationExecutionRequest -

Returns:

Result of the GetAutomationExecution operation returned by the service.

See Also:

• AWS API Documentation

getAutomationExecution

default GetAutomationExecutionResponse getAutomationExecution(Consumer<GetAutomationExecutionRequest.Builder> getAutomationExecutionRequest)
                                                       throws AutomationExecutionNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getAutomationExecutionRequest - A Consumer that will call methods on GetAutomationExecutionRequest.Builder to create a request.

Returns:

Result of the GetAutomationExecution operation returned by the service.

See Also:

• AWS API Documentation

getCalendarState

default GetCalendarStateResponse getCalendarState(GetCalendarStateRequest getCalendarStateRequest)
                                           throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentTypeException,
UnsupportedCalendarException,
AwsServiceException,
SdkClientException,
SsmException

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a tool in Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Parameters:

getCalendarStateRequest -

Returns:

Result of the GetCalendarState operation returned by the service.

See Also:

• AWS API Documentation

getCalendarState

default GetCalendarStateResponse getCalendarState(Consumer<GetCalendarStateRequest.Builder> getCalendarStateRequest)
                                           throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentTypeException,
UnsupportedCalendarException,
AwsServiceException,
SdkClientException,
SsmException

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a tool in Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services 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()

Parameters:

getCalendarStateRequest - A Consumer that will call methods on GetCalendarStateRequest.Builder to create a request.

Returns:

Result of the GetCalendarState operation returned by the service.

See Also:

• AWS API Documentation

getCommandInvocation

default GetCommandInvocationResponse getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
                                                   throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidPluginNameException,
InvocationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

Parameters:

getCommandInvocationRequest -

Returns:

Result of the GetCommandInvocation operation returned by the service.

See Also:

• AWS API Documentation

getCommandInvocation

default GetCommandInvocationResponse getCommandInvocation(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest)
                                                   throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidPluginNameException,
InvocationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

This is a convenience which creates an instance of the GetCommandInvocationRequest.Builder avoiding the need to create one manually via GetCommandInvocationRequest.builder()

Parameters:

getCommandInvocationRequest - A Consumer that will call methods on GetCommandInvocationRequest.Builder to create a request.

Returns:

Result of the GetCommandInvocation operation returned by the service.

See Also:

• AWS API Documentation

getConnectionStatus

default GetConnectionStatusResponse getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)
                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

Parameters:

getConnectionStatusRequest -

Returns:

Result of the GetConnectionStatus operation returned by the service.

See Also:

• AWS API Documentation

getConnectionStatus

default GetConnectionStatusResponse getConnectionStatus(Consumer<GetConnectionStatusRequest.Builder> getConnectionStatusRequest)
                                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the Session Manager connection status for a managed node 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()

Parameters:

getConnectionStatusRequest - A Consumer that will call methods on GetConnectionStatusRequest.Builder to create a request.

Returns:

Result of the GetConnectionStatus operation returned by the service.

See Also:

• AWS API Documentation

getDefaultPatchBaseline

default GetDefaultPatchBaselineResponse getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
                                                         throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you don't specify an operating system value, the default patch baseline for Windows is returned.

Parameters:

getDefaultPatchBaselineRequest -

Returns:

Result of the GetDefaultPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

getDefaultPatchBaseline

default GetDefaultPatchBaselineResponse getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest)
                                                         throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you don't specify an operating system value, the default patch baseline for Windows is returned.

This is a convenience which creates an instance of the GetDefaultPatchBaselineRequest.Builder avoiding the need to create one manually via GetDefaultPatchBaselineRequest.builder()

Parameters:

getDefaultPatchBaselineRequest - A Consumer that will call methods on GetDefaultPatchBaselineRequest.Builder to create a request.

Returns:

Result of the GetDefaultPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

getDefaultPatchBaseline

default GetDefaultPatchBaselineResponse getDefaultPatchBaseline()
                                                         throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you don't specify an operating system value, the default patch baseline for Windows is returned.

Returns:

Result of the GetDefaultPatchBaseline operation returned by the service.

See Also:

• getDefaultPatchBaseline(GetDefaultPatchBaselineRequest)
• AWS API Documentation

getDeployablePatchSnapshotForInstance

default GetDeployablePatchSnapshotForInstanceResponse getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
                                                                                     throws InternalServerErrorException,
UnsupportedOperatingSystemException,
UnsupportedFeatureRequiredException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a tool in Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.

Parameters:

getDeployablePatchSnapshotForInstanceRequest -

Returns:

Result of the GetDeployablePatchSnapshotForInstance operation returned by the service.

See Also:

• AWS API Documentation

getDeployablePatchSnapshotForInstance

default GetDeployablePatchSnapshotForInstanceResponse getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest)
                                                                                     throws InternalServerErrorException,
UnsupportedOperatingSystemException,
UnsupportedFeatureRequiredException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a tool in Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.

This is a convenience which creates an instance of the GetDeployablePatchSnapshotForInstanceRequest.Builder avoiding the need to create one manually via GetDeployablePatchSnapshotForInstanceRequest.builder()

Parameters:

getDeployablePatchSnapshotForInstanceRequest - A Consumer that will call methods on GetDeployablePatchSnapshotForInstanceRequest.Builder to create a request.

Returns:

Result of the GetDeployablePatchSnapshotForInstance operation returned by the service.

See Also:

• AWS API Documentation

getDocument

default GetDocumentResponse getDocument(GetDocumentRequest getDocumentRequest)
                                 throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
AwsServiceException,
SdkClientException,
SsmException

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

Parameters:

getDocumentRequest -

Returns:

Result of the GetDocument operation returned by the service.

See Also:

• AWS API Documentation

getDocument

default GetDocumentResponse getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
                                 throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
AwsServiceException,
SdkClientException,
SsmException

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

This is a convenience which creates an instance of the GetDocumentRequest.Builder avoiding the need to create one manually via GetDocumentRequest.builder()

Parameters:

getDocumentRequest - A Consumer that will call methods on GetDocumentRequest.Builder to create a request.

Returns:

Result of the GetDocument operation returned by the service.

See Also:

• AWS API Documentation

getExecutionPreview

default GetExecutionPreviewResponse getExecutionPreview(GetExecutionPreviewRequest getExecutionPreviewRequest)
                                                 throws InternalServerErrorException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

Parameters:

getExecutionPreviewRequest -

Returns:

Result of the GetExecutionPreview operation returned by the service.

See Also:

• AWS API Documentation

getExecutionPreview

default GetExecutionPreviewResponse getExecutionPreview(Consumer<GetExecutionPreviewRequest.Builder> getExecutionPreviewRequest)
                                                 throws InternalServerErrorException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

This is a convenience which creates an instance of the GetExecutionPreviewRequest.Builder avoiding the need to create one manually via GetExecutionPreviewRequest.builder()

Parameters:

getExecutionPreviewRequest - A Consumer that will call methods on GetExecutionPreviewRequest.Builder to create a request.

Returns:

Result of the GetExecutionPreview operation returned by the service.

See Also:

• AWS API Documentation

getInventory

default GetInventoryResponse getInventory(GetInventoryRequest getInventoryRequest)
                                   throws InternalServerErrorException,
InvalidFilterException,
InvalidInventoryGroupException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
InvalidResultAttributeException,
AwsServiceException,
SdkClientException,
SsmException

Query inventory information. This includes managed node status, such as Stopped or Terminated.

Parameters:

getInventoryRequest -

Returns:

Result of the GetInventory operation returned by the service.

See Also:

• AWS API Documentation

getInventory

default GetInventoryResponse getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
                                   throws InternalServerErrorException,
InvalidFilterException,
InvalidInventoryGroupException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
InvalidResultAttributeException,
AwsServiceException,
SdkClientException,
SsmException

Query inventory information. This includes managed node status, such as Stopped or Terminated.

This is a convenience which creates an instance of the GetInventoryRequest.Builder avoiding the need to create one manually via GetInventoryRequest.builder()

Parameters:

getInventoryRequest - A Consumer that will call methods on GetInventoryRequest.Builder to create a request.

Returns:

Result of the GetInventory operation returned by the service.

See Also:

• AWS API Documentation

getInventory

default GetInventoryResponse getInventory()
                                   throws InternalServerErrorException,
InvalidFilterException,
InvalidInventoryGroupException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
InvalidResultAttributeException,
AwsServiceException,
SdkClientException,
SsmException

Query inventory information. This includes managed node status, such as Stopped or Terminated.

Returns:

Result of the GetInventory operation returned by the service.

See Also:

• getInventory(GetInventoryRequest)
• AWS API Documentation

getInventoryPaginator

default GetInventoryIterable getInventoryPaginator()
                                            throws InternalServerErrorException,
InvalidFilterException,
InvalidInventoryGroupException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
InvalidResultAttributeException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetInventoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getInventoryPaginator(GetInventoryRequest)
• AWS API Documentation

getInventoryPaginator

default GetInventoryIterable getInventoryPaginator(GetInventoryRequest getInventoryRequest)
                                            throws InternalServerErrorException,
InvalidFilterException,
InvalidInventoryGroupException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
InvalidResultAttributeException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetInventoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

getInventoryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getInventoryPaginator

default GetInventoryIterable getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
                                            throws InternalServerErrorException,
InvalidFilterException,
InvalidInventoryGroupException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
InvalidResultAttributeException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetInventoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

getInventoryRequest - A Consumer that will call methods on GetInventoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getInventorySchema

default GetInventorySchemaResponse getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest)
                                               throws InternalServerErrorException,
InvalidTypeNameException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Parameters:

getInventorySchemaRequest -

Returns:

Result of the GetInventorySchema operation returned by the service.

See Also:

• AWS API Documentation

getInventorySchema

default GetInventorySchemaResponse getInventorySchema(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest)
                                               throws InternalServerErrorException,
InvalidTypeNameException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getInventorySchemaRequest - A Consumer that will call methods on GetInventorySchemaRequest.Builder to create a request.

Returns:

Result of the GetInventorySchema operation returned by the service.

See Also:

• AWS API Documentation

getInventorySchema

default GetInventorySchemaResponse getInventorySchema()
                                               throws InternalServerErrorException,
InvalidTypeNameException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Returns:

Result of the GetInventorySchema operation returned by the service.

See Also:

• getInventorySchema(GetInventorySchemaRequest)
• AWS API Documentation

getInventorySchemaPaginator

default GetInventorySchemaIterable getInventorySchemaPaginator()
                                                        throws InternalServerErrorException,
InvalidTypeNameException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client
             .getInventorySchemaPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getInventorySchemaPaginator(GetInventorySchemaRequest)
• AWS API Documentation

getInventorySchemaPaginator

default GetInventorySchemaIterable getInventorySchemaPaginator(GetInventorySchemaRequest getInventorySchemaRequest)
                                                        throws InternalServerErrorException,
InvalidTypeNameException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client
             .getInventorySchemaPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

getInventorySchemaRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getInventorySchemaPaginator

default GetInventorySchemaIterable getInventorySchemaPaginator(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest)
                                                        throws InternalServerErrorException,
InvalidTypeNameException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client
             .getInventorySchemaPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

getInventorySchemaRequest - A Consumer that will call methods on GetInventorySchemaRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getMaintenanceWindow

default GetMaintenanceWindowResponse getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
                                                   throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves a maintenance window.

Parameters:

getMaintenanceWindowRequest -

Returns:

Result of the GetMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindow

default GetMaintenanceWindowResponse getMaintenanceWindow(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest)
                                                   throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getMaintenanceWindowRequest - A Consumer that will call methods on GetMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the GetMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowExecution

default GetMaintenanceWindowExecutionResponse getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
                                                                     throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves details about a specific a maintenance window execution.

Parameters:

getMaintenanceWindowExecutionRequest -

Returns:

Result of the GetMaintenanceWindowExecution operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowExecution

default GetMaintenanceWindowExecutionResponse getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest)
                                                                     throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getMaintenanceWindowExecutionRequest - A Consumer that will call methods on GetMaintenanceWindowExecutionRequest.Builder to create a request.

Returns:

Result of the GetMaintenanceWindowExecution operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowExecutionTask

default GetMaintenanceWindowExecutionTaskResponse getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
                                                                             throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the details about a specific task run as part of a maintenance window execution.

Parameters:

getMaintenanceWindowExecutionTaskRequest -

Returns:

Result of the GetMaintenanceWindowExecutionTask operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowExecutionTask

default GetMaintenanceWindowExecutionTaskResponse getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)
                                                                             throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getMaintenanceWindowExecutionTaskRequest - A Consumer that will call methods on GetMaintenanceWindowExecutionTaskRequest.Builder to create a request.

Returns:

Result of the GetMaintenanceWindowExecutionTask operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowExecutionTaskInvocation

default GetMaintenanceWindowExecutionTaskInvocationResponse getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
                                                                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves information about a specific task running on a specific target.

Parameters:

getMaintenanceWindowExecutionTaskInvocationRequest -

Returns:

Result of the GetMaintenanceWindowExecutionTaskInvocation operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowExecutionTaskInvocation

default GetMaintenanceWindowExecutionTaskInvocationResponse getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)
                                                                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getMaintenanceWindowExecutionTaskInvocationRequest - A Consumer that will call methods on GetMaintenanceWindowExecutionTaskInvocationRequest.Builder to create a request.

Returns:

Result of the GetMaintenanceWindowExecutionTaskInvocation operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowTask

default GetMaintenanceWindowTaskResponse getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
                                                           throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the details of a maintenance window task.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

Parameters:

getMaintenanceWindowTaskRequest -

Returns:

Result of the GetMaintenanceWindowTask operation returned by the service.

See Also:

• AWS API Documentation

getMaintenanceWindowTask

default GetMaintenanceWindowTaskResponse getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest)
                                                           throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the details of a maintenance window task.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

This is a convenience which creates an instance of the GetMaintenanceWindowTaskRequest.Builder avoiding the need to create one manually via GetMaintenanceWindowTaskRequest.builder()

Parameters:

getMaintenanceWindowTaskRequest - A Consumer that will call methods on GetMaintenanceWindowTaskRequest.Builder to create a request.

Returns:

Result of the GetMaintenanceWindowTask operation returned by the service.

See Also:

• AWS API Documentation

getOpsItem

default GetOpsItemResponse getOpsItem(GetOpsItemRequest getOpsItemRequest)
                               throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemAccessDeniedException,
AwsServiceException,
SdkClientException,
SsmException

Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Parameters:

getOpsItemRequest -

Returns:

Result of the GetOpsItem operation returned by the service.

See Also:

• AWS API Documentation

getOpsItem

default GetOpsItemResponse getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest)
                               throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemAccessDeniedException,
AwsServiceException,
SdkClientException,
SsmException

Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

This is a convenience which creates an instance of the GetOpsItemRequest.Builder avoiding the need to create one manually via GetOpsItemRequest.builder()

Parameters:

getOpsItemRequest - A Consumer that will call methods on GetOpsItemRequest.Builder to create a request.

Returns:

Result of the GetOpsItem operation returned by the service.

See Also:

• AWS API Documentation

getOpsMetadata

default GetOpsMetadataResponse getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)
                                       throws OpsMetadataNotFoundException,
OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

View operational metadata related to an application in Application Manager.

Parameters:

getOpsMetadataRequest -

Returns:

Result of the GetOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

getOpsMetadata

default GetOpsMetadataResponse getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest)
                                       throws OpsMetadataNotFoundException,
OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getOpsMetadataRequest - A Consumer that will call methods on GetOpsMetadataRequest.Builder to create a request.

Returns:

Result of the GetOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

getOpsSummary

default GetOpsSummaryResponse getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
                                     throws InternalServerErrorException,
ResourceDataSyncNotFoundException,
InvalidFilterException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
AwsServiceException,
SdkClientException,
SsmException

View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

Parameters:

getOpsSummaryRequest -

Returns:

Result of the GetOpsSummary operation returned by the service.

See Also:

• AWS API Documentation

getOpsSummary

default GetOpsSummaryResponse getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
                                     throws InternalServerErrorException,
ResourceDataSyncNotFoundException,
InvalidFilterException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
AwsServiceException,
SdkClientException,
SsmException

View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

This is a convenience which creates an instance of the GetOpsSummaryRequest.Builder avoiding the need to create one manually via GetOpsSummaryRequest.builder()

Parameters:

getOpsSummaryRequest - A Consumer that will call methods on GetOpsSummaryRequest.Builder to create a request.

Returns:

Result of the GetOpsSummary operation returned by the service.

See Also:

• AWS API Documentation

getOpsSummaryPaginator

default GetOpsSummaryIterable getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest)
                                              throws InternalServerErrorException,
ResourceDataSyncNotFoundException,
InvalidFilterException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

getOpsSummaryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getOpsSummaryPaginator

default GetOpsSummaryIterable getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
                                              throws InternalServerErrorException,
ResourceDataSyncNotFoundException,
InvalidFilterException,
InvalidNextTokenException,
InvalidTypeNameException,
InvalidAggregatorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

getOpsSummaryRequest - A Consumer that will call methods on GetOpsSummaryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getParameter

default GetParameterResponse getParameter(GetParameterRequest getParameterRequest)
                                   throws InternalServerErrorException,
InvalidKeyIdException,
ParameterNotFoundException,
ParameterVersionNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Get information about a single parameter by specifying the parameter name.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

To get information about more than one parameter at a time, use the GetParameters operation.

Parameters:

getParameterRequest -

Returns:

Result of the GetParameter operation returned by the service.

See Also:

• AWS API Documentation

getParameter

default GetParameterResponse getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)
                                   throws InternalServerErrorException,
InvalidKeyIdException,
ParameterNotFoundException,
ParameterVersionNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Get information about a single parameter by specifying the parameter name.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

To get information about more than one parameter at a time, use the GetParameters operation.

This is a convenience which creates an instance of the GetParameterRequest.Builder avoiding the need to create one manually via GetParameterRequest.builder()

Parameters:

getParameterRequest - A Consumer that will call methods on GetParameterRequest.Builder to create a request.

Returns:

Result of the GetParameter operation returned by the service.

See Also:

• AWS API Documentation

getParameterHistory

default GetParameterHistoryResponse getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
                                                 throws InternalServerErrorException,
ParameterNotFoundException,
InvalidNextTokenException,
InvalidKeyIdException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the history of all changes to a parameter.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing.

Parameters:

getParameterHistoryRequest -

Returns:

Result of the GetParameterHistory operation returned by the service.

See Also:

• AWS API Documentation

getParameterHistory

default GetParameterHistoryResponse getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
                                                 throws InternalServerErrorException,
ParameterNotFoundException,
InvalidNextTokenException,
InvalidKeyIdException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the history of all changes to a parameter.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing.

This is a convenience which creates an instance of the GetParameterHistoryRequest.Builder avoiding the need to create one manually via GetParameterHistoryRequest.builder()

Parameters:

getParameterHistoryRequest - A Consumer that will call methods on GetParameterHistoryRequest.Builder to create a request.

Returns:

Result of the GetParameterHistory operation returned by the service.

See Also:

• AWS API Documentation

getParameterHistoryPaginator

default GetParameterHistoryIterable getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
                                                          throws InternalServerErrorException,
ParameterNotFoundException,
InvalidNextTokenException,
InvalidKeyIdException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client
             .getParameterHistoryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

getParameterHistoryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getParameterHistoryPaginator

default GetParameterHistoryIterable getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
                                                          throws InternalServerErrorException,
ParameterNotFoundException,
InvalidNextTokenException,
InvalidKeyIdException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client
             .getParameterHistoryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

getParameterHistoryRequest - A Consumer that will call methods on GetParameterHistoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getParameters

default GetParametersResponse getParameters(GetParametersRequest getParametersRequest)
                                     throws InvalidKeyIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Get information about one or more parameters by specifying multiple parameter names.

To get information about a single parameter, you can use the GetParameter operation instead.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

Parameters:

getParametersRequest -

Returns:

Result of the GetParameters operation returned by the service.

See Also:

• AWS API Documentation

getParameters

default GetParametersResponse getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)
                                     throws InvalidKeyIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Get information about one or more parameters by specifying multiple parameter names.

To get information about a single parameter, you can use the GetParameter operation instead.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

This is a convenience which creates an instance of the GetParametersRequest.Builder avoiding the need to create one manually via GetParametersRequest.builder()

Parameters:

getParametersRequest - A Consumer that will call methods on GetParametersRequest.Builder to create a request.

Returns:

Result of the GetParameters operation returned by the service.

See Also:

• AWS API Documentation

getParametersByPath

default GetParametersByPathResponse getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
                                                 throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidKeyIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieve information about one or more parameters under a specified level in a 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.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

Parameters:

getParametersByPathRequest -

Returns:

Result of the GetParametersByPath operation returned by the service.

See Also:

• AWS API Documentation

getParametersByPath

default GetParametersByPathResponse getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
                                                 throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidKeyIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Retrieve information about one or more parameters under a specified level in a 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.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

This is a convenience which creates an instance of the GetParametersByPathRequest.Builder avoiding the need to create one manually via GetParametersByPathRequest.builder()

Parameters:

getParametersByPathRequest - A Consumer that will call methods on GetParametersByPathRequest.Builder to create a request.

Returns:

Result of the GetParametersByPath operation returned by the service.

See Also:

• AWS API Documentation

getParametersByPathPaginator

default GetParametersByPathIterable getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)
                                                          throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidKeyIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client
             .getParametersByPathPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

getParametersByPathRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getParametersByPathPaginator

default GetParametersByPathIterable getParametersByPathPaginator(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
                                                          throws InternalServerErrorException,
InvalidFilterKeyException,
InvalidFilterOptionException,
InvalidFilterValueException,
InvalidKeyIdException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client
             .getParametersByPathPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

getParametersByPathRequest - A Consumer that will call methods on GetParametersByPathRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getPatchBaseline

default GetPatchBaselineResponse getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
                                           throws DoesNotExistException,
InvalidResourceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves information about a patch baseline.

Parameters:

getPatchBaselineRequest -

Returns:

Result of the GetPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

getPatchBaseline

default GetPatchBaselineResponse getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest)
                                           throws DoesNotExistException,
InvalidResourceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getPatchBaselineRequest - A Consumer that will call methods on GetPatchBaselineRequest.Builder to create a request.

Returns:

Result of the GetPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

getPatchBaselineForPatchGroup

default GetPatchBaselineForPatchGroupResponse getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
                                                                     throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves the patch baseline that should be used for the specified patch group.

Parameters:

getPatchBaselineForPatchGroupRequest -

Returns:

Result of the GetPatchBaselineForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

getPatchBaselineForPatchGroup

default GetPatchBaselineForPatchGroupResponse getPatchBaselineForPatchGroup(Consumer<GetPatchBaselineForPatchGroupRequest.Builder> getPatchBaselineForPatchGroupRequest)
                                                                     throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

getPatchBaselineForPatchGroupRequest - A Consumer that will call methods on GetPatchBaselineForPatchGroupRequest.Builder to create a request.

Returns:

Result of the GetPatchBaselineForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicies

default GetResourcePoliciesResponse getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
                                                 throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Returns an array of the Policy object.

Parameters:

getResourcePoliciesRequest -

Returns:

Result of the GetResourcePolicies operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicies

default GetResourcePoliciesResponse getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)
                                                 throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Returns an array of the Policy object.

This is a convenience which creates an instance of the GetResourcePoliciesRequest.Builder avoiding the need to create one manually via GetResourcePoliciesRequest.builder()

Parameters:

getResourcePoliciesRequest - A Consumer that will call methods on GetResourcePoliciesRequest.Builder to create a request.

Returns:

Result of the GetResourcePolicies operation returned by the service.

See Also:

• AWS API Documentation

getResourcePoliciesPaginator

default GetResourcePoliciesIterable getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest)
                                                          throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client
             .getResourcePoliciesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation.

Parameters:

getResourcePoliciesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getResourcePoliciesPaginator

default GetResourcePoliciesIterable getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)
                                                          throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client
             .getResourcePoliciesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation.

This is a convenience which creates an instance of the GetResourcePoliciesRequest.Builder avoiding the need to create one manually via GetResourcePoliciesRequest.builder()

Parameters:

getResourcePoliciesRequest - A Consumer that will call methods on GetResourcePoliciesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getServiceSetting

default GetServiceSettingResponse getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
                                             throws InternalServerErrorException,
ServiceSettingNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Query the current service setting for the Amazon Web Services account.

Parameters:

getServiceSettingRequest - The request body of the GetServiceSetting API operation.

Returns:

Result of the GetServiceSetting operation returned by the service.

See Also:

• AWS API Documentation

getServiceSetting

default GetServiceSettingResponse getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest)
                                             throws InternalServerErrorException,
ServiceSettingNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Query the current service setting for the Amazon Web Services account.

This is a convenience which creates an instance of the GetServiceSettingRequest.Builder avoiding the need to create one manually via GetServiceSettingRequest.builder()

Parameters:

getServiceSettingRequest - A Consumer that will call methods on GetServiceSettingRequest.Builder to create a request. The request body of the GetServiceSetting API operation.

Returns:

Result of the GetServiceSetting operation returned by the service.

See Also:

• AWS API Documentation

labelParameterVersion

default LabelParameterVersionResponse labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)
                                                     throws InternalServerErrorException,
TooManyUpdatesException,
ParameterNotFoundException,
ParameterVersionNotFoundException,
ParameterVersionLabelLimitExceededException,
AwsServiceException,
SdkClientException,
SsmException

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

Parameter labels have the following requirements and restrictions.

• A version of a parameter can have a maximum of 10 labels.

• You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

• You can move a label from one version of a parameter to another.

• You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

• If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.

• A label can have a maximum of 100 characters.

• Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

• Labels can't begin with a number, "aws" or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels.

• Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

Parameters:

labelParameterVersionRequest -

Returns:

Result of the LabelParameterVersion operation returned by the service.

See Also:

• AWS API Documentation

labelParameterVersion

default LabelParameterVersionResponse labelParameterVersion(Consumer<LabelParameterVersionRequest.Builder> labelParameterVersionRequest)
                                                     throws InternalServerErrorException,
TooManyUpdatesException,
ParameterNotFoundException,
ParameterVersionNotFoundException,
ParameterVersionLabelLimitExceededException,
AwsServiceException,
SdkClientException,
SsmException

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

Parameter labels have the following requirements and restrictions.

• A version of a parameter can have a maximum of 10 labels.

• You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

• You can move a label from one version of a parameter to another.

• You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

• If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.

• A label can have a maximum of 100 characters.

• Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

• Labels can't begin with a number, "aws" or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels.

• Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

This is a convenience which creates an instance of the LabelParameterVersionRequest.Builder avoiding the need to create one manually via LabelParameterVersionRequest.builder()

Parameters:

labelParameterVersionRequest - A Consumer that will call methods on LabelParameterVersionRequest.Builder to create a request.

Returns:

Result of the LabelParameterVersion operation returned by the service.

See Also:

• AWS API Documentation

listAssociationVersions

default ListAssociationVersionsResponse listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
                                                         throws InternalServerErrorException,
InvalidNextTokenException,
AssociationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Retrieves all versions of an association for a specific association ID.

Parameters:

listAssociationVersionsRequest -

Returns:

Result of the ListAssociationVersions operation returned by the service.

See Also:

• AWS API Documentation

listAssociationVersions

default ListAssociationVersionsResponse listAssociationVersions(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
                                                         throws InternalServerErrorException,
InvalidNextTokenException,
AssociationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

listAssociationVersionsRequest - A Consumer that will call methods on ListAssociationVersionsRequest.Builder to create a request.

Returns:

Result of the ListAssociationVersions operation returned by the service.

See Also:

• AWS API Documentation

listAssociationVersionsPaginator

default ListAssociationVersionsIterable listAssociationVersionsPaginator(ListAssociationVersionsRequest listAssociationVersionsRequest)
                                                                  throws InternalServerErrorException,
InvalidNextTokenException,
AssociationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client
             .listAssociationVersionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listAssociationVersionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociationVersionsPaginator

default ListAssociationVersionsIterable listAssociationVersionsPaginator(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
                                                                  throws InternalServerErrorException,
InvalidNextTokenException,
AssociationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client
             .listAssociationVersionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listAssociationVersionsRequest - A Consumer that will call methods on ListAssociationVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociations

default ListAssociationsResponse listAssociations(ListAssociationsRequest listAssociationsRequest)
                                           throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.

Parameters:

listAssociationsRequest -

Returns:

Result of the ListAssociations operation returned by the service.

See Also:

• AWS API Documentation

listAssociations

default ListAssociationsResponse listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
                                           throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.

This is a convenience which creates an instance of the ListAssociationsRequest.Builder avoiding the need to create one manually via ListAssociationsRequest.builder()

Parameters:

listAssociationsRequest - A Consumer that will call methods on ListAssociationsRequest.Builder to create a request.

Returns:

Result of the ListAssociations operation returned by the service.

See Also:

• AWS API Documentation

listAssociations

default ListAssociationsResponse listAssociations()
                                           throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.

Returns:

Result of the ListAssociations operation returned by the service.

See Also:

• listAssociations(ListAssociationsRequest)
• AWS API Documentation

listAssociationsPaginator

default ListAssociationsIterable listAssociationsPaginator()
                                                    throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listAssociationsPaginator(ListAssociationsRequest)
• AWS API Documentation

listAssociationsPaginator

default ListAssociationsIterable listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)
                                                    throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listAssociationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociationsPaginator

default ListAssociationsIterable listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
                                                    throws InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listAssociationsRequest - A Consumer that will call methods on ListAssociationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCommandInvocations

default ListCommandInvocationsResponse listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
                                                       throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

Parameters:

listCommandInvocationsRequest -

Returns:

Result of the ListCommandInvocations operation returned by the service.

See Also:

• AWS API Documentation

listCommandInvocations

default ListCommandInvocationsResponse listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
                                                       throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

This is a convenience which creates an instance of the ListCommandInvocationsRequest.Builder avoiding the need to create one manually via ListCommandInvocationsRequest.builder()

Parameters:

listCommandInvocationsRequest - A Consumer that will call methods on ListCommandInvocationsRequest.Builder to create a request.

Returns:

Result of the ListCommandInvocations operation returned by the service.

See Also:

• AWS API Documentation

listCommandInvocations

default ListCommandInvocationsResponse listCommandInvocations()
                                                       throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

Returns:

Result of the ListCommandInvocations operation returned by the service.

See Also:

• listCommandInvocations(ListCommandInvocationsRequest)
• AWS API Documentation

listCommandInvocationsPaginator

default ListCommandInvocationsIterable listCommandInvocationsPaginator()
                                                                throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client
             .listCommandInvocationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listCommandInvocationsPaginator(ListCommandInvocationsRequest)
• AWS API Documentation

listCommandInvocationsPaginator

default ListCommandInvocationsIterable listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest)
                                                                throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client
             .listCommandInvocationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listCommandInvocationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCommandInvocationsPaginator

default ListCommandInvocationsIterable listCommandInvocationsPaginator(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
                                                                throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client
             .listCommandInvocationsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listCommandInvocationsRequest - A Consumer that will call methods on ListCommandInvocationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCommands

default ListCommandsResponse listCommands(ListCommandsRequest listCommandsRequest)
                                   throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Lists the commands requested by users of the Amazon Web Services account.

Parameters:

listCommandsRequest -

Returns:

Result of the ListCommands operation returned by the service.

See Also:

• AWS API Documentation

listCommands

default ListCommandsResponse listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
                                   throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Lists the commands requested by users of the Amazon Web Services account.

This is a convenience which creates an instance of the ListCommandsRequest.Builder avoiding the need to create one manually via ListCommandsRequest.builder()

Parameters:

listCommandsRequest - A Consumer that will call methods on ListCommandsRequest.Builder to create a request.

Returns:

Result of the ListCommands operation returned by the service.

See Also:

• AWS API Documentation

listCommands

default ListCommandsResponse listCommands()
                                   throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Lists the commands requested by users of the Amazon Web Services account.

Returns:

Result of the ListCommands operation returned by the service.

See Also:

• listCommands(ListCommandsRequest)
• AWS API Documentation

listCommandsPaginator

default ListCommandsIterable listCommandsPaginator()
                                            throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListCommandsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listCommandsPaginator(ListCommandsRequest)
• AWS API Documentation

listCommandsPaginator

default ListCommandsIterable listCommandsPaginator(ListCommandsRequest listCommandsRequest)
                                            throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListCommandsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listCommandsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCommandsPaginator

default ListCommandsIterable listCommandsPaginator(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
                                            throws InternalServerErrorException,
InvalidCommandIdException,
InvalidInstanceIdException,
InvalidFilterKeyException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListCommandsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listCommandsRequest - A Consumer that will call methods on ListCommandsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listComplianceItems

default ListComplianceItemsResponse listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
                                                 throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

Parameters:

listComplianceItemsRequest -

Returns:

Result of the ListComplianceItems operation returned by the service.

See Also:

• AWS API Documentation

listComplianceItems

default ListComplianceItemsResponse listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
                                                 throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

This is a convenience which creates an instance of the ListComplianceItemsRequest.Builder avoiding the need to create one manually via ListComplianceItemsRequest.builder()

Parameters:

listComplianceItemsRequest - A Consumer that will call methods on ListComplianceItemsRequest.Builder to create a request.

Returns:

Result of the ListComplianceItems operation returned by the service.

See Also:

• AWS API Documentation

listComplianceItemsPaginator

default ListComplianceItemsIterable listComplianceItemsPaginator(ListComplianceItemsRequest listComplianceItemsRequest)
                                                          throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client
             .listComplianceItemsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listComplianceItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listComplianceItemsPaginator

default ListComplianceItemsIterable listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
                                                          throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client
             .listComplianceItemsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listComplianceItemsRequest - A Consumer that will call methods on ListComplianceItemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listComplianceSummaries

default ListComplianceSummariesResponse listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
                                                         throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

listComplianceSummariesRequest -

Returns:

Result of the ListComplianceSummaries operation returned by the service.

See Also:

• AWS API Documentation

listComplianceSummaries

default ListComplianceSummariesResponse listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
                                                         throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

listComplianceSummariesRequest - A Consumer that will call methods on ListComplianceSummariesRequest.Builder to create a request.

Returns:

Result of the ListComplianceSummaries operation returned by the service.

See Also:

• AWS API Documentation

listComplianceSummaries

default ListComplianceSummariesResponse listComplianceSummaries()
                                                         throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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.

Returns:

Result of the ListComplianceSummaries operation returned by the service.

See Also:

• listComplianceSummaries(ListComplianceSummariesRequest)
• AWS API Documentation

listComplianceSummariesPaginator

default ListComplianceSummariesIterable listComplianceSummariesPaginator()
                                                                  throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client
             .listComplianceSummariesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listComplianceSummariesPaginator(ListComplianceSummariesRequest)
• AWS API Documentation

listComplianceSummariesPaginator

default ListComplianceSummariesIterable listComplianceSummariesPaginator(ListComplianceSummariesRequest listComplianceSummariesRequest)
                                                                  throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client
             .listComplianceSummariesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listComplianceSummariesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listComplianceSummariesPaginator

default ListComplianceSummariesIterable listComplianceSummariesPaginator(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
                                                                  throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client
             .listComplianceSummariesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listComplianceSummariesRequest - A Consumer that will call methods on ListComplianceSummariesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDocumentMetadataHistory

default ListDocumentMetadataHistoryResponse listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
                                                                 throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Information about approval reviews for a version of a change template in Change Manager.

Parameters:

listDocumentMetadataHistoryRequest -

Returns:

Result of the ListDocumentMetadataHistory operation returned by the service.

See Also:

• AWS API Documentation

listDocumentMetadataHistory

default ListDocumentMetadataHistoryResponse listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest)
                                                                 throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

Information about approval reviews for a version of a change template in Change Manager.

This is a convenience which creates an instance of the ListDocumentMetadataHistoryRequest.Builder avoiding the need to create one manually via ListDocumentMetadataHistoryRequest.builder()

Parameters:

listDocumentMetadataHistoryRequest - A Consumer that will call methods on ListDocumentMetadataHistoryRequest.Builder to create a request.

Returns:

Result of the ListDocumentMetadataHistory operation returned by the service.

See Also:

• AWS API Documentation

listDocumentVersions

default ListDocumentVersionsResponse listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
                                                   throws InternalServerErrorException,
InvalidNextTokenException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

List all versions for a document.

Parameters:

listDocumentVersionsRequest -

Returns:

Result of the ListDocumentVersions operation returned by the service.

See Also:

• AWS API Documentation

listDocumentVersions

default ListDocumentVersionsResponse listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
                                                   throws InternalServerErrorException,
InvalidNextTokenException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

listDocumentVersionsRequest - A Consumer that will call methods on ListDocumentVersionsRequest.Builder to create a request.

Returns:

Result of the ListDocumentVersions operation returned by the service.

See Also:

• AWS API Documentation

listDocumentVersionsPaginator

default ListDocumentVersionsIterable listDocumentVersionsPaginator(ListDocumentVersionsRequest listDocumentVersionsRequest)
                                                            throws InternalServerErrorException,
InvalidNextTokenException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client
             .listDocumentVersionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listDocumentVersionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDocumentVersionsPaginator

default ListDocumentVersionsIterable listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
                                                            throws InternalServerErrorException,
InvalidNextTokenException,
InvalidDocumentException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client
             .listDocumentVersionsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listDocumentVersionsRequest - A Consumer that will call methods on ListDocumentVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDocuments

default ListDocumentsResponse listDocuments(ListDocumentsRequest listDocumentsRequest)
                                     throws InternalServerErrorException,
InvalidNextTokenException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

Parameters:

listDocumentsRequest -

Returns:

Result of the ListDocuments operation returned by the service.

See Also:

• AWS API Documentation

listDocuments

default ListDocumentsResponse listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
                                     throws InternalServerErrorException,
InvalidNextTokenException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

This is a convenience which creates an instance of the ListDocumentsRequest.Builder avoiding the need to create one manually via ListDocumentsRequest.builder()

Parameters:

listDocumentsRequest - A Consumer that will call methods on ListDocumentsRequest.Builder to create a request.

Returns:

Result of the ListDocuments operation returned by the service.

See Also:

• AWS API Documentation

listDocuments

default ListDocumentsResponse listDocuments()
                                     throws InternalServerErrorException,
InvalidNextTokenException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

Returns:

Result of the ListDocuments operation returned by the service.

See Also:

• listDocuments(ListDocumentsRequest)
• AWS API Documentation

listDocumentsPaginator

default ListDocumentsIterable listDocumentsPaginator()
                                              throws InternalServerErrorException,
InvalidNextTokenException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listDocumentsPaginator(ListDocumentsRequest)
• AWS API Documentation

listDocumentsPaginator

default ListDocumentsIterable listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)
                                              throws InternalServerErrorException,
InvalidNextTokenException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listDocumentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDocumentsPaginator

default ListDocumentsIterable listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
                                              throws InternalServerErrorException,
InvalidNextTokenException,
InvalidFilterKeyException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listDocumentsRequest - A Consumer that will call methods on ListDocumentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInventoryEntries

default ListInventoryEntriesResponse listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
                                                   throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidTypeNameException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

A list of inventory items returned by the request.

Parameters:

listInventoryEntriesRequest -

Returns:

Result of the ListInventoryEntries operation returned by the service.

See Also:

• AWS API Documentation

listInventoryEntries

default ListInventoryEntriesResponse listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest)
                                                   throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidTypeNameException,
InvalidFilterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

listInventoryEntriesRequest - A Consumer that will call methods on ListInventoryEntriesRequest.Builder to create a request.

Returns:

Result of the ListInventoryEntries operation returned by the service.

See Also:

• AWS API Documentation

listNodes

default ListNodesResponse listNodes(ListNodesRequest listNodesRequest)
                             throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

Takes in filters and returns a list of managed nodes matching the filter criteria.

Parameters:

listNodesRequest -

Returns:

Result of the ListNodes operation returned by the service.

See Also:

• AWS API Documentation

listNodes

default ListNodesResponse listNodes(Consumer<ListNodesRequest.Builder> listNodesRequest)
                             throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

Takes in filters and returns a list of managed nodes matching the filter criteria.

This is a convenience which creates an instance of the ListNodesRequest.Builder avoiding the need to create one manually via ListNodesRequest.builder()

Parameters:

listNodesRequest - A Consumer that will call methods on ListNodesRequest.Builder to create a request.

Returns:

Result of the ListNodes operation returned by the service.

See Also:

• AWS API Documentation

listNodesPaginator

default ListNodesIterable listNodesPaginator(ListNodesRequest listNodesRequest)
                                      throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listNodes(software.amazon.awssdk.services.ssm.model.ListNodesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListNodesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listNodes(software.amazon.awssdk.services.ssm.model.ListNodesRequest) operation.

Parameters:

listNodesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNodesPaginator

default ListNodesIterable listNodesPaginator(Consumer<ListNodesRequest.Builder> listNodesRequest)
                                      throws InternalServerErrorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listNodes(software.amazon.awssdk.services.ssm.model.ListNodesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListNodesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listNodes(software.amazon.awssdk.services.ssm.model.ListNodesRequest) operation.

This is a convenience which creates an instance of the ListNodesRequest.Builder avoiding the need to create one manually via ListNodesRequest.builder()

Parameters:

listNodesRequest - A Consumer that will call methods on ListNodesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNodesSummary

default ListNodesSummaryResponse listNodesSummary(ListNodesSummaryRequest listNodesSummaryRequest)
                                           throws InternalServerErrorException,
InvalidAggregatorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.

Parameters:

listNodesSummaryRequest -

Returns:

Result of the ListNodesSummary operation returned by the service.

See Also:

• AWS API Documentation

listNodesSummary

default ListNodesSummaryResponse listNodesSummary(Consumer<ListNodesSummaryRequest.Builder> listNodesSummaryRequest)
                                           throws InternalServerErrorException,
InvalidAggregatorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.

This is a convenience which creates an instance of the ListNodesSummaryRequest.Builder avoiding the need to create one manually via ListNodesSummaryRequest.builder()

Parameters:

listNodesSummaryRequest - A Consumer that will call methods on ListNodesSummaryRequest.Builder to create a request.

Returns:

Result of the ListNodesSummary operation returned by the service.

See Also:

• AWS API Documentation

listNodesSummaryPaginator

default ListNodesSummaryIterable listNodesSummaryPaginator(ListNodesSummaryRequest listNodesSummaryRequest)
                                                    throws InternalServerErrorException,
InvalidAggregatorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listNodesSummary(software.amazon.awssdk.services.ssm.model.ListNodesSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesSummaryIterable responses = client.listNodesSummaryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListNodesSummaryIterable responses = client.listNodesSummaryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListNodesSummaryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesSummaryIterable responses = client.listNodesSummaryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listNodesSummary(software.amazon.awssdk.services.ssm.model.ListNodesSummaryRequest) operation.

Parameters:

listNodesSummaryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNodesSummaryPaginator

default ListNodesSummaryIterable listNodesSummaryPaginator(Consumer<ListNodesSummaryRequest.Builder> listNodesSummaryRequest)
                                                    throws InternalServerErrorException,
InvalidAggregatorException,
InvalidFilterException,
InvalidNextTokenException,
ResourceDataSyncNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listNodesSummary(software.amazon.awssdk.services.ssm.model.ListNodesSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesSummaryIterable responses = client.listNodesSummaryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListNodesSummaryIterable responses = client.listNodesSummaryPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListNodesSummaryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListNodesSummaryIterable responses = client.listNodesSummaryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listNodesSummary(software.amazon.awssdk.services.ssm.model.ListNodesSummaryRequest) operation.

This is a convenience which creates an instance of the ListNodesSummaryRequest.Builder avoiding the need to create one manually via ListNodesSummaryRequest.builder()

Parameters:

listNodesSummaryRequest - A Consumer that will call methods on ListNodesSummaryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOpsItemEvents

default ListOpsItemEventsResponse listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)
                                             throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.

Parameters:

listOpsItemEventsRequest -

Returns:

Result of the ListOpsItemEvents operation returned by the service.

See Also:

• AWS API Documentation

listOpsItemEvents

default ListOpsItemEventsResponse listOpsItemEvents(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
                                             throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.

This is a convenience which creates an instance of the ListOpsItemEventsRequest.Builder avoiding the need to create one manually via ListOpsItemEventsRequest.builder()

Parameters:

listOpsItemEventsRequest - A Consumer that will call methods on ListOpsItemEventsRequest.Builder to create a request.

Returns:

Result of the ListOpsItemEvents operation returned by the service.

See Also:

• AWS API Documentation

listOpsItemEventsPaginator

default ListOpsItemEventsIterable listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest)
                                                      throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client
             .listOpsItemEventsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listOpsItemEventsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOpsItemEventsPaginator

default ListOpsItemEventsIterable listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
                                                      throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client
             .listOpsItemEventsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listOpsItemEventsRequest - A Consumer that will call methods on ListOpsItemEventsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOpsItemRelatedItems

default ListOpsItemRelatedItemsResponse listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)
                                                         throws InternalServerErrorException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.

Parameters:

listOpsItemRelatedItemsRequest -

Returns:

Result of the ListOpsItemRelatedItems operation returned by the service.

See Also:

• AWS API Documentation

listOpsItemRelatedItems

default ListOpsItemRelatedItemsResponse listOpsItemRelatedItems(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)
                                                         throws InternalServerErrorException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.

This is a convenience which creates an instance of the ListOpsItemRelatedItemsRequest.Builder avoiding the need to create one manually via ListOpsItemRelatedItemsRequest.builder()

Parameters:

listOpsItemRelatedItemsRequest - A Consumer that will call methods on ListOpsItemRelatedItemsRequest.Builder to create a request.

Returns:

Result of the ListOpsItemRelatedItems operation returned by the service.

See Also:

• AWS API Documentation

listOpsItemRelatedItemsPaginator

default ListOpsItemRelatedItemsIterable listOpsItemRelatedItemsPaginator(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)
                                                                  throws InternalServerErrorException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client
             .listOpsItemRelatedItemsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation.

Parameters:

listOpsItemRelatedItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOpsItemRelatedItemsPaginator

default ListOpsItemRelatedItemsIterable listOpsItemRelatedItemsPaginator(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)
                                                                  throws InternalServerErrorException,
OpsItemInvalidParameterException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client
             .listOpsItemRelatedItemsPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation.

This is a convenience which creates an instance of the ListOpsItemRelatedItemsRequest.Builder avoiding the need to create one manually via ListOpsItemRelatedItemsRequest.builder()

Parameters:

listOpsItemRelatedItemsRequest - A Consumer that will call methods on ListOpsItemRelatedItemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOpsMetadata

default ListOpsMetadataResponse listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)
                                         throws OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

Parameters:

listOpsMetadataRequest -

Returns:

Result of the ListOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

listOpsMetadata

default ListOpsMetadataResponse listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
                                         throws OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Amazon Web Services Systems Manager calls this API operation 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()

Parameters:

listOpsMetadataRequest - A Consumer that will call methods on ListOpsMetadataRequest.Builder to create a request.

Returns:

Result of the ListOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

listOpsMetadataPaginator

default ListOpsMetadataIterable listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest)
                                                  throws OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listOpsMetadataRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOpsMetadataPaginator

default ListOpsMetadataIterable listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
                                                  throws OpsMetadataInvalidArgumentException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listOpsMetadataRequest - A Consumer that will call methods on ListOpsMetadataRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listResourceComplianceSummaries

default ListResourceComplianceSummariesResponse listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
                                                                         throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

listResourceComplianceSummariesRequest -

Returns:

Result of the ListResourceComplianceSummaries operation returned by the service.

See Also:

• AWS API Documentation

listResourceComplianceSummaries

default ListResourceComplianceSummariesResponse listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
                                                                         throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

listResourceComplianceSummariesRequest - A Consumer that will call methods on ListResourceComplianceSummariesRequest.Builder to create a request.

Returns:

Result of the ListResourceComplianceSummaries operation returned by the service.

See Also:

• AWS API Documentation

listResourceComplianceSummaries

default ListResourceComplianceSummariesResponse listResourceComplianceSummaries()
                                                                         throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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.

Returns:

Result of the ListResourceComplianceSummaries operation returned by the service.

See Also:

• listResourceComplianceSummaries(ListResourceComplianceSummariesRequest)
• AWS API Documentation

listResourceComplianceSummariesPaginator

default ListResourceComplianceSummariesIterable listResourceComplianceSummariesPaginator()
                                                                                  throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client
             .listResourceComplianceSummariesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest)
• AWS API Documentation

listResourceComplianceSummariesPaginator

default ListResourceComplianceSummariesIterable listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
                                                                                  throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client
             .listResourceComplianceSummariesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listResourceComplianceSummariesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listResourceComplianceSummariesPaginator

default ListResourceComplianceSummariesIterable listResourceComplianceSummariesPaginator(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
                                                                                  throws InvalidFilterException,
InvalidNextTokenException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client
             .listResourceComplianceSummariesPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listResourceComplianceSummariesRequest - A Consumer that will call methods on ListResourceComplianceSummariesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listResourceDataSync

default ListResourceDataSyncResponse listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
                                                   throws ResourceDataSyncInvalidConfigurationException,
InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

listResourceDataSyncRequest -

Returns:

Result of the ListResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

listResourceDataSync

default ListResourceDataSyncResponse listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
                                                   throws ResourceDataSyncInvalidConfigurationException,
InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

listResourceDataSyncRequest - A Consumer that will call methods on ListResourceDataSyncRequest.Builder to create a request.

Returns:

Result of the ListResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

listResourceDataSync

default ListResourceDataSyncResponse listResourceDataSync()
                                                   throws ResourceDataSyncInvalidConfigurationException,
InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

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.

Returns:

Result of the ListResourceDataSync operation returned by the service.

See Also:

• listResourceDataSync(ListResourceDataSyncRequest)
• AWS API Documentation

listResourceDataSyncPaginator

default ListResourceDataSyncIterable listResourceDataSyncPaginator()
                                                            throws ResourceDataSyncInvalidConfigurationException,
InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client
             .listResourceDataSyncPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listResourceDataSyncPaginator(ListResourceDataSyncRequest)
• AWS API Documentation

listResourceDataSyncPaginator

default ListResourceDataSyncIterable listResourceDataSyncPaginator(ListResourceDataSyncRequest listResourceDataSyncRequest)
                                                            throws ResourceDataSyncInvalidConfigurationException,
InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client
             .listResourceDataSyncPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listResourceDataSyncRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listResourceDataSyncPaginator

default ListResourceDataSyncIterable listResourceDataSyncPaginator(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
                                                            throws ResourceDataSyncInvalidConfigurationException,
InternalServerErrorException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
SsmException

This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client
             .listResourceDataSyncPaginator(request);
     for (software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listResourceDataSyncRequest - A Consumer that will call methods on ListResourceDataSyncRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Returns a list of the tags assigned to the specified resource.

For information about the ID format for each supported resource type, see AddTagsToResource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Returns a list of the tags assigned to the specified resource.

For information about the ID format for each supported resource type, see AddTagsToResource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

modifyDocumentPermission

default ModifyDocumentPermissionResponse modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
                                                           throws InternalServerErrorException,
InvalidDocumentException,
InvalidPermissionTypeException,
DocumentPermissionLimitException,
DocumentLimitExceededException,
AwsServiceException,
SdkClientException,
SsmException

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Parameters:

modifyDocumentPermissionRequest -

Returns:

Result of the ModifyDocumentPermission operation returned by the service.

See Also:

• AWS API Documentation

modifyDocumentPermission

default ModifyDocumentPermissionResponse modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest)
                                                           throws InternalServerErrorException,
InvalidDocumentException,
InvalidPermissionTypeException,
DocumentPermissionLimitException,
DocumentLimitExceededException,
AwsServiceException,
SdkClientException,
SsmException

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

This is a convenience which creates an instance of the ModifyDocumentPermissionRequest.Builder avoiding the need to create one manually via ModifyDocumentPermissionRequest.builder()

Parameters:

modifyDocumentPermissionRequest - A Consumer that will call methods on ModifyDocumentPermissionRequest.Builder to create a request.

Returns:

Result of the ModifyDocumentPermission operation returned by the service.

See Also:

• AWS API Documentation

putComplianceItems

default PutComplianceItemsResponse putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
                                               throws InternalServerErrorException,
InvalidItemContentException,
TotalSizeLimitExceededException,
ItemSizeLimitExceededException,
ComplianceTypeCountLimitExceededException,
InvalidResourceTypeException,
InvalidResourceIdException,
AwsServiceException,
SdkClientException,
SsmException

Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

ComplianceType can be one of the following:

• ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

• ExecutionType: Specify patch, association, or Custom:string.

• ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.

  For State Manager associations, this represents the time when compliance status was captured by the Systems Manager service during its internal compliance aggregation workflow, not necessarily when the association was executed on the managed node. State Manager updates compliance information for all associations on an instance whenever any association executes, which may result in multiple associations showing the same execution time.

• Id: The patch, association, or custom compliance ID.

• Title: A title.

• Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

• Severity: A patch severity. For example, Critical.

• DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

• DocumentVersion: An SSM document version number. For example, 4.

• Classification: A patch classification. For example, security updates.

• PatchBaselineId: A patch baseline ID.

• PatchSeverity: A patch severity. For example, Critical.

• PatchState: A patch state. For example, InstancesWithFailedPatches.

• PatchGroup: The name of a patch group.

• InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

Parameters:

putComplianceItemsRequest -

Returns:

Result of the PutComplianceItems operation returned by the service.

See Also:

• AWS API Documentation

putComplianceItems

default PutComplianceItemsResponse putComplianceItems(Consumer<PutComplianceItemsRequest.Builder> putComplianceItemsRequest)
                                               throws InternalServerErrorException,
InvalidItemContentException,
TotalSizeLimitExceededException,
ItemSizeLimitExceededException,
ComplianceTypeCountLimitExceededException,
InvalidResourceTypeException,
InvalidResourceIdException,
AwsServiceException,
SdkClientException,
SsmException

Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

ComplianceType can be one of the following:

• ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

• ExecutionType: Specify patch, association, or Custom:string.

• ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.

  For State Manager associations, this represents the time when compliance status was captured by the Systems Manager service during its internal compliance aggregation workflow, not necessarily when the association was executed on the managed node. State Manager updates compliance information for all associations on an instance whenever any association executes, which may result in multiple associations showing the same execution time.

• Id: The patch, association, or custom compliance ID.

• Title: A title.

• Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

• Severity: A patch severity. For example, Critical.

• DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

• DocumentVersion: An SSM document version number. For example, 4.

• Classification: A patch classification. For example, security updates.

• PatchBaselineId: A patch baseline ID.

• PatchSeverity: A patch severity. For example, Critical.

• PatchState: A patch state. For example, InstancesWithFailedPatches.

• PatchGroup: The name of a patch group.

• InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

This is a convenience which creates an instance of the PutComplianceItemsRequest.Builder avoiding the need to create one manually via PutComplianceItemsRequest.builder()

Parameters:

putComplianceItemsRequest - A Consumer that will call methods on PutComplianceItemsRequest.Builder to create a request.

Returns:

Result of the PutComplianceItems operation returned by the service.

See Also:

• AWS API Documentation

putInventory

default PutInventoryResponse putInventory(PutInventoryRequest putInventoryRequest)
                                   throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidTypeNameException,
InvalidItemContentException,
TotalSizeLimitExceededException,
ItemSizeLimitExceededException,
ItemContentMismatchException,
CustomSchemaCountLimitExceededException,
UnsupportedInventorySchemaVersionException,
UnsupportedInventoryItemContextException,
InvalidInventoryItemContextException,
SubTypeCountLimitExceededException,
AwsServiceException,
SdkClientException,
SsmException

Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

Parameters:

putInventoryRequest -

Returns:

Result of the PutInventory operation returned by the service.

See Also:

• AWS API Documentation

putInventory

default PutInventoryResponse putInventory(Consumer<PutInventoryRequest.Builder> putInventoryRequest)
                                   throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidTypeNameException,
InvalidItemContentException,
TotalSizeLimitExceededException,
ItemSizeLimitExceededException,
ItemContentMismatchException,
CustomSchemaCountLimitExceededException,
UnsupportedInventorySchemaVersionException,
UnsupportedInventoryItemContextException,
InvalidInventoryItemContextException,
SubTypeCountLimitExceededException,
AwsServiceException,
SdkClientException,
SsmException

Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

This is a convenience which creates an instance of the PutInventoryRequest.Builder avoiding the need to create one manually via PutInventoryRequest.builder()

Parameters:

putInventoryRequest - A Consumer that will call methods on PutInventoryRequest.Builder to create a request.

Returns:

Result of the PutInventory operation returned by the service.

See Also:

• AWS API Documentation

putParameter

default PutParameterResponse putParameter(PutParameterRequest putParameterRequest)
                                   throws InternalServerErrorException,
InvalidKeyIdException,
ParameterLimitExceededException,
TooManyUpdatesException,
ParameterAlreadyExistsException,
HierarchyLevelLimitExceededException,
HierarchyTypeMismatchException,
InvalidAllowedPatternException,
ParameterMaxVersionLimitExceededException,
ParameterPatternMismatchException,
UnsupportedParameterTypeException,
PoliciesLimitExceededException,
InvalidPolicyTypeException,
InvalidPolicyAttributeException,
IncompatiblePolicyException,
AwsServiceException,
SdkClientException,
SsmException

Create or update a parameter in Parameter Store.

Parameters:

putParameterRequest -

Returns:

Result of the PutParameter operation returned by the service.

See Also:

• AWS API Documentation

putParameter

default PutParameterResponse putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest)
                                   throws InternalServerErrorException,
InvalidKeyIdException,
ParameterLimitExceededException,
TooManyUpdatesException,
ParameterAlreadyExistsException,
HierarchyLevelLimitExceededException,
HierarchyTypeMismatchException,
InvalidAllowedPatternException,
ParameterMaxVersionLimitExceededException,
ParameterPatternMismatchException,
UnsupportedParameterTypeException,
PoliciesLimitExceededException,
InvalidPolicyTypeException,
InvalidPolicyAttributeException,
IncompatiblePolicyException,
AwsServiceException,
SdkClientException,
SsmException

Create or update a parameter in Parameter Store.

This is a convenience which creates an instance of the PutParameterRequest.Builder avoiding the need to create one manually via PutParameterRequest.builder()

Parameters:

putParameterRequest - A Consumer that will call methods on PutParameterRequest.Builder to create a request.

Returns:

Result of the PutParameter operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
                                             throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourcePolicyLimitExceededException,
ResourcePolicyConflictException,
ResourceNotFoundException,
MalformedResourcePolicyDocumentException,
ResourcePolicyNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

• OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

• Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).

  To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.

  To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.

  While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option.

  For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide

Parameters:

putResourcePolicyRequest -

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
                                             throws InternalServerErrorException,
ResourcePolicyInvalidParameterException,
ResourcePolicyLimitExceededException,
ResourcePolicyConflictException,
ResourceNotFoundException,
MalformedResourcePolicyDocumentException,
ResourcePolicyNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

• OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

• Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).

  To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.

  To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.

  While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option.

  For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide

This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

Parameters:

putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

registerDefaultPatchBaseline

default RegisterDefaultPatchBaselineResponse registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
                                                                   throws InvalidResourceIdException,
DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Defines the default patch baseline for the relevant operating system.

To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

Parameters:

registerDefaultPatchBaselineRequest -

Returns:

Result of the RegisterDefaultPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

registerDefaultPatchBaseline

default RegisterDefaultPatchBaselineResponse registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)
                                                                   throws InvalidResourceIdException,
DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Defines the default patch baseline for the relevant operating system.

To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

This is a convenience which creates an instance of the RegisterDefaultPatchBaselineRequest.Builder avoiding the need to create one manually via RegisterDefaultPatchBaselineRequest.builder()

Parameters:

registerDefaultPatchBaselineRequest - A Consumer that will call methods on RegisterDefaultPatchBaselineRequest.Builder to create a request.

Returns:

Result of the RegisterDefaultPatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

registerPatchBaselineForPatchGroup

default RegisterPatchBaselineForPatchGroupResponse registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
                                                                               throws AlreadyExistsException,
DoesNotExistException,
InvalidResourceIdException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Registers a patch baseline for a patch group.

Parameters:

registerPatchBaselineForPatchGroupRequest -

Returns:

Result of the RegisterPatchBaselineForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

registerPatchBaselineForPatchGroup

default RegisterPatchBaselineForPatchGroupResponse registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest)
                                                                               throws AlreadyExistsException,
DoesNotExistException,
InvalidResourceIdException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

registerPatchBaselineForPatchGroupRequest - A Consumer that will call methods on RegisterPatchBaselineForPatchGroupRequest.Builder to create a request.

Returns:

Result of the RegisterPatchBaselineForPatchGroup operation returned by the service.

See Also:

• AWS API Documentation

registerTargetWithMaintenanceWindow

default RegisterTargetWithMaintenanceWindowResponse registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
                                                                                 throws IdempotentParameterMismatchException,
DoesNotExistException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Registers a target with a maintenance window.

Parameters:

registerTargetWithMaintenanceWindowRequest -

Returns:

Result of the RegisterTargetWithMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

registerTargetWithMaintenanceWindow

default RegisterTargetWithMaintenanceWindowResponse registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest)
                                                                                 throws IdempotentParameterMismatchException,
DoesNotExistException,
ResourceLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

registerTargetWithMaintenanceWindowRequest - A Consumer that will call methods on RegisterTargetWithMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the RegisterTargetWithMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

registerTaskWithMaintenanceWindow

default RegisterTaskWithMaintenanceWindowResponse registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
                                                                             throws IdempotentParameterMismatchException,
DoesNotExistException,
ResourceLimitExceededException,
FeatureNotAvailableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Adds a new task to a maintenance window.

Parameters:

registerTaskWithMaintenanceWindowRequest -

Returns:

Result of the RegisterTaskWithMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

registerTaskWithMaintenanceWindow

default RegisterTaskWithMaintenanceWindowResponse registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest)
                                                                             throws IdempotentParameterMismatchException,
DoesNotExistException,
ResourceLimitExceededException,
FeatureNotAvailableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

registerTaskWithMaintenanceWindowRequest - A Consumer that will call methods on RegisterTaskWithMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the RegisterTaskWithMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

removeTagsFromResource

default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
                                                       throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Removes tag keys from the specified resource.

Parameters:

removeTagsFromResourceRequest -

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

See Also:

• AWS API Documentation

removeTagsFromResource

default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
                                                       throws InvalidResourceTypeException,
InvalidResourceIdException,
InternalServerErrorException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a request.

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

See Also:

• AWS API Documentation

resetServiceSetting

default ResetServiceSettingResponse resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)
                                                 throws InternalServerErrorException,
ServiceSettingNotFoundException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

Parameters:

resetServiceSettingRequest - The request body of the ResetServiceSetting API operation.

Returns:

Result of the ResetServiceSetting operation returned by the service.

See Also:

• AWS API Documentation

resetServiceSetting

default ResetServiceSettingResponse resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest)
                                                 throws InternalServerErrorException,
ServiceSettingNotFoundException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

This is a convenience which creates an instance of the ResetServiceSettingRequest.Builder avoiding the need to create one manually via ResetServiceSettingRequest.builder()

Parameters:

resetServiceSettingRequest - A Consumer that will call methods on ResetServiceSettingRequest.Builder to create a request. The request body of the ResetServiceSetting API operation.

Returns:

Result of the ResetServiceSetting operation returned by the service.

See Also:

• AWS API Documentation

resumeSession

default ResumeSessionResponse resumeSession(ResumeSessionRequest resumeSessionRequest)
                                     throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

Parameters:

resumeSessionRequest -

Returns:

Result of the ResumeSession operation returned by the service.

See Also:

• AWS API Documentation

resumeSession

default ResumeSessionResponse resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest)
                                     throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

This is a convenience which creates an instance of the ResumeSessionRequest.Builder avoiding the need to create one manually via ResumeSessionRequest.builder()

Parameters:

resumeSessionRequest - A Consumer that will call methods on ResumeSessionRequest.Builder to create a request.

Returns:

Result of the ResumeSession operation returned by the service.

See Also:

• AWS API Documentation

sendAutomationSignal

default SendAutomationSignalResponse sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
                                                   throws AutomationExecutionNotFoundException,
AutomationStepNotFoundException,
InvalidAutomationSignalException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Parameters:

sendAutomationSignalRequest -

Returns:

Result of the SendAutomationSignal operation returned by the service.

See Also:

• AWS API Documentation

sendAutomationSignal

default SendAutomationSignalResponse sendAutomationSignal(Consumer<SendAutomationSignalRequest.Builder> sendAutomationSignalRequest)
                                                   throws AutomationExecutionNotFoundException,
AutomationStepNotFoundException,
InvalidAutomationSignalException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

sendAutomationSignalRequest - A Consumer that will call methods on SendAutomationSignalRequest.Builder to create a request.

Returns:

Result of the SendAutomationSignal operation returned by the service.

See Also:

• AWS API Documentation

sendCommand

default SendCommandResponse sendCommand(SendCommandRequest sendCommandRequest)
                                 throws DuplicateInstanceIdException,
InternalServerErrorException,
InvalidInstanceIdException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidOutputFolderException,
InvalidParametersException,
UnsupportedPlatformTypeException,
MaxDocumentSizeExceededException,
InvalidRoleException,
InvalidNotificationConfigException,
AwsServiceException,
SdkClientException,
SsmException

Runs commands on one or more managed nodes.

Parameters:

sendCommandRequest -

Returns:

Result of the SendCommand operation returned by the service.

See Also:

• AWS API Documentation

sendCommand

default SendCommandResponse sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
                                 throws DuplicateInstanceIdException,
InternalServerErrorException,
InvalidInstanceIdException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidOutputFolderException,
InvalidParametersException,
UnsupportedPlatformTypeException,
MaxDocumentSizeExceededException,
InvalidRoleException,
InvalidNotificationConfigException,
AwsServiceException,
SdkClientException,
SsmException

Runs commands on one or more managed nodes.

This is a convenience which creates an instance of the SendCommandRequest.Builder avoiding the need to create one manually via SendCommandRequest.builder()

Parameters:

sendCommandRequest - A Consumer that will call methods on SendCommandRequest.Builder to create a request.

Returns:

Result of the SendCommand operation returned by the service.

See Also:

• AWS API Documentation

startAccessRequest

default StartAccessRequestResponse startAccessRequest(StartAccessRequestRequest startAccessRequestRequest)
                                               throws InternalServerErrorException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmException

Starts the workflow for just-in-time node access sessions.

Parameters:

startAccessRequestRequest -

Returns:

Result of the StartAccessRequest operation returned by the service.

See Also:

• AWS API Documentation

startAccessRequest

default StartAccessRequestResponse startAccessRequest(Consumer<StartAccessRequestRequest.Builder> startAccessRequestRequest)
                                               throws InternalServerErrorException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmException

Starts the workflow for just-in-time node access sessions.

This is a convenience which creates an instance of the StartAccessRequestRequest.Builder avoiding the need to create one manually via StartAccessRequestRequest.builder()

Parameters:

startAccessRequestRequest - A Consumer that will call methods on StartAccessRequestRequest.Builder to create a request.

Returns:

Result of the StartAccessRequest operation returned by the service.

See Also:

• AWS API Documentation

startAssociationsOnce

default StartAssociationsOnceResponse startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
                                                     throws InvalidAssociationException,
AssociationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.

Parameters:

startAssociationsOnceRequest -

Returns:

Result of the StartAssociationsOnce operation returned by the service.

See Also:

• AWS API Documentation

startAssociationsOnce

default StartAssociationsOnceResponse startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest)
                                                     throws InvalidAssociationException,
AssociationDoesNotExistException,
AwsServiceException,
SdkClientException,
SsmException

Runs an association immediately and only one time. This operation 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()

Parameters:

startAssociationsOnceRequest - A Consumer that will call methods on StartAssociationsOnceRequest.Builder to create a request.

Returns:

Result of the StartAssociationsOnce operation returned by the service.

See Also:

• AWS API Documentation

startAutomationExecution

default StartAutomationExecutionResponse startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
                                                           throws AutomationDefinitionNotFoundException,
InvalidAutomationExecutionParametersException,
AutomationExecutionLimitExceededException,
AutomationDefinitionVersionNotFoundException,
IdempotentParameterMismatchException,
InvalidTargetException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Initiates execution of an Automation runbook.

Parameters:

startAutomationExecutionRequest -

Returns:

Result of the StartAutomationExecution operation returned by the service.

See Also:

• AWS API Documentation

startAutomationExecution

default StartAutomationExecutionResponse startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest)
                                                           throws AutomationDefinitionNotFoundException,
InvalidAutomationExecutionParametersException,
AutomationExecutionLimitExceededException,
AutomationDefinitionVersionNotFoundException,
IdempotentParameterMismatchException,
InvalidTargetException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Initiates execution of an Automation runbook.

This is a convenience which creates an instance of the StartAutomationExecutionRequest.Builder avoiding the need to create one manually via StartAutomationExecutionRequest.builder()

Parameters:

startAutomationExecutionRequest - A Consumer that will call methods on StartAutomationExecutionRequest.Builder to create a request.

Returns:

Result of the StartAutomationExecution operation returned by the service.

See Also:

• AWS API Documentation

startChangeRequestExecution

default StartChangeRequestExecutionResponse startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
                                                                 throws AutomationDefinitionNotFoundException,
InvalidAutomationExecutionParametersException,
AutomationExecutionLimitExceededException,
AutomationDefinitionVersionNotFoundException,
IdempotentParameterMismatchException,
InternalServerErrorException,
AutomationDefinitionNotApprovedException,
AwsServiceException,
SdkClientException,
SsmException

Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.

Parameters:

startChangeRequestExecutionRequest -

Returns:

Result of the StartChangeRequestExecution operation returned by the service.

See Also:

• AWS API Documentation

startChangeRequestExecution

default StartChangeRequestExecutionResponse startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest)
                                                                 throws AutomationDefinitionNotFoundException,
InvalidAutomationExecutionParametersException,
AutomationExecutionLimitExceededException,
AutomationDefinitionVersionNotFoundException,
IdempotentParameterMismatchException,
InternalServerErrorException,
AutomationDefinitionNotApprovedException,
AwsServiceException,
SdkClientException,
SsmException

Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.

This is a convenience which creates an instance of the StartChangeRequestExecutionRequest.Builder avoiding the need to create one manually via StartChangeRequestExecutionRequest.builder()

Parameters:

startChangeRequestExecutionRequest - A Consumer that will call methods on StartChangeRequestExecutionRequest.Builder to create a request.

Returns:

Result of the StartChangeRequestExecution operation returned by the service.

See Also:

• AWS API Documentation

startExecutionPreview

default StartExecutionPreviewResponse startExecutionPreview(StartExecutionPreviewRequest startExecutionPreviewRequest)
                                                     throws InternalServerErrorException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmException

Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.

Parameters:

startExecutionPreviewRequest -

Returns:

Result of the StartExecutionPreview operation returned by the service.

See Also:

• AWS API Documentation

startExecutionPreview

default StartExecutionPreviewResponse startExecutionPreview(Consumer<StartExecutionPreviewRequest.Builder> startExecutionPreviewRequest)
                                                     throws InternalServerErrorException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmException

Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.

This is a convenience which creates an instance of the StartExecutionPreviewRequest.Builder avoiding the need to create one manually via StartExecutionPreviewRequest.builder()

Parameters:

startExecutionPreviewRequest - A Consumer that will call methods on StartExecutionPreviewRequest.Builder to create a request.

Returns:

Result of the StartExecutionPreview operation returned by the service.

See Also:

• AWS API Documentation

startSession

default StartSessionResponse startSession(StartSessionRequest startSessionRequest)
                                   throws InvalidDocumentException,
TargetNotConnectedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

Parameters:

startSessionRequest -

Returns:

Result of the StartSession operation returned by the service.

See Also:

• AWS API Documentation

startSession

default StartSessionResponse startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)
                                   throws InvalidDocumentException,
TargetNotConnectedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

This is a convenience which creates an instance of the StartSessionRequest.Builder avoiding the need to create one manually via StartSessionRequest.builder()

Parameters:

startSessionRequest - A Consumer that will call methods on StartSessionRequest.Builder to create a request.

Returns:

Result of the StartSession operation returned by the service.

See Also:

• AWS API Documentation

stopAutomationExecution

default StopAutomationExecutionResponse stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
                                                         throws AutomationExecutionNotFoundException,
InvalidAutomationStatusUpdateException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Stop an Automation that is currently running.

Parameters:

stopAutomationExecutionRequest -

Returns:

Result of the StopAutomationExecution operation returned by the service.

See Also:

• AWS API Documentation

stopAutomationExecution

default StopAutomationExecutionResponse stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)
                                                         throws AutomationExecutionNotFoundException,
InvalidAutomationStatusUpdateException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

stopAutomationExecutionRequest - A Consumer that will call methods on StopAutomationExecutionRequest.Builder to create a request.

Returns:

Result of the StopAutomationExecution operation returned by the service.

See Also:

• AWS API Documentation

terminateSession

default TerminateSessionResponse terminateSession(TerminateSessionRequest terminateSessionRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.

Parameters:

terminateSessionRequest -

Returns:

Result of the TerminateSession operation returned by the service.

See Also:

• AWS API Documentation

terminateSession

default TerminateSessionResponse terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.

This is a convenience which creates an instance of the TerminateSessionRequest.Builder avoiding the need to create one manually via TerminateSessionRequest.builder()

Parameters:

terminateSessionRequest - A Consumer that will call methods on TerminateSessionRequest.Builder to create a request.

Returns:

Result of the TerminateSession operation returned by the service.

See Also:

• AWS API Documentation

unlabelParameterVersion

default UnlabelParameterVersionResponse unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
                                                         throws InternalServerErrorException,
TooManyUpdatesException,
ParameterNotFoundException,
ParameterVersionNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Remove a label or labels from a parameter.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

Parameters:

unlabelParameterVersionRequest -

Returns:

Result of the UnlabelParameterVersion operation returned by the service.

See Also:

• AWS API Documentation

unlabelParameterVersion

default UnlabelParameterVersionResponse unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest)
                                                         throws InternalServerErrorException,
TooManyUpdatesException,
ParameterNotFoundException,
ParameterVersionNotFoundException,
AwsServiceException,
SdkClientException,
SsmException

Remove a label or labels from a parameter.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

This is a convenience which creates an instance of the UnlabelParameterVersionRequest.Builder avoiding the need to create one manually via UnlabelParameterVersionRequest.builder()

Parameters:

unlabelParameterVersionRequest - A Consumer that will call methods on UnlabelParameterVersionRequest.Builder to create a request.

Returns:

Result of the UnlabelParameterVersion operation returned by the service.

See Also:

• AWS API Documentation

updateAssociation

default UpdateAssociationResponse updateAssociation(UpdateAssociationRequest updateAssociationRequest)
                                             throws InternalServerErrorException,
InvalidScheduleException,
InvalidParametersException,
InvalidOutputLocationException,
InvalidDocumentVersionException,
AssociationDoesNotExistException,
InvalidUpdateException,
TooManyUpdatesException,
InvalidDocumentException,
InvalidTargetException,
InvalidAssociationVersionException,
AssociationVersionLimitExceededException,
InvalidTargetMapsException,
AwsServiceException,
SdkClientException,
SsmException

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.

In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.

Parameters:

updateAssociationRequest -

Returns:

Result of the UpdateAssociation operation returned by the service.

See Also:

• AWS API Documentation

updateAssociation

default UpdateAssociationResponse updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest)
                                             throws InternalServerErrorException,
InvalidScheduleException,
InvalidParametersException,
InvalidOutputLocationException,
InvalidDocumentVersionException,
AssociationDoesNotExistException,
InvalidUpdateException,
TooManyUpdatesException,
InvalidDocumentException,
InvalidTargetException,
InvalidAssociationVersionException,
AssociationVersionLimitExceededException,
InvalidTargetMapsException,
AwsServiceException,
SdkClientException,
SsmException

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.

In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.

This is a convenience which creates an instance of the UpdateAssociationRequest.Builder avoiding the need to create one manually via UpdateAssociationRequest.builder()

Parameters:

updateAssociationRequest - A Consumer that will call methods on UpdateAssociationRequest.Builder to create a request.

Returns:

Result of the UpdateAssociation operation returned by the service.

See Also:

• AWS API Documentation

updateAssociationStatus

default UpdateAssociationStatusResponse updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
                                                         throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidDocumentException,
AssociationDoesNotExistException,
StatusUnchangedException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.

UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.

Parameters:

updateAssociationStatusRequest -

Returns:

Result of the UpdateAssociationStatus operation returned by the service.

See Also:

• AWS API Documentation

updateAssociationStatus

default UpdateAssociationStatusResponse updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest)
                                                         throws InternalServerErrorException,
InvalidInstanceIdException,
InvalidDocumentException,
AssociationDoesNotExistException,
StatusUnchangedException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.

UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.

This is a convenience which creates an instance of the UpdateAssociationStatusRequest.Builder avoiding the need to create one manually via UpdateAssociationStatusRequest.builder()

Parameters:

updateAssociationStatusRequest - A Consumer that will call methods on UpdateAssociationStatusRequest.Builder to create a request.

Returns:

Result of the UpdateAssociationStatus operation returned by the service.

See Also:

• AWS API Documentation

updateDocument

default UpdateDocumentResponse updateDocument(UpdateDocumentRequest updateDocumentRequest)
                                       throws MaxDocumentSizeExceededException,
DocumentVersionLimitExceededException,
InternalServerErrorException,
DuplicateDocumentContentException,
DuplicateDocumentVersionNameException,
InvalidDocumentContentException,
InvalidDocumentVersionException,
InvalidDocumentSchemaVersionException,
InvalidDocumentException,
InvalidDocumentOperationException,
AwsServiceException,
SdkClientException,
SsmException

Updates one or more values for an SSM document.

Parameters:

updateDocumentRequest -

Returns:

Result of the UpdateDocument operation returned by the service.

See Also:

• AWS API Documentation

updateDocument

default UpdateDocumentResponse updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
                                       throws MaxDocumentSizeExceededException,
DocumentVersionLimitExceededException,
InternalServerErrorException,
DuplicateDocumentContentException,
DuplicateDocumentVersionNameException,
InvalidDocumentContentException,
InvalidDocumentVersionException,
InvalidDocumentSchemaVersionException,
InvalidDocumentException,
InvalidDocumentOperationException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

updateDocumentRequest - A Consumer that will call methods on UpdateDocumentRequest.Builder to create a request.

Returns:

Result of the UpdateDocument operation returned by the service.

See Also:

• AWS API Documentation

updateDocumentDefaultVersion

default UpdateDocumentDefaultVersionResponse updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
                                                                   throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidDocumentSchemaVersionException,
AwsServiceException,
SdkClientException,
SsmException

Set the default version of a document.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

Parameters:

updateDocumentDefaultVersionRequest -

Returns:

Result of the UpdateDocumentDefaultVersion operation returned by the service.

See Also:

• AWS API Documentation

updateDocumentDefaultVersion

default UpdateDocumentDefaultVersionResponse updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest)
                                                                   throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentVersionException,
InvalidDocumentSchemaVersionException,
AwsServiceException,
SdkClientException,
SsmException

Set the default version of a document.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

This is a convenience which creates an instance of the UpdateDocumentDefaultVersionRequest.Builder avoiding the need to create one manually via UpdateDocumentDefaultVersionRequest.builder()

Parameters:

updateDocumentDefaultVersionRequest - A Consumer that will call methods on UpdateDocumentDefaultVersionRequest.Builder to create a request.

Returns:

Result of the UpdateDocumentDefaultVersion operation returned by the service.

See Also:

• AWS API Documentation

updateDocumentMetadata

default UpdateDocumentMetadataResponse updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)
                                                       throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentOperationException,
InvalidDocumentVersionException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Updates information related to approval reviews for a specific version of a change template in Change Manager.

Parameters:

updateDocumentMetadataRequest -

Returns:

Result of the UpdateDocumentMetadata operation returned by the service.

See Also:

• AWS API Documentation

updateDocumentMetadata

default UpdateDocumentMetadataResponse updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest)
                                                       throws InternalServerErrorException,
InvalidDocumentException,
InvalidDocumentOperationException,
InvalidDocumentVersionException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

Updates information related to approval reviews for a specific version of a change template in Change Manager.

This is a convenience which creates an instance of the UpdateDocumentMetadataRequest.Builder avoiding the need to create one manually via UpdateDocumentMetadataRequest.builder()

Parameters:

updateDocumentMetadataRequest - A Consumer that will call methods on UpdateDocumentMetadataRequest.Builder to create a request.

Returns:

Result of the UpdateDocumentMetadata operation returned by the service.

See Also:

• AWS API Documentation

updateMaintenanceWindow

default UpdateMaintenanceWindowResponse updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
                                                         throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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.

Parameters:

updateMaintenanceWindowRequest -

Returns:

Result of the UpdateMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

updateMaintenanceWindow

default UpdateMaintenanceWindowResponse updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest)
                                                         throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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()

Parameters:

updateMaintenanceWindowRequest - A Consumer that will call methods on UpdateMaintenanceWindowRequest.Builder to create a request.

Returns:

Result of the UpdateMaintenanceWindow operation returned by the service.

See Also:

• AWS API Documentation

updateMaintenanceWindowTarget

default UpdateMaintenanceWindowTargetResponse updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
                                                                     throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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 isn't modified.

Parameters:

updateMaintenanceWindowTargetRequest -

Returns:

Result of the UpdateMaintenanceWindowTarget operation returned by the service.

See Also:

• AWS API Documentation

updateMaintenanceWindowTarget

default UpdateMaintenanceWindowTargetResponse updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest)
                                                                     throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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 isn't modified.

This is a convenience which creates an instance of the UpdateMaintenanceWindowTargetRequest.Builder avoiding the need to create one manually via UpdateMaintenanceWindowTargetRequest.builder()

Parameters:

updateMaintenanceWindowTargetRequest - A Consumer that will call methods on UpdateMaintenanceWindowTargetRequest.Builder to create a request.

Returns:

Result of the UpdateMaintenanceWindowTarget operation returned by the service.

See Also:

• AWS API Documentation

updateMaintenanceWindowTask

default UpdateMaintenanceWindowTaskResponse updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
                                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation 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 don't 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.

Parameters:

updateMaintenanceWindowTaskRequest -

Returns:

Result of the UpdateMaintenanceWindowTask operation returned by the service.

See Also:

• AWS API Documentation

updateMaintenanceWindowTask

default UpdateMaintenanceWindowTaskResponse updateMaintenanceWindowTask(Consumer<UpdateMaintenanceWindowTaskRequest.Builder> updateMaintenanceWindowTaskRequest)
                                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation 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 don't 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()

Parameters:

updateMaintenanceWindowTaskRequest - A Consumer that will call methods on UpdateMaintenanceWindowTaskRequest.Builder to create a request.

Returns:

Result of the UpdateMaintenanceWindowTask operation returned by the service.

See Also:

• AWS API Documentation

updateManagedInstanceRole

default UpdateManagedInstanceRoleResponse updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
                                                             throws InvalidInstanceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.

Parameters:

updateManagedInstanceRoleRequest -

Returns:

Result of the UpdateManagedInstanceRole operation returned by the service.

See Also:

• AWS API Documentation

updateManagedInstanceRole

default UpdateManagedInstanceRoleResponse updateManagedInstanceRole(Consumer<UpdateManagedInstanceRoleRequest.Builder> updateManagedInstanceRoleRequest)
                                                             throws InvalidInstanceIdException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes 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()

Parameters:

updateManagedInstanceRoleRequest - A Consumer that will call methods on UpdateManagedInstanceRoleRequest.Builder to create a request.

Returns:

Result of the UpdateManagedInstanceRole operation returned by the service.

See Also:

• AWS API Documentation

updateOpsItem

default UpdateOpsItemResponse updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
                                     throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemAlreadyExistsException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
OpsItemAccessDeniedException,
OpsItemConflictException,
AwsServiceException,
SdkClientException,
SsmException

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Parameters:

updateOpsItemRequest -

Returns:

Result of the UpdateOpsItem operation returned by the service.

See Also:

• AWS API Documentation

updateOpsItem

default UpdateOpsItemResponse updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest)
                                     throws InternalServerErrorException,
OpsItemNotFoundException,
OpsItemAlreadyExistsException,
OpsItemLimitExceededException,
OpsItemInvalidParameterException,
OpsItemAccessDeniedException,
OpsItemConflictException,
AwsServiceException,
SdkClientException,
SsmException

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

This is a convenience which creates an instance of the UpdateOpsItemRequest.Builder avoiding the need to create one manually via UpdateOpsItemRequest.builder()

Parameters:

updateOpsItemRequest - A Consumer that will call methods on UpdateOpsItemRequest.Builder to create a request.

Returns:

Result of the UpdateOpsItem operation returned by the service.

See Also:

• AWS API Documentation

updateOpsMetadata

default UpdateOpsMetadataResponse updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)
                                             throws OpsMetadataNotFoundException,
OpsMetadataInvalidArgumentException,
OpsMetadataKeyLimitExceededException,
OpsMetadataTooManyUpdatesException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

Parameters:

updateOpsMetadataRequest -

Returns:

Result of the UpdateOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

updateOpsMetadata

default UpdateOpsMetadataResponse updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest)
                                             throws OpsMetadataNotFoundException,
OpsMetadataInvalidArgumentException,
OpsMetadataKeyLimitExceededException,
OpsMetadataTooManyUpdatesException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Amazon Web Services Systems Manager calls this API operation 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()

Parameters:

updateOpsMetadataRequest - A Consumer that will call methods on UpdateOpsMetadataRequest.Builder to create a request.

Returns:

Result of the UpdateOpsMetadata operation returned by the service.

See Also:

• AWS API Documentation

updatePatchBaseline

default UpdatePatchBaselineResponse updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Parameters:

updatePatchBaselineRequest -

Returns:

Result of the UpdatePatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

updatePatchBaseline

default UpdatePatchBaselineResponse updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)
                                                 throws DoesNotExistException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

For information about valid key-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()

Parameters:

updatePatchBaselineRequest - A Consumer that will call methods on UpdatePatchBaselineRequest.Builder to create a request.

Returns:

Result of the UpdatePatchBaseline operation returned by the service.

See Also:

• AWS API Documentation

updateResourceDataSync

default UpdateResourceDataSyncResponse updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)
                                                       throws ResourceDataSyncNotFoundException,
ResourceDataSyncInvalidConfigurationException,
ResourceDataSyncConflictException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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 Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.

This API operation only supports a resource data sync that was created with a SyncFromSource SyncType.

Parameters:

updateResourceDataSyncRequest -

Returns:

Result of the UpdateResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

updateResourceDataSync

default UpdateResourceDataSyncResponse updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest)
                                                       throws ResourceDataSyncNotFoundException,
ResourceDataSyncInvalidConfigurationException,
ResourceDataSyncConflictException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
SsmException

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 Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.

This API operation 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()

Parameters:

updateResourceDataSyncRequest - A Consumer that will call methods on UpdateResourceDataSyncRequest.Builder to create a request.

Returns:

Result of the UpdateResourceDataSync operation returned by the service.

See Also:

• AWS API Documentation

updateServiceSetting

default UpdateServiceSettingResponse updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)
                                                   throws InternalServerErrorException,
ServiceSettingNotFoundException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Update the service setting for the account.

Parameters:

updateServiceSettingRequest - The request body of the UpdateServiceSetting API operation.

Returns:

Result of the UpdateServiceSetting operation returned by the service.

See Also:

• AWS API Documentation

updateServiceSetting

default UpdateServiceSettingResponse updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest)
                                                   throws InternalServerErrorException,
ServiceSettingNotFoundException,
TooManyUpdatesException,
AwsServiceException,
SdkClientException,
SsmException

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services 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()

Parameters:

updateServiceSettingRequest - A Consumer that will call methods on UpdateServiceSettingRequest.Builder to create a request. The request body of the UpdateServiceSetting API operation.

Returns:

Result of the UpdateServiceSetting operation returned by the service.

See Also:

• AWS API Documentation

waiter

default SsmWaiter waiter()

Create an instance of SsmWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of SsmWaiter

create

static SsmClient create()

Create a SsmClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SsmClientBuilder builder()

Create a builder that can be used to configure and create a SsmClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SsmServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration