Package software.amazon.awssdk.services.backup

Interface BackupAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BackupAsyncClient extends AwsClient
Service client for accessing AWS Backup asynchronously. This can be created using the static builder() method. Backup

Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

  • Field Details

  • Method Details

    • cancelLegalHold

      default CompletableFuture<CancelLegalHoldResponse> cancelLegalHold(CancelLegalHoldRequest cancelLegalHoldRequest)

      This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

      Parameters:
      cancelLegalHoldRequest -
      Returns:
      A Java Future containing the result of the CancelLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidResourceStateException Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelLegalHold

      default CompletableFuture<CancelLegalHoldResponse> cancelLegalHold(Consumer<CancelLegalHoldRequest.Builder> cancelLegalHoldRequest)

      This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.


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

      Parameters:
      cancelLegalHoldRequest - A Consumer that will call methods on CancelLegalHoldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidResourceStateException Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackupPlan

      default CompletableFuture<CreateBackupPlanResponse> createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)

      Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.

      If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

      Parameters:
      createBackupPlanRequest -
      Returns:
      A Java Future containing the result of the CreateBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • AlreadyExistsException The required resource already exists.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackupPlan

      default CompletableFuture<CreateBackupPlanResponse> createBackupPlan(Consumer<CreateBackupPlanRequest.Builder> createBackupPlanRequest)

      Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.

      If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.


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

      Parameters:
      createBackupPlanRequest - A Consumer that will call methods on CreateBackupPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • AlreadyExistsException The required resource already exists.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackupSelection

      default CompletableFuture<CreateBackupSelectionResponse> createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)

      Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.

      Parameters:
      createBackupSelectionRequest -
      Returns:
      A Java Future containing the result of the CreateBackupSelection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • AlreadyExistsException The required resource already exists.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackupSelection

      default CompletableFuture<CreateBackupSelectionResponse> createBackupSelection(Consumer<CreateBackupSelectionRequest.Builder> createBackupSelectionRequest)

      Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.


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

      Parameters:
      createBackupSelectionRequest - A Consumer that will call methods on CreateBackupSelectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBackupSelection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • AlreadyExistsException The required resource already exists.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackupVault

      default CompletableFuture<CreateBackupVaultResponse> createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)

      Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

      Do not include sensitive data, such as passport numbers, in the name of a backup vault.

      Parameters:
      createBackupVaultRequest -
      Returns:
      A Java Future containing the result of the CreateBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • AlreadyExistsException The required resource already exists.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackupVault

      default CompletableFuture<CreateBackupVaultResponse> createBackupVault(Consumer<CreateBackupVaultRequest.Builder> createBackupVaultRequest)

      Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

      Do not include sensitive data, such as passport numbers, in the name of a backup vault.


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

      Parameters:
      createBackupVaultRequest - A Consumer that will call methods on CreateBackupVaultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • AlreadyExistsException The required resource already exists.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFramework

      default CompletableFuture<CreateFrameworkResponse> createFramework(CreateFrameworkRequest createFrameworkRequest)

      Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

      Parameters:
      createFrameworkRequest -
      Returns:
      A Java Future containing the result of the CreateFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFramework

      default CompletableFuture<CreateFrameworkResponse> createFramework(Consumer<CreateFrameworkRequest.Builder> createFrameworkRequest)

      Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.


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

      Parameters:
      createFrameworkRequest - A Consumer that will call methods on CreateFrameworkRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLegalHold

      default CompletableFuture<CreateLegalHoldResponse> createLegalHold(CreateLegalHoldRequest createLegalHoldRequest)

      This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

      Parameters:
      createLegalHoldRequest -
      Returns:
      A Java Future containing the result of the CreateLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLegalHold

      default CompletableFuture<CreateLegalHoldResponse> createLegalHold(Consumer<CreateLegalHoldRequest.Builder> createLegalHoldRequest)

      This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.


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

      Parameters:
      createLegalHoldRequest - A Consumer that will call methods on CreateLegalHoldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLogicallyAirGappedBackupVault

      default CompletableFuture<CreateLogicallyAirGappedBackupVaultResponse> createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest)

      This request creates a logical container to where backups may be copied.

      This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

      Do not include sensitive data, such as passport numbers, in the name of a backup vault.

      Parameters:
      createLogicallyAirGappedBackupVaultRequest -
      Returns:
      A Java Future containing the result of the CreateLogicallyAirGappedBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLogicallyAirGappedBackupVault

      default CompletableFuture<CreateLogicallyAirGappedBackupVaultResponse> createLogicallyAirGappedBackupVault(Consumer<CreateLogicallyAirGappedBackupVaultRequest.Builder> createLogicallyAirGappedBackupVaultRequest)

      This request creates a logical container to where backups may be copied.

      This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

      Do not include sensitive data, such as passport numbers, in the name of a backup vault.


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

      Parameters:
      createLogicallyAirGappedBackupVaultRequest - A Consumer that will call methods on CreateLogicallyAirGappedBackupVaultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLogicallyAirGappedBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createReportPlan

      default CompletableFuture<CreateReportPlanResponse> createReportPlan(CreateReportPlanRequest createReportPlanRequest)

      Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

      If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

      Parameters:
      createReportPlanRequest -
      Returns:
      A Java Future containing the result of the CreateReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createReportPlan

      default CompletableFuture<CreateReportPlanResponse> createReportPlan(Consumer<CreateReportPlanRequest.Builder> createReportPlanRequest)

      Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

      If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.


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

      Parameters:
      createReportPlanRequest - A Consumer that will call methods on CreateReportPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupPlan

      default CompletableFuture<DeleteBackupPlanResponse> deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)

      Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

      Parameters:
      deleteBackupPlanRequest -
      Returns:
      A Java Future containing the result of the DeleteBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupPlan

      default CompletableFuture<DeleteBackupPlanResponse> deleteBackupPlan(Consumer<DeleteBackupPlanRequest.Builder> deleteBackupPlanRequest)

      Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.


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

      Parameters:
      deleteBackupPlanRequest - A Consumer that will call methods on DeleteBackupPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupSelection

      default CompletableFuture<DeleteBackupSelectionResponse> deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)

      Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

      Parameters:
      deleteBackupSelectionRequest -
      Returns:
      A Java Future containing the result of the DeleteBackupSelection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupSelection

      default CompletableFuture<DeleteBackupSelectionResponse> deleteBackupSelection(Consumer<DeleteBackupSelectionRequest.Builder> deleteBackupSelectionRequest)

      Deletes the resource selection associated with a backup plan that is specified by the SelectionId.


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

      Parameters:
      deleteBackupSelectionRequest - A Consumer that will call methods on DeleteBackupSelectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBackupSelection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVault

      default CompletableFuture<DeleteBackupVaultResponse> deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)

      Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

      Parameters:
      deleteBackupVaultRequest -
      Returns:
      A Java Future containing the result of the DeleteBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVault

      default CompletableFuture<DeleteBackupVaultResponse> deleteBackupVault(Consumer<DeleteBackupVaultRequest.Builder> deleteBackupVaultRequest)

      Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.


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

      Parameters:
      deleteBackupVaultRequest - A Consumer that will call methods on DeleteBackupVaultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVaultAccessPolicy

      default CompletableFuture<DeleteBackupVaultAccessPolicyResponse> deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)

      Deletes the policy document that manages permissions on a backup vault.

      Parameters:
      deleteBackupVaultAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteBackupVaultAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVaultAccessPolicy

      default CompletableFuture<DeleteBackupVaultAccessPolicyResponse> deleteBackupVaultAccessPolicy(Consumer<DeleteBackupVaultAccessPolicyRequest.Builder> deleteBackupVaultAccessPolicyRequest)

      Deletes the policy document that manages permissions on a backup vault.


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

      Parameters:
      deleteBackupVaultAccessPolicyRequest - A Consumer that will call methods on DeleteBackupVaultAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBackupVaultAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVaultLockConfiguration

      default CompletableFuture<DeleteBackupVaultLockConfigurationResponse> deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)

      Deletes Backup Vault Lock from a backup vault specified by a backup vault name.

      If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.

      Parameters:
      deleteBackupVaultLockConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteBackupVaultLockConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVaultLockConfiguration

      default CompletableFuture<DeleteBackupVaultLockConfigurationResponse> deleteBackupVaultLockConfiguration(Consumer<DeleteBackupVaultLockConfigurationRequest.Builder> deleteBackupVaultLockConfigurationRequest)

      Deletes Backup Vault Lock from a backup vault specified by a backup vault name.

      If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.


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

      Parameters:
      deleteBackupVaultLockConfigurationRequest - A Consumer that will call methods on DeleteBackupVaultLockConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBackupVaultLockConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVaultNotifications

      default CompletableFuture<DeleteBackupVaultNotificationsResponse> deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)

      Deletes event notifications for the specified backup vault.

      Parameters:
      deleteBackupVaultNotificationsRequest -
      Returns:
      A Java Future containing the result of the DeleteBackupVaultNotifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackupVaultNotifications

      default CompletableFuture<DeleteBackupVaultNotificationsResponse> deleteBackupVaultNotifications(Consumer<DeleteBackupVaultNotificationsRequest.Builder> deleteBackupVaultNotificationsRequest)

      Deletes event notifications for the specified backup vault.


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

      Parameters:
      deleteBackupVaultNotificationsRequest - A Consumer that will call methods on DeleteBackupVaultNotificationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBackupVaultNotifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFramework

      default CompletableFuture<DeleteFrameworkResponse> deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)

      Deletes the framework specified by a framework name.

      Parameters:
      deleteFrameworkRequest -
      Returns:
      A Java Future containing the result of the DeleteFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFramework

      default CompletableFuture<DeleteFrameworkResponse> deleteFramework(Consumer<DeleteFrameworkRequest.Builder> deleteFrameworkRequest)

      Deletes the framework specified by a framework name.


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

      Parameters:
      deleteFrameworkRequest - A Consumer that will call methods on DeleteFrameworkRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRecoveryPoint

      default CompletableFuture<DeleteRecoveryPointResponse> deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)

      Deletes the recovery point specified by a recovery point ID.

      If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.

      When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.

      EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions.

      If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.

      Parameters:
      deleteRecoveryPointRequest -
      Returns:
      A Java Future containing the result of the DeleteRecoveryPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidResourceStateException Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRecoveryPoint

      default CompletableFuture<DeleteRecoveryPointResponse> deleteRecoveryPoint(Consumer<DeleteRecoveryPointRequest.Builder> deleteRecoveryPointRequest)

      Deletes the recovery point specified by a recovery point ID.

      If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.

      When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.

      EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions.

      If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.


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

      Parameters:
      deleteRecoveryPointRequest - A Consumer that will call methods on DeleteRecoveryPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRecoveryPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidResourceStateException Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteReportPlan

      default CompletableFuture<DeleteReportPlanResponse> deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)

      Deletes the report plan specified by a report plan name.

      Parameters:
      deleteReportPlanRequest -
      Returns:
      A Java Future containing the result of the DeleteReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteReportPlan

      default CompletableFuture<DeleteReportPlanResponse> deleteReportPlan(Consumer<DeleteReportPlanRequest.Builder> deleteReportPlanRequest)

      Deletes the report plan specified by a report plan name.


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

      Parameters:
      deleteReportPlanRequest - A Consumer that will call methods on DeleteReportPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupJob

      default CompletableFuture<DescribeBackupJobResponse> describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)

      Returns backup job details for the specified BackupJobId.

      Parameters:
      describeBackupJobRequest -
      Returns:
      A Java Future containing the result of the DescribeBackupJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • DependencyFailureException A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupJob

      default CompletableFuture<DescribeBackupJobResponse> describeBackupJob(Consumer<DescribeBackupJobRequest.Builder> describeBackupJobRequest)

      Returns backup job details for the specified BackupJobId.


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

      Parameters:
      describeBackupJobRequest - A Consumer that will call methods on DescribeBackupJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeBackupJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • DependencyFailureException A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupVault

      default CompletableFuture<DescribeBackupVaultResponse> describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)

      Returns metadata about a backup vault specified by its name.

      Parameters:
      describeBackupVaultRequest -
      Returns:
      A Java Future containing the result of the DescribeBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupVault

      default CompletableFuture<DescribeBackupVaultResponse> describeBackupVault(Consumer<DescribeBackupVaultRequest.Builder> describeBackupVaultRequest)

      Returns metadata about a backup vault specified by its name.


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

      Parameters:
      describeBackupVaultRequest - A Consumer that will call methods on DescribeBackupVaultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCopyJob

      default CompletableFuture<DescribeCopyJobResponse> describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)

      Returns metadata associated with creating a copy of a resource.

      Parameters:
      describeCopyJobRequest -
      Returns:
      A Java Future containing the result of the DescribeCopyJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCopyJob

      default CompletableFuture<DescribeCopyJobResponse> describeCopyJob(Consumer<DescribeCopyJobRequest.Builder> describeCopyJobRequest)

      Returns metadata associated with creating a copy of a resource.


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

      Parameters:
      describeCopyJobRequest - A Consumer that will call methods on DescribeCopyJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCopyJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFramework

      default CompletableFuture<DescribeFrameworkResponse> describeFramework(DescribeFrameworkRequest describeFrameworkRequest)

      Returns the framework details for the specified FrameworkName.

      Parameters:
      describeFrameworkRequest -
      Returns:
      A Java Future containing the result of the DescribeFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFramework

      default CompletableFuture<DescribeFrameworkResponse> describeFramework(Consumer<DescribeFrameworkRequest.Builder> describeFrameworkRequest)

      Returns the framework details for the specified FrameworkName.


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

      Parameters:
      describeFrameworkRequest - A Consumer that will call methods on DescribeFrameworkRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGlobalSettings

      default CompletableFuture<DescribeGlobalSettingsResponse> describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)

      Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2

      Parameters:
      describeGlobalSettingsRequest -
      Returns:
      A Java Future containing the result of the DescribeGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGlobalSettings

      default CompletableFuture<DescribeGlobalSettingsResponse> describeGlobalSettings(Consumer<DescribeGlobalSettingsRequest.Builder> describeGlobalSettingsRequest)

      Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2


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

      Parameters:
      describeGlobalSettingsRequest - A Consumer that will call methods on DescribeGlobalSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProtectedResource

      default CompletableFuture<DescribeProtectedResourceResponse> describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)

      Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.

      Parameters:
      describeProtectedResourceRequest -
      Returns:
      A Java Future containing the result of the DescribeProtectedResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProtectedResource

      default CompletableFuture<DescribeProtectedResourceResponse> describeProtectedResource(Consumer<DescribeProtectedResourceRequest.Builder> describeProtectedResourceRequest)

      Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.


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

      Parameters:
      describeProtectedResourceRequest - A Consumer that will call methods on DescribeProtectedResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeProtectedResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRecoveryPoint

      default CompletableFuture<DescribeRecoveryPointResponse> describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)

      Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

      Parameters:
      describeRecoveryPointRequest -
      Returns:
      A Java Future containing the result of the DescribeRecoveryPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRecoveryPoint

      default CompletableFuture<DescribeRecoveryPointResponse> describeRecoveryPoint(Consumer<DescribeRecoveryPointRequest.Builder> describeRecoveryPointRequest)

      Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.


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

      Parameters:
      describeRecoveryPointRequest - A Consumer that will call methods on DescribeRecoveryPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRecoveryPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRegionSettings

      default CompletableFuture<DescribeRegionSettingsResponse> describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)

      Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.

      Parameters:
      describeRegionSettingsRequest -
      Returns:
      A Java Future containing the result of the DescribeRegionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRegionSettings

      default CompletableFuture<DescribeRegionSettingsResponse> describeRegionSettings(Consumer<DescribeRegionSettingsRequest.Builder> describeRegionSettingsRequest)

      Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.


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

      Parameters:
      describeRegionSettingsRequest - A Consumer that will call methods on DescribeRegionSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRegionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReportJob

      default CompletableFuture<DescribeReportJobResponse> describeReportJob(DescribeReportJobRequest describeReportJobRequest)

      Returns the details associated with creating a report as specified by its ReportJobId.

      Parameters:
      describeReportJobRequest -
      Returns:
      A Java Future containing the result of the DescribeReportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReportJob

      default CompletableFuture<DescribeReportJobResponse> describeReportJob(Consumer<DescribeReportJobRequest.Builder> describeReportJobRequest)

      Returns the details associated with creating a report as specified by its ReportJobId.


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

      Parameters:
      describeReportJobRequest - A Consumer that will call methods on DescribeReportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeReportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReportPlan

      default CompletableFuture<DescribeReportPlanResponse> describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)

      Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

      Parameters:
      describeReportPlanRequest -
      Returns:
      A Java Future containing the result of the DescribeReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReportPlan

      default CompletableFuture<DescribeReportPlanResponse> describeReportPlan(Consumer<DescribeReportPlanRequest.Builder> describeReportPlanRequest)

      Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.


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

      Parameters:
      describeReportPlanRequest - A Consumer that will call methods on DescribeReportPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRestoreJob

      default CompletableFuture<DescribeRestoreJobResponse> describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)

      Returns metadata associated with a restore job that is specified by a job ID.

      Parameters:
      describeRestoreJobRequest -
      Returns:
      A Java Future containing the result of the DescribeRestoreJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • DependencyFailureException A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRestoreJob

      default CompletableFuture<DescribeRestoreJobResponse> describeRestoreJob(Consumer<DescribeRestoreJobRequest.Builder> describeRestoreJobRequest)

      Returns metadata associated with a restore job that is specified by a job ID.


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

      Parameters:
      describeRestoreJobRequest - A Consumer that will call methods on DescribeRestoreJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRestoreJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • DependencyFailureException A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateRecoveryPoint

      default CompletableFuture<DisassociateRecoveryPointResponse> disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)

      Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.

      Does not support snapshot backup recovery points.

      Parameters:
      disassociateRecoveryPointRequest -
      Returns:
      A Java Future containing the result of the DisassociateRecoveryPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidResourceStateException Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateRecoveryPoint

      default CompletableFuture<DisassociateRecoveryPointResponse> disassociateRecoveryPoint(Consumer<DisassociateRecoveryPointRequest.Builder> disassociateRecoveryPointRequest)

      Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.

      Does not support snapshot backup recovery points.


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

      Parameters:
      disassociateRecoveryPointRequest - A Consumer that will call methods on DisassociateRecoveryPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateRecoveryPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidResourceStateException Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateRecoveryPointFromParent

      default CompletableFuture<DisassociateRecoveryPointFromParentResponse> disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest)

      This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.

      Parameters:
      disassociateRecoveryPointFromParentRequest -
      Returns:
      A Java Future containing the result of the DisassociateRecoveryPointFromParent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateRecoveryPointFromParent

      default CompletableFuture<DisassociateRecoveryPointFromParentResponse> disassociateRecoveryPointFromParent(Consumer<DisassociateRecoveryPointFromParentRequest.Builder> disassociateRecoveryPointFromParentRequest)

      This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.


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

      Parameters:
      disassociateRecoveryPointFromParentRequest - A Consumer that will call methods on DisassociateRecoveryPointFromParentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateRecoveryPointFromParent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportBackupPlanTemplate

      default CompletableFuture<ExportBackupPlanTemplateResponse> exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)

      Returns the backup plan that is specified by the plan ID as a backup template.

      Parameters:
      exportBackupPlanTemplateRequest -
      Returns:
      A Java Future containing the result of the ExportBackupPlanTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportBackupPlanTemplate

      default CompletableFuture<ExportBackupPlanTemplateResponse> exportBackupPlanTemplate(Consumer<ExportBackupPlanTemplateRequest.Builder> exportBackupPlanTemplateRequest)

      Returns the backup plan that is specified by the plan ID as a backup template.


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

      Parameters:
      exportBackupPlanTemplateRequest - A Consumer that will call methods on ExportBackupPlanTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportBackupPlanTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupPlan

      default CompletableFuture<GetBackupPlanResponse> getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)

      Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

      Parameters:
      getBackupPlanRequest -
      Returns:
      A Java Future containing the result of the GetBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupPlan

      default CompletableFuture<GetBackupPlanResponse> getBackupPlan(Consumer<GetBackupPlanRequest.Builder> getBackupPlanRequest)

      Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.


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

      Parameters:
      getBackupPlanRequest - A Consumer that will call methods on GetBackupPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupPlanFromJSON

      default CompletableFuture<GetBackupPlanFromJsonResponse> getBackupPlanFromJSON(GetBackupPlanFromJsonRequest getBackupPlanFromJsonRequest)

      Returns a valid JSON document specifying a backup plan or an error.

      Parameters:
      getBackupPlanFromJsonRequest -
      Returns:
      A Java Future containing the result of the GetBackupPlanFromJSON operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupPlanFromJSON

      default CompletableFuture<GetBackupPlanFromJsonResponse> getBackupPlanFromJSON(Consumer<GetBackupPlanFromJsonRequest.Builder> getBackupPlanFromJsonRequest)

      Returns a valid JSON document specifying a backup plan or an error.


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

      Parameters:
      getBackupPlanFromJsonRequest - A Consumer that will call methods on GetBackupPlanFromJsonRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBackupPlanFromJSON operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupPlanFromTemplate

      default CompletableFuture<GetBackupPlanFromTemplateResponse> getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)

      Returns the template specified by its templateId as a backup plan.

      Parameters:
      getBackupPlanFromTemplateRequest -
      Returns:
      A Java Future containing the result of the GetBackupPlanFromTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupPlanFromTemplate

      default CompletableFuture<GetBackupPlanFromTemplateResponse> getBackupPlanFromTemplate(Consumer<GetBackupPlanFromTemplateRequest.Builder> getBackupPlanFromTemplateRequest)

      Returns the template specified by its templateId as a backup plan.


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

      Parameters:
      getBackupPlanFromTemplateRequest - A Consumer that will call methods on GetBackupPlanFromTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBackupPlanFromTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupSelection

      default CompletableFuture<GetBackupSelectionResponse> getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest)

      Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

      Parameters:
      getBackupSelectionRequest -
      Returns:
      A Java Future containing the result of the GetBackupSelection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupSelection

      default CompletableFuture<GetBackupSelectionResponse> getBackupSelection(Consumer<GetBackupSelectionRequest.Builder> getBackupSelectionRequest)

      Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.


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

      Parameters:
      getBackupSelectionRequest - A Consumer that will call methods on GetBackupSelectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBackupSelection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupVaultAccessPolicy

      default CompletableFuture<GetBackupVaultAccessPolicyResponse> getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)

      Returns the access policy document that is associated with the named backup vault.

      Parameters:
      getBackupVaultAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the GetBackupVaultAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupVaultAccessPolicy

      default CompletableFuture<GetBackupVaultAccessPolicyResponse> getBackupVaultAccessPolicy(Consumer<GetBackupVaultAccessPolicyRequest.Builder> getBackupVaultAccessPolicyRequest)

      Returns the access policy document that is associated with the named backup vault.


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

      Parameters:
      getBackupVaultAccessPolicyRequest - A Consumer that will call methods on GetBackupVaultAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBackupVaultAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupVaultNotifications

      default CompletableFuture<GetBackupVaultNotificationsResponse> getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)

      Returns event notifications for the specified backup vault.

      Parameters:
      getBackupVaultNotificationsRequest -
      Returns:
      A Java Future containing the result of the GetBackupVaultNotifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBackupVaultNotifications

      default CompletableFuture<GetBackupVaultNotificationsResponse> getBackupVaultNotifications(Consumer<GetBackupVaultNotificationsRequest.Builder> getBackupVaultNotificationsRequest)

      Returns event notifications for the specified backup vault.


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

      Parameters:
      getBackupVaultNotificationsRequest - A Consumer that will call methods on GetBackupVaultNotificationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBackupVaultNotifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLegalHold

      default CompletableFuture<GetLegalHoldResponse> getLegalHold(GetLegalHoldRequest getLegalHoldRequest)

      This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

      Parameters:
      getLegalHoldRequest -
      Returns:
      A Java Future containing the result of the GetLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLegalHold

      default CompletableFuture<GetLegalHoldResponse> getLegalHold(Consumer<GetLegalHoldRequest.Builder> getLegalHoldRequest)

      This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.


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

      Parameters:
      getLegalHoldRequest - A Consumer that will call methods on GetLegalHoldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecoveryPointRestoreMetadata

      default CompletableFuture<GetRecoveryPointRestoreMetadataResponse> getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)

      Returns a set of metadata key-value pairs that were used to create the backup.

      Parameters:
      getRecoveryPointRestoreMetadataRequest -
      Returns:
      A Java Future containing the result of the GetRecoveryPointRestoreMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecoveryPointRestoreMetadata

      default CompletableFuture<GetRecoveryPointRestoreMetadataResponse> getRecoveryPointRestoreMetadata(Consumer<GetRecoveryPointRestoreMetadataRequest.Builder> getRecoveryPointRestoreMetadataRequest)

      Returns a set of metadata key-value pairs that were used to create the backup.


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

      Parameters:
      getRecoveryPointRestoreMetadataRequest - A Consumer that will call methods on GetRecoveryPointRestoreMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRecoveryPointRestoreMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSupportedResourceTypes

      default CompletableFuture<GetSupportedResourceTypesResponse> getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)

      Returns the Amazon Web Services resource types supported by Backup.

      Parameters:
      getSupportedResourceTypesRequest -
      Returns:
      A Java Future containing the result of the GetSupportedResourceTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSupportedResourceTypes

      default CompletableFuture<GetSupportedResourceTypesResponse> getSupportedResourceTypes(Consumer<GetSupportedResourceTypesRequest.Builder> getSupportedResourceTypesRequest)

      Returns the Amazon Web Services resource types supported by Backup.


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

      Parameters:
      getSupportedResourceTypesRequest - A Consumer that will call methods on GetSupportedResourceTypesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSupportedResourceTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupJobs

      default CompletableFuture<ListBackupJobsResponse> listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)

      Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

      Parameters:
      listBackupJobsRequest -
      Returns:
      A Java Future containing the result of the ListBackupJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupJobs

      default CompletableFuture<ListBackupJobsResponse> listBackupJobs(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest)

      Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.


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

      Parameters:
      listBackupJobsRequest - A Consumer that will call methods on ListBackupJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBackupJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupJobs

      default CompletableFuture<ListBackupJobsResponse> listBackupJobs()

      Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

      Returns:
      A Java Future containing the result of the ListBackupJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupJobsPaginator

      default ListBackupJobsPublisher listBackupJobsPaginator()

      Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.


      This is a variant of listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest) 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.backup.paginators.ListBackupJobsPublisher publisher = client.listBackupJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupJobsPublisher publisher = client.listBackupJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupJobsResponse 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 listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest) 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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupJobsPaginator

      default ListBackupJobsPublisher listBackupJobsPaginator(ListBackupJobsRequest listBackupJobsRequest)

      Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.


      This is a variant of listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest) 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.backup.paginators.ListBackupJobsPublisher publisher = client.listBackupJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupJobsPublisher publisher = client.listBackupJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupJobsResponse 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 listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest) operation.

      Parameters:
      listBackupJobsRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupJobsPaginator

      default ListBackupJobsPublisher listBackupJobsPaginator(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest)

      Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.


      This is a variant of listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest) 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.backup.paginators.ListBackupJobsPublisher publisher = client.listBackupJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupJobsPublisher publisher = client.listBackupJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupJobsResponse 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 listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest) operation.

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

      Parameters:
      listBackupJobsRequest - A Consumer that will call methods on ListBackupJobsRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanTemplates

      default CompletableFuture<ListBackupPlanTemplatesResponse> listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)

      Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

      Parameters:
      listBackupPlanTemplatesRequest -
      Returns:
      A Java Future containing the result of the ListBackupPlanTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanTemplates

      default CompletableFuture<ListBackupPlanTemplatesResponse> listBackupPlanTemplates(Consumer<ListBackupPlanTemplatesRequest.Builder> listBackupPlanTemplatesRequest)

      Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.


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

      Parameters:
      listBackupPlanTemplatesRequest - A Consumer that will call methods on ListBackupPlanTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBackupPlanTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanTemplates

      default CompletableFuture<ListBackupPlanTemplatesResponse> listBackupPlanTemplates()

      Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

      Returns:
      A Java Future containing the result of the ListBackupPlanTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanTemplatesPaginator

      default ListBackupPlanTemplatesPublisher listBackupPlanTemplatesPaginator()

      Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.


      This is a variant of listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest) 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.backup.paginators.ListBackupPlanTemplatesPublisher publisher = client.listBackupPlanTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesPublisher publisher = client.listBackupPlanTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse 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 listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest) 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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanTemplatesPaginator

      default ListBackupPlanTemplatesPublisher listBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)

      Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.


      This is a variant of listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest) 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.backup.paginators.ListBackupPlanTemplatesPublisher publisher = client.listBackupPlanTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesPublisher publisher = client.listBackupPlanTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse 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 listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest) operation.

      Parameters:
      listBackupPlanTemplatesRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanTemplatesPaginator

      default ListBackupPlanTemplatesPublisher listBackupPlanTemplatesPaginator(Consumer<ListBackupPlanTemplatesRequest.Builder> listBackupPlanTemplatesRequest)

      Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.


      This is a variant of listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest) 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.backup.paginators.ListBackupPlanTemplatesPublisher publisher = client.listBackupPlanTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesPublisher publisher = client.listBackupPlanTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse 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 listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest) operation.

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

      Parameters:
      listBackupPlanTemplatesRequest - A Consumer that will call methods on ListBackupPlanTemplatesRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanVersions

      default CompletableFuture<ListBackupPlanVersionsResponse> listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)

      Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

      Parameters:
      listBackupPlanVersionsRequest -
      Returns:
      A Java Future containing the result of the ListBackupPlanVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanVersions

      default CompletableFuture<ListBackupPlanVersionsResponse> listBackupPlanVersions(Consumer<ListBackupPlanVersionsRequest.Builder> listBackupPlanVersionsRequest)

      Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.


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

      Parameters:
      listBackupPlanVersionsRequest - A Consumer that will call methods on ListBackupPlanVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBackupPlanVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanVersionsPaginator

      default ListBackupPlanVersionsPublisher listBackupPlanVersionsPaginator(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)

      Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.


      This is a variant of listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest) 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.backup.paginators.ListBackupPlanVersionsPublisher publisher = client.listBackupPlanVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsPublisher publisher = client.listBackupPlanVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse 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 listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest) operation.

      Parameters:
      listBackupPlanVersionsRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlanVersionsPaginator

      default ListBackupPlanVersionsPublisher listBackupPlanVersionsPaginator(Consumer<ListBackupPlanVersionsRequest.Builder> listBackupPlanVersionsRequest)

      Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.


      This is a variant of listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest) 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.backup.paginators.ListBackupPlanVersionsPublisher publisher = client.listBackupPlanVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsPublisher publisher = client.listBackupPlanVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse 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 listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest) operation.

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

      Parameters:
      listBackupPlanVersionsRequest - A Consumer that will call methods on ListBackupPlanVersionsRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlans

      default CompletableFuture<ListBackupPlansResponse> listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)

      Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

      Parameters:
      listBackupPlansRequest -
      Returns:
      A Java Future containing the result of the ListBackupPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlans

      default CompletableFuture<ListBackupPlansResponse> listBackupPlans(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest)

      Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.


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

      Parameters:
      listBackupPlansRequest - A Consumer that will call methods on ListBackupPlansRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBackupPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlans

      default CompletableFuture<ListBackupPlansResponse> listBackupPlans()

      Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

      Returns:
      A Java Future containing the result of the ListBackupPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlansPaginator

      default ListBackupPlansPublisher listBackupPlansPaginator()

      Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.


      This is a variant of listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest) 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.backup.paginators.ListBackupPlansPublisher publisher = client.listBackupPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlansPublisher publisher = client.listBackupPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlansResponse 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 listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest) 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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlansPaginator

      default ListBackupPlansPublisher listBackupPlansPaginator(ListBackupPlansRequest listBackupPlansRequest)

      Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.


      This is a variant of listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest) 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.backup.paginators.ListBackupPlansPublisher publisher = client.listBackupPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlansPublisher publisher = client.listBackupPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlansResponse 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 listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest) operation.

      Parameters:
      listBackupPlansRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupPlansPaginator

      default ListBackupPlansPublisher listBackupPlansPaginator(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest)

      Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.


      This is a variant of listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest) 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.backup.paginators.ListBackupPlansPublisher publisher = client.listBackupPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupPlansPublisher publisher = client.listBackupPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupPlansResponse 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 listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest) operation.

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

      Parameters:
      listBackupPlansRequest - A Consumer that will call methods on ListBackupPlansRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupSelections

      default CompletableFuture<ListBackupSelectionsResponse> listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)

      Returns an array containing metadata of the resources associated with the target backup plan.

      Parameters:
      listBackupSelectionsRequest -
      Returns:
      A Java Future containing the result of the ListBackupSelections operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupSelections

      default CompletableFuture<ListBackupSelectionsResponse> listBackupSelections(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest)

      Returns an array containing metadata of the resources associated with the target backup plan.


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

      Parameters:
      listBackupSelectionsRequest - A Consumer that will call methods on ListBackupSelectionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBackupSelections operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupSelectionsPaginator

      default ListBackupSelectionsPublisher listBackupSelectionsPaginator(ListBackupSelectionsRequest listBackupSelectionsRequest)

      Returns an array containing metadata of the resources associated with the target backup plan.


      This is a variant of listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest) 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.backup.paginators.ListBackupSelectionsPublisher publisher = client.listBackupSelectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsPublisher publisher = client.listBackupSelectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse 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 listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest) operation.

      Parameters:
      listBackupSelectionsRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupSelectionsPaginator

      default ListBackupSelectionsPublisher listBackupSelectionsPaginator(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest)

      Returns an array containing metadata of the resources associated with the target backup plan.


      This is a variant of listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest) 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.backup.paginators.ListBackupSelectionsPublisher publisher = client.listBackupSelectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsPublisher publisher = client.listBackupSelectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse 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 listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest) operation.

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

      Parameters:
      listBackupSelectionsRequest - A Consumer that will call methods on ListBackupSelectionsRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupVaults

      default CompletableFuture<ListBackupVaultsResponse> listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)

      Returns a list of recovery point storage containers along with information about them.

      Parameters:
      listBackupVaultsRequest -
      Returns:
      A Java Future containing the result of the ListBackupVaults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupVaults

      default CompletableFuture<ListBackupVaultsResponse> listBackupVaults(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest)

      Returns a list of recovery point storage containers along with information about them.


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

      Parameters:
      listBackupVaultsRequest - A Consumer that will call methods on ListBackupVaultsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBackupVaults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupVaults

      default CompletableFuture<ListBackupVaultsResponse> listBackupVaults()

      Returns a list of recovery point storage containers along with information about them.

      Returns:
      A Java Future containing the result of the ListBackupVaults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupVaultsPaginator

      default ListBackupVaultsPublisher listBackupVaultsPaginator()

      Returns a list of recovery point storage containers along with information about them.


      This is a variant of listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest) 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.backup.paginators.ListBackupVaultsPublisher publisher = client.listBackupVaultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupVaultsPublisher publisher = client.listBackupVaultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse 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 listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest) 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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupVaultsPaginator

      default ListBackupVaultsPublisher listBackupVaultsPaginator(ListBackupVaultsRequest listBackupVaultsRequest)

      Returns a list of recovery point storage containers along with information about them.


      This is a variant of listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest) 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.backup.paginators.ListBackupVaultsPublisher publisher = client.listBackupVaultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupVaultsPublisher publisher = client.listBackupVaultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse 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 listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest) operation.

      Parameters:
      listBackupVaultsRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBackupVaultsPaginator

      default ListBackupVaultsPublisher listBackupVaultsPaginator(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest)

      Returns a list of recovery point storage containers along with information about them.


      This is a variant of listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest) 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.backup.paginators.ListBackupVaultsPublisher publisher = client.listBackupVaultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListBackupVaultsPublisher publisher = client.listBackupVaultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse 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 listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest) operation.

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

      Parameters:
      listBackupVaultsRequest - A Consumer that will call methods on ListBackupVaultsRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCopyJobs

      default CompletableFuture<ListCopyJobsResponse> listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)

      Returns metadata about your copy jobs.

      Parameters:
      listCopyJobsRequest -
      Returns:
      A Java Future containing the result of the ListCopyJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCopyJobs

      default CompletableFuture<ListCopyJobsResponse> listCopyJobs(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest)

      Returns metadata about your copy jobs.


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

      Parameters:
      listCopyJobsRequest - A Consumer that will call methods on ListCopyJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCopyJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCopyJobsPaginator

      default ListCopyJobsPublisher listCopyJobsPaginator(ListCopyJobsRequest listCopyJobsRequest)

      Returns metadata about your copy jobs.


      This is a variant of listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest) 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.backup.paginators.ListCopyJobsPublisher publisher = client.listCopyJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListCopyJobsPublisher publisher = client.listCopyJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListCopyJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListCopyJobsResponse 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 listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest) operation.

      Parameters:
      listCopyJobsRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCopyJobsPaginator

      default ListCopyJobsPublisher listCopyJobsPaginator(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest)

      Returns metadata about your copy jobs.


      This is a variant of listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest) 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.backup.paginators.ListCopyJobsPublisher publisher = client.listCopyJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListCopyJobsPublisher publisher = client.listCopyJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListCopyJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListCopyJobsResponse 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 listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest) operation.

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

      Parameters:
      listCopyJobsRequest - A Consumer that will call methods on ListCopyJobsRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFrameworks

      default CompletableFuture<ListFrameworksResponse> listFrameworks(ListFrameworksRequest listFrameworksRequest)

      Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

      Parameters:
      listFrameworksRequest -
      Returns:
      A Java Future containing the result of the ListFrameworks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFrameworks

      default CompletableFuture<ListFrameworksResponse> listFrameworks(Consumer<ListFrameworksRequest.Builder> listFrameworksRequest)

      Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.


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

      Parameters:
      listFrameworksRequest - A Consumer that will call methods on ListFrameworksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFrameworks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFrameworksPaginator

      default ListFrameworksPublisher listFrameworksPaginator(ListFrameworksRequest listFrameworksRequest)

      Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.


      This is a variant of listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest) 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.backup.paginators.ListFrameworksPublisher publisher = client.listFrameworksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListFrameworksPublisher publisher = client.listFrameworksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListFrameworksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListFrameworksResponse 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 listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest) operation.

      Parameters:
      listFrameworksRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFrameworksPaginator

      default ListFrameworksPublisher listFrameworksPaginator(Consumer<ListFrameworksRequest.Builder> listFrameworksRequest)

      Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.


      This is a variant of listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest) 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.backup.paginators.ListFrameworksPublisher publisher = client.listFrameworksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListFrameworksPublisher publisher = client.listFrameworksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListFrameworksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListFrameworksResponse 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 listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest) operation.

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

      Parameters:
      listFrameworksRequest - A Consumer that will call methods on ListFrameworksRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLegalHolds

      default CompletableFuture<ListLegalHoldsResponse> listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest)

      This action returns metadata about active and previous legal holds.

      Parameters:
      listLegalHoldsRequest -
      Returns:
      A Java Future containing the result of the ListLegalHolds operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLegalHolds

      default CompletableFuture<ListLegalHoldsResponse> listLegalHolds(Consumer<ListLegalHoldsRequest.Builder> listLegalHoldsRequest)

      This action returns metadata about active and previous legal holds.


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

      Parameters:
      listLegalHoldsRequest - A Consumer that will call methods on ListLegalHoldsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLegalHolds operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLegalHoldsPaginator

      default ListLegalHoldsPublisher listLegalHoldsPaginator(ListLegalHoldsRequest listLegalHoldsRequest)

      This action returns metadata about active and previous legal holds.


      This is a variant of listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest) 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.backup.paginators.ListLegalHoldsPublisher publisher = client.listLegalHoldsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListLegalHoldsPublisher publisher = client.listLegalHoldsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse 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 listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest) operation.

      Parameters:
      listLegalHoldsRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLegalHoldsPaginator

      default ListLegalHoldsPublisher listLegalHoldsPaginator(Consumer<ListLegalHoldsRequest.Builder> listLegalHoldsRequest)

      This action returns metadata about active and previous legal holds.


      This is a variant of listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest) 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.backup.paginators.ListLegalHoldsPublisher publisher = client.listLegalHoldsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListLegalHoldsPublisher publisher = client.listLegalHoldsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse 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 listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest) operation.

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

      Parameters:
      listLegalHoldsRequest - A Consumer that will call methods on ListLegalHoldsRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResources

      default CompletableFuture<ListProtectedResourcesResponse> listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)

      Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

      Parameters:
      listProtectedResourcesRequest -
      Returns:
      A Java Future containing the result of the ListProtectedResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResources

      default CompletableFuture<ListProtectedResourcesResponse> listProtectedResources(Consumer<ListProtectedResourcesRequest.Builder> listProtectedResourcesRequest)

      Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.


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

      Parameters:
      listProtectedResourcesRequest - A Consumer that will call methods on ListProtectedResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProtectedResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResources

      default CompletableFuture<ListProtectedResourcesResponse> listProtectedResources()

      Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

      Returns:
      A Java Future containing the result of the ListProtectedResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResourcesByBackupVault

      default CompletableFuture<ListProtectedResourcesByBackupVaultResponse> listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)

      This request lists the protected resources corresponding to each backup vault.

      Parameters:
      listProtectedResourcesByBackupVaultRequest -
      Returns:
      A Java Future containing the result of the ListProtectedResourcesByBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResourcesByBackupVault

      default CompletableFuture<ListProtectedResourcesByBackupVaultResponse> listProtectedResourcesByBackupVault(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest)

      This request lists the protected resources corresponding to each backup vault.


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

      Parameters:
      listProtectedResourcesByBackupVaultRequest - A Consumer that will call methods on ListProtectedResourcesByBackupVaultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProtectedResourcesByBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResourcesByBackupVaultPaginator

      default ListProtectedResourcesByBackupVaultPublisher listProtectedResourcesByBackupVaultPaginator(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)

      This request lists the protected resources corresponding to each backup vault.


      This is a variant of listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest) 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.backup.paginators.ListProtectedResourcesByBackupVaultPublisher publisher = client.listProtectedResourcesByBackupVaultPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultPublisher publisher = client.listProtectedResourcesByBackupVaultPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse 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 listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest) operation.

      Parameters:
      listProtectedResourcesByBackupVaultRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResourcesByBackupVaultPaginator

      default ListProtectedResourcesByBackupVaultPublisher listProtectedResourcesByBackupVaultPaginator(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest)

      This request lists the protected resources corresponding to each backup vault.


      This is a variant of listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest) 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.backup.paginators.ListProtectedResourcesByBackupVaultPublisher publisher = client.listProtectedResourcesByBackupVaultPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultPublisher publisher = client.listProtectedResourcesByBackupVaultPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse 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 listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest) operation.

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

      Parameters:
      listProtectedResourcesByBackupVaultRequest - A Consumer that will call methods on ListProtectedResourcesByBackupVaultRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResourcesPaginator

      default ListProtectedResourcesPublisher listProtectedResourcesPaginator()

      Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.


      This is a variant of listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest) 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.backup.paginators.ListProtectedResourcesPublisher publisher = client.listProtectedResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesPublisher publisher = client.listProtectedResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse 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 listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest) 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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResourcesPaginator

      default ListProtectedResourcesPublisher listProtectedResourcesPaginator(ListProtectedResourcesRequest listProtectedResourcesRequest)

      Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.


      This is a variant of listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest) 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.backup.paginators.ListProtectedResourcesPublisher publisher = client.listProtectedResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesPublisher publisher = client.listProtectedResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse 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 listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest) operation.

      Parameters:
      listProtectedResourcesRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProtectedResourcesPaginator

      default ListProtectedResourcesPublisher listProtectedResourcesPaginator(Consumer<ListProtectedResourcesRequest.Builder> listProtectedResourcesRequest)

      Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.


      This is a variant of listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest) 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.backup.paginators.ListProtectedResourcesPublisher publisher = client.listProtectedResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesPublisher publisher = client.listProtectedResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse 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 listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest) operation.

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

      Parameters:
      listProtectedResourcesRequest - A Consumer that will call methods on ListProtectedResourcesRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByBackupVault

      default CompletableFuture<ListRecoveryPointsByBackupVaultResponse> listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)

      Returns detailed information about the recovery points stored in a backup vault.

      Parameters:
      listRecoveryPointsByBackupVaultRequest -
      Returns:
      A Java Future containing the result of the ListRecoveryPointsByBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByBackupVault

      default CompletableFuture<ListRecoveryPointsByBackupVaultResponse> listRecoveryPointsByBackupVault(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest)

      Returns detailed information about the recovery points stored in a backup vault.


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

      Parameters:
      listRecoveryPointsByBackupVaultRequest - A Consumer that will call methods on ListRecoveryPointsByBackupVaultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRecoveryPointsByBackupVault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByBackupVaultPaginator

      default ListRecoveryPointsByBackupVaultPublisher listRecoveryPointsByBackupVaultPaginator(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)

      Returns detailed information about the recovery points stored in a backup vault.


      This is a variant of listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest) 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.backup.paginators.ListRecoveryPointsByBackupVaultPublisher publisher = client.listRecoveryPointsByBackupVaultPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultPublisher publisher = client.listRecoveryPointsByBackupVaultPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse 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 listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest) operation.

      Parameters:
      listRecoveryPointsByBackupVaultRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByBackupVaultPaginator

      default ListRecoveryPointsByBackupVaultPublisher listRecoveryPointsByBackupVaultPaginator(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest)

      Returns detailed information about the recovery points stored in a backup vault.


      This is a variant of listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest) 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.backup.paginators.ListRecoveryPointsByBackupVaultPublisher publisher = client.listRecoveryPointsByBackupVaultPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultPublisher publisher = client.listRecoveryPointsByBackupVaultPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse 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 listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest) operation.

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

      Parameters:
      listRecoveryPointsByBackupVaultRequest - A Consumer that will call methods on ListRecoveryPointsByBackupVaultRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByLegalHold

      default CompletableFuture<ListRecoveryPointsByLegalHoldResponse> listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)

      This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

      Parameters:
      listRecoveryPointsByLegalHoldRequest -
      Returns:
      A Java Future containing the result of the ListRecoveryPointsByLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByLegalHold

      default CompletableFuture<ListRecoveryPointsByLegalHoldResponse> listRecoveryPointsByLegalHold(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest)

      This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.


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

      Parameters:
      listRecoveryPointsByLegalHoldRequest - A Consumer that will call methods on ListRecoveryPointsByLegalHoldRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRecoveryPointsByLegalHold operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByLegalHoldPaginator

      default ListRecoveryPointsByLegalHoldPublisher listRecoveryPointsByLegalHoldPaginator(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)

      This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.


      This is a variant of listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest) 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.backup.paginators.ListRecoveryPointsByLegalHoldPublisher publisher = client.listRecoveryPointsByLegalHoldPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldPublisher publisher = client.listRecoveryPointsByLegalHoldPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse 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 listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest) operation.

      Parameters:
      listRecoveryPointsByLegalHoldRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByLegalHoldPaginator

      default ListRecoveryPointsByLegalHoldPublisher listRecoveryPointsByLegalHoldPaginator(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest)

      This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.


      This is a variant of listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest) 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.backup.paginators.ListRecoveryPointsByLegalHoldPublisher publisher = client.listRecoveryPointsByLegalHoldPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldPublisher publisher = client.listRecoveryPointsByLegalHoldPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse 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 listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest) operation.

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

      Parameters:
      listRecoveryPointsByLegalHoldRequest - A Consumer that will call methods on ListRecoveryPointsByLegalHoldRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByResource

      default CompletableFuture<ListRecoveryPointsByResourceResponse> listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)

      Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

      For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

      Parameters:
      listRecoveryPointsByResourceRequest -
      Returns:
      A Java Future containing the result of the ListRecoveryPointsByResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByResource

      default CompletableFuture<ListRecoveryPointsByResourceResponse> listRecoveryPointsByResource(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest)

      Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

      For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.


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

      Parameters:
      listRecoveryPointsByResourceRequest - A Consumer that will call methods on ListRecoveryPointsByResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRecoveryPointsByResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByResourcePaginator

      default ListRecoveryPointsByResourcePublisher listRecoveryPointsByResourcePaginator(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)

      Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

      For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.


      This is a variant of listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest) 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.backup.paginators.ListRecoveryPointsByResourcePublisher publisher = client.listRecoveryPointsByResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourcePublisher publisher = client.listRecoveryPointsByResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse 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 listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest) operation.

      Parameters:
      listRecoveryPointsByResourceRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRecoveryPointsByResourcePaginator

      default ListRecoveryPointsByResourcePublisher listRecoveryPointsByResourcePaginator(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest)

      Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

      For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.


      This is a variant of listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest) 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.backup.paginators.ListRecoveryPointsByResourcePublisher publisher = client.listRecoveryPointsByResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourcePublisher publisher = client.listRecoveryPointsByResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse 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 listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest) operation.

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

      Parameters:
      listRecoveryPointsByResourceRequest - A Consumer that will call methods on ListRecoveryPointsByResourceRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportJobs

      default CompletableFuture<ListReportJobsResponse> listReportJobs(ListReportJobsRequest listReportJobsRequest)

      Returns details about your report jobs.

      Parameters:
      listReportJobsRequest -
      Returns:
      A Java Future containing the result of the ListReportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportJobs

      default CompletableFuture<ListReportJobsResponse> listReportJobs(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest)

      Returns details about your report jobs.


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

      Parameters:
      listReportJobsRequest - A Consumer that will call methods on ListReportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListReportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportJobsPaginator

      default ListReportJobsPublisher listReportJobsPaginator(ListReportJobsRequest listReportJobsRequest)

      Returns details about your report jobs.


      This is a variant of listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest) 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.backup.paginators.ListReportJobsPublisher publisher = client.listReportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListReportJobsPublisher publisher = client.listReportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListReportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListReportJobsResponse 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 listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest) operation.

      Parameters:
      listReportJobsRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportJobsPaginator

      default ListReportJobsPublisher listReportJobsPaginator(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest)

      Returns details about your report jobs.


      This is a variant of listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest) 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.backup.paginators.ListReportJobsPublisher publisher = client.listReportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListReportJobsPublisher publisher = client.listReportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListReportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListReportJobsResponse 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 listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest) operation.

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

      Parameters:
      listReportJobsRequest - A Consumer that will call methods on ListReportJobsRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportPlans

      default CompletableFuture<ListReportPlansResponse> listReportPlans(ListReportPlansRequest listReportPlansRequest)

      Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

      Parameters:
      listReportPlansRequest -
      Returns:
      A Java Future containing the result of the ListReportPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportPlans

      default CompletableFuture<ListReportPlansResponse> listReportPlans(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest)

      Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.


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

      Parameters:
      listReportPlansRequest - A Consumer that will call methods on ListReportPlansRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListReportPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportPlansPaginator

      default ListReportPlansPublisher listReportPlansPaginator(ListReportPlansRequest listReportPlansRequest)

      Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.


      This is a variant of listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest) 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.backup.paginators.ListReportPlansPublisher publisher = client.listReportPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListReportPlansPublisher publisher = client.listReportPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListReportPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListReportPlansResponse 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 listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest) operation.

      Parameters:
      listReportPlansRequest -
      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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReportPlansPaginator

      default ListReportPlansPublisher listReportPlansPaginator(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest)

      Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.


      This is a variant of listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest) 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.backup.paginators.ListReportPlansPublisher publisher = client.listReportPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListReportPlansPublisher publisher = client.listReportPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListReportPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListReportPlansResponse 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 listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest) operation.

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

      Parameters:
      listReportPlansRequest - A Consumer that will call methods on ListReportPlansRequest.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.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRestoreJobs

      default CompletableFuture<ListRestoreJobsResponse> listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)

      Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

      Parameters:
      listRestoreJobsRequest -
      Returns:
      A Java Future containing the result of the ListRestoreJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRestoreJobs

      default CompletableFuture<ListRestoreJobsResponse> listRestoreJobs(Consumer<ListRestoreJobsRequest.Builder> listRestoreJobsRequest)

      Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.


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

      Parameters:
      listRestoreJobsRequest - A Consumer that will call methods on ListRestoreJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRestoreJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRestoreJobs

      default CompletableFuture<ListRestoreJobsResponse> listRestoreJobs()

      Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

      Returns:
      A Java Future containing the result of the ListRestoreJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRestoreJobsPaginator

      default ListRestoreJobsPublisher listRestoreJobsPaginator()

      Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.


      This is a variant of listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest) 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.backup.paginators.ListRestoreJobsPublisher publisher = client.listRestoreJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRestoreJobsPublisher publisher = client.listRestoreJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse 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 listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest) 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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRestoreJobsPaginator

      default ListRestoreJobsPublisher listRestoreJobsPaginator(ListRestoreJobsRequest listRestoreJobsRequest)

      Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.


      This is a variant of listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest) 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.backup.paginators.ListRestoreJobsPublisher publisher = client.listRestoreJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRestoreJobsPublisher publisher = client.listRestoreJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse 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 listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest) operation.

      Parameters:
      listRestoreJobsRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRestoreJobsPaginator

      default ListRestoreJobsPublisher listRestoreJobsPaginator(Consumer<ListRestoreJobsRequest.Builder> listRestoreJobsRequest)

      Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.


      This is a variant of listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest) 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.backup.paginators.ListRestoreJobsPublisher publisher = client.listRestoreJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListRestoreJobsPublisher publisher = client.listRestoreJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse 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 listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest) operation.

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

      Parameters:
      listRestoreJobsRequest - A Consumer that will call methods on ListRestoreJobsRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)

      Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

      ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.

      Parameters:
      listTagsRequest -
      Returns:
      A Java Future containing the result of the ListTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)

      Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

      ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.


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

      Parameters:
      listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsPaginator

      default ListTagsPublisher listTagsPaginator(ListTagsRequest listTagsRequest)

      Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

      ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.


      This is a variant of listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest) 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.backup.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListTagsResponse 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 listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest) operation.

      Parameters:
      listTagsRequest -
      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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsPaginator

      default ListTagsPublisher listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)

      Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

      ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.


      This is a variant of listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest) 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.backup.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.backup.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backup.model.ListTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backup.model.ListTagsResponse 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 listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest) operation.

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

      Parameters:
      listTagsRequest - A Consumer that will call methods on ListTagsRequest.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.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupVaultAccessPolicy

      default CompletableFuture<PutBackupVaultAccessPolicyResponse> putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)

      Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

      Parameters:
      putBackupVaultAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the PutBackupVaultAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupVaultAccessPolicy

      default CompletableFuture<PutBackupVaultAccessPolicyResponse> putBackupVaultAccessPolicy(Consumer<PutBackupVaultAccessPolicyRequest.Builder> putBackupVaultAccessPolicyRequest)

      Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.


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

      Parameters:
      putBackupVaultAccessPolicyRequest - A Consumer that will call methods on PutBackupVaultAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBackupVaultAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupVaultLockConfiguration

      default CompletableFuture<PutBackupVaultLockConfigurationResponse> putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)

      Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.

      Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.

      Parameters:
      putBackupVaultLockConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutBackupVaultLockConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupVaultLockConfiguration

      default CompletableFuture<PutBackupVaultLockConfigurationResponse> putBackupVaultLockConfiguration(Consumer<PutBackupVaultLockConfigurationRequest.Builder> putBackupVaultLockConfigurationRequest)

      Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.

      Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.


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

      Parameters:
      putBackupVaultLockConfigurationRequest - A Consumer that will call methods on PutBackupVaultLockConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBackupVaultLockConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupVaultNotifications

      default CompletableFuture<PutBackupVaultNotificationsResponse> putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)

      Turns on notifications on a backup vault for the specified topic and events.

      Parameters:
      putBackupVaultNotificationsRequest -
      Returns:
      A Java Future containing the result of the PutBackupVaultNotifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupVaultNotifications

      default CompletableFuture<PutBackupVaultNotificationsResponse> putBackupVaultNotifications(Consumer<PutBackupVaultNotificationsRequest.Builder> putBackupVaultNotificationsRequest)

      Turns on notifications on a backup vault for the specified topic and events.


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

      Parameters:
      putBackupVaultNotificationsRequest - A Consumer that will call methods on PutBackupVaultNotificationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBackupVaultNotifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startBackupJob

      default CompletableFuture<StartBackupJobResponse> startBackupJob(StartBackupJobRequest startBackupJobRequest)

      Starts an on-demand backup job for the specified resource.

      Parameters:
      startBackupJobRequest -
      Returns:
      A Java Future containing the result of the StartBackupJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startBackupJob

      default CompletableFuture<StartBackupJobResponse> startBackupJob(Consumer<StartBackupJobRequest.Builder> startBackupJobRequest)

      Starts an on-demand backup job for the specified resource.


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

      Parameters:
      startBackupJobRequest - A Consumer that will call methods on StartBackupJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartBackupJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startCopyJob

      default CompletableFuture<StartCopyJobResponse> startCopyJob(StartCopyJobRequest startCopyJobRequest)

      Starts a job to create a one-time copy of the specified resource.

      Does not support continuous backups.

      Parameters:
      startCopyJobRequest -
      Returns:
      A Java Future containing the result of the StartCopyJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startCopyJob

      default CompletableFuture<StartCopyJobResponse> startCopyJob(Consumer<StartCopyJobRequest.Builder> startCopyJobRequest)

      Starts a job to create a one-time copy of the specified resource.

      Does not support continuous backups.


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

      Parameters:
      startCopyJobRequest - A Consumer that will call methods on StartCopyJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartCopyJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startReportJob

      default CompletableFuture<StartReportJobResponse> startReportJob(StartReportJobRequest startReportJobRequest)

      Starts an on-demand report job for the specified report plan.

      Parameters:
      startReportJobRequest -
      Returns:
      A Java Future containing the result of the StartReportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startReportJob

      default CompletableFuture<StartReportJobResponse> startReportJob(Consumer<StartReportJobRequest.Builder> startReportJobRequest)

      Starts an on-demand report job for the specified report plan.


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

      Parameters:
      startReportJobRequest - A Consumer that will call methods on StartReportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartReportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startRestoreJob

      default CompletableFuture<StartRestoreJobResponse> startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)

      Recovers the saved resource identified by an Amazon Resource Name (ARN).

      Parameters:
      startRestoreJobRequest -
      Returns:
      A Java Future containing the result of the StartRestoreJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startRestoreJob

      default CompletableFuture<StartRestoreJobResponse> startRestoreJob(Consumer<StartRestoreJobRequest.Builder> startRestoreJobRequest)

      Recovers the saved resource identified by an Amazon Resource Name (ARN).


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

      Parameters:
      startRestoreJobRequest - A Consumer that will call methods on StartRestoreJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartRestoreJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopBackupJob

      default CompletableFuture<StopBackupJobResponse> stopBackupJob(StopBackupJobRequest stopBackupJobRequest)

      Attempts to cancel a job to create a one-time backup of a resource.

      This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

      Parameters:
      stopBackupJobRequest -
      Returns:
      A Java Future containing the result of the StopBackupJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopBackupJob

      default CompletableFuture<StopBackupJobResponse> stopBackupJob(Consumer<StopBackupJobRequest.Builder> stopBackupJobRequest)

      Attempts to cancel a job to create a one-time backup of a resource.

      This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.


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

      Parameters:
      stopBackupJobRequest - A Consumer that will call methods on StopBackupJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopBackupJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBackupPlan

      default CompletableFuture<UpdateBackupPlanResponse> updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)

      Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

      Parameters:
      updateBackupPlanRequest -
      Returns:
      A Java Future containing the result of the UpdateBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBackupPlan

      default CompletableFuture<UpdateBackupPlanResponse> updateBackupPlan(Consumer<UpdateBackupPlanRequest.Builder> updateBackupPlanRequest)

      Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.


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

      Parameters:
      updateBackupPlanRequest - A Consumer that will call methods on UpdateBackupPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBackupPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFramework

      default CompletableFuture<UpdateFrameworkResponse> updateFramework(UpdateFrameworkRequest updateFrameworkRequest)

      Updates an existing framework identified by its FrameworkName with the input document in JSON format.

      Parameters:
      updateFrameworkRequest -
      Returns:
      A Java Future containing the result of the UpdateFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFramework

      default CompletableFuture<UpdateFrameworkResponse> updateFramework(Consumer<UpdateFrameworkRequest.Builder> updateFrameworkRequest)

      Updates an existing framework identified by its FrameworkName with the input document in JSON format.


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

      Parameters:
      updateFrameworkRequest - A Consumer that will call methods on UpdateFrameworkRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFramework operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • AlreadyExistsException The required resource already exists.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGlobalSettings

      default CompletableFuture<UpdateGlobalSettingsResponse> updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)

      Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

      Parameters:
      updateGlobalSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGlobalSettings

      default CompletableFuture<UpdateGlobalSettingsResponse> updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest)

      Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.


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

      Parameters:
      updateGlobalSettingsRequest - A Consumer that will call methods on UpdateGlobalSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong 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.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRecoveryPointLifecycle

      default CompletableFuture<UpdateRecoveryPointLifecycleResponse> updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)

      Sets the transition lifecycle of a recovery point.

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

      This operation does not support continuous backups.

      Parameters:
      updateRecoveryPointLifecycleRequest -
      Returns:
      A Java Future containing the result of the UpdateRecoveryPointLifecycle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRecoveryPointLifecycle

      default CompletableFuture<UpdateRecoveryPointLifecycleResponse> updateRecoveryPointLifecycle(Consumer<UpdateRecoveryPointLifecycleRequest.Builder> updateRecoveryPointLifecycleRequest)

      Sets the transition lifecycle of a recovery point.

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

      This operation does not support continuous backups.


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

      Parameters:
      updateRecoveryPointLifecycleRequest - A Consumer that will call methods on UpdateRecoveryPointLifecycleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRecoveryPointLifecycle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRegionSettings

      default CompletableFuture<UpdateRegionSettingsResponse> updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)

      Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.

      Parameters:
      updateRegionSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateRegionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRegionSettings

      default CompletableFuture<UpdateRegionSettingsResponse> updateRegionSettings(Consumer<UpdateRegionSettingsRequest.Builder> updateRegionSettingsRequest)

      Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.


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

      Parameters:
      updateRegionSettingsRequest - A Consumer that will call methods on UpdateRegionSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRegionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateReportPlan

      default CompletableFuture<UpdateReportPlanResponse> updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)

      Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

      Parameters:
      updateReportPlanRequest -
      Returns:
      A Java Future containing the result of the UpdateReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateReportPlan

      default CompletableFuture<UpdateReportPlanResponse> updateReportPlan(Consumer<UpdateReportPlanRequest.Builder> updateReportPlanRequest)

      Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.


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

      Parameters:
      updateReportPlanRequest - A Consumer that will call methods on UpdateReportPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateReportPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException A resource that is required for the action doesn't exist.
      • InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
      • ServiceUnavailableException The request failed due to a temporary failure of the server.
      • MissingParameterValueException Indicates that a required parameter is missing.
      • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BackupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default BackupServiceClientConfiguration 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 BackupAsyncClient create()
      Create a BackupAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BackupAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BackupAsyncClient.