Interface SsmAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SsmAsyncClient extends AwsClient
Service client for accessing Amazon SSM asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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

  • Field Details

  • Method Details

    • addTagsToResource

      default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

      Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your 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:
      A Java Future containing the result of the AddTagsToResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyTagsErrorException The Targets parameter includes too many tags. Remove one or more tags and try the command again.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addTagsToResource

      default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)

      Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your 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:
      A Java Future containing the result of the AddTagsToResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyTagsErrorException The Targets parameter includes too many tags. Remove one or more tags and try the command again.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateOpsItemRelatedItem

      default CompletableFuture<AssociateOpsItemRelatedItemResponse> associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest)

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

      Parameters:
      associateOpsItemRelatedItemRequest -
      Returns:
      A Java Future containing the result of the AssociateOpsItemRelatedItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemRelatedItemAlreadyExistsException The Amazon Resource Name (ARN) is already associated with the OpsItem.
      • OpsItemConflictException The specified OpsItem is in the process of being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateOpsItemRelatedItem

      default CompletableFuture<AssociateOpsItemRelatedItemResponse> associateOpsItemRelatedItem(Consumer<AssociateOpsItemRelatedItemRequest.Builder> associateOpsItemRelatedItemRequest)

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


      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:
      A Java Future containing the result of the AssociateOpsItemRelatedItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemRelatedItemAlreadyExistsException The Amazon Resource Name (ARN) is already associated with the OpsItem.
      • OpsItemConflictException The specified OpsItem is in the process of being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelCommand

      default CompletableFuture<CancelCommandResponse> cancelCommand(CancelCommandRequest cancelCommandRequest)

      Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

      Parameters:
      cancelCommandRequest -
      Returns:
      A Java Future containing the result of the CancelCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelCommand

      default CompletableFuture<CancelCommandResponse> cancelCommand(Consumer<CancelCommandRequest.Builder> cancelCommandRequest)

      Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.


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

      Parameters:
      cancelCommandRequest - A Consumer that will call methods on CancelCommandRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelMaintenanceWindowExecution

      default CompletableFuture<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. Tasks already in progress will continue to completion.

      Parameters:
      cancelMaintenanceWindowExecutionRequest -
      Returns:
      A Java Future containing the result of the CancelMaintenanceWindowExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelMaintenanceWindowExecution

      default CompletableFuture<CancelMaintenanceWindowExecutionResponse> cancelMaintenanceWindowExecution(Consumer<CancelMaintenanceWindowExecutionRequest.Builder> cancelMaintenanceWindowExecutionRequest)

      Stops a maintenance window execution that is already in progress and cancels any tasks in the window that 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:
      A Java Future containing the result of the CancelMaintenanceWindowExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createActivation

      default CompletableFuture<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. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see 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:
      A Java Future containing the result of the CreateActivation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createActivation

      default CompletableFuture<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. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see 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:
      A Java Future containing the result of the CreateActivation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssociation

      default CompletableFuture<CreateAssociationResponse> createAssociation(CreateAssociationRequest createAssociationRequest)

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

      Parameters:
      createAssociationRequest -
      Returns:
      A Java Future containing the result of the CreateAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AssociationAlreadyExistsException The specified association already exists.
      • AssociationLimitExceededException You can have at most 2,000 active associations.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • UnsupportedPlatformTypeException The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        • InvalidOutputLocationException The output location isn't valid or doesn't exist.
        • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
        • InvalidScheduleException The schedule is invalid. Verify your cron or rate expression and try again.
        • InvalidTargetMapsException TargetMap parameter isn't valid.
        • InvalidTagException The specified tag key or value isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssociation

      default CompletableFuture<CreateAssociationResponse> createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)

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


      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:
      A Java Future containing the result of the CreateAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AssociationAlreadyExistsException The specified association already exists.
      • AssociationLimitExceededException You can have at most 2,000 active associations.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • UnsupportedPlatformTypeException The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        • InvalidOutputLocationException The output location isn't valid or doesn't exist.
        • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
        • InvalidScheduleException The schedule is invalid. Verify your cron or rate expression and try again.
        • InvalidTargetMapsException TargetMap parameter isn't valid.
        • InvalidTagException The specified tag key or value isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssociationBatch

      default CompletableFuture<CreateAssociationBatchResponse> createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)

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

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

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

      Parameters:
      createAssociationBatchRequest -
      Returns:
      A Java Future containing the result of the CreateAssociationBatch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        • DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
        • AssociationLimitExceededException You can have at most 2,000 active associations.
        • UnsupportedPlatformTypeException The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        • InvalidOutputLocationException The output location isn't valid or doesn't exist.
        • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
        • InvalidScheduleException The schedule is invalid. Verify your cron or rate expression and try again.
        • InvalidTargetMapsException TargetMap parameter isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssociationBatch

      default CompletableFuture<CreateAssociationBatchResponse> createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest)

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

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

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


      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:
      A Java Future containing the result of the CreateAssociationBatch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        • DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
        • AssociationLimitExceededException You can have at most 2,000 active associations.
        • UnsupportedPlatformTypeException The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        • InvalidOutputLocationException The output location isn't valid or doesn't exist.
        • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
        • InvalidScheduleException The schedule is invalid. Verify your cron or rate expression and try again.
        • InvalidTargetMapsException TargetMap parameter isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDocument

      default CompletableFuture<CreateDocumentResponse> createDocument(CreateDocumentRequest createDocumentRequest)

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

      Parameters:
      createDocumentRequest -
      Returns:
      A Java Future containing the result of the CreateDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DocumentAlreadyExistsException The specified document already exists.
      • MaxDocumentSizeExceededException The size limit of a document is 64 KB.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentContentException The content for the document isn't valid.
      • DocumentLimitExceededException You can have at most 500 active SSM documents.
      • InvalidDocumentSchemaVersionException The version of the document schema isn't supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDocument

      default CompletableFuture<CreateDocumentResponse> createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)

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


      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:
      A Java Future containing the result of the CreateDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DocumentAlreadyExistsException The specified document already exists.
      • MaxDocumentSizeExceededException The size limit of a document is 64 KB.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentContentException The content for the document isn't valid.
      • DocumentLimitExceededException You can have at most 500 active SSM documents.
      • InvalidDocumentSchemaVersionException The version of the document schema isn't supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMaintenanceWindow

      default CompletableFuture<CreateMaintenanceWindowResponse> createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)

      Creates a new maintenance window.

      The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

      Parameters:
      createMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the CreateMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMaintenanceWindow

      default CompletableFuture<CreateMaintenanceWindowResponse> createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)

      Creates a new maintenance window.

      The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.


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

      Parameters:
      createMaintenanceWindowRequest - A Consumer that will call methods on CreateMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOpsItem

      default CompletableFuture<CreateOpsItemResponse> createOpsItem(CreateOpsItemRequest createOpsItemRequest)

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

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

      Parameters:
      createOpsItemRequest -
      Returns:
      A Java Future containing the result of the CreateOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemAlreadyExistsException The OpsItem already exists.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemAccessDeniedException You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOpsItem

      default CompletableFuture<CreateOpsItemResponse> createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest)

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

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


      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:
      A Java Future containing the result of the CreateOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemAlreadyExistsException The OpsItem already exists.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemAccessDeniedException You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOpsMetadata

      default CompletableFuture<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.

      Parameters:
      createOpsMetadataRequest -
      Returns:
      A Java Future containing the result of the CreateOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataAlreadyExistsException An OpsMetadata object already exists for the selected resource.
      • OpsMetadataTooManyUpdatesException The system is processing too many concurrent updates. Wait a few moments and try again.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • OpsMetadataLimitExceededException Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOpsMetadata

      default CompletableFuture<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.


      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:
      A Java Future containing the result of the CreateOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataAlreadyExistsException An OpsMetadata object already exists for the selected resource.
      • OpsMetadataTooManyUpdatesException The system is processing too many concurrent updates. Wait a few moments and try again.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • OpsMetadataLimitExceededException Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPatchBaseline

      default CompletableFuture<CreatePatchBaselineResponse> createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)

      Creates a patch baseline.

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

      Parameters:
      createPatchBaselineRequest -
      Returns:
      A Java Future containing the result of the CreatePatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPatchBaseline

      default CompletableFuture<CreatePatchBaselineResponse> createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)

      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:
      A Java Future containing the result of the CreatePatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createResourceDataSync

      default CompletableFuture<CreateResourceDataSyncResponse> createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)

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

      You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Creatinga 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:
      A Java Future containing the result of the CreateResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncCountExceededException You have exceeded the allowed maximum sync configurations.
      • ResourceDataSyncAlreadyExistsException A sync configuration with the same name already exists.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createResourceDataSync

      default CompletableFuture<CreateResourceDataSyncResponse> createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)

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

      You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Creatinga 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:
      A Java Future containing the result of the CreateResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncCountExceededException You have exceeded the allowed maximum sync configurations.
      • ResourceDataSyncAlreadyExistsException A sync configuration with the same name already exists.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteActivation

      default CompletableFuture<DeleteActivationResponse> deleteActivation(DeleteActivationRequest deleteActivationRequest)

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

      Parameters:
      deleteActivationRequest -
      Returns:
      A Java Future containing the result of the DeleteActivation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidActivationIdException The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
      • InvalidActivationException The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteActivation

      default CompletableFuture<DeleteActivationResponse> deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest)

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


      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:
      A Java Future containing the result of the DeleteActivation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidActivationIdException The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
      • InvalidActivationException The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssociation

      default CompletableFuture<DeleteAssociationResponse> deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)

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

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

      Parameters:
      deleteAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssociation

      default CompletableFuture<DeleteAssociationResponse> deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)

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

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


      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:
      A Java Future containing the result of the DeleteAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDocument

      default CompletableFuture<DeleteDocumentResponse> deleteDocument(DeleteDocumentRequest deleteDocumentRequest)

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

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

      Parameters:
      deleteDocumentRequest -
      Returns:
      A Java Future containing the result of the DeleteDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • AssociatedInstancesException You must disassociate a document from all managed nodes before you can delete it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDocument

      default CompletableFuture<DeleteDocumentResponse> deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)

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

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


      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:
      A Java Future containing the result of the DeleteDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • AssociatedInstancesException You must disassociate a document from all managed nodes before you can delete it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInventory

      default CompletableFuture<DeleteInventoryResponse> deleteInventory(DeleteInventoryRequest deleteInventoryRequest)

      Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

      Parameters:
      deleteInventoryRequest -
      Returns:
      A Java Future containing the result of the DeleteInventory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidOptionException The delete inventory option specified isn't valid. Verify the option and try again.
      • InvalidDeleteInventoryParametersException One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.
      • InvalidInventoryRequestException The request isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInventory

      default CompletableFuture<DeleteInventoryResponse> deleteInventory(Consumer<DeleteInventoryRequest.Builder> deleteInventoryRequest)

      Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.


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

      Parameters:
      deleteInventoryRequest - A Consumer that will call methods on DeleteInventoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInventory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidOptionException The delete inventory option specified isn't valid. Verify the option and try again.
      • InvalidDeleteInventoryParametersException One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.
      • InvalidInventoryRequestException The request isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMaintenanceWindow

      default CompletableFuture<DeleteMaintenanceWindowResponse> deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)

      Deletes a maintenance window.

      Parameters:
      deleteMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the DeleteMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMaintenanceWindow

      default CompletableFuture<DeleteMaintenanceWindowResponse> deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)

      Deletes a maintenance window.


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

      Parameters:
      deleteMaintenanceWindowRequest - A Consumer that will call methods on DeleteMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteOpsItem

      default CompletableFuture<DeleteOpsItemResponse> deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest)

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

      Note the following important information about this operation.

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

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

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

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

      Parameters:
      deleteOpsItemRequest -
      Returns:
      A Java Future containing the result of the DeleteOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteOpsItem

      default CompletableFuture<DeleteOpsItemResponse> deleteOpsItem(Consumer<DeleteOpsItemRequest.Builder> deleteOpsItemRequest)

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

      Note the following important information about this operation.

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

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

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

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


      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:
      A Java Future containing the result of the DeleteOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteOpsMetadata

      default CompletableFuture<DeleteOpsMetadataResponse> deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)

      Delete OpsMetadata related to an application.

      Parameters:
      deleteOpsMetadataRequest -
      Returns:
      A Java Future containing the result of the DeleteOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataNotFoundException The OpsMetadata object doesn't exist.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteOpsMetadata

      default CompletableFuture<DeleteOpsMetadataResponse> deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest)

      Delete OpsMetadata related to an application.


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

      Parameters:
      deleteOpsMetadataRequest - A Consumer that will call methods on DeleteOpsMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataNotFoundException The OpsMetadata object doesn't exist.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteParameter

      default CompletableFuture<DeleteParameterResponse> deleteParameter(DeleteParameterRequest deleteParameterRequest)

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

      Parameters:
      deleteParameterRequest -
      Returns:
      A Java Future containing the result of the DeleteParameter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteParameter

      default CompletableFuture<DeleteParameterResponse> deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest)

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


      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:
      A Java Future containing the result of the DeleteParameter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteParameters

      default CompletableFuture<DeleteParametersResponse> deleteParameters(DeleteParametersRequest deleteParametersRequest)

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

      Parameters:
      deleteParametersRequest -
      Returns:
      A Java Future containing the result of the DeleteParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteParameters

      default CompletableFuture<DeleteParametersResponse> deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)

      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:
      A Java Future containing the result of the DeleteParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePatchBaseline

      default CompletableFuture<DeletePatchBaselineResponse> deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)

      Deletes a patch baseline.

      Parameters:
      deletePatchBaselineRequest -
      Returns:
      A Java Future containing the result of the DeletePatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceInUseException Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePatchBaseline

      default CompletableFuture<DeletePatchBaselineResponse> deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)

      Deletes a patch baseline.


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

      Parameters:
      deletePatchBaselineRequest - A Consumer that will call methods on DeletePatchBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceInUseException Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourceDataSync

      default CompletableFuture<DeleteResourceDataSyncResponse> deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)

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

      Parameters:
      deleteResourceDataSyncRequest -
      Returns:
      A Java Future containing the result of the DeleteResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourceDataSync

      default CompletableFuture<DeleteResourceDataSyncResponse> deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)

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


      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:
      A Java Future containing the result of the DeleteResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

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

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

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

      Parameters:
      deleteResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourcePolicyConflictException The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • MalformedResourcePolicyDocumentException The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.
      • ResourcePolicyNotFoundException No policies with the specified policy ID and hash could be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)

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

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

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


      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:
      A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourcePolicyConflictException The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • MalformedResourcePolicyDocumentException The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.
      • ResourcePolicyNotFoundException No policies with the specified policy ID and hash could be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterManagedInstance

      default CompletableFuture<DeregisterManagedInstanceResponse> deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)

      Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.

      Parameters:
      deregisterManagedInstanceRequest -
      Returns:
      A Java Future containing the result of the DeregisterManagedInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InternalServerErrorException An error occurred on the server side.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterManagedInstance

      default CompletableFuture<DeregisterManagedInstanceResponse> deregisterManagedInstance(Consumer<DeregisterManagedInstanceRequest.Builder> deregisterManagedInstanceRequest)

      Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.


      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:
      A Java Future containing the result of the DeregisterManagedInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InternalServerErrorException An error occurred on the server side.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterPatchBaselineForPatchGroup

      default CompletableFuture<DeregisterPatchBaselineForPatchGroupResponse> deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)

      Removes a patch group from a patch baseline.

      Parameters:
      deregisterPatchBaselineForPatchGroupRequest -
      Returns:
      A Java Future containing the result of the DeregisterPatchBaselineForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterPatchBaselineForPatchGroup

      default CompletableFuture<DeregisterPatchBaselineForPatchGroupResponse> deregisterPatchBaselineForPatchGroup(Consumer<DeregisterPatchBaselineForPatchGroupRequest.Builder> deregisterPatchBaselineForPatchGroupRequest)

      Removes a patch group from a patch baseline.


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

      Parameters:
      deregisterPatchBaselineForPatchGroupRequest - A Consumer that will call methods on DeregisterPatchBaselineForPatchGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterPatchBaselineForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterTargetFromMaintenanceWindow

      default CompletableFuture<DeregisterTargetFromMaintenanceWindowResponse> deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)

      Removes a target from a maintenance window.

      Parameters:
      deregisterTargetFromMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the DeregisterTargetFromMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • TargetInUseException You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterTargetFromMaintenanceWindow

      default CompletableFuture<DeregisterTargetFromMaintenanceWindowResponse> deregisterTargetFromMaintenanceWindow(Consumer<DeregisterTargetFromMaintenanceWindowRequest.Builder> deregisterTargetFromMaintenanceWindowRequest)

      Removes a target from a maintenance window.


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

      Parameters:
      deregisterTargetFromMaintenanceWindowRequest - A Consumer that will call methods on DeregisterTargetFromMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterTargetFromMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • TargetInUseException You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterTaskFromMaintenanceWindow

      default CompletableFuture<DeregisterTaskFromMaintenanceWindowResponse> deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)

      Removes a task from a maintenance window.

      Parameters:
      deregisterTaskFromMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the DeregisterTaskFromMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterTaskFromMaintenanceWindow

      default CompletableFuture<DeregisterTaskFromMaintenanceWindowResponse> deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest)

      Removes a task from a maintenance window.


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

      Parameters:
      deregisterTaskFromMaintenanceWindowRequest - A Consumer that will call methods on DeregisterTaskFromMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterTaskFromMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivations

      default CompletableFuture<DescribeActivationsResponse> describeActivations(DescribeActivationsRequest describeActivationsRequest)

      Describes details about the activation, such as the date and time the activation was created, its expiration date, the 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:
      A Java Future containing the result of the DescribeActivations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivations

      default CompletableFuture<DescribeActivationsResponse> describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)

      Describes details about the activation, such as the date and time the activation was created, its expiration date, the 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:
      A Java Future containing the result of the DescribeActivations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivations

      default CompletableFuture<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.

      Returns:
      A Java Future containing the result of the DescribeActivations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivationsPaginator

      default DescribeActivationsPublisher describeActivationsPaginator()

      This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivationsPaginator

      default DescribeActivationsPublisher describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)

      This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation.

      Parameters:
      describeActivationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivationsPaginator

      default DescribeActivationsPublisher describeActivationsPaginator(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)

      This is a variant of describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeActivationsPublisher publisher = client.describeActivationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest) operation.


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

      Parameters:
      describeActivationsRequest - A Consumer that will call methods on DescribeActivationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociation

      default CompletableFuture<DescribeAssociationResponse> describeAssociation(DescribeAssociationRequest describeAssociationRequest)

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

      Parameters:
      describeAssociationRequest -
      Returns:
      A Java Future containing the result of the DescribeAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidAssociationVersionException The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the invalid input: '&#36'LATEST parameter to view the latest version of the association.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociation

      default CompletableFuture<DescribeAssociationResponse> describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest)

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


      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:
      A Java Future containing the result of the DescribeAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidAssociationVersionException The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the invalid input: '&#36'LATEST parameter to view the latest version of the association.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutionTargets

      default CompletableFuture<DescribeAssociationExecutionTargetsResponse> describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)

      Views information about a specific execution of a specific association.

      Parameters:
      describeAssociationExecutionTargetsRequest -
      Returns:
      A Java Future containing the result of the DescribeAssociationExecutionTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationExecutionDoesNotExistException The specified execution ID doesn't exist. Verify the ID number and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutionTargets

      default CompletableFuture<DescribeAssociationExecutionTargetsResponse> describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)

      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:
      A Java Future containing the result of the DescribeAssociationExecutionTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationExecutionDoesNotExistException The specified execution ID doesn't exist. Verify the ID number and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutionTargetsPaginator

      default DescribeAssociationExecutionTargetsPublisher describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)

      This is a variant of describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation.

      Parameters:
      describeAssociationExecutionTargetsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationExecutionDoesNotExistException The specified execution ID doesn't exist. Verify the ID number and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutionTargetsPaginator

      default DescribeAssociationExecutionTargetsPublisher describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)

      This is a variant of describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsPublisher publisher = client.describeAssociationExecutionTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest) operation.


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

      Parameters:
      describeAssociationExecutionTargetsRequest - A Consumer that will call methods on DescribeAssociationExecutionTargetsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationExecutionDoesNotExistException The specified execution ID doesn't exist. Verify the ID number and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutions

      default CompletableFuture<DescribeAssociationExecutionsResponse> describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)

      Views all executions for a specific association ID.

      Parameters:
      describeAssociationExecutionsRequest -
      Returns:
      A Java Future containing the result of the DescribeAssociationExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutions

      default CompletableFuture<DescribeAssociationExecutionsResponse> describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)

      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:
      A Java Future containing the result of the DescribeAssociationExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutionsPaginator

      default DescribeAssociationExecutionsPublisher describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)

      This is a variant of describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation.

      Parameters:
      describeAssociationExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssociationExecutionsPaginator

      default DescribeAssociationExecutionsPublisher describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)

      This is a variant of describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsPublisher publisher = client.describeAssociationExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest) operation.


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

      Parameters:
      describeAssociationExecutionsRequest - A Consumer that will call methods on DescribeAssociationExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationExecutions

      default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)

      Provides details about all active and terminated Automation executions.

      Parameters:
      describeAutomationExecutionsRequest -
      Returns:
      A Java Future containing the result of the DescribeAutomationExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationExecutions

      default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)

      Provides details about all active and terminated Automation executions.


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

      Parameters:
      describeAutomationExecutionsRequest - A Consumer that will call methods on DescribeAutomationExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAutomationExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationExecutions

      default CompletableFuture<DescribeAutomationExecutionsResponse> describeAutomationExecutions()

      Provides details about all active and terminated Automation executions.

      Returns:
      A Java Future containing the result of the DescribeAutomationExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationExecutionsPaginator

      default DescribeAutomationExecutionsPublisher describeAutomationExecutionsPaginator()

      This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationExecutionsPaginator

      default DescribeAutomationExecutionsPublisher describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)

      This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation.

      Parameters:
      describeAutomationExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationExecutionsPaginator

      default DescribeAutomationExecutionsPublisher describeAutomationExecutionsPaginator(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)

      This is a variant of describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsPublisher publisher = client.describeAutomationExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest) operation.


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

      Parameters:
      describeAutomationExecutionsRequest - A Consumer that will call methods on DescribeAutomationExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationStepExecutions

      default CompletableFuture<DescribeAutomationStepExecutionsResponse> describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)

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

      Parameters:
      describeAutomationStepExecutionsRequest -
      Returns:
      A Java Future containing the result of the DescribeAutomationStepExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationStepExecutions

      default CompletableFuture<DescribeAutomationStepExecutionsResponse> describeAutomationStepExecutions(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)

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


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

      Parameters:
      describeAutomationStepExecutionsRequest - A Consumer that will call methods on DescribeAutomationStepExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAutomationStepExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationStepExecutionsPaginator

      default DescribeAutomationStepExecutionsPublisher describeAutomationStepExecutionsPaginator(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)

      This is a variant of describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation.

      Parameters:
      describeAutomationStepExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutomationStepExecutionsPaginator

      default DescribeAutomationStepExecutionsPublisher describeAutomationStepExecutionsPaginator(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)

      This is a variant of describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsPublisher publisher = client.describeAutomationStepExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest) operation.


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

      Parameters:
      describeAutomationStepExecutionsRequest - A Consumer that will call methods on DescribeAutomationStepExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailablePatches

      default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)

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

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

      Parameters:
      describeAvailablePatchesRequest -
      Returns:
      A Java Future containing the result of the DescribeAvailablePatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailablePatches

      default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)

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

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


      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 Java Future containing the result of the DescribeAvailablePatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailablePatches

      default CompletableFuture<DescribeAvailablePatchesResponse> describeAvailablePatches()

      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:
      A Java Future containing the result of the DescribeAvailablePatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailablePatchesPaginator

      default DescribeAvailablePatchesPublisher describeAvailablePatchesPaginator()

      This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailablePatchesPaginator

      default DescribeAvailablePatchesPublisher describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)

      This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation.

      Parameters:
      describeAvailablePatchesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailablePatchesPaginator

      default DescribeAvailablePatchesPublisher describeAvailablePatchesPaginator(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)

      This is a variant of describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesPublisher publisher = client.describeAvailablePatchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest) operation.


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

      Parameters:
      describeAvailablePatchesRequest - A Consumer that will call methods on DescribeAvailablePatchesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocument

      default CompletableFuture<DescribeDocumentResponse> describeDocument(DescribeDocumentRequest describeDocumentRequest)

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

      Parameters:
      describeDocumentRequest -
      Returns:
      A Java Future containing the result of the DescribeDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocument

      default CompletableFuture<DescribeDocumentResponse> describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest)

      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:
      A Java Future containing the result of the DescribeDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocumentPermission

      default CompletableFuture<DescribeDocumentPermissionResponse> describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)

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

      Parameters:
      describeDocumentPermissionRequest -
      Returns:
      A Java Future containing the result of the DescribeDocumentPermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidPermissionTypeException The permission type isn't supported. Share is the only supported permission type.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDocumentPermission

      default CompletableFuture<DescribeDocumentPermissionResponse> describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest)

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


      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:
      A Java Future containing the result of the DescribeDocumentPermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidPermissionTypeException The permission type isn't supported. Share is the only supported permission type.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectiveInstanceAssociations

      default CompletableFuture<DescribeEffectiveInstanceAssociationsResponse> describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)

      All associations for the managed nodes.

      Parameters:
      describeEffectiveInstanceAssociationsRequest -
      Returns:
      A Java Future containing the result of the DescribeEffectiveInstanceAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectiveInstanceAssociations

      default CompletableFuture<DescribeEffectiveInstanceAssociationsResponse> describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)

      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:
      A Java Future containing the result of the DescribeEffectiveInstanceAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectiveInstanceAssociationsPaginator

      default DescribeEffectiveInstanceAssociationsPublisher describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)

      This is a variant of describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation.

      Parameters:
      describeEffectiveInstanceAssociationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectiveInstanceAssociationsPaginator

      default DescribeEffectiveInstanceAssociationsPublisher describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)

      This is a variant of describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsPublisher publisher = client.describeEffectiveInstanceAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest) operation.


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

      Parameters:
      describeEffectiveInstanceAssociationsRequest - A Consumer that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectivePatchesForPatchBaseline

      default CompletableFuture<DescribeEffectivePatchesForPatchBaselineResponse> describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)

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

      Parameters:
      describeEffectivePatchesForPatchBaselineRequest -
      Returns:
      A Java Future containing the result of the DescribeEffectivePatchesForPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • UnsupportedOperatingSystemException The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectivePatchesForPatchBaseline

      default CompletableFuture<DescribeEffectivePatchesForPatchBaselineResponse> describeEffectivePatchesForPatchBaseline(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)

      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:
      A Java Future containing the result of the DescribeEffectivePatchesForPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • UnsupportedOperatingSystemException The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectivePatchesForPatchBaselinePaginator

      default DescribeEffectivePatchesForPatchBaselinePublisher describeEffectivePatchesForPatchBaselinePaginator(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)

      This is a variant of describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation.

      Parameters:
      describeEffectivePatchesForPatchBaselineRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • UnsupportedOperatingSystemException The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEffectivePatchesForPatchBaselinePaginator

      default DescribeEffectivePatchesForPatchBaselinePublisher describeEffectivePatchesForPatchBaselinePaginator(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)

      This is a variant of describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselinePublisher publisher = client.describeEffectivePatchesForPatchBaselinePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest) operation.


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

      Parameters:
      describeEffectivePatchesForPatchBaselineRequest - A Consumer that will call methods on DescribeEffectivePatchesForPatchBaselineRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • UnsupportedOperatingSystemException The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceAssociationsStatus

      default CompletableFuture<DescribeInstanceAssociationsStatusResponse> describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)

      The status of the associations for the managed nodes.

      Parameters:
      describeInstanceAssociationsStatusRequest -
      Returns:
      A Java Future containing the result of the DescribeInstanceAssociationsStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceAssociationsStatus

      default CompletableFuture<DescribeInstanceAssociationsStatusResponse> describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)

      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:
      A Java Future containing the result of the DescribeInstanceAssociationsStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceAssociationsStatusPaginator

      default DescribeInstanceAssociationsStatusPublisher describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)

      This is a variant of describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation.

      Parameters:
      describeInstanceAssociationsStatusRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceAssociationsStatusPaginator

      default DescribeInstanceAssociationsStatusPublisher describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)

      This is a variant of describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusPublisher publisher = client.describeInstanceAssociationsStatusPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest) operation.


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

      Parameters:
      describeInstanceAssociationsStatusRequest - A Consumer that will call methods on DescribeInstanceAssociationsStatusRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceInformation

      default CompletableFuture<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. 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:
      A Java Future containing the result of the DescribeInstanceInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • InvalidInstanceInformationFilterValueException The specified filter value isn't valid.
        • InvalidFilterKeyException The specified key isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceInformation

      default CompletableFuture<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. 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:
      A Java Future containing the result of the DescribeInstanceInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • InvalidInstanceInformationFilterValueException The specified filter value isn't valid.
        • InvalidFilterKeyException The specified key isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceInformation

      default CompletableFuture<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. 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:
      A Java Future containing the result of the DescribeInstanceInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • InvalidInstanceInformationFilterValueException The specified filter value isn't valid.
        • InvalidFilterKeyException The specified key isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceInformationPaginator

      default DescribeInstanceInformationPublisher describeInstanceInformationPaginator()

      This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • InvalidInstanceInformationFilterValueException The specified filter value isn't valid.
        • InvalidFilterKeyException The specified key isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceInformationPaginator

      default DescribeInstanceInformationPublisher describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)

      This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation.

      Parameters:
      describeInstanceInformationRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • InvalidInstanceInformationFilterValueException The specified filter value isn't valid.
        • InvalidFilterKeyException The specified key isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceInformationPaginator

      default DescribeInstanceInformationPublisher describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)

      This is a variant of describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationPublisher publisher = client.describeInstanceInformationPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest) operation.


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

      Parameters:
      describeInstanceInformationRequest - A Consumer that will call methods on DescribeInstanceInformationRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidNextTokenException The specified token isn't valid.
        • InvalidInstanceInformationFilterValueException The specified filter value isn't valid.
        • InvalidFilterKeyException The specified key isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStates

      default CompletableFuture<DescribeInstancePatchStatesResponse> describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)

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

      Parameters:
      describeInstancePatchStatesRequest -
      Returns:
      A Java Future containing the result of the DescribeInstancePatchStates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStates

      default CompletableFuture<DescribeInstancePatchStatesResponse> describeInstancePatchStates(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)

      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:
      A Java Future containing the result of the DescribeInstancePatchStates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStatesForPatchGroup

      default CompletableFuture<DescribeInstancePatchStatesForPatchGroupResponse> describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)

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

      Parameters:
      describeInstancePatchStatesForPatchGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeInstancePatchStatesForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStatesForPatchGroup

      default CompletableFuture<DescribeInstancePatchStatesForPatchGroupResponse> describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)

      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:
      A Java Future containing the result of the DescribeInstancePatchStatesForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStatesForPatchGroupPaginator

      default DescribeInstancePatchStatesForPatchGroupPublisher describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)

      This is a variant of describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation.

      Parameters:
      describeInstancePatchStatesForPatchGroupRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStatesForPatchGroupPaginator

      default DescribeInstancePatchStatesForPatchGroupPublisher describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)

      This is a variant of describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupPublisher publisher = client.describeInstancePatchStatesForPatchGroupPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest) operation.


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

      Parameters:
      describeInstancePatchStatesForPatchGroupRequest - A Consumer that will call methods on DescribeInstancePatchStatesForPatchGroupRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStatesPaginator

      default DescribeInstancePatchStatesPublisher describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)

      This is a variant of describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation.

      Parameters:
      describeInstancePatchStatesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchStatesPaginator

      default DescribeInstancePatchStatesPublisher describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)

      This is a variant of describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesPublisher publisher = client.describeInstancePatchStatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest) operation.


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

      Parameters:
      describeInstancePatchStatesRequest - A Consumer that will call methods on DescribeInstancePatchStatesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatches

      default CompletableFuture<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.

      Parameters:
      describeInstancePatchesRequest -
      Returns:
      A Java Future containing the result of the DescribeInstancePatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatches

      default CompletableFuture<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.


      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 Java Future containing the result of the DescribeInstancePatches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchesPaginator

      default DescribeInstancePatchesPublisher describeInstancePatchesPaginator(DescribeInstancePatchesRequest describeInstancePatchesRequest)

      This is a variant of describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation.

      Parameters:
      describeInstancePatchesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePatchesPaginator

      default DescribeInstancePatchesPublisher describeInstancePatchesPaginator(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)

      This is a variant of describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesPublisher publisher = client.describeInstancePatchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest) operation.


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

      Parameters:
      describeInstancePatchesRequest - A Consumer that will call methods on DescribeInstancePatchesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceProperties

      default CompletableFuture<DescribeInstancePropertiesResponse> describeInstanceProperties(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)

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

      Parameters:
      describeInstancePropertiesRequest -
      Returns:
      A Java Future containing the result of the DescribeInstanceProperties operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidActivationIdException The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
        • InvalidInstancePropertyFilterValueException The specified filter value isn't valid.
        • InternalServerErrorException An error occurred on the server side.
        • InvalidDocumentException The specified SSM document doesn't exist.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceProperties

      default CompletableFuture<DescribeInstancePropertiesResponse> describeInstanceProperties(Consumer<DescribeInstancePropertiesRequest.Builder> describeInstancePropertiesRequest)

      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:
      A Java Future containing the result of the DescribeInstanceProperties operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidActivationIdException The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
        • InvalidInstancePropertyFilterValueException The specified filter value isn't valid.
        • InternalServerErrorException An error occurred on the server side.
        • InvalidDocumentException The specified SSM document doesn't exist.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePropertiesPaginator

      default DescribeInstancePropertiesPublisher describeInstancePropertiesPaginator(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)

      This is a variant of describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesPublisher publisher = client.describeInstancePropertiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesPublisher publisher = client.describeInstancePropertiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation.

      Parameters:
      describeInstancePropertiesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidActivationIdException The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
        • InvalidInstancePropertyFilterValueException The specified filter value isn't valid.
        • InternalServerErrorException An error occurred on the server side.
        • InvalidDocumentException The specified SSM document doesn't exist.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstancePropertiesPaginator

      default DescribeInstancePropertiesPublisher describeInstancePropertiesPaginator(Consumer<DescribeInstancePropertiesRequest.Builder> describeInstancePropertiesRequest)

      This is a variant of describeInstanceProperties(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesPublisher publisher = client.describeInstancePropertiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInstancePropertiesPublisher publisher = client.describeInstancePropertiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInstancePropertiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the 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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidActivationIdException The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
        • InvalidInstancePropertyFilterValueException The specified filter value isn't valid.
        • InternalServerErrorException An error occurred on the server side.
        • InvalidDocumentException The specified SSM document doesn't exist.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInventoryDeletions

      default CompletableFuture<DescribeInventoryDeletionsResponse> describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)

      Describes a specific delete inventory operation.

      Parameters:
      describeInventoryDeletionsRequest -
      Returns:
      A Java Future containing the result of the DescribeInventoryDeletions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDeletionIdException The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInventoryDeletions

      default CompletableFuture<DescribeInventoryDeletionsResponse> describeInventoryDeletions(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)

      Describes a specific delete inventory operation.


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

      Parameters:
      describeInventoryDeletionsRequest - A Consumer that will call methods on DescribeInventoryDeletionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeInventoryDeletions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDeletionIdException The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInventoryDeletions

      default CompletableFuture<DescribeInventoryDeletionsResponse> describeInventoryDeletions()

      Describes a specific delete inventory operation.

      Returns:
      A Java Future containing the result of the DescribeInventoryDeletions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDeletionIdException The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInventoryDeletionsPaginator

      default DescribeInventoryDeletionsPublisher describeInventoryDeletionsPaginator()

      This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDeletionIdException The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInventoryDeletionsPaginator

      default DescribeInventoryDeletionsPublisher describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)

      This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation.

      Parameters:
      describeInventoryDeletionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDeletionIdException The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInventoryDeletionsPaginator

      default DescribeInventoryDeletionsPublisher describeInventoryDeletionsPaginator(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)

      This is a variant of describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsPublisher publisher = client.describeInventoryDeletionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest) operation.


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

      Parameters:
      describeInventoryDeletionsRequest - A Consumer that will call methods on DescribeInventoryDeletionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDeletionIdException The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTaskInvocations

      default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)

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

      Parameters:
      describeMaintenanceWindowExecutionTaskInvocationsRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowExecutionTaskInvocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTaskInvocations

      default CompletableFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResponse> describeMaintenanceWindowExecutionTaskInvocations(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)

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


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

      Parameters:
      describeMaintenanceWindowExecutionTaskInvocationsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowExecutionTaskInvocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTaskInvocationsPaginator

      default DescribeMaintenanceWindowExecutionTaskInvocationsPublisher describeMaintenanceWindowExecutionTaskInvocationsPaginator(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)

      This is a variant of describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation.

      Parameters:
      describeMaintenanceWindowExecutionTaskInvocationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTaskInvocationsPaginator

      default DescribeMaintenanceWindowExecutionTaskInvocationsPublisher describeMaintenanceWindowExecutionTaskInvocationsPaginator(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)

      This is a variant of describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsPublisher publisher = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest) operation.


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

      Parameters:
      describeMaintenanceWindowExecutionTaskInvocationsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTasks

      default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)

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

      Parameters:
      describeMaintenanceWindowExecutionTasksRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowExecutionTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTasks

      default CompletableFuture<DescribeMaintenanceWindowExecutionTasksResponse> describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)

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


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

      Parameters:
      describeMaintenanceWindowExecutionTasksRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowExecutionTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTasksPaginator

      default DescribeMaintenanceWindowExecutionTasksPublisher describeMaintenanceWindowExecutionTasksPaginator(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)

      This is a variant of describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation.

      Parameters:
      describeMaintenanceWindowExecutionTasksRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionTasksPaginator

      default DescribeMaintenanceWindowExecutionTasksPublisher describeMaintenanceWindowExecutionTasksPaginator(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)

      This is a variant of describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksPublisher publisher = client.describeMaintenanceWindowExecutionTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest) operation.


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

      Parameters:
      describeMaintenanceWindowExecutionTasksRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionTasksRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutions

      default CompletableFuture<DescribeMaintenanceWindowExecutionsResponse> describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)

      Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

      Parameters:
      describeMaintenanceWindowExecutionsRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutions

      default CompletableFuture<DescribeMaintenanceWindowExecutionsResponse> describeMaintenanceWindowExecutions(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)

      Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.


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

      Parameters:
      describeMaintenanceWindowExecutionsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionsPaginator

      default DescribeMaintenanceWindowExecutionsPublisher describeMaintenanceWindowExecutionsPaginator(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)

      This is a variant of describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation.

      Parameters:
      describeMaintenanceWindowExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowExecutionsPaginator

      default DescribeMaintenanceWindowExecutionsPublisher describeMaintenanceWindowExecutionsPaginator(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)

      This is a variant of describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsPublisher publisher = client.describeMaintenanceWindowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest) operation.


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

      Parameters:
      describeMaintenanceWindowExecutionsRequest - A Consumer that will call methods on DescribeMaintenanceWindowExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowSchedule

      default CompletableFuture<DescribeMaintenanceWindowScheduleResponse> describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)

      Retrieves information about upcoming executions of a maintenance window.

      Parameters:
      describeMaintenanceWindowScheduleRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowSchedule

      default CompletableFuture<DescribeMaintenanceWindowScheduleResponse> describeMaintenanceWindowSchedule(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)

      Retrieves information about upcoming executions of a maintenance window.


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

      Parameters:
      describeMaintenanceWindowScheduleRequest - A Consumer that will call methods on DescribeMaintenanceWindowScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowSchedulePaginator

      default DescribeMaintenanceWindowSchedulePublisher describeMaintenanceWindowSchedulePaginator(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)

      This is a variant of describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation.

      Parameters:
      describeMaintenanceWindowScheduleRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowSchedulePaginator

      default DescribeMaintenanceWindowSchedulePublisher describeMaintenanceWindowSchedulePaginator(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)

      This is a variant of describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowSchedulePublisher publisher = client.describeMaintenanceWindowSchedulePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest) operation.


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

      Parameters:
      describeMaintenanceWindowScheduleRequest - A Consumer that will call methods on DescribeMaintenanceWindowScheduleRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTargets

      default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)

      Lists the targets registered with the maintenance window.

      Parameters:
      describeMaintenanceWindowTargetsRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTargets

      default CompletableFuture<DescribeMaintenanceWindowTargetsResponse> describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)

      Lists the targets registered with the maintenance window.


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

      Parameters:
      describeMaintenanceWindowTargetsRequest - A Consumer that will call methods on DescribeMaintenanceWindowTargetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTargetsPaginator

      default DescribeMaintenanceWindowTargetsPublisher describeMaintenanceWindowTargetsPaginator(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)

      This is a variant of describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation.

      Parameters:
      describeMaintenanceWindowTargetsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTargetsPaginator

      default DescribeMaintenanceWindowTargetsPublisher describeMaintenanceWindowTargetsPaginator(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)

      This is a variant of describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsPublisher publisher = client.describeMaintenanceWindowTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest) operation.


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

      Parameters:
      describeMaintenanceWindowTargetsRequest - A Consumer that will call methods on DescribeMaintenanceWindowTargetsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTasks

      default CompletableFuture<DescribeMaintenanceWindowTasksResponse> describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)

      Lists the tasks in a maintenance window.

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

      Parameters:
      describeMaintenanceWindowTasksRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTasks

      default CompletableFuture<DescribeMaintenanceWindowTasksResponse> describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)

      Lists the tasks in a maintenance window.

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


      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 Java Future containing the result of the DescribeMaintenanceWindowTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTasksPaginator

      default DescribeMaintenanceWindowTasksPublisher describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)

      This is a variant of describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation.

      Parameters:
      describeMaintenanceWindowTasksRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowTasksPaginator

      default DescribeMaintenanceWindowTasksPublisher describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)

      This is a variant of describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksPublisher publisher = client.describeMaintenanceWindowTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest) operation.


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

      Parameters:
      describeMaintenanceWindowTasksRequest - A Consumer that will call methods on DescribeMaintenanceWindowTasksRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindows

      default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)

      Retrieves the maintenance windows in an Amazon Web Services account.

      Parameters:
      describeMaintenanceWindowsRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindows

      default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)

      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:
      A Java Future containing the result of the DescribeMaintenanceWindows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindows

      default CompletableFuture<DescribeMaintenanceWindowsResponse> describeMaintenanceWindows()

      Retrieves the maintenance windows in an Amazon Web Services account.

      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowsForTarget

      default CompletableFuture<DescribeMaintenanceWindowsForTargetResponse> describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)

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

      Parameters:
      describeMaintenanceWindowsForTargetRequest -
      Returns:
      A Java Future containing the result of the DescribeMaintenanceWindowsForTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowsForTarget

      default CompletableFuture<DescribeMaintenanceWindowsForTargetResponse> describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)

      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:
      A Java Future containing the result of the DescribeMaintenanceWindowsForTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowsForTargetPaginator

      default DescribeMaintenanceWindowsForTargetPublisher describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)

      This is a variant of describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation.

      Parameters:
      describeMaintenanceWindowsForTargetRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowsForTargetPaginator

      default DescribeMaintenanceWindowsForTargetPublisher describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)

      This is a variant of describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetPublisher publisher = client.describeMaintenanceWindowsForTargetPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest) operation.


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

      Parameters:
      describeMaintenanceWindowsForTargetRequest - A Consumer that will call methods on DescribeMaintenanceWindowsForTargetRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowsPaginator

      default DescribeMaintenanceWindowsPublisher describeMaintenanceWindowsPaginator()

      This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowsPaginator

      default DescribeMaintenanceWindowsPublisher describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)

      This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation.

      Parameters:
      describeMaintenanceWindowsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceWindowsPaginator

      default DescribeMaintenanceWindowsPublisher describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)

      This is a variant of describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsPublisher publisher = client.describeMaintenanceWindowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest) operation.


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

      Parameters:
      describeMaintenanceWindowsRequest - A Consumer that will call methods on DescribeMaintenanceWindowsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeOpsItems

      default CompletableFuture<DescribeOpsItemsResponse> describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)

      Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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

      Parameters:
      describeOpsItemsRequest -
      Returns:
      A Java Future containing the result of the DescribeOpsItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeOpsItems

      default CompletableFuture<DescribeOpsItemsResponse> describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)

      Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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


      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 Java Future containing the result of the DescribeOpsItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeOpsItemsPaginator

      default DescribeOpsItemsPublisher describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest)

      This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation.

      Parameters:
      describeOpsItemsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeOpsItemsPaginator

      default DescribeOpsItemsPublisher describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)

      This is a variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsPublisher publisher = client.describeOpsItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest) operation.


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

      Parameters:
      describeOpsItemsRequest - A Consumer that will call methods on DescribeOpsItemsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameters

      default CompletableFuture<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.

      Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

      If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.

      Parameters:
      describeParametersRequest -
      Returns:
      A Java Future containing the result of the DescribeParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameters

      default CompletableFuture<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.

      Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

      If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.


      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 Java Future containing the result of the DescribeParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameters

      default CompletableFuture<DescribeParametersResponse> describeParameters()

      Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.

      Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

      If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.

      Returns:
      A Java Future containing the result of the DescribeParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParametersPaginator

      default DescribeParametersPublisher describeParametersPaginator()

      This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeParametersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParametersPaginator

      default DescribeParametersPublisher describeParametersPaginator(DescribeParametersRequest describeParametersRequest)

      This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeParametersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation.

      Parameters:
      describeParametersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParametersPaginator

      default DescribeParametersPublisher describeParametersPaginator(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)

      This is a variant of describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeParametersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest) operation.


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

      Parameters:
      describeParametersRequest - A Consumer that will call methods on DescribeParametersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchBaselines

      default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)

      Lists the patch baselines in your Amazon Web Services account.

      Parameters:
      describePatchBaselinesRequest -
      Returns:
      A Java Future containing the result of the DescribePatchBaselines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchBaselines

      default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)

      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:
      A Java Future containing the result of the DescribePatchBaselines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchBaselines

      default CompletableFuture<DescribePatchBaselinesResponse> describePatchBaselines()

      Lists the patch baselines in your Amazon Web Services account.

      Returns:
      A Java Future containing the result of the DescribePatchBaselines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchBaselinesPaginator

      default DescribePatchBaselinesPublisher describePatchBaselinesPaginator()

      This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchBaselinesPaginator

      default DescribePatchBaselinesPublisher describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest)

      This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation.

      Parameters:
      describePatchBaselinesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchBaselinesPaginator

      default DescribePatchBaselinesPublisher describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)

      This is a variant of describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesPublisher publisher = client.describePatchBaselinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest) operation.


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

      Parameters:
      describePatchBaselinesRequest - A Consumer that will call methods on DescribePatchBaselinesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroupState

      default CompletableFuture<DescribePatchGroupStateResponse> describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)

      Returns high-level aggregated patch compliance state information for a patch group.

      Parameters:
      describePatchGroupStateRequest -
      Returns:
      A Java Future containing the result of the DescribePatchGroupState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroupState

      default CompletableFuture<DescribePatchGroupStateResponse> describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest)

      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:
      A Java Future containing the result of the DescribePatchGroupState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroups

      default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)

      Lists all patch groups that have been registered with patch baselines.

      Parameters:
      describePatchGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribePatchGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroups

      default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)

      Lists all patch groups that have been registered with patch baselines.


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

      Parameters:
      describePatchGroupsRequest - A Consumer that will call methods on DescribePatchGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePatchGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroups

      default CompletableFuture<DescribePatchGroupsResponse> describePatchGroups()

      Lists all patch groups that have been registered with patch baselines.

      Returns:
      A Java Future containing the result of the DescribePatchGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroupsPaginator

      default DescribePatchGroupsPublisher describePatchGroupsPaginator()

      This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroupsPaginator

      default DescribePatchGroupsPublisher describePatchGroupsPaginator(DescribePatchGroupsRequest describePatchGroupsRequest)

      This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation.

      Parameters:
      describePatchGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchGroupsPaginator

      default DescribePatchGroupsPublisher describePatchGroupsPaginator(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)

      This is a variant of describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsPublisher publisher = client.describePatchGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest) operation.


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

      Parameters:
      describePatchGroupsRequest - A Consumer that will call methods on DescribePatchGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchProperties

      default CompletableFuture<DescribePatchPropertiesResponse> describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)

      Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for 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:
      A Java Future containing the result of the DescribePatchProperties operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchProperties

      default CompletableFuture<DescribePatchPropertiesResponse> describePatchProperties(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)

      Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for 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:
      A Java Future containing the result of the DescribePatchProperties operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchPropertiesPaginator

      default DescribePatchPropertiesPublisher describePatchPropertiesPaginator(DescribePatchPropertiesRequest describePatchPropertiesRequest)

      This is a variant of describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation.

      Parameters:
      describePatchPropertiesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePatchPropertiesPaginator

      default DescribePatchPropertiesPublisher describePatchPropertiesPaginator(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)

      This is a variant of describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesPublisher publisher = client.describePatchPropertiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest) operation.


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

      Parameters:
      describePatchPropertiesRequest - A Consumer that will call methods on DescribePatchPropertiesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSessions

      default CompletableFuture<DescribeSessionsResponse> describeSessions(DescribeSessionsRequest describeSessionsRequest)

      Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

      Parameters:
      describeSessionsRequest -
      Returns:
      A Java Future containing the result of the DescribeSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSessions

      default CompletableFuture<DescribeSessionsResponse> describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)

      Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.


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

      Parameters:
      describeSessionsRequest - A Consumer that will call methods on DescribeSessionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSessionsPaginator

      default DescribeSessionsPublisher describeSessionsPaginator(DescribeSessionsRequest describeSessionsRequest)

      This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation.

      Parameters:
      describeSessionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSessionsPaginator

      default DescribeSessionsPublisher describeSessionsPaginator(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)

      This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.DescribeSessionsPublisher publisher = client.describeSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest) operation.


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

      Parameters:
      describeSessionsRequest - A Consumer that will call methods on DescribeSessionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateOpsItemRelatedItem

      default CompletableFuture<DisassociateOpsItemRelatedItemResponse> disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest)

      Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.

      Parameters:
      disassociateOpsItemRelatedItemRequest -
      Returns:
      A Java Future containing the result of the DisassociateOpsItemRelatedItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemRelatedItemAssociationNotFoundException The association wasn't found using the parameters you specified in the call. Verify the information and try again.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemConflictException The specified OpsItem is in the process of being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateOpsItemRelatedItem

      default CompletableFuture<DisassociateOpsItemRelatedItemResponse> disassociateOpsItemRelatedItem(Consumer<DisassociateOpsItemRelatedItemRequest.Builder> disassociateOpsItemRelatedItemRequest)

      Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.


      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:
      A Java Future containing the result of the DisassociateOpsItemRelatedItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemRelatedItemAssociationNotFoundException The association wasn't found using the parameters you specified in the call. Verify the information and try again.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemConflictException The specified OpsItem is in the process of being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAutomationExecution

      default CompletableFuture<GetAutomationExecutionResponse> getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)

      Get detailed information about a particular Automation execution.

      Parameters:
      getAutomationExecutionRequest -
      Returns:
      A Java Future containing the result of the GetAutomationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAutomationExecution

      default CompletableFuture<GetAutomationExecutionResponse> getAutomationExecution(Consumer<GetAutomationExecutionRequest.Builder> getAutomationExecutionRequest)

      Get detailed information about a particular Automation execution.


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

      Parameters:
      getAutomationExecutionRequest - A Consumer that will call methods on GetAutomationExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAutomationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalendarState

      default CompletableFuture<GetCalendarStateResponse> getCalendarState(GetCalendarStateRequest getCalendarStateRequest)

      Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

      If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

      For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      getCalendarStateRequest -
      Returns:
      A Java Future containing the result of the GetCalendarState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentTypeException The SSM document type isn't valid. Valid document types are described in the DocumentType property.
      • UnsupportedCalendarException The calendar entry contained in the specified SSM document isn't supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalendarState

      default CompletableFuture<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. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

      If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

      For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.


      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:
      A Java Future containing the result of the GetCalendarState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentTypeException The SSM document type isn't valid. Valid document types are described in the DocumentType property.
      • UnsupportedCalendarException The calendar entry contained in the specified SSM document isn't supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCommandInvocation

      default CompletableFuture<GetCommandInvocationResponse> getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)

      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:
      A Java Future containing the result of the GetCommandInvocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidPluginNameException The plugin name isn't valid.
        • InvocationDoesNotExistException The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCommandInvocation

      default CompletableFuture<GetCommandInvocationResponse> getCommandInvocation(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest)

      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:
      A Java Future containing the result of the GetCommandInvocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidPluginNameException The plugin name isn't valid.
        • InvocationDoesNotExistException The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConnectionStatus

      default CompletableFuture<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.

      Parameters:
      getConnectionStatusRequest -
      Returns:
      A Java Future containing the result of the GetConnectionStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConnectionStatus

      default CompletableFuture<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.


      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:
      A Java Future containing the result of the GetConnectionStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDefaultPatchBaseline

      default CompletableFuture<GetDefaultPatchBaselineResponse> getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)

      Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

      If you don't specify an operating system value, the default patch baseline for Windows is returned.

      Parameters:
      getDefaultPatchBaselineRequest -
      Returns:
      A Java Future containing the result of the GetDefaultPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDefaultPatchBaseline

      default CompletableFuture<GetDefaultPatchBaselineResponse> getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest)

      Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

      If you don't specify an operating system value, the default patch baseline for Windows is returned.


      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:
      A Java Future containing the result of the GetDefaultPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDefaultPatchBaseline

      default CompletableFuture<GetDefaultPatchBaselineResponse> getDefaultPatchBaseline()

      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:
      A Java Future containing the result of the GetDefaultPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDeployablePatchSnapshotForInstance

      default CompletableFuture<GetDeployablePatchSnapshotForInstanceResponse> getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)

      Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

      If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.

      Parameters:
      getDeployablePatchSnapshotForInstanceRequest -
      Returns:
      A Java Future containing the result of the GetDeployablePatchSnapshotForInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • UnsupportedOperatingSystemException The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
      • UnsupportedFeatureRequiredException Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Turning on the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDeployablePatchSnapshotForInstance

      default CompletableFuture<GetDeployablePatchSnapshotForInstanceResponse> getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest)

      Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

      If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.


      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:
      A Java Future containing the result of the GetDeployablePatchSnapshotForInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • UnsupportedOperatingSystemException The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
      • UnsupportedFeatureRequiredException Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Turning on the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDocument

      default CompletableFuture<GetDocumentResponse> getDocument(GetDocumentRequest getDocumentRequest)

      Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

      Parameters:
      getDocumentRequest -
      Returns:
      A Java Future containing the result of the GetDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDocument

      default CompletableFuture<GetDocumentResponse> getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)

      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:
      A Java Future containing the result of the GetDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventory

      default CompletableFuture<GetInventoryResponse> getInventory(GetInventoryRequest getInventoryRequest)

      Query inventory information. This includes managed node status, such as Stopped or Terminated.

      Parameters:
      getInventoryRequest -
      Returns:
      A Java Future containing the result of the GetInventory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidInventoryGroupException The specified inventory group isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • InvalidResultAttributeException The specified inventory item result attribute isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventory

      default CompletableFuture<GetInventoryResponse> getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest)

      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:
      A Java Future containing the result of the GetInventory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidInventoryGroupException The specified inventory group isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • InvalidResultAttributeException The specified inventory item result attribute isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventory

      default CompletableFuture<GetInventoryResponse> getInventory()

      Query inventory information. This includes managed node status, such as Stopped or Terminated.

      Returns:
      A Java Future containing the result of the GetInventory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidInventoryGroupException The specified inventory group isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • InvalidResultAttributeException The specified inventory item result attribute isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventoryPaginator

      default GetInventoryPublisher getInventoryPaginator()

      This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetInventoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidInventoryGroupException The specified inventory group isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • InvalidResultAttributeException The specified inventory item result attribute isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventoryPaginator

      default GetInventoryPublisher getInventoryPaginator(GetInventoryRequest getInventoryRequest)

      This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetInventoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation.

      Parameters:
      getInventoryRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidInventoryGroupException The specified inventory group isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • InvalidResultAttributeException The specified inventory item result attribute isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventoryPaginator

      default GetInventoryPublisher getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest)

      This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventoryPublisher publisher = client.getInventoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetInventoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest) operation.


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

      Parameters:
      getInventoryRequest - A Consumer that will call methods on GetInventoryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidInventoryGroupException The specified inventory group isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • InvalidResultAttributeException The specified inventory item result attribute isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventorySchema

      default CompletableFuture<GetInventorySchemaResponse> getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest)

      Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

      Parameters:
      getInventorySchemaRequest -
      Returns:
      A Java Future containing the result of the GetInventorySchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventorySchema

      default CompletableFuture<GetInventorySchemaResponse> getInventorySchema(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest)

      Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.


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

      Parameters:
      getInventorySchemaRequest - A Consumer that will call methods on GetInventorySchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInventorySchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventorySchema

      default CompletableFuture<GetInventorySchemaResponse> getInventorySchema()

      Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

      Returns:
      A Java Future containing the result of the GetInventorySchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventorySchemaPaginator

      default GetInventorySchemaPublisher getInventorySchemaPaginator()

      This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventorySchemaPaginator

      default GetInventorySchemaPublisher getInventorySchemaPaginator(GetInventorySchemaRequest getInventorySchemaRequest)

      This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation.

      Parameters:
      getInventorySchemaRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInventorySchemaPaginator

      default GetInventorySchemaPublisher getInventorySchemaPaginator(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest)

      This is a variant of getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaPublisher publisher = client.getInventorySchemaPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest) operation.


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

      Parameters:
      getInventorySchemaRequest - A Consumer that will call methods on GetInventorySchemaRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindow

      default CompletableFuture<GetMaintenanceWindowResponse> getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)

      Retrieves a maintenance window.

      Parameters:
      getMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the GetMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindow

      default CompletableFuture<GetMaintenanceWindowResponse> getMaintenanceWindow(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest)

      Retrieves a maintenance window.


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

      Parameters:
      getMaintenanceWindowRequest - A Consumer that will call methods on GetMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowExecution

      default CompletableFuture<GetMaintenanceWindowExecutionResponse> getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)

      Retrieves details about a specific a maintenance window execution.

      Parameters:
      getMaintenanceWindowExecutionRequest -
      Returns:
      A Java Future containing the result of the GetMaintenanceWindowExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowExecution

      default CompletableFuture<GetMaintenanceWindowExecutionResponse> getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest)

      Retrieves details about a specific a maintenance window execution.


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

      Parameters:
      getMaintenanceWindowExecutionRequest - A Consumer that will call methods on GetMaintenanceWindowExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMaintenanceWindowExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowExecutionTask

      default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)

      Retrieves the details about a specific task run as part of a maintenance window execution.

      Parameters:
      getMaintenanceWindowExecutionTaskRequest -
      Returns:
      A Java Future containing the result of the GetMaintenanceWindowExecutionTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowExecutionTask

      default CompletableFuture<GetMaintenanceWindowExecutionTaskResponse> getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)

      Retrieves the details about a specific task run as part of a maintenance window execution.


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

      Parameters:
      getMaintenanceWindowExecutionTaskRequest - A Consumer that will call methods on GetMaintenanceWindowExecutionTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMaintenanceWindowExecutionTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowExecutionTaskInvocation

      default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)

      Retrieves information about a specific task running on a specific target.

      Parameters:
      getMaintenanceWindowExecutionTaskInvocationRequest -
      Returns:
      A Java Future containing the result of the GetMaintenanceWindowExecutionTaskInvocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowExecutionTaskInvocation

      default CompletableFuture<GetMaintenanceWindowExecutionTaskInvocationResponse> getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)

      Retrieves information about a specific task running on a specific target.


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

      Parameters:
      getMaintenanceWindowExecutionTaskInvocationRequest - A Consumer that will call methods on GetMaintenanceWindowExecutionTaskInvocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMaintenanceWindowExecutionTaskInvocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowTask

      default CompletableFuture<GetMaintenanceWindowTaskResponse> getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)

      Retrieves the details of a maintenance window task.

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

      To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

      Parameters:
      getMaintenanceWindowTaskRequest -
      Returns:
      A Java Future containing the result of the GetMaintenanceWindowTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMaintenanceWindowTask

      default CompletableFuture<GetMaintenanceWindowTaskResponse> getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest)

      Retrieves the details of a maintenance window task.

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

      To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.


      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:
      A Java Future containing the result of the GetMaintenanceWindowTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsItem

      default CompletableFuture<GetOpsItemResponse> getOpsItem(GetOpsItemRequest getOpsItemRequest)

      Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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

      Parameters:
      getOpsItemRequest -
      Returns:
      A Java Future containing the result of the GetOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemAccessDeniedException You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsItem

      default CompletableFuture<GetOpsItemResponse> getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest)

      Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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


      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:
      A Java Future containing the result of the GetOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemAccessDeniedException You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsMetadata

      default CompletableFuture<GetOpsMetadataResponse> getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)

      View operational metadata related to an application in Application Manager.

      Parameters:
      getOpsMetadataRequest -
      Returns:
      A Java Future containing the result of the GetOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataNotFoundException The OpsMetadata object doesn't exist.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsMetadata

      default CompletableFuture<GetOpsMetadataResponse> getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest)

      View operational metadata related to an application in Application Manager.


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

      Parameters:
      getOpsMetadataRequest - A Consumer that will call methods on GetOpsMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataNotFoundException The OpsMetadata object doesn't exist.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsSummary

      default CompletableFuture<GetOpsSummaryResponse> getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)

      View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

      Parameters:
      getOpsSummaryRequest -
      Returns:
      A Java Future containing the result of the GetOpsSummary operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsSummary

      default CompletableFuture<GetOpsSummaryResponse> getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)

      View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.


      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 Java Future containing the result of the GetOpsSummary operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsSummaryPaginator

      default GetOpsSummaryPublisher getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest)

      This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation.

      Parameters:
      getOpsSummaryRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpsSummaryPaginator

      default GetOpsSummaryPublisher getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)

      This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryPublisher publisher = client.getOpsSummaryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest) operation.


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

      Parameters:
      getOpsSummaryRequest - A Consumer that will call methods on GetOpsSummaryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidTypeNameException The parameter type name isn't valid.
      • InvalidAggregatorException The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameter

      default CompletableFuture<GetParameterResponse> getParameter(GetParameterRequest getParameterRequest)

      Get information about a single parameter by specifying the parameter name.

      To get information about more than one parameter at a time, use the GetParameters operation.

      Parameters:
      getParameterRequest -
      Returns:
      A Java Future containing the result of the GetParameter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidKeyIdException The query key ID isn't valid.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • ParameterVersionNotFoundException The specified parameter version wasn't found. Verify the parameter name and version, and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameter

      default CompletableFuture<GetParameterResponse> getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)

      Get information about a single parameter by specifying the parameter name.

      To get information about more than one parameter at a time, use the GetParameters operation.


      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:
      A Java Future containing the result of the GetParameter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidKeyIdException The query key ID isn't valid.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • ParameterVersionNotFoundException The specified parameter version wasn't found. Verify the parameter name and version, and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameterHistory

      default CompletableFuture<GetParameterHistoryResponse> getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)

      Retrieves the history of all changes to a parameter.

      If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing.

      Parameters:
      getParameterHistoryRequest -
      Returns:
      A Java Future containing the result of the GetParameterHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidKeyIdException The query key ID isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameterHistory

      default CompletableFuture<GetParameterHistoryResponse> getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)

      Retrieves the history of all changes to a parameter.

      If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing.


      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 Java Future containing the result of the GetParameterHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidKeyIdException The query key ID isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameterHistoryPaginator

      default GetParameterHistoryPublisher getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)

      This is a variant of getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation.

      Parameters:
      getParameterHistoryRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidKeyIdException The query key ID isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameterHistoryPaginator

      default GetParameterHistoryPublisher getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)

      This is a variant of getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryPublisher publisher = client.getParameterHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest) operation.


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

      Parameters:
      getParameterHistoryRequest - A Consumer that will call methods on GetParameterHistoryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidKeyIdException The query key ID isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameters

      default CompletableFuture<GetParametersResponse> getParameters(GetParametersRequest getParametersRequest)

      Get information about one or more parameters by specifying multiple parameter names.

      To get information about a single parameter, you can use the GetParameter operation instead.

      Parameters:
      getParametersRequest -
      Returns:
      A Java Future containing the result of the GetParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidKeyIdException The query key ID isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParameters

      default CompletableFuture<GetParametersResponse> getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)

      Get information about one or more parameters by specifying multiple parameter names.

      To get information about a single parameter, you can use the GetParameter operation instead.


      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:
      A Java Future containing the result of the GetParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidKeyIdException The query key ID isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParametersByPath

      default CompletableFuture<GetParametersByPathResponse> getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)

      Retrieve information about one or more parameters in a specific hierarchy.

      Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

      Parameters:
      getParametersByPathRequest -
      Returns:
      A Java Future containing the result of the GetParametersByPath operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidKeyIdException The query key ID isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParametersByPath

      default CompletableFuture<GetParametersByPathResponse> getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)

      Retrieve information about one or more parameters in a specific hierarchy.

      Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.


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

      Parameters:
      getParametersByPathRequest - A Consumer that will call methods on GetParametersByPathRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetParametersByPath operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidKeyIdException The query key ID isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParametersByPathPaginator

      default GetParametersByPathPublisher getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)

      This is a variant of getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation.

      Parameters:
      getParametersByPathRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidKeyIdException The query key ID isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getParametersByPathPaginator

      default GetParametersByPathPublisher getParametersByPathPaginator(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)

      This is a variant of getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetParametersByPathPublisher publisher = client.getParametersByPathPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest) operation.


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

      Parameters:
      getParametersByPathRequest - A Consumer that will call methods on GetParametersByPathRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterKeyException The specified key isn't valid.
      • InvalidFilterOptionException The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
      • InvalidFilterValueException The filter value isn't valid. Verify the value and try again.
      • InvalidKeyIdException The query key ID isn't valid.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPatchBaseline

      default CompletableFuture<GetPatchBaselineResponse> getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)

      Retrieves information about a patch baseline.

      Parameters:
      getPatchBaselineRequest -
      Returns:
      A Java Future containing the result of the GetPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPatchBaseline

      default CompletableFuture<GetPatchBaselineResponse> getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest)

      Retrieves information about a patch baseline.


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

      Parameters:
      getPatchBaselineRequest - A Consumer that will call methods on GetPatchBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPatchBaselineForPatchGroup

      default CompletableFuture<GetPatchBaselineForPatchGroupResponse> getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)

      Retrieves the patch baseline that should be used for the specified patch group.

      Parameters:
      getPatchBaselineForPatchGroupRequest -
      Returns:
      A Java Future containing the result of the GetPatchBaselineForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPatchBaselineForPatchGroup

      default CompletableFuture<GetPatchBaselineForPatchGroupResponse> getPatchBaselineForPatchGroup(Consumer<GetPatchBaselineForPatchGroupRequest.Builder> getPatchBaselineForPatchGroupRequest)

      Retrieves the patch baseline that should be used for the specified patch group.


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

      Parameters:
      getPatchBaselineForPatchGroupRequest - A Consumer that will call methods on GetPatchBaselineForPatchGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPatchBaselineForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePolicies

      default CompletableFuture<GetResourcePoliciesResponse> getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)

      Returns an array of the Policy object.

      Parameters:
      getResourcePoliciesRequest -
      Returns:
      A Java Future containing the result of the GetResourcePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePolicies

      default CompletableFuture<GetResourcePoliciesResponse> getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)

      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:
      A Java Future containing the result of the GetResourcePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePoliciesPaginator

      default GetResourcePoliciesPublisher getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest)

      This is a variant of getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation.

      Parameters:
      getResourcePoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePoliciesPaginator

      default GetResourcePoliciesPublisher getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)

      This is a variant of getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the 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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getServiceSetting

      default CompletableFuture<GetServiceSettingResponse> getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)

      ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.

      Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

      Query the current service setting for the Amazon Web Services account.

      Parameters:
      getServiceSettingRequest - The request body of the GetServiceSetting API operation.
      Returns:
      A Java Future containing the result of the GetServiceSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ServiceSettingNotFoundException The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getServiceSetting

      default CompletableFuture<GetServiceSettingResponse> getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest)

      ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.

      Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

      Query the current service setting for the Amazon Web Services account.


      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:
      A Java Future containing the result of the GetServiceSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ServiceSettingNotFoundException The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • labelParameterVersion

      default CompletableFuture<LabelParameterVersionResponse> labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)

      A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, 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.

      Parameters:
      labelParameterVersionRequest -
      Returns:
      A Java Future containing the result of the LabelParameterVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • ParameterVersionNotFoundException The specified parameter version wasn't found. Verify the parameter name and version, and try again.
      • ParameterVersionLabelLimitExceededException A parameter version can have a maximum of ten labels.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • labelParameterVersion

      default CompletableFuture<LabelParameterVersionResponse> labelParameterVersion(Consumer<LabelParameterVersionRequest.Builder> labelParameterVersionRequest)

      A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, 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.


      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:
      A Java Future containing the result of the LabelParameterVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • ParameterVersionNotFoundException The specified parameter version wasn't found. Verify the parameter name and version, and try again.
      • ParameterVersionLabelLimitExceededException A parameter version can have a maximum of ten labels.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationVersions

      default CompletableFuture<ListAssociationVersionsResponse> listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)

      Retrieves all versions of an association for a specific association ID.

      Parameters:
      listAssociationVersionsRequest -
      Returns:
      A Java Future containing the result of the ListAssociationVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationVersions

      default CompletableFuture<ListAssociationVersionsResponse> listAssociationVersions(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)

      Retrieves all versions of an association for a specific association ID.


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

      Parameters:
      listAssociationVersionsRequest - A Consumer that will call methods on ListAssociationVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssociationVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationVersionsPaginator

      default ListAssociationVersionsPublisher listAssociationVersionsPaginator(ListAssociationVersionsRequest listAssociationVersionsRequest)

      This is a variant of listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation.

      Parameters:
      listAssociationVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationVersionsPaginator

      default ListAssociationVersionsPublisher listAssociationVersionsPaginator(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)

      This is a variant of listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsPublisher publisher = client.listAssociationVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest) operation.


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

      Parameters:
      listAssociationVersionsRequest - A Consumer that will call methods on ListAssociationVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociations

      default CompletableFuture<ListAssociationsResponse> listAssociations(ListAssociationsRequest listAssociationsRequest)

      Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

      Parameters:
      listAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociations

      default CompletableFuture<ListAssociationsResponse> listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)

      Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.


      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 Java Future containing the result of the ListAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociations

      default CompletableFuture<ListAssociationsResponse> listAssociations()

      Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

      Returns:
      A Java Future containing the result of the ListAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationsPaginator

      default ListAssociationsPublisher listAssociationsPaginator()

      This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationsPaginator

      default ListAssociationsPublisher listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)

      This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation.

      Parameters:
      listAssociationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationsPaginator

      default ListAssociationsPublisher listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)

      This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest) operation.


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

      Parameters:
      listAssociationsRequest - A Consumer that will call methods on ListAssociationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandInvocations

      default CompletableFuture<ListCommandInvocationsResponse> listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)

      An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

      Parameters:
      listCommandInvocationsRequest -
      Returns:
      A Java Future containing the result of the ListCommandInvocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandInvocations

      default CompletableFuture<ListCommandInvocationsResponse> listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)

      An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.


      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 Java Future containing the result of the ListCommandInvocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandInvocations

      default CompletableFuture<ListCommandInvocationsResponse> listCommandInvocations()

      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:
      A Java Future containing the result of the ListCommandInvocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandInvocationsPaginator

      default ListCommandInvocationsPublisher listCommandInvocationsPaginator()

      This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandInvocationsPaginator

      default ListCommandInvocationsPublisher listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest)

      This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation.

      Parameters:
      listCommandInvocationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandInvocationsPaginator

      default ListCommandInvocationsPublisher listCommandInvocationsPaginator(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)

      This is a variant of listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsPublisher publisher = client.listCommandInvocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest) operation.


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

      Parameters:
      listCommandInvocationsRequest - A Consumer that will call methods on ListCommandInvocationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommands

      default CompletableFuture<ListCommandsResponse> listCommands(ListCommandsRequest listCommandsRequest)

      Lists the commands requested by users of the Amazon Web Services account.

      Parameters:
      listCommandsRequest -
      Returns:
      A Java Future containing the result of the ListCommands operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommands

      default CompletableFuture<ListCommandsResponse> listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest)

      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:
      A Java Future containing the result of the ListCommands operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommands

      default CompletableFuture<ListCommandsResponse> listCommands()

      Lists the commands requested by users of the Amazon Web Services account.

      Returns:
      A Java Future containing the result of the ListCommands operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandsPaginator

      default ListCommandsPublisher listCommandsPaginator()

      This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandsPaginator

      default ListCommandsPublisher listCommandsPaginator(ListCommandsRequest listCommandsRequest)

      This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation.

      Parameters:
      listCommandsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommandsPaginator

      default ListCommandsPublisher listCommandsPaginator(Consumer<ListCommandsRequest.Builder> listCommandsRequest)

      This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListCommandsPublisher publisher = client.listCommandsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListCommandsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListCommandsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest) operation.


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

      Parameters:
      listCommandsRequest - A Consumer that will call methods on ListCommandsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidCommandIdException The specified command ID isn't valid. Verify the ID and try again.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidFilterKeyException The specified key isn't valid.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceItems

      default CompletableFuture<ListComplianceItemsResponse> listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)

      For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

      Parameters:
      listComplianceItemsRequest -
      Returns:
      A Java Future containing the result of the ListComplianceItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceItems

      default CompletableFuture<ListComplianceItemsResponse> listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)

      For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.


      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 Java Future containing the result of the ListComplianceItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceItemsPaginator

      default ListComplianceItemsPublisher listComplianceItemsPaginator(ListComplianceItemsRequest listComplianceItemsRequest)

      This is a variant of listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation.

      Parameters:
      listComplianceItemsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceItemsPaginator

      default ListComplianceItemsPublisher listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)

      This is a variant of listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsPublisher publisher = client.listComplianceItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest) operation.


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

      Parameters:
      listComplianceItemsRequest - A Consumer that will call methods on ListComplianceItemsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceSummaries

      default CompletableFuture<ListComplianceSummariesResponse> listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)

      Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

      Parameters:
      listComplianceSummariesRequest -
      Returns:
      A Java Future containing the result of the ListComplianceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceSummaries

      default CompletableFuture<ListComplianceSummariesResponse> listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)

      Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.


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

      Parameters:
      listComplianceSummariesRequest - A Consumer that will call methods on ListComplianceSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComplianceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceSummaries

      default CompletableFuture<ListComplianceSummariesResponse> listComplianceSummaries()

      Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

      Returns:
      A Java Future containing the result of the ListComplianceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceSummariesPaginator

      default ListComplianceSummariesPublisher listComplianceSummariesPaginator()

      This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceSummariesPaginator

      default ListComplianceSummariesPublisher listComplianceSummariesPaginator(ListComplianceSummariesRequest listComplianceSummariesRequest)

      This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation.

      Parameters:
      listComplianceSummariesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComplianceSummariesPaginator

      default ListComplianceSummariesPublisher listComplianceSummariesPaginator(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)

      This is a variant of listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesPublisher publisher = client.listComplianceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest) operation.


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

      Parameters:
      listComplianceSummariesRequest - A Consumer that will call methods on ListComplianceSummariesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentMetadataHistory

      default CompletableFuture<ListDocumentMetadataHistoryResponse> listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)

      Information about approval reviews for a version of a change template in Change Manager.

      Parameters:
      listDocumentMetadataHistoryRequest -
      Returns:
      A Java Future containing the result of the ListDocumentMetadataHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentMetadataHistory

      default CompletableFuture<ListDocumentMetadataHistoryResponse> listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest)

      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:
      A Java Future containing the result of the ListDocumentMetadataHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentVersions

      default CompletableFuture<ListDocumentVersionsResponse> listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)

      List all versions for a document.

      Parameters:
      listDocumentVersionsRequest -
      Returns:
      A Java Future containing the result of the ListDocumentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentVersions

      default CompletableFuture<ListDocumentVersionsResponse> listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)

      List all versions for a document.


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

      Parameters:
      listDocumentVersionsRequest - A Consumer that will call methods on ListDocumentVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDocumentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentVersionsPaginator

      default ListDocumentVersionsPublisher listDocumentVersionsPaginator(ListDocumentVersionsRequest listDocumentVersionsRequest)

      This is a variant of listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation.

      Parameters:
      listDocumentVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentVersionsPaginator

      default ListDocumentVersionsPublisher listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)

      This is a variant of listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsPublisher publisher = client.listDocumentVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest) operation.


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

      Parameters:
      listDocumentVersionsRequest - A Consumer that will call methods on ListDocumentVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocuments

      default CompletableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest listDocumentsRequest)

      Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

      Parameters:
      listDocumentsRequest -
      Returns:
      A Java Future containing the result of the ListDocuments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocuments

      default CompletableFuture<ListDocumentsResponse> listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)

      Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.


      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 Java Future containing the result of the ListDocuments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocuments

      default CompletableFuture<ListDocumentsResponse> listDocuments()

      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:
      A Java Future containing the result of the ListDocuments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentsPaginator

      default ListDocumentsPublisher listDocumentsPaginator()

      This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentsPaginator

      default ListDocumentsPublisher listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)

      This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation.

      Parameters:
      listDocumentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentsPaginator

      default ListDocumentsPublisher listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)

      This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListDocumentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest) operation.


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

      Parameters:
      listDocumentsRequest - A Consumer that will call methods on ListDocumentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • InvalidFilterKeyException The specified key isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInventoryEntries

      default CompletableFuture<ListInventoryEntriesResponse> listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)

      A list of inventory items returned by the request.

      Parameters:
      listInventoryEntriesRequest -
      Returns:
      A Java Future containing the result of the ListInventoryEntries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidTypeNameException The parameter type name isn't valid.
        • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInventoryEntries

      default CompletableFuture<ListInventoryEntriesResponse> listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest)

      A list of inventory items returned by the request.


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

      Parameters:
      listInventoryEntriesRequest - A Consumer that will call methods on ListInventoryEntriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInventoryEntries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidTypeNameException The parameter type name isn't valid.
        • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
        • InvalidNextTokenException The specified token isn't valid.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemEvents

      default CompletableFuture<ListOpsItemEventsResponse> listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)

      Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.

      Parameters:
      listOpsItemEventsRequest -
      Returns:
      A Java Future containing the result of the ListOpsItemEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemEvents

      default CompletableFuture<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. 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:
      A Java Future containing the result of the ListOpsItemEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemEventsPaginator

      default ListOpsItemEventsPublisher listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest)

      This is a variant of listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation.

      Parameters:
      listOpsItemEventsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemEventsPaginator

      default ListOpsItemEventsPublisher listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)

      This is a variant of listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsPublisher publisher = client.listOpsItemEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest) operation.


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

      Parameters:
      listOpsItemEventsRequest - A Consumer that will call methods on ListOpsItemEventsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemRelatedItems

      default CompletableFuture<ListOpsItemRelatedItemsResponse> listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)

      Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.

      Parameters:
      listOpsItemRelatedItemsRequest -
      Returns:
      A Java Future containing the result of the ListOpsItemRelatedItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemRelatedItems

      default CompletableFuture<ListOpsItemRelatedItemsResponse> listOpsItemRelatedItems(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)

      Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of 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:
      A Java Future containing the result of the ListOpsItemRelatedItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemRelatedItemsPaginator

      default ListOpsItemRelatedItemsPublisher listOpsItemRelatedItemsPaginator(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)

      This is a variant of listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsPublisher publisher = client.listOpsItemRelatedItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsPublisher publisher = client.listOpsItemRelatedItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation.

      Parameters:
      listOpsItemRelatedItemsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsItemRelatedItemsPaginator

      default ListOpsItemRelatedItemsPublisher listOpsItemRelatedItemsPaginator(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)

      This is a variant of listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsPublisher publisher = client.listOpsItemRelatedItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsPublisher publisher = client.listOpsItemRelatedItemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the 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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsMetadata

      default CompletableFuture<ListOpsMetadataResponse> listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)

      Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

      Parameters:
      listOpsMetadataRequest -
      Returns:
      A Java Future containing the result of the ListOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsMetadata

      default CompletableFuture<ListOpsMetadataResponse> listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)

      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:
      A Java Future containing the result of the ListOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsMetadataPaginator

      default ListOpsMetadataPublisher listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest)

      This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation.

      Parameters:
      listOpsMetadataRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOpsMetadataPaginator

      default ListOpsMetadataPublisher listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)

      This is a variant of listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataPublisher publisher = client.listOpsMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest) operation.


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

      Parameters:
      listOpsMetadataRequest - A Consumer that will call methods on ListOpsMetadataRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceComplianceSummaries

      default CompletableFuture<ListResourceComplianceSummariesResponse> listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)

      Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

      Parameters:
      listResourceComplianceSummariesRequest -
      Returns:
      A Java Future containing the result of the ListResourceComplianceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceComplianceSummaries

      default CompletableFuture<ListResourceComplianceSummariesResponse> listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)

      Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.


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

      Parameters:
      listResourceComplianceSummariesRequest - A Consumer that will call methods on ListResourceComplianceSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListResourceComplianceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceComplianceSummaries

      default CompletableFuture<ListResourceComplianceSummariesResponse> listResourceComplianceSummaries()

      Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

      Returns:
      A Java Future containing the result of the ListResourceComplianceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceComplianceSummariesPaginator

      default ListResourceComplianceSummariesPublisher listResourceComplianceSummariesPaginator()

      This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceComplianceSummariesPaginator

      default ListResourceComplianceSummariesPublisher listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)

      This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation.

      Parameters:
      listResourceComplianceSummariesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceComplianceSummariesPaginator

      default ListResourceComplianceSummariesPublisher listResourceComplianceSummariesPaginator(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)

      This is a variant of listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesPublisher publisher = client.listResourceComplianceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest) operation.


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

      Parameters:
      listResourceComplianceSummariesRequest - A Consumer that will call methods on ListResourceComplianceSummariesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidFilterException The filter name isn't valid. Verify the you entered the correct name and try again.
      • InvalidNextTokenException The specified token isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceDataSync

      default CompletableFuture<ListResourceDataSyncResponse> listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)

      Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

      The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

      Parameters:
      listResourceDataSyncRequest -
      Returns:
      A Java Future containing the result of the ListResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceDataSync

      default CompletableFuture<ListResourceDataSyncResponse> listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)

      Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

      The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.


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

      Parameters:
      listResourceDataSyncRequest - A Consumer that will call methods on ListResourceDataSyncRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceDataSync

      default CompletableFuture<ListResourceDataSyncResponse> listResourceDataSync()

      Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

      The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

      Returns:
      A Java Future containing the result of the ListResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceDataSyncPaginator

      default ListResourceDataSyncPublisher listResourceDataSyncPaginator()

      This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceDataSyncPaginator

      default ListResourceDataSyncPublisher listResourceDataSyncPaginator(ListResourceDataSyncRequest listResourceDataSyncRequest)

      This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation.

      Parameters:
      listResourceDataSyncRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceDataSyncPaginator

      default ListResourceDataSyncPublisher listResourceDataSyncPaginator(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)

      This is a variant of listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncPublisher publisher = client.listResourceDataSyncPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest) operation.


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

      Parameters:
      listResourceDataSyncRequest - A Consumer that will call methods on ListResourceDataSyncRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidNextTokenException The specified token isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns a list of the tags assigned to the specified resource.

      For information about the ID format for each supported resource type, see AddTagsToResource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns a list of the tags assigned to the specified resource.

      For information about the ID format for each supported resource type, see AddTagsToResource.


      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyDocumentPermission

      default CompletableFuture<ModifyDocumentPermissionResponse> modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)

      Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

      Parameters:
      modifyDocumentPermissionRequest -
      Returns:
      A Java Future containing the result of the ModifyDocumentPermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidPermissionTypeException The permission type isn't supported. Share is the only supported permission type.
      • DocumentPermissionLimitException The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.

        By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.

        If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.

      • DocumentLimitExceededException You can have at most 500 active SSM documents.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyDocumentPermission

      default CompletableFuture<ModifyDocumentPermissionResponse> modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest)

      Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.


      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:
      A Java Future containing the result of the ModifyDocumentPermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidPermissionTypeException The permission type isn't supported. Share is the only supported permission type.
      • DocumentPermissionLimitException The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.

        By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.

        If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.

      • DocumentLimitExceededException You can have at most 500 active SSM documents.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putComplianceItems

      default CompletableFuture<PutComplianceItemsResponse> putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)

      Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

      ComplianceType can be one of the following:

      • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

      • ExecutionType: Specify patch, association, or Custom:string.

      • ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.

      • Id: The patch, association, or custom compliance ID.

      • Title: A title.

      • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

      • Severity: A patch severity. For example, Critical.

      • DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

      • DocumentVersion: An SSM document version number. For example, 4.

      • Classification: A patch classification. For example, security updates.

      • PatchBaselineId: A patch baseline ID.

      • PatchSeverity: A patch severity. For example, Critical.

      • PatchState: A patch state. For example, InstancesWithFailedPatches.

      • PatchGroup: The name of a patch group.

      • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

      Parameters:
      putComplianceItemsRequest -
      Returns:
      A Java Future containing the result of the PutComplianceItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidItemContentException One or more content items isn't valid.
      • TotalSizeLimitExceededException The size of inventory data has exceeded the total size limit for the resource.
      • ItemSizeLimitExceededException The inventory item size has exceeded the size limit.
      • ComplianceTypeCountLimitExceededException You specified too many custom compliance types. You can specify a maximum of 10 different types.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putComplianceItems

      default CompletableFuture<PutComplianceItemsResponse> putComplianceItems(Consumer<PutComplianceItemsRequest.Builder> putComplianceItemsRequest)

      Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

      ComplianceType can be one of the following:

      • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

      • ExecutionType: Specify patch, association, or Custom:string.

      • ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.

      • Id: The patch, association, or custom compliance ID.

      • Title: A title.

      • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

      • Severity: A patch severity. For example, Critical.

      • DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

      • DocumentVersion: An SSM document version number. For example, 4.

      • Classification: A patch classification. For example, security updates.

      • PatchBaselineId: A patch baseline ID.

      • PatchSeverity: A patch severity. For example, Critical.

      • PatchState: A patch state. For example, InstancesWithFailedPatches.

      • PatchGroup: The name of a patch group.

      • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'


      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:
      A Java Future containing the result of the PutComplianceItems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidItemContentException One or more content items isn't valid.
      • TotalSizeLimitExceededException The size of inventory data has exceeded the total size limit for the resource.
      • ItemSizeLimitExceededException The inventory item size has exceeded the size limit.
      • ComplianceTypeCountLimitExceededException You specified too many custom compliance types. You can specify a maximum of 10 different types.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putInventory

      default CompletableFuture<PutInventoryResponse> putInventory(PutInventoryRequest putInventoryRequest)

      Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

      Parameters:
      putInventoryRequest -
      Returns:
      A Java Future containing the result of the PutInventory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidTypeNameException The parameter type name isn't valid.
        • InvalidItemContentException One or more content items isn't valid.
        • TotalSizeLimitExceededException The size of inventory data has exceeded the total size limit for the resource.
        • ItemSizeLimitExceededException The inventory item size has exceeded the size limit.
        • ItemContentMismatchException The inventory item has invalid content.
        • CustomSchemaCountLimitExceededException You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.
        • UnsupportedInventorySchemaVersionException Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.
        • UnsupportedInventoryItemContextException The Context attribute that you specified for the InventoryItem isn't allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.
        • InvalidInventoryItemContextException You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.
        • SubTypeCountLimitExceededException The sub-type count exceeded the limit for the inventory type.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putInventory

      default CompletableFuture<PutInventoryResponse> putInventory(Consumer<PutInventoryRequest.Builder> putInventoryRequest)

      Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.


      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:
      A Java Future containing the result of the PutInventory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidTypeNameException The parameter type name isn't valid.
        • InvalidItemContentException One or more content items isn't valid.
        • TotalSizeLimitExceededException The size of inventory data has exceeded the total size limit for the resource.
        • ItemSizeLimitExceededException The inventory item size has exceeded the size limit.
        • ItemContentMismatchException The inventory item has invalid content.
        • CustomSchemaCountLimitExceededException You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.
        • UnsupportedInventorySchemaVersionException Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.
        • UnsupportedInventoryItemContextException The Context attribute that you specified for the InventoryItem isn't allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.
        • InvalidInventoryItemContextException You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.
        • SubTypeCountLimitExceededException The sub-type count exceeded the limit for the inventory type.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putParameter

      default CompletableFuture<PutParameterResponse> putParameter(PutParameterRequest putParameterRequest)

      Add a parameter to the system.

      Parameters:
      putParameterRequest -
      Returns:
      A Java Future containing the result of the PutParameter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidKeyIdException The query key ID isn't valid.
      • ParameterLimitExceededException You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more parameters and try again.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • ParameterAlreadyExistsException The parameter already exists. You can't create duplicate parameters.
      • HierarchyLevelLimitExceededException A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.
      • HierarchyTypeMismatchException Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.
      • InvalidAllowedPatternException The request doesn't meet the regular expression requirement.
      • ParameterMaxVersionLimitExceededException Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store won't delete the version and instead presents this error message:

        An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.

        This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.

      • ParameterPatternMismatchException The parameter name isn't valid.
      • UnsupportedParameterTypeException The parameter type isn't supported.
      • PoliciesLimitExceededException You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.
      • InvalidPolicyTypeException The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
      • InvalidPolicyAttributeException A policy attribute or its value is invalid.
      • IncompatiblePolicyException There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putParameter

      default CompletableFuture<PutParameterResponse> putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest)

      Add a parameter to the system.


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

      Parameters:
      putParameterRequest - A Consumer that will call methods on PutParameterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutParameter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidKeyIdException The query key ID isn't valid.
      • ParameterLimitExceededException You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more parameters and try again.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • ParameterAlreadyExistsException The parameter already exists. You can't create duplicate parameters.
      • HierarchyLevelLimitExceededException A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.
      • HierarchyTypeMismatchException Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.
      • InvalidAllowedPatternException The request doesn't meet the regular expression requirement.
      • ParameterMaxVersionLimitExceededException Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store won't delete the version and instead presents this error message:

        An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.

        This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.

      • ParameterPatternMismatchException The parameter name isn't valid.
      • UnsupportedParameterTypeException The parameter type isn't supported.
      • PoliciesLimitExceededException You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.
      • InvalidPolicyTypeException The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
      • InvalidPolicyAttributeException A policy attribute or its value is invalid.
      • IncompatiblePolicyException There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

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

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

      • Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).

        To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.

        To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.

        While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option.

        For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide

      Parameters:
      putResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the PutResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourcePolicyLimitExceededException The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. Verify these limits and try again.
      • ResourcePolicyConflictException The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • MalformedResourcePolicyDocumentException The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.
      • ResourcePolicyNotFoundException No policies with the specified policy ID and hash could be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)

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

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

      • Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).

        To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.

        To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.

        While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option.

        For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide


      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:
      A Java Future containing the result of the PutResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
      • ResourcePolicyLimitExceededException The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. Verify these limits and try again.
      • ResourcePolicyConflictException The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.
      • ResourceNotFoundException The specified parameter to be shared could not be found.
      • MalformedResourcePolicyDocumentException The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.
      • ResourcePolicyNotFoundException No policies with the specified policy ID and hash could be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerDefaultPatchBaseline

      default CompletableFuture<RegisterDefaultPatchBaselineResponse> registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)

      Defines the default patch baseline for the relevant operating system.

      To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

      Parameters:
      registerDefaultPatchBaselineRequest -
      Returns:
      A Java Future containing the result of the RegisterDefaultPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerDefaultPatchBaseline

      default CompletableFuture<RegisterDefaultPatchBaselineResponse> registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)

      Defines the default patch baseline for the relevant operating system.

      To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.


      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:
      A Java Future containing the result of the RegisterDefaultPatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerPatchBaselineForPatchGroup

      default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)

      Registers a patch baseline for a patch group.

      Parameters:
      registerPatchBaselineForPatchGroupRequest -
      Returns:
      A Java Future containing the result of the RegisterPatchBaselineForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AlreadyExistsException Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerPatchBaselineForPatchGroup

      default CompletableFuture<RegisterPatchBaselineForPatchGroupResponse> registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest)

      Registers a patch baseline for a patch group.


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

      Parameters:
      registerPatchBaselineForPatchGroupRequest - A Consumer that will call methods on RegisterPatchBaselineForPatchGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterPatchBaselineForPatchGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AlreadyExistsException Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerTargetWithMaintenanceWindow

      default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)

      Registers a target with a maintenance window.

      Parameters:
      registerTargetWithMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the RegisterTargetWithMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerTargetWithMaintenanceWindow

      default CompletableFuture<RegisterTargetWithMaintenanceWindowResponse> registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest)

      Registers a target with a maintenance window.


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

      Parameters:
      registerTargetWithMaintenanceWindowRequest - A Consumer that will call methods on RegisterTargetWithMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterTargetWithMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerTaskWithMaintenanceWindow

      default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)

      Adds a new task to a maintenance window.

      Parameters:
      registerTaskWithMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the RegisterTaskWithMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • FeatureNotAvailableException You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service isn't available.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerTaskWithMaintenanceWindow

      default CompletableFuture<RegisterTaskWithMaintenanceWindowResponse> registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest)

      Adds a new task to a maintenance window.


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

      Parameters:
      registerTaskWithMaintenanceWindowRequest - A Consumer that will call methods on RegisterTaskWithMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterTaskWithMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • ResourceLimitExceededException Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

        For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • FeatureNotAvailableException You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service isn't available.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTagsFromResource

      default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

      Removes tag keys from the specified resource.

      Parameters:
      removeTagsFromResourceRequest -
      Returns:
      A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTagsFromResource

      default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)

      Removes tag keys from the specified resource.


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

      Parameters:
      removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceTypeException The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
      • InvalidResourceIdException The resource ID isn't valid. Verify that you entered the correct ID and try again.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetServiceSetting

      default CompletableFuture<ResetServiceSettingResponse> resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)

      ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

      Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

      Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

      Parameters:
      resetServiceSettingRequest - The request body of the ResetServiceSetting API operation.
      Returns:
      A Java Future containing the result of the ResetServiceSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ServiceSettingNotFoundException The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetServiceSetting

      default CompletableFuture<ResetServiceSettingResponse> resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest)

      ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

      Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

      Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.


      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:
      A Java Future containing the result of the ResetServiceSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ServiceSettingNotFoundException The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resumeSession

      default CompletableFuture<ResumeSessionResponse> resumeSession(ResumeSessionRequest resumeSessionRequest)

      Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

      This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

      Parameters:
      resumeSessionRequest -
      Returns:
      A Java Future containing the result of the ResumeSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resumeSession

      default CompletableFuture<ResumeSessionResponse> resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest)

      Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

      This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.


      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:
      A Java Future containing the result of the ResumeSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendAutomationSignal

      default CompletableFuture<SendAutomationSignalResponse> sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)

      Sends a signal to an Automation execution to change the current behavior or status of the execution.

      Parameters:
      sendAutomationSignalRequest -
      Returns:
      A Java Future containing the result of the SendAutomationSignal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • AutomationStepNotFoundException The specified step name and execution ID don't exist. Verify the information and try again.
      • InvalidAutomationSignalException The signal isn't valid for the current Automation execution.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendAutomationSignal

      default CompletableFuture<SendAutomationSignalResponse> sendAutomationSignal(Consumer<SendAutomationSignalRequest.Builder> sendAutomationSignalRequest)

      Sends a signal to an Automation execution to change the current behavior or status of the execution.


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

      Parameters:
      sendAutomationSignalRequest - A Consumer that will call methods on SendAutomationSignalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendAutomationSignal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • AutomationStepNotFoundException The specified step name and execution ID don't exist. Verify the information and try again.
      • InvalidAutomationSignalException The signal isn't valid for the current Automation execution.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendCommand

      default CompletableFuture<SendCommandResponse> sendCommand(SendCommandRequest sendCommandRequest)

      Runs commands on one or more managed nodes.

      Parameters:
      sendCommandRequest -
      Returns:
      A Java Future containing the result of the SendCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidDocumentException The specified SSM document doesn't exist.
        • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
        • InvalidOutputFolderException The S3 bucket doesn't exist.
        • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        • UnsupportedPlatformTypeException The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        • MaxDocumentSizeExceededException The size limit of a document is 64 KB.
        • InvalidRoleException The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
        • InvalidNotificationConfigException One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendCommand

      default CompletableFuture<SendCommandResponse> sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)

      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:
      A Java Future containing the result of the SendCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidDocumentException The specified SSM document doesn't exist.
        • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
        • InvalidOutputFolderException The S3 bucket doesn't exist.
        • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        • UnsupportedPlatformTypeException The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        • MaxDocumentSizeExceededException The size limit of a document is 64 KB.
        • InvalidRoleException The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
        • InvalidNotificationConfigException One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAssociationsOnce

      default CompletableFuture<StartAssociationsOnceResponse> startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)

      Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.

      Parameters:
      startAssociationsOnceRequest -
      Returns:
      A Java Future containing the result of the StartAssociationsOnce operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidAssociationException The association isn't valid or doesn't exist.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAssociationsOnce

      default CompletableFuture<StartAssociationsOnceResponse> startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest)

      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:
      A Java Future containing the result of the StartAssociationsOnce operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidAssociationException The association isn't valid or doesn't exist.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAutomationExecution

      default CompletableFuture<StartAutomationExecutionResponse> startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)

      Initiates execution of an Automation runbook.

      Parameters:
      startAutomationExecutionRequest -
      Returns:
      A Java Future containing the result of the StartAutomationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationDefinitionNotFoundException An Automation runbook with the specified name couldn't be found.
      • InvalidAutomationExecutionParametersException The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
      • AutomationExecutionLimitExceededException The number of simultaneously running Automation executions exceeded the allowable limit.
      • AutomationDefinitionVersionNotFoundException An Automation runbook with the specified name and version couldn't be found.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAutomationExecution

      default CompletableFuture<StartAutomationExecutionResponse> startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest)

      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:
      A Java Future containing the result of the StartAutomationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationDefinitionNotFoundException An Automation runbook with the specified name couldn't be found.
      • InvalidAutomationExecutionParametersException The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
      • AutomationExecutionLimitExceededException The number of simultaneously running Automation executions exceeded the allowable limit.
      • AutomationDefinitionVersionNotFoundException An Automation runbook with the specified name and version couldn't be found.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startChangeRequestExecution

      default CompletableFuture<StartChangeRequestExecutionResponse> startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)

      Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.

      Parameters:
      startChangeRequestExecutionRequest -
      Returns:
      A Java Future containing the result of the StartChangeRequestExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationDefinitionNotFoundException An Automation runbook with the specified name couldn't be found.
      • InvalidAutomationExecutionParametersException The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
      • AutomationExecutionLimitExceededException The number of simultaneously running Automation executions exceeded the allowable limit.
      • AutomationDefinitionVersionNotFoundException An Automation runbook with the specified name and version couldn't be found.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • InternalServerErrorException An error occurred on the server side.
      • AutomationDefinitionNotApprovedException Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startChangeRequestExecution

      default CompletableFuture<StartChangeRequestExecutionResponse> startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest)

      Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.


      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:
      A Java Future containing the result of the StartChangeRequestExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationDefinitionNotFoundException An Automation runbook with the specified name couldn't be found.
      • InvalidAutomationExecutionParametersException The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
      • AutomationExecutionLimitExceededException The number of simultaneously running Automation executions exceeded the allowable limit.
      • AutomationDefinitionVersionNotFoundException An Automation runbook with the specified name and version couldn't be found.
      • IdempotentParameterMismatchException Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.
      • InternalServerErrorException An error occurred on the server side.
      • AutomationDefinitionNotApprovedException Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSession

      default CompletableFuture<StartSessionResponse> startSession(StartSessionRequest startSessionRequest)

      Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

      Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

      Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

      Parameters:
      startSessionRequest -
      Returns:
      A Java Future containing the result of the StartSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • TargetNotConnectedException The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Setting up Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on a managed node that is located in a different account or Region
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSession

      default CompletableFuture<StartSessionResponse> startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)

      Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

      Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

      Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.


      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:
      A Java Future containing the result of the StartSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • TargetNotConnectedException The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Setting up Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on a managed node that is located in a different account or Region
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopAutomationExecution

      default CompletableFuture<StopAutomationExecutionResponse> stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)

      Stop an Automation that is currently running.

      Parameters:
      stopAutomationExecutionRequest -
      Returns:
      A Java Future containing the result of the StopAutomationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InvalidAutomationStatusUpdateException The specified update status operation isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopAutomationExecution

      default CompletableFuture<StopAutomationExecutionResponse> stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)

      Stop an Automation that is currently running.


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

      Parameters:
      stopAutomationExecutionRequest - A Consumer that will call methods on StopAutomationExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopAutomationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID.
      • InvalidAutomationStatusUpdateException The specified update status operation isn't valid.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateSession

      default CompletableFuture<TerminateSessionResponse> terminateSession(TerminateSessionRequest terminateSessionRequest)

      Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.

      Parameters:
      terminateSessionRequest -
      Returns:
      A Java Future containing the result of the TerminateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateSession

      default CompletableFuture<TerminateSessionResponse> terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest)

      Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the 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:
      A Java Future containing the result of the TerminateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unlabelParameterVersion

      default CompletableFuture<UnlabelParameterVersionResponse> unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)

      Remove a label or labels from a parameter.

      Parameters:
      unlabelParameterVersionRequest -
      Returns:
      A Java Future containing the result of the UnlabelParameterVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • ParameterVersionNotFoundException The specified parameter version wasn't found. Verify the parameter name and version, and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unlabelParameterVersion

      default CompletableFuture<UnlabelParameterVersionResponse> unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest)

      Remove a label or labels from a parameter.


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

      Parameters:
      unlabelParameterVersionRequest - A Consumer that will call methods on UnlabelParameterVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UnlabelParameterVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • ParameterNotFoundException The parameter couldn't be found. Verify the name and try again.
      • ParameterVersionNotFoundException The specified parameter version wasn't found. Verify the parameter name and version, and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssociation

      default CompletableFuture<UpdateAssociationResponse> updateAssociation(UpdateAssociationRequest updateAssociationRequest)

      Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.

      In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

      When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.

      Parameters:
      updateAssociationRequest -
      Returns:
      A Java Future containing the result of the UpdateAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidScheduleException The schedule is invalid. Verify your cron or rate expression and try again.
      • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
      • InvalidOutputLocationException The output location isn't valid or doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidUpdateException The update isn't valid.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
      • InvalidAssociationVersionException The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the invalid input: '&#36'LATEST parameter to view the latest version of the association.
      • AssociationVersionLimitExceededException You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.
      • InvalidTargetMapsException TargetMap parameter isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssociation

      default CompletableFuture<UpdateAssociationResponse> updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest)

      Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon 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:
      A Java Future containing the result of the UpdateAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidScheduleException The schedule is invalid. Verify your cron or rate expression and try again.
      • InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
      • InvalidOutputLocationException The output location isn't valid or doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • AssociationDoesNotExistException The specified association doesn't exist.
      • InvalidUpdateException The update isn't valid.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidTargetException The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
      • InvalidAssociationVersionException The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the invalid input: '&#36'LATEST parameter to view the latest version of the association.
      • AssociationVersionLimitExceededException You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.
      • InvalidTargetMapsException TargetMap parameter isn't valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssociationStatus

      default CompletableFuture<UpdateAssociationStatusResponse> updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)

      Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.

      UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.

      Parameters:
      updateAssociationStatusRequest -
      Returns:
      A Java Future containing the result of the UpdateAssociationStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidDocumentException The specified SSM document doesn't exist.
        • AssociationDoesNotExistException The specified association doesn't exist.
        • StatusUnchangedException The updated status is the same as the current status.
        • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssociationStatus

      default CompletableFuture<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.

      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:
      A Java Future containing the result of the UpdateAssociationStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InvalidDocumentException The specified SSM document doesn't exist.
        • AssociationDoesNotExistException The specified association doesn't exist.
        • StatusUnchangedException The updated status is the same as the current status.
        • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDocument

      default CompletableFuture<UpdateDocumentResponse> updateDocument(UpdateDocumentRequest updateDocumentRequest)

      Updates one or more values for an SSM document.

      Parameters:
      updateDocumentRequest -
      Returns:
      A Java Future containing the result of the UpdateDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MaxDocumentSizeExceededException The size limit of a document is 64 KB.
      • DocumentVersionLimitExceededException The document has too many versions. Delete one or more document versions and try again.
      • InternalServerErrorException An error occurred on the server side.
      • DuplicateDocumentContentException The content of the association document matches another document. Change the content of the document and try again.
      • DuplicateDocumentVersionNameException The version name has already been used in this document. Specify a different version name, and then try again.
      • InvalidDocumentContentException The content for the document isn't valid.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidDocumentSchemaVersionException The version of the document schema isn't supported.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDocument

      default CompletableFuture<UpdateDocumentResponse> updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)

      Updates one or more values for an SSM document.


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

      Parameters:
      updateDocumentRequest - A Consumer that will call methods on UpdateDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MaxDocumentSizeExceededException The size limit of a document is 64 KB.
      • DocumentVersionLimitExceededException The document has too many versions. Delete one or more document versions and try again.
      • InternalServerErrorException An error occurred on the server side.
      • DuplicateDocumentContentException The content of the association document matches another document. Change the content of the document and try again.
      • DuplicateDocumentVersionNameException The version name has already been used in this document. Specify a different version name, and then try again.
      • InvalidDocumentContentException The content for the document isn't valid.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidDocumentSchemaVersionException The version of the document schema isn't supported.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDocumentDefaultVersion

      default CompletableFuture<UpdateDocumentDefaultVersionResponse> updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)

      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:
      A Java Future containing the result of the UpdateDocumentDefaultVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidDocumentSchemaVersionException The version of the document schema isn't supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDocumentDefaultVersion

      default CompletableFuture<UpdateDocumentDefaultVersionResponse> updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest)

      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:
      A Java Future containing the result of the UpdateDocumentDefaultVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • InvalidDocumentSchemaVersionException The version of the document schema isn't supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDocumentMetadata

      default CompletableFuture<UpdateDocumentMetadataResponse> updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)

      Updates information related to approval reviews for a specific version of a change template in Change Manager.

      Parameters:
      updateDocumentMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateDocumentMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDocumentMetadata

      default CompletableFuture<UpdateDocumentMetadataResponse> updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest)

      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:
      A Java Future containing the result of the UpdateDocumentMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • InvalidDocumentException The specified SSM document doesn't exist.
      • InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
      • InvalidDocumentVersionException The document version isn't valid or doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceWindow

      default CompletableFuture<UpdateMaintenanceWindowResponse> updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)

      Updates an existing maintenance window. Only specified parameters are modified.

      The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

      Parameters:
      updateMaintenanceWindowRequest -
      Returns:
      A Java Future containing the result of the UpdateMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceWindow

      default CompletableFuture<UpdateMaintenanceWindowResponse> updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest)

      Updates an existing maintenance window. Only specified parameters are modified.

      The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.


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

      Parameters:
      updateMaintenanceWindowRequest - A Consumer that will call methods on UpdateMaintenanceWindowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMaintenanceWindow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceWindowTarget

      default CompletableFuture<UpdateMaintenanceWindowTargetResponse> updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)

      Modifies the target of an existing maintenance window. You can change the following:

      • Name

      • Description

      • Owner

      • IDs for an ID target

      • Tags for a Tag target

      • From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

      If a parameter is null, then the corresponding field isn't modified.

      Parameters:
      updateMaintenanceWindowTargetRequest -
      Returns:
      A Java Future containing the result of the UpdateMaintenanceWindowTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceWindowTarget

      default CompletableFuture<UpdateMaintenanceWindowTargetResponse> updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest)

      Modifies the target of an existing maintenance window. You can change the following:

      • Name

      • Description

      • Owner

      • IDs for an ID target

      • Tags for a Tag target

      • From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

      If a parameter is null, then the corresponding field 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:
      A Java Future containing the result of the UpdateMaintenanceWindowTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceWindowTask

      default CompletableFuture<UpdateMaintenanceWindowTaskResponse> updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)

      Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:

      • TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

      • ServiceRoleArn

      • TaskInvocationParameters

      • Priority

      • MaxConcurrency

      • MaxErrors

      One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, 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:
      A Java Future containing the result of the UpdateMaintenanceWindowTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceWindowTask

      default CompletableFuture<UpdateMaintenanceWindowTaskResponse> updateMaintenanceWindowTask(Consumer<UpdateMaintenanceWindowTaskRequest.Builder> updateMaintenanceWindowTaskRequest)

      Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:

      • TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

      • ServiceRoleArn

      • TaskInvocationParameters

      • Priority

      • MaxConcurrency

      • MaxErrors

      One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, 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:
      A Java Future containing the result of the UpdateMaintenanceWindowTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateManagedInstanceRole

      default CompletableFuture<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). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.

      Parameters:
      updateManagedInstanceRoleRequest -
      Returns:
      A Java Future containing the result of the UpdateManagedInstanceRole operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InternalServerErrorException An error occurred on the server side.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateManagedInstanceRole

      default CompletableFuture<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). 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:
      A Java Future containing the result of the UpdateManagedInstanceRole operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInstanceIdException The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        • InternalServerErrorException An error occurred on the server side.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateOpsItem

      default CompletableFuture<UpdateOpsItemResponse> updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)

      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:
      A Java Future containing the result of the UpdateOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemAlreadyExistsException The OpsItem already exists.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemAccessDeniedException You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
      • OpsItemConflictException The specified OpsItem is in the process of being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateOpsItem

      default CompletableFuture<UpdateOpsItemResponse> updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest)

      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:
      A Java Future containing the result of the UpdateOpsItem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again.
      • OpsItemAlreadyExistsException The OpsItem already exists.
      • OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas.
      • OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again.
      • OpsItemAccessDeniedException You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
      • OpsItemConflictException The specified OpsItem is in the process of being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateOpsMetadata

      default CompletableFuture<UpdateOpsMetadataResponse> updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)

      Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

      Parameters:
      updateOpsMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataNotFoundException The OpsMetadata object doesn't exist.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • OpsMetadataKeyLimitExceededException The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.
      • OpsMetadataTooManyUpdatesException The system is processing too many concurrent updates. Wait a few moments and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateOpsMetadata

      default CompletableFuture<UpdateOpsMetadataResponse> updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest)

      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:
      A Java Future containing the result of the UpdateOpsMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OpsMetadataNotFoundException The OpsMetadata object doesn't exist.
      • OpsMetadataInvalidArgumentException One of the arguments passed is invalid.
      • OpsMetadataKeyLimitExceededException The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.
      • OpsMetadataTooManyUpdatesException The system is processing too many concurrent updates. Wait a few moments and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePatchBaseline

      default CompletableFuture<UpdatePatchBaselineResponse> updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)

      Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

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

      Parameters:
      updatePatchBaselineRequest -
      Returns:
      A Java Future containing the result of the UpdatePatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePatchBaseline

      default CompletableFuture<UpdatePatchBaselineResponse> updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)

      Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

      For information about valid key-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:
      A Java Future containing the result of the UpdatePatchBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

        For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateResourceDataSync

      default CompletableFuture<UpdateResourceDataSyncResponse> updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)

      Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my 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:
      A Java Future containing the result of the UpdateResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • ResourceDataSyncConflictException Another UpdateResourceDataSync request is being processed. Wait a few minutes and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateResourceDataSync

      default CompletableFuture<UpdateResourceDataSyncResponse> updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest)

      Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my 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:
      A Java Future containing the result of the UpdateResourceDataSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceDataSyncNotFoundException The specified sync name wasn't found.
      • ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid.
      • ResourceDataSyncConflictException Another UpdateResourceDataSync request is being processed. Wait a few minutes and try again.
      • InternalServerErrorException An error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateServiceSetting

      default CompletableFuture<UpdateServiceSettingResponse> updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)

      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:
      A Java Future containing the result of the UpdateServiceSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ServiceSettingNotFoundException The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateServiceSetting

      default CompletableFuture<UpdateServiceSettingResponse> updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest)

      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:
      A Java Future containing the result of the UpdateServiceSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException An error occurred on the server side.
      • ServiceSettingNotFoundException The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
      • TooManyUpdatesException There are concurrent updates for a resource that supports one update at a time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default SsmAsyncWaiter waiter()
      Create an instance of SsmAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of SsmAsyncWaiter

    • 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

    • create

      static SsmAsyncClient create()
      Create a SsmAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SsmAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SsmAsyncClient.