@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface BackupAsyncClient extends SdkClient
builder()
method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static BackupAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
BackupAsyncClient. |
static BackupAsyncClient |
create()
Create a
BackupAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateBackupPlanResponse> |
createBackupPlan(Consumer<CreateBackupPlanRequest.Builder> createBackupPlanRequest)
Creates a backup plan using a backup plan name and backup rules.
|
default CompletableFuture<CreateBackupPlanResponse> |
createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)
Creates a backup plan using a backup plan name and backup rules.
|
default CompletableFuture<CreateBackupSelectionResponse> |
createBackupSelection(Consumer<CreateBackupSelectionRequest.Builder> createBackupSelectionRequest)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
default CompletableFuture<CreateBackupSelectionResponse> |
createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
default CompletableFuture<CreateBackupVaultResponse> |
createBackupVault(Consumer<CreateBackupVaultRequest.Builder> createBackupVaultRequest)
Creates a logical container where backups are stored.
|
default CompletableFuture<CreateBackupVaultResponse> |
createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)
Creates a logical container where backups are stored.
|
default CompletableFuture<CreateFrameworkResponse> |
createFramework(Consumer<CreateFrameworkRequest.Builder> createFrameworkRequest)
Creates a framework with one or more controls.
|
default CompletableFuture<CreateFrameworkResponse> |
createFramework(CreateFrameworkRequest createFrameworkRequest)
Creates a framework with one or more controls.
|
default CompletableFuture<CreateReportPlanResponse> |
createReportPlan(Consumer<CreateReportPlanRequest.Builder> createReportPlanRequest)
Creates a report plan.
|
default CompletableFuture<CreateReportPlanResponse> |
createReportPlan(CreateReportPlanRequest createReportPlanRequest)
Creates a report plan.
|
default CompletableFuture<DeleteBackupPlanResponse> |
deleteBackupPlan(Consumer<DeleteBackupPlanRequest.Builder> deleteBackupPlanRequest)
Deletes a backup plan.
|
default CompletableFuture<DeleteBackupPlanResponse> |
deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)
Deletes a backup plan.
|
default CompletableFuture<DeleteBackupSelectionResponse> |
deleteBackupSelection(Consumer<DeleteBackupSelectionRequest.Builder> deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId. |
default CompletableFuture<DeleteBackupSelectionResponse> |
deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId. |
default CompletableFuture<DeleteBackupVaultResponse> |
deleteBackupVault(Consumer<DeleteBackupVaultRequest.Builder> deleteBackupVaultRequest)
Deletes the backup vault identified by its name.
|
default CompletableFuture<DeleteBackupVaultResponse> |
deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name.
|
default CompletableFuture<DeleteBackupVaultAccessPolicyResponse> |
deleteBackupVaultAccessPolicy(Consumer<DeleteBackupVaultAccessPolicyRequest.Builder> deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
|
default CompletableFuture<DeleteBackupVaultAccessPolicyResponse> |
deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
|
default CompletableFuture<DeleteBackupVaultLockConfigurationResponse> |
deleteBackupVaultLockConfiguration(Consumer<DeleteBackupVaultLockConfigurationRequest.Builder> deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
|
default CompletableFuture<DeleteBackupVaultLockConfigurationResponse> |
deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
|
default CompletableFuture<DeleteBackupVaultNotificationsResponse> |
deleteBackupVaultNotifications(Consumer<DeleteBackupVaultNotificationsRequest.Builder> deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
|
default CompletableFuture<DeleteBackupVaultNotificationsResponse> |
deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
|
default CompletableFuture<DeleteFrameworkResponse> |
deleteFramework(Consumer<DeleteFrameworkRequest.Builder> deleteFrameworkRequest)
Deletes the framework specified by a framework name.
|
default CompletableFuture<DeleteFrameworkResponse> |
deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)
Deletes the framework specified by a framework name.
|
default CompletableFuture<DeleteRecoveryPointResponse> |
deleteRecoveryPoint(Consumer<DeleteRecoveryPointRequest.Builder> deleteRecoveryPointRequest)
Deletes the recovery point specified by a recovery point ID.
|
default CompletableFuture<DeleteRecoveryPointResponse> |
deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
Deletes the recovery point specified by a recovery point ID.
|
default CompletableFuture<DeleteReportPlanResponse> |
deleteReportPlan(Consumer<DeleteReportPlanRequest.Builder> deleteReportPlanRequest)
Deletes the report plan specified by a report plan name.
|
default CompletableFuture<DeleteReportPlanResponse> |
deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)
Deletes the report plan specified by a report plan name.
|
default CompletableFuture<DescribeBackupJobResponse> |
describeBackupJob(Consumer<DescribeBackupJobRequest.Builder> describeBackupJobRequest)
Returns backup job details for the specified
BackupJobId. |
default CompletableFuture<DescribeBackupJobResponse> |
describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
Returns backup job details for the specified
BackupJobId. |
default CompletableFuture<DescribeBackupVaultResponse> |
describeBackupVault(Consumer<DescribeBackupVaultRequest.Builder> describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
|
default CompletableFuture<DescribeBackupVaultResponse> |
describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
|
default CompletableFuture<DescribeCopyJobResponse> |
describeCopyJob(Consumer<DescribeCopyJobRequest.Builder> describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
|
default CompletableFuture<DescribeCopyJobResponse> |
describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
|
default CompletableFuture<DescribeFrameworkResponse> |
describeFramework(Consumer<DescribeFrameworkRequest.Builder> describeFrameworkRequest)
Returns the framework details for the specified
FrameworkName. |
default CompletableFuture<DescribeFrameworkResponse> |
describeFramework(DescribeFrameworkRequest describeFrameworkRequest)
Returns the framework details for the specified
FrameworkName. |
default CompletableFuture<DescribeGlobalSettingsResponse> |
describeGlobalSettings(Consumer<DescribeGlobalSettingsRequest.Builder> describeGlobalSettingsRequest)
Describes whether the Amazon Web Services account is opted in to cross-account backup.
|
default CompletableFuture<DescribeGlobalSettingsResponse> |
describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)
Describes whether the Amazon Web Services account is opted in to cross-account backup.
|
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.
|
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.
|
default CompletableFuture<DescribeRecoveryPointResponse> |
describeRecoveryPoint(Consumer<DescribeRecoveryPointRequest.Builder> describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
default CompletableFuture<DescribeRecoveryPointResponse> |
describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
default CompletableFuture<DescribeRegionSettingsResponse> |
describeRegionSettings(Consumer<DescribeRegionSettingsRequest.Builder> describeRegionSettingsRequest)
Returns the current service opt-in settings for the Region.
|
default CompletableFuture<DescribeRegionSettingsResponse> |
describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)
Returns the current service opt-in settings for the Region.
|
default CompletableFuture<DescribeReportJobResponse> |
describeReportJob(Consumer<DescribeReportJobRequest.Builder> describeReportJobRequest)
Returns the details associated with creating a report as specified by its
ReportJobId. |
default CompletableFuture<DescribeReportJobResponse> |
describeReportJob(DescribeReportJobRequest describeReportJobRequest)
Returns the details associated with creating a report as specified by its
ReportJobId. |
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.
|
default CompletableFuture<DescribeReportPlanResponse> |
describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
|
default CompletableFuture<DescribeRestoreJobResponse> |
describeRestoreJob(Consumer<DescribeRestoreJobRequest.Builder> describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
|
default CompletableFuture<DescribeRestoreJobResponse> |
describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
|
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.
|
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.
|
default CompletableFuture<ExportBackupPlanTemplateResponse> |
exportBackupPlanTemplate(Consumer<ExportBackupPlanTemplateRequest.Builder> exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
|
default CompletableFuture<ExportBackupPlanTemplateResponse> |
exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
|
default CompletableFuture<GetBackupPlanResponse> |
getBackupPlan(Consumer<GetBackupPlanRequest.Builder> getBackupPlanRequest)
Returns
BackupPlan details for the specified BackupPlanId. |
default CompletableFuture<GetBackupPlanResponse> |
getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)
Returns
BackupPlan details for the specified BackupPlanId. |
default CompletableFuture<GetBackupPlanFromJsonResponse> |
getBackupPlanFromJSON(Consumer<GetBackupPlanFromJsonRequest.Builder> getBackupPlanFromJsonRequest)
Returns a valid JSON document specifying a backup plan or an error.
|
default CompletableFuture<GetBackupPlanFromJsonResponse> |
getBackupPlanFromJSON(GetBackupPlanFromJsonRequest getBackupPlanFromJsonRequest)
Returns a valid JSON document specifying a backup plan or an error.
|
default CompletableFuture<GetBackupPlanFromTemplateResponse> |
getBackupPlanFromTemplate(Consumer<GetBackupPlanFromTemplateRequest.Builder> getBackupPlanFromTemplateRequest)
Returns the template specified by its
templateId as a backup plan. |
default CompletableFuture<GetBackupPlanFromTemplateResponse> |
getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its
templateId as a backup plan. |
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.
|
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.
|
default CompletableFuture<GetBackupVaultAccessPolicyResponse> |
getBackupVaultAccessPolicy(Consumer<GetBackupVaultAccessPolicyRequest.Builder> getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
|
default CompletableFuture<GetBackupVaultAccessPolicyResponse> |
getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
|
default CompletableFuture<GetBackupVaultNotificationsResponse> |
getBackupVaultNotifications(Consumer<GetBackupVaultNotificationsRequest.Builder> getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
|
default CompletableFuture<GetBackupVaultNotificationsResponse> |
getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
|
default CompletableFuture<GetRecoveryPointRestoreMetadataResponse> |
getRecoveryPointRestoreMetadata(Consumer<GetRecoveryPointRestoreMetadataRequest.Builder> getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
|
default CompletableFuture<GetRecoveryPointRestoreMetadataResponse> |
getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
|
default CompletableFuture<GetSupportedResourceTypesResponse> |
getSupportedResourceTypes(Consumer<GetSupportedResourceTypesRequest.Builder> getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
|
default CompletableFuture<GetSupportedResourceTypesResponse> |
getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
|
default CompletableFuture<ListBackupJobsResponse> |
listBackupJobs()
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default CompletableFuture<ListBackupJobsResponse> |
listBackupJobs(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default CompletableFuture<ListBackupJobsResponse> |
listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default ListBackupJobsPublisher |
listBackupJobsPaginator()
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default ListBackupJobsPublisher |
listBackupJobsPaginator(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default ListBackupJobsPublisher |
listBackupJobsPaginator(ListBackupJobsRequest listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default CompletableFuture<ListBackupPlansResponse> |
listBackupPlans()
Returns a list of all active backup plans for an authenticated account.
|
default CompletableFuture<ListBackupPlansResponse> |
listBackupPlans(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
default CompletableFuture<ListBackupPlansResponse> |
listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
default ListBackupPlansPublisher |
listBackupPlansPaginator()
Returns a list of all active backup plans for an authenticated account.
|
default ListBackupPlansPublisher |
listBackupPlansPaginator(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
default ListBackupPlansPublisher |
listBackupPlansPaginator(ListBackupPlansRequest listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
default CompletableFuture<ListBackupPlanTemplatesResponse> |
listBackupPlanTemplates()
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
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.
|
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.
|
default ListBackupPlanTemplatesPublisher |
listBackupPlanTemplatesPaginator()
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
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.
|
default ListBackupPlanTemplatesPublisher |
listBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
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.
|
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.
|
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.
|
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.
|
default CompletableFuture<ListBackupSelectionsResponse> |
listBackupSelections(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
default CompletableFuture<ListBackupSelectionsResponse> |
listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
default ListBackupSelectionsPublisher |
listBackupSelectionsPaginator(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
default ListBackupSelectionsPublisher |
listBackupSelectionsPaginator(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
default CompletableFuture<ListBackupVaultsResponse> |
listBackupVaults()
Returns a list of recovery point storage containers along with information about them.
|
default CompletableFuture<ListBackupVaultsResponse> |
listBackupVaults(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
default CompletableFuture<ListBackupVaultsResponse> |
listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
default ListBackupVaultsPublisher |
listBackupVaultsPaginator()
Returns a list of recovery point storage containers along with information about them.
|
default ListBackupVaultsPublisher |
listBackupVaultsPaginator(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
default ListBackupVaultsPublisher |
listBackupVaultsPaginator(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
default CompletableFuture<ListCopyJobsResponse> |
listCopyJobs(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest)
Returns metadata about your copy jobs.
|
default CompletableFuture<ListCopyJobsResponse> |
listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
|
default ListCopyJobsPublisher |
listCopyJobsPaginator(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest)
Returns metadata about your copy jobs.
|
default ListCopyJobsPublisher |
listCopyJobsPaginator(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
|
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.
|
default CompletableFuture<ListFrameworksResponse> |
listFrameworks(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
default ListFrameworksPublisher |
listFrameworksPaginator(Consumer<ListFrameworksRequest.Builder> listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
default ListFrameworksPublisher |
listFrameworksPaginator(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
default CompletableFuture<ListRecoveryPointsByBackupVaultResponse> |
listRecoveryPointsByBackupVault(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
default CompletableFuture<ListRecoveryPointsByBackupVaultResponse> |
listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
default ListRecoveryPointsByBackupVaultPublisher |
listRecoveryPointsByBackupVaultPaginator(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
default ListRecoveryPointsByBackupVaultPublisher |
listRecoveryPointsByBackupVaultPaginator(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
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).
|
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).
|
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).
|
default ListRecoveryPointsByResourcePublisher |
listRecoveryPointsByResourcePaginator(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
default CompletableFuture<ListReportJobsResponse> |
listReportJobs(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest)
Returns details about your report jobs.
|
default CompletableFuture<ListReportJobsResponse> |
listReportJobs(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
|
default ListReportJobsPublisher |
listReportJobsPaginator(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest)
Returns details about your report jobs.
|
default ListReportJobsPublisher |
listReportJobsPaginator(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
|
default CompletableFuture<ListReportPlansResponse> |
listReportPlans(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest)
Returns a list of your report plans.
|
default CompletableFuture<ListReportPlansResponse> |
listReportPlans(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans.
|
default ListReportPlansPublisher |
listReportPlansPaginator(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest)
Returns a list of your report plans.
|
default ListReportPlansPublisher |
listReportPlansPaginator(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans.
|
default CompletableFuture<ListRestoreJobsResponse> |
listRestoreJobs()
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
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.
|
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.
|
default ListRestoreJobsPublisher |
listRestoreJobsPaginator()
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
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.
|
default ListRestoreJobsPublisher |
listRestoreJobsPaginator(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
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.
|
default CompletableFuture<ListTagsResponse> |
listTags(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
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.
|
default ListTagsPublisher |
listTagsPaginator(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
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.
|
default CompletableFuture<PutBackupVaultAccessPolicyResponse> |
putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
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.
|
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.
|
default CompletableFuture<PutBackupVaultNotificationsResponse> |
putBackupVaultNotifications(Consumer<PutBackupVaultNotificationsRequest.Builder> putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
|
default CompletableFuture<PutBackupVaultNotificationsResponse> |
putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
|
default CompletableFuture<StartBackupJobResponse> |
startBackupJob(Consumer<StartBackupJobRequest.Builder> startBackupJobRequest)
Starts an on-demand backup job for the specified resource.
|
default CompletableFuture<StartBackupJobResponse> |
startBackupJob(StartBackupJobRequest startBackupJobRequest)
Starts an on-demand backup job for the specified resource.
|
default CompletableFuture<StartCopyJobResponse> |
startCopyJob(Consumer<StartCopyJobRequest.Builder> startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
|
default CompletableFuture<StartCopyJobResponse> |
startCopyJob(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
|
default CompletableFuture<StartReportJobResponse> |
startReportJob(Consumer<StartReportJobRequest.Builder> startReportJobRequest)
Starts an on-demand report job for the specified report plan.
|
default CompletableFuture<StartReportJobResponse> |
startReportJob(StartReportJobRequest startReportJobRequest)
Starts an on-demand report job for the specified report plan.
|
default CompletableFuture<StartRestoreJobResponse> |
startRestoreJob(Consumer<StartRestoreJobRequest.Builder> startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
default CompletableFuture<StartRestoreJobResponse> |
startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
default CompletableFuture<StopBackupJobResponse> |
stopBackupJob(Consumer<StopBackupJobRequest.Builder> stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
|
default CompletableFuture<StopBackupJobResponse> |
stopBackupJob(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
|
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).
|
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).
|
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)
|
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)
|
default CompletableFuture<UpdateBackupPlanResponse> |
updateBackupPlan(Consumer<UpdateBackupPlanRequest.Builder> updateBackupPlanRequest)
Updates an existing backup plan identified by its
backupPlanId with the input document in JSON
format. |
default CompletableFuture<UpdateBackupPlanResponse> |
updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
Updates an existing backup plan identified by its
backupPlanId with the input document in JSON
format. |
default CompletableFuture<UpdateFrameworkResponse> |
updateFramework(Consumer<UpdateFrameworkRequest.Builder> updateFrameworkRequest)
Updates an existing framework identified by its
FrameworkName with the input document in JSON
format. |
default CompletableFuture<UpdateFrameworkResponse> |
updateFramework(UpdateFrameworkRequest updateFrameworkRequest)
Updates an existing framework identified by its
FrameworkName with the input document in JSON
format. |
default CompletableFuture<UpdateGlobalSettingsResponse> |
updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest)
Updates whether the Amazon Web Services account is opted in to cross-account backup.
|
default CompletableFuture<UpdateGlobalSettingsResponse> |
updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates whether the Amazon Web Services account is opted in to cross-account backup.
|
default CompletableFuture<UpdateRecoveryPointLifecycleResponse> |
updateRecoveryPointLifecycle(Consumer<UpdateRecoveryPointLifecycleRequest.Builder> updateRecoveryPointLifecycleRequest)
Sets the transition lifecycle of a recovery point.
|
default CompletableFuture<UpdateRecoveryPointLifecycleResponse> |
updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)
Sets the transition lifecycle of a recovery point.
|
default CompletableFuture<UpdateRegionSettingsResponse> |
updateRegionSettings(Consumer<UpdateRegionSettingsRequest.Builder> updateRegionSettingsRequest)
Updates the current service opt-in settings for the Region.
|
default CompletableFuture<UpdateRegionSettingsResponse> |
updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)
Updates the current service opt-in settings for the Region.
|
default CompletableFuture<UpdateReportPlanResponse> |
updateReportPlan(Consumer<UpdateReportPlanRequest.Builder> updateReportPlanRequest)
Updates an existing report plan identified by its
ReportPlanName with the input document in JSON
format. |
default CompletableFuture<UpdateReportPlanResponse> |
updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)
Updates an existing report plan identified by its
ReportPlanName with the input document in JSON
format. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static BackupAsyncClient create()
BackupAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BackupAsyncClientBuilder builder()
BackupAsyncClient.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.
createBackupPlanRequest - 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()
createBackupPlanRequest - A Consumer that will call methods on CreateBackupPlanInput.Builder to create a request.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.
createBackupSelectionRequest - 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()
createBackupSelectionRequest - A Consumer that will call methods on CreateBackupSelectionInput.Builder to create a
request.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.
createBackupVaultRequest - 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()
createBackupVaultRequest - A Consumer that will call methods on CreateBackupVaultInput.Builder to create a request.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.
createFrameworkRequest - 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()
createFrameworkRequest - A Consumer that will call methods on CreateFrameworkInput.Builder to create a request.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.
createReportPlanRequest - 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()
createReportPlanRequest - A Consumer that will call methods on CreateReportPlanInput.Builder to create a request.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.
deleteBackupPlanRequest - 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()
deleteBackupPlanRequest - A Consumer that will call methods on DeleteBackupPlanInput.Builder to create a request.default CompletableFuture<DeleteBackupSelectionResponse> deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
deleteBackupSelectionRequest - 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()
deleteBackupSelectionRequest - A Consumer that will call methods on DeleteBackupSelectionInput.Builder to create a
request.default CompletableFuture<DeleteBackupVaultResponse> deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVaultRequest - 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()
deleteBackupVaultRequest - A Consumer that will call methods on DeleteBackupVaultInput.Builder to create a request.default CompletableFuture<DeleteBackupVaultAccessPolicyResponse> deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicyRequest - 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()
deleteBackupVaultAccessPolicyRequest - A Consumer that will call methods on DeleteBackupVaultAccessPolicyInput.Builder to create
a request.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.
deleteBackupVaultLockConfigurationRequest - 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()
deleteBackupVaultLockConfigurationRequest - A Consumer that will call methods on DeleteBackupVaultLockConfigurationInput.Builder to
create a request.default CompletableFuture<DeleteBackupVaultNotificationsResponse> deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotificationsRequest - 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()
deleteBackupVaultNotificationsRequest - A Consumer that will call methods on DeleteBackupVaultNotificationsInput.Builder to create
a request.default CompletableFuture<DeleteFrameworkResponse> deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)
Deletes the framework specified by a framework name.
deleteFrameworkRequest - 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()
deleteFrameworkRequest - A Consumer that will call methods on DeleteFrameworkInput.Builder to create a request.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.
deleteRecoveryPointRequest - 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.
This is a convenience which creates an instance of the DeleteRecoveryPointRequest.Builder avoiding the
need to create one manually via DeleteRecoveryPointRequest.builder()
deleteRecoveryPointRequest - A Consumer that will call methods on DeleteRecoveryPointInput.Builder to create a request.default CompletableFuture<DeleteReportPlanResponse> deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)
Deletes the report plan specified by a report plan name.
deleteReportPlanRequest - 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()
deleteReportPlanRequest - A Consumer that will call methods on DeleteReportPlanInput.Builder to create a request.default CompletableFuture<DescribeBackupJobResponse> describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
Returns backup job details for the specified BackupJobId.
describeBackupJobRequest - 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()
describeBackupJobRequest - A Consumer that will call methods on DescribeBackupJobInput.Builder to create a request.default CompletableFuture<DescribeBackupVaultResponse> describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
describeBackupVaultRequest - 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()
describeBackupVaultRequest - A Consumer that will call methods on DescribeBackupVaultInput.Builder to create a request.default CompletableFuture<DescribeCopyJobResponse> describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
describeCopyJobRequest - 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()
describeCopyJobRequest - A Consumer that will call methods on DescribeCopyJobInput.Builder to create a request.default CompletableFuture<DescribeFrameworkResponse> describeFramework(DescribeFrameworkRequest describeFrameworkRequest)
Returns the framework details for the specified FrameworkName.
describeFrameworkRequest - 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()
describeFrameworkRequest - A Consumer that will call methods on DescribeFrameworkInput.Builder to create a request.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
describeGlobalSettingsRequest - 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()
describeGlobalSettingsRequest - A Consumer that will call methods on DescribeGlobalSettingsInput.Builder to create a
request.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.
describeProtectedResourceRequest - 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()
describeProtectedResourceRequest - A Consumer that will call methods on DescribeProtectedResourceInput.Builder to create a
request.default CompletableFuture<DescribeRecoveryPointResponse> describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRecoveryPointRequest - 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()
describeRecoveryPointRequest - A Consumer that will call methods on DescribeRecoveryPointInput.Builder to create a
request.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.
describeRegionSettingsRequest - 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()
describeRegionSettingsRequest - A Consumer that will call methods on DescribeRegionSettingsInput.Builder to create a
request.default CompletableFuture<DescribeReportJobResponse> describeReportJob(DescribeReportJobRequest describeReportJobRequest)
Returns the details associated with creating a report as specified by its ReportJobId.
describeReportJobRequest - 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()
describeReportJobRequest - A Consumer that will call methods on DescribeReportJobInput.Builder to create a request.default CompletableFuture<DescribeReportPlanResponse> describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
describeReportPlanRequest - 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()
describeReportPlanRequest - A Consumer that will call methods on DescribeReportPlanInput.Builder to create a request.default CompletableFuture<DescribeRestoreJobResponse> describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
describeRestoreJobRequest - 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()
describeRestoreJobRequest - A Consumer that will call methods on DescribeRestoreJobInput.Builder to create a request.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.
disassociateRecoveryPointRequest - 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()
disassociateRecoveryPointRequest - A Consumer that will call methods on DisassociateRecoveryPointInput.Builder to create a
request.default CompletableFuture<ExportBackupPlanTemplateResponse> exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
exportBackupPlanTemplateRequest - 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()
exportBackupPlanTemplateRequest - A Consumer that will call methods on ExportBackupPlanTemplateInput.Builder to create a
request.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.
getBackupPlanRequest - 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()
getBackupPlanRequest - A Consumer that will call methods on GetBackupPlanInput.Builder to create a request.default CompletableFuture<GetBackupPlanFromJsonResponse> getBackupPlanFromJSON(GetBackupPlanFromJsonRequest getBackupPlanFromJsonRequest)
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromJsonRequest - 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()
getBackupPlanFromJsonRequest - A Consumer that will call methods on GetBackupPlanFromJSONInput.Builder to create a
request.default CompletableFuture<GetBackupPlanFromTemplateResponse> getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its templateId as a backup plan.
getBackupPlanFromTemplateRequest - 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()
getBackupPlanFromTemplateRequest - A Consumer that will call methods on GetBackupPlanFromTemplateInput.Builder to create a
request.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.
getBackupSelectionRequest - 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()
getBackupSelectionRequest - A Consumer that will call methods on GetBackupSelectionInput.Builder to create a request.default CompletableFuture<GetBackupVaultAccessPolicyResponse> getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
getBackupVaultAccessPolicyRequest - 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()
getBackupVaultAccessPolicyRequest - A Consumer that will call methods on GetBackupVaultAccessPolicyInput.Builder to create a
request.default CompletableFuture<GetBackupVaultNotificationsResponse> getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
getBackupVaultNotificationsRequest - 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()
getBackupVaultNotificationsRequest - A Consumer that will call methods on GetBackupVaultNotificationsInput.Builder to create a
request.default CompletableFuture<GetRecoveryPointRestoreMetadataResponse> getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
getRecoveryPointRestoreMetadataRequest - 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()
getRecoveryPointRestoreMetadataRequest - A Consumer that will call methods on GetRecoveryPointRestoreMetadataInput.Builder to
create a request.default CompletableFuture<GetSupportedResourceTypesResponse> getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
getSupportedResourceTypesRequest - 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()
getSupportedResourceTypesRequest - A Consumer that will call methods on GetSupportedResourceTypesRequest.Builder to create a
request.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.
listBackupJobsRequest - 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()
listBackupJobsRequest - A Consumer that will call methods on ListBackupJobsInput.Builder to create a request.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.
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.
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.
listBackupJobsRequest - 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()
listBackupJobsRequest - A Consumer that will call methods on ListBackupJobsInput.Builder to create a request.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.
listBackupPlanTemplatesRequest - 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()
listBackupPlanTemplatesRequest - A Consumer that will call methods on ListBackupPlanTemplatesInput.Builder to create a
request.default CompletableFuture<ListBackupPlanTemplatesResponse> listBackupPlanTemplates()
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
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.
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.
listBackupPlanTemplatesRequest - 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()
listBackupPlanTemplatesRequest - A Consumer that will call methods on ListBackupPlanTemplatesInput.Builder to create a
request.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.
listBackupPlanVersionsRequest - 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()
listBackupPlanVersionsRequest - A Consumer that will call methods on ListBackupPlanVersionsInput.Builder to create a
request.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.
listBackupPlanVersionsRequest - 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()
listBackupPlanVersionsRequest - A Consumer that will call methods on ListBackupPlanVersionsInput.Builder to create a
request.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.
listBackupPlansRequest - 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()
listBackupPlansRequest - A Consumer that will call methods on ListBackupPlansInput.Builder to create a request.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.
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.
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.
listBackupPlansRequest - 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()
listBackupPlansRequest - A Consumer that will call methods on ListBackupPlansInput.Builder to create a request.default CompletableFuture<ListBackupSelectionsResponse> listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupSelectionsRequest - 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()
listBackupSelectionsRequest - A Consumer that will call methods on ListBackupSelectionsInput.Builder to create a
request.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.
listBackupSelectionsRequest - 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()
listBackupSelectionsRequest - A Consumer that will call methods on ListBackupSelectionsInput.Builder to create a
request.default CompletableFuture<ListBackupVaultsResponse> listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
listBackupVaultsRequest - 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()
listBackupVaultsRequest - A Consumer that will call methods on ListBackupVaultsInput.Builder to create a request.default CompletableFuture<ListBackupVaultsResponse> listBackupVaults()
Returns a list of recovery point storage containers along with information about them.
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.
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.
listBackupVaultsRequest - 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()
listBackupVaultsRequest - A Consumer that will call methods on ListBackupVaultsInput.Builder to create a request.default CompletableFuture<ListCopyJobsResponse> listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
listCopyJobsRequest - 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()
listCopyJobsRequest - A Consumer that will call methods on ListCopyJobsInput.Builder to create a request.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.
listCopyJobsRequest - 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()
listCopyJobsRequest - A Consumer that will call methods on ListCopyJobsInput.Builder to create a request.default CompletableFuture<ListFrameworksResponse> listFrameworks(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
listFrameworksRequest - 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()
listFrameworksRequest - A Consumer that will call methods on ListFrameworksInput.Builder to create a request.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.
listFrameworksRequest - 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()
listFrameworksRequest - A Consumer that will call methods on ListFrameworksInput.Builder to create a request.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.
listProtectedResourcesRequest - 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()
listProtectedResourcesRequest - A Consumer that will call methods on ListProtectedResourcesInput.Builder to create a
request.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.
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.
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.
listProtectedResourcesRequest - 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()
listProtectedResourcesRequest - A Consumer that will call methods on ListProtectedResourcesInput.Builder to create a
request.default CompletableFuture<ListRecoveryPointsByBackupVaultResponse> listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVaultRequest - 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()
listRecoveryPointsByBackupVaultRequest - A Consumer that will call methods on ListRecoveryPointsByBackupVaultInput.Builder to
create a request.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.
listRecoveryPointsByBackupVaultRequest - 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()
listRecoveryPointsByBackupVaultRequest - A Consumer that will call methods on ListRecoveryPointsByBackupVaultInput.Builder to
create a request.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.
listRecoveryPointsByResourceRequest - 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()
listRecoveryPointsByResourceRequest - A Consumer that will call methods on ListRecoveryPointsByResourceInput.Builder to create a
request.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.
listRecoveryPointsByResourceRequest - 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()
listRecoveryPointsByResourceRequest - A Consumer that will call methods on ListRecoveryPointsByResourceInput.Builder to create a
request.default CompletableFuture<ListReportJobsResponse> listReportJobs(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
listReportJobsRequest - 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()
listReportJobsRequest - A Consumer that will call methods on ListReportJobsInput.Builder to create a request.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.
listReportJobsRequest - 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()
listReportJobsRequest - A Consumer that will call methods on ListReportJobsInput.Builder to create a request.default CompletableFuture<ListReportPlansResponse> listReportPlans(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans. For detailed information about a single report plan, use
DescribeReportPlan.
listReportPlansRequest - 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()
listReportPlansRequest - A Consumer that will call methods on ListReportPlansInput.Builder to create a request.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.
listReportPlansRequest - 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()
listReportPlansRequest - A Consumer that will call methods on ListReportPlansInput.Builder to create a request.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.
listRestoreJobsRequest - 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()
listRestoreJobsRequest - A Consumer that will call methods on ListRestoreJobsInput.Builder to create a request.default CompletableFuture<ListRestoreJobsResponse> listRestoreJobs()
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
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.
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.
listRestoreJobsRequest - 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()
listRestoreJobsRequest - A Consumer that will call methods on ListRestoreJobsInput.Builder to create a request.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.
listTagsRequest - 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()
listTagsRequest - A Consumer that will call methods on ListTagsInput.Builder to create a request.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.
listTagsRequest - 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()
listTagsRequest - A Consumer that will call methods on ListTagsInput.Builder to create a request.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.
putBackupVaultAccessPolicyRequest - 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()
putBackupVaultAccessPolicyRequest - A Consumer that will call methods on PutBackupVaultAccessPolicyInput.Builder to create a
request.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 yet to receive a third-party assessment for SEC 17a-4(f) and CFTC.
putBackupVaultLockConfigurationRequest - 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 yet to receive a third-party assessment for SEC 17a-4(f) and CFTC.
This is a convenience which creates an instance of the PutBackupVaultLockConfigurationRequest.Builder
avoiding the need to create one manually via PutBackupVaultLockConfigurationRequest.builder()
putBackupVaultLockConfigurationRequest - A Consumer that will call methods on PutBackupVaultLockConfigurationInput.Builder to
create a request.default CompletableFuture<PutBackupVaultNotificationsResponse> putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
putBackupVaultNotificationsRequest - 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()
putBackupVaultNotificationsRequest - A Consumer that will call methods on PutBackupVaultNotificationsInput.Builder to create a
request.default CompletableFuture<StartBackupJobResponse> startBackupJob(StartBackupJobRequest startBackupJobRequest)
Starts an on-demand backup job for the specified resource.
startBackupJobRequest - 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()
startBackupJobRequest - A Consumer that will call methods on StartBackupJobInput.Builder to create a request.default CompletableFuture<StartCopyJobResponse> startCopyJob(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
startCopyJobRequest - 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()
startCopyJobRequest - A Consumer that will call methods on StartCopyJobInput.Builder to create a request.default CompletableFuture<StartReportJobResponse> startReportJob(StartReportJobRequest startReportJobRequest)
Starts an on-demand report job for the specified report plan.
startReportJobRequest - 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()
startReportJobRequest - A Consumer that will call methods on StartReportJobInput.Builder to create a request.default CompletableFuture<StartRestoreJobResponse> startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
startRestoreJobRequest - 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()
startRestoreJobRequest - A Consumer that will call methods on StartRestoreJobInput.Builder to create a request.default CompletableFuture<StopBackupJobResponse> stopBackupJob(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
stopBackupJobRequest - default CompletableFuture<StopBackupJobResponse> stopBackupJob(Consumer<StopBackupJobRequest.Builder> stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
This is a convenience which creates an instance of the StopBackupJobRequest.Builder avoiding the need to
create one manually via StopBackupJobRequest.builder()
stopBackupJobRequest - A Consumer that will call methods on StopBackupJobInput.Builder to create a request.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).
tagResourceRequest - 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()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.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)
untagResourceRequest - 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()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.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.
updateBackupPlanRequest - 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()
updateBackupPlanRequest - A Consumer that will call methods on UpdateBackupPlanInput.Builder to create a request.default CompletableFuture<UpdateFrameworkResponse> updateFramework(UpdateFrameworkRequest updateFrameworkRequest)
Updates an existing framework identified by its FrameworkName with the input document in JSON
format.
updateFrameworkRequest - 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()
updateFrameworkRequest - A Consumer that will call methods on UpdateFrameworkInput.Builder to create a request.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.
updateGlobalSettingsRequest - 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()
updateGlobalSettingsRequest - A Consumer that will call methods on UpdateGlobalSettingsInput.Builder to create a
request.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.
updateRecoveryPointLifecycleRequest - 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()
updateRecoveryPointLifecycleRequest - A Consumer that will call methods on UpdateRecoveryPointLifecycleInput.Builder to create a
request.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.
updateRegionSettingsRequest - 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()
updateRegionSettingsRequest - A Consumer that will call methods on UpdateRegionSettingsInput.Builder to create a
request.default CompletableFuture<UpdateReportPlanResponse> updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)
Updates an existing report plan identified by its ReportPlanName with the input document in JSON
format.
updateReportPlanRequest - 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()
updateReportPlanRequest - A Consumer that will call methods on UpdateReportPlanInput.Builder to create a request.Copyright © 2022. All rights reserved.