Interface BackupClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic BackupClientBuilder
builder()
Create a builder that can be used to configure and create aBackupClient
.default CancelLegalHoldResponse
cancelLegalHold
(Consumer<CancelLegalHoldRequest.Builder> cancelLegalHoldRequest) This action removes the specified legal hold on a recovery point.default CancelLegalHoldResponse
cancelLegalHold
(CancelLegalHoldRequest cancelLegalHoldRequest) This action removes the specified legal hold on a recovery point.static BackupClient
create()
Create aBackupClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateBackupPlanResponse
createBackupPlan
(Consumer<CreateBackupPlanRequest.Builder> createBackupPlanRequest) Creates a backup plan using a backup plan name and backup rules.default CreateBackupPlanResponse
createBackupPlan
(CreateBackupPlanRequest createBackupPlanRequest) Creates a backup plan using a backup plan name and backup rules.default CreateBackupSelectionResponse
createBackupSelection
(Consumer<CreateBackupSelectionRequest.Builder> createBackupSelectionRequest) Creates a JSON document that specifies a set of resources to assign to a backup plan.default CreateBackupSelectionResponse
createBackupSelection
(CreateBackupSelectionRequest createBackupSelectionRequest) Creates a JSON document that specifies a set of resources to assign to a backup plan.default CreateBackupVaultResponse
createBackupVault
(Consumer<CreateBackupVaultRequest.Builder> createBackupVaultRequest) Creates a logical container where backups are stored.default CreateBackupVaultResponse
createBackupVault
(CreateBackupVaultRequest createBackupVaultRequest) Creates a logical container where backups are stored.default CreateFrameworkResponse
createFramework
(Consumer<CreateFrameworkRequest.Builder> createFrameworkRequest) Creates a framework with one or more controls.default CreateFrameworkResponse
createFramework
(CreateFrameworkRequest createFrameworkRequest) Creates a framework with one or more controls.default CreateLegalHoldResponse
createLegalHold
(Consumer<CreateLegalHoldRequest.Builder> createLegalHoldRequest) This action creates a legal hold on a recovery point (backup).default CreateLegalHoldResponse
createLegalHold
(CreateLegalHoldRequest createLegalHoldRequest) This action creates a legal hold on a recovery point (backup).createLogicallyAirGappedBackupVault
(Consumer<CreateLogicallyAirGappedBackupVaultRequest.Builder> createLogicallyAirGappedBackupVaultRequest) This request creates a logical container to where backups may be copied.createLogicallyAirGappedBackupVault
(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest) This request creates a logical container to where backups may be copied.default CreateReportPlanResponse
createReportPlan
(Consumer<CreateReportPlanRequest.Builder> createReportPlanRequest) Creates a report plan.default CreateReportPlanResponse
createReportPlan
(CreateReportPlanRequest createReportPlanRequest) Creates a report plan.default CreateRestoreTestingPlanResponse
createRestoreTestingPlan
(Consumer<CreateRestoreTestingPlanRequest.Builder> createRestoreTestingPlanRequest) This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.default CreateRestoreTestingPlanResponse
createRestoreTestingPlan
(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest) This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.createRestoreTestingSelection
(Consumer<CreateRestoreTestingSelectionRequest.Builder> createRestoreTestingSelectionRequest) This request can be sent after CreateRestoreTestingPlan request returns successfully.createRestoreTestingSelection
(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest) This request can be sent after CreateRestoreTestingPlan request returns successfully.default DeleteBackupPlanResponse
deleteBackupPlan
(Consumer<DeleteBackupPlanRequest.Builder> deleteBackupPlanRequest) Deletes a backup plan.default DeleteBackupPlanResponse
deleteBackupPlan
(DeleteBackupPlanRequest deleteBackupPlanRequest) Deletes a backup plan.default DeleteBackupSelectionResponse
deleteBackupSelection
(Consumer<DeleteBackupSelectionRequest.Builder> deleteBackupSelectionRequest) Deletes the resource selection associated with a backup plan that is specified by theSelectionId
.default DeleteBackupSelectionResponse
deleteBackupSelection
(DeleteBackupSelectionRequest deleteBackupSelectionRequest) Deletes the resource selection associated with a backup plan that is specified by theSelectionId
.default DeleteBackupVaultResponse
deleteBackupVault
(Consumer<DeleteBackupVaultRequest.Builder> deleteBackupVaultRequest) Deletes the backup vault identified by its name.default DeleteBackupVaultResponse
deleteBackupVault
(DeleteBackupVaultRequest deleteBackupVaultRequest) Deletes the backup vault identified by its name.deleteBackupVaultAccessPolicy
(Consumer<DeleteBackupVaultAccessPolicyRequest.Builder> deleteBackupVaultAccessPolicyRequest) Deletes the policy document that manages permissions on a backup vault.deleteBackupVaultAccessPolicy
(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest) Deletes the policy document that manages permissions on a backup vault.deleteBackupVaultLockConfiguration
(Consumer<DeleteBackupVaultLockConfigurationRequest.Builder> deleteBackupVaultLockConfigurationRequest) Deletes Backup Vault Lock from a backup vault specified by a backup vault name.deleteBackupVaultLockConfiguration
(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest) Deletes Backup Vault Lock from a backup vault specified by a backup vault name.deleteBackupVaultNotifications
(Consumer<DeleteBackupVaultNotificationsRequest.Builder> deleteBackupVaultNotificationsRequest) Deletes event notifications for the specified backup vault.deleteBackupVaultNotifications
(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest) Deletes event notifications for the specified backup vault.default DeleteFrameworkResponse
deleteFramework
(Consumer<DeleteFrameworkRequest.Builder> deleteFrameworkRequest) Deletes the framework specified by a framework name.default DeleteFrameworkResponse
deleteFramework
(DeleteFrameworkRequest deleteFrameworkRequest) Deletes the framework specified by a framework name.default DeleteRecoveryPointResponse
deleteRecoveryPoint
(Consumer<DeleteRecoveryPointRequest.Builder> deleteRecoveryPointRequest) Deletes the recovery point specified by a recovery point ID.default DeleteRecoveryPointResponse
deleteRecoveryPoint
(DeleteRecoveryPointRequest deleteRecoveryPointRequest) Deletes the recovery point specified by a recovery point ID.default DeleteReportPlanResponse
deleteReportPlan
(Consumer<DeleteReportPlanRequest.Builder> deleteReportPlanRequest) Deletes the report plan specified by a report plan name.default DeleteReportPlanResponse
deleteReportPlan
(DeleteReportPlanRequest deleteReportPlanRequest) Deletes the report plan specified by a report plan name.default DeleteRestoreTestingPlanResponse
deleteRestoreTestingPlan
(Consumer<DeleteRestoreTestingPlanRequest.Builder> deleteRestoreTestingPlanRequest) This request deletes the specified restore testing plan.default DeleteRestoreTestingPlanResponse
deleteRestoreTestingPlan
(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest) This request deletes the specified restore testing plan.deleteRestoreTestingSelection
(Consumer<DeleteRestoreTestingSelectionRequest.Builder> deleteRestoreTestingSelectionRequest) Input the Restore Testing Plan name and Restore Testing Selection name.deleteRestoreTestingSelection
(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest) Input the Restore Testing Plan name and Restore Testing Selection name.default DescribeBackupJobResponse
describeBackupJob
(Consumer<DescribeBackupJobRequest.Builder> describeBackupJobRequest) Returns backup job details for the specifiedBackupJobId
.default DescribeBackupJobResponse
describeBackupJob
(DescribeBackupJobRequest describeBackupJobRequest) Returns backup job details for the specifiedBackupJobId
.default DescribeBackupVaultResponse
describeBackupVault
(Consumer<DescribeBackupVaultRequest.Builder> describeBackupVaultRequest) Returns metadata about a backup vault specified by its name.default DescribeBackupVaultResponse
describeBackupVault
(DescribeBackupVaultRequest describeBackupVaultRequest) Returns metadata about a backup vault specified by its name.default DescribeCopyJobResponse
describeCopyJob
(Consumer<DescribeCopyJobRequest.Builder> describeCopyJobRequest) Returns metadata associated with creating a copy of a resource.default DescribeCopyJobResponse
describeCopyJob
(DescribeCopyJobRequest describeCopyJobRequest) Returns metadata associated with creating a copy of a resource.default DescribeFrameworkResponse
describeFramework
(Consumer<DescribeFrameworkRequest.Builder> describeFrameworkRequest) Returns the framework details for the specifiedFrameworkName
.default DescribeFrameworkResponse
describeFramework
(DescribeFrameworkRequest describeFrameworkRequest) Returns the framework details for the specifiedFrameworkName
.default DescribeGlobalSettingsResponse
describeGlobalSettings
(Consumer<DescribeGlobalSettingsRequest.Builder> describeGlobalSettingsRequest) Describes whether the Amazon Web Services account is opted in to cross-account backup.default DescribeGlobalSettingsResponse
describeGlobalSettings
(DescribeGlobalSettingsRequest describeGlobalSettingsRequest) Describes whether the Amazon Web Services account is opted in to cross-account backup.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.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 DescribeRecoveryPointResponse
describeRecoveryPoint
(Consumer<DescribeRecoveryPointRequest.Builder> describeRecoveryPointRequest) Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.default DescribeRecoveryPointResponse
describeRecoveryPoint
(DescribeRecoveryPointRequest describeRecoveryPointRequest) Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.default DescribeRegionSettingsResponse
describeRegionSettings
(Consumer<DescribeRegionSettingsRequest.Builder> describeRegionSettingsRequest) Returns the current service opt-in settings for the Region.default DescribeRegionSettingsResponse
describeRegionSettings
(DescribeRegionSettingsRequest describeRegionSettingsRequest) Returns the current service opt-in settings for the Region.default DescribeReportJobResponse
describeReportJob
(Consumer<DescribeReportJobRequest.Builder> describeReportJobRequest) Returns the details associated with creating a report as specified by itsReportJobId
.default DescribeReportJobResponse
describeReportJob
(DescribeReportJobRequest describeReportJobRequest) Returns the details associated with creating a report as specified by itsReportJobId
.default 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 DescribeReportPlanResponse
describeReportPlan
(DescribeReportPlanRequest describeReportPlanRequest) Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.default DescribeRestoreJobResponse
describeRestoreJob
(Consumer<DescribeRestoreJobRequest.Builder> describeRestoreJobRequest) Returns metadata associated with a restore job that is specified by a job ID.default DescribeRestoreJobResponse
describeRestoreJob
(DescribeRestoreJobRequest describeRestoreJobRequest) Returns metadata associated with a restore job that is specified by a job ID.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.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.disassociateRecoveryPointFromParent
(Consumer<DisassociateRecoveryPointFromParentRequest.Builder> disassociateRecoveryPointFromParentRequest) This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.disassociateRecoveryPointFromParent
(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest) This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.default ExportBackupPlanTemplateResponse
exportBackupPlanTemplate
(Consumer<ExportBackupPlanTemplateRequest.Builder> exportBackupPlanTemplateRequest) Returns the backup plan that is specified by the plan ID as a backup template.default ExportBackupPlanTemplateResponse
exportBackupPlanTemplate
(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest) Returns the backup plan that is specified by the plan ID as a backup template.default GetBackupPlanResponse
getBackupPlan
(Consumer<GetBackupPlanRequest.Builder> getBackupPlanRequest) ReturnsBackupPlan
details for the specifiedBackupPlanId
.default GetBackupPlanResponse
getBackupPlan
(GetBackupPlanRequest getBackupPlanRequest) ReturnsBackupPlan
details for the specifiedBackupPlanId
.default GetBackupPlanFromJsonResponse
getBackupPlanFromJSON
(Consumer<GetBackupPlanFromJsonRequest.Builder> getBackupPlanFromJsonRequest) Returns a valid JSON document specifying a backup plan or an error.default GetBackupPlanFromJsonResponse
getBackupPlanFromJSON
(GetBackupPlanFromJsonRequest getBackupPlanFromJsonRequest) Returns a valid JSON document specifying a backup plan or an error.getBackupPlanFromTemplate
(Consumer<GetBackupPlanFromTemplateRequest.Builder> getBackupPlanFromTemplateRequest) Returns the template specified by itstemplateId
as a backup plan.getBackupPlanFromTemplate
(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest) Returns the template specified by itstemplateId
as a backup plan.default 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 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.getBackupVaultAccessPolicy
(Consumer<GetBackupVaultAccessPolicyRequest.Builder> getBackupVaultAccessPolicyRequest) Returns the access policy document that is associated with the named backup vault.getBackupVaultAccessPolicy
(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest) Returns the access policy document that is associated with the named backup vault.getBackupVaultNotifications
(Consumer<GetBackupVaultNotificationsRequest.Builder> getBackupVaultNotificationsRequest) Returns event notifications for the specified backup vault.getBackupVaultNotifications
(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest) Returns event notifications for the specified backup vault.default GetLegalHoldResponse
getLegalHold
(Consumer<GetLegalHoldRequest.Builder> getLegalHoldRequest) This action returns details for a specified legal hold.default GetLegalHoldResponse
getLegalHold
(GetLegalHoldRequest getLegalHoldRequest) This action returns details for a specified legal hold.getRecoveryPointRestoreMetadata
(Consumer<GetRecoveryPointRestoreMetadataRequest.Builder> getRecoveryPointRestoreMetadataRequest) Returns a set of metadata key-value pairs that were used to create the backup.getRecoveryPointRestoreMetadata
(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest) Returns a set of metadata key-value pairs that were used to create the backup.default GetRestoreJobMetadataResponse
getRestoreJobMetadata
(Consumer<GetRestoreJobMetadataRequest.Builder> getRestoreJobMetadataRequest) This request returns the metadata for the specified restore job.default GetRestoreJobMetadataResponse
getRestoreJobMetadata
(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest) This request returns the metadata for the specified restore job.getRestoreTestingInferredMetadata
(Consumer<GetRestoreTestingInferredMetadataRequest.Builder> getRestoreTestingInferredMetadataRequest) This request returns the minimal required set of metadata needed to start a restore job with secure default settings.getRestoreTestingInferredMetadata
(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest) This request returns the minimal required set of metadata needed to start a restore job with secure default settings.default GetRestoreTestingPlanResponse
getRestoreTestingPlan
(Consumer<GetRestoreTestingPlanRequest.Builder> getRestoreTestingPlanRequest) ReturnsRestoreTestingPlan
details for the specifiedRestoreTestingPlanName
.default GetRestoreTestingPlanResponse
getRestoreTestingPlan
(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest) ReturnsRestoreTestingPlan
details for the specifiedRestoreTestingPlanName
.getRestoreTestingSelection
(Consumer<GetRestoreTestingSelectionRequest.Builder> getRestoreTestingSelectionRequest) Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.getRestoreTestingSelection
(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest) Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.getSupportedResourceTypes
(Consumer<GetSupportedResourceTypesRequest.Builder> getSupportedResourceTypesRequest) Returns the Amazon Web Services resource types supported by Backup.getSupportedResourceTypes
(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest) Returns the Amazon Web Services resource types supported by Backup.default ListBackupJobsResponse
Returns a list of existing backup jobs for an authenticated account for the last 30 days.default ListBackupJobsResponse
listBackupJobs
(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest) Returns a list of existing backup jobs for an authenticated account for the last 30 days.default ListBackupJobsResponse
listBackupJobs
(ListBackupJobsRequest listBackupJobsRequest) Returns a list of existing backup jobs for an authenticated account for the last 30 days.default ListBackupJobsIterable
This is a variant oflistBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation.default ListBackupJobsIterable
listBackupJobsPaginator
(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest) This is a variant oflistBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation.default ListBackupJobsIterable
listBackupJobsPaginator
(ListBackupJobsRequest listBackupJobsRequest) This is a variant oflistBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation.default ListBackupJobSummariesResponse
listBackupJobSummaries
(Consumer<ListBackupJobSummariesRequest.Builder> listBackupJobSummariesRequest) This is a request for a summary of backup jobs created or running within the most recent 30 days.default ListBackupJobSummariesResponse
listBackupJobSummaries
(ListBackupJobSummariesRequest listBackupJobSummariesRequest) This is a request for a summary of backup jobs created or running within the most recent 30 days.default ListBackupJobSummariesIterable
listBackupJobSummariesPaginator
(Consumer<ListBackupJobSummariesRequest.Builder> listBackupJobSummariesRequest) This is a variant oflistBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)
operation.default ListBackupJobSummariesIterable
listBackupJobSummariesPaginator
(ListBackupJobSummariesRequest listBackupJobSummariesRequest) This is a variant oflistBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)
operation.default ListBackupPlansResponse
Returns a list of all active backup plans for an authenticated account.default ListBackupPlansResponse
listBackupPlans
(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest) Returns a list of all active backup plans for an authenticated account.default ListBackupPlansResponse
listBackupPlans
(ListBackupPlansRequest listBackupPlansRequest) Returns a list of all active backup plans for an authenticated account.default ListBackupPlansIterable
This is a variant oflistBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation.default ListBackupPlansIterable
listBackupPlansPaginator
(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest) This is a variant oflistBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation.default ListBackupPlansIterable
listBackupPlansPaginator
(ListBackupPlansRequest listBackupPlansRequest) This is a variant oflistBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation.default ListBackupPlanTemplatesResponse
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.default 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 ListBackupPlanTemplatesResponse
listBackupPlanTemplates
(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest) Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.default ListBackupPlanTemplatesIterable
This is a variant oflistBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation.default ListBackupPlanTemplatesIterable
listBackupPlanTemplatesPaginator
(Consumer<ListBackupPlanTemplatesRequest.Builder> listBackupPlanTemplatesRequest) This is a variant oflistBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation.default ListBackupPlanTemplatesIterable
listBackupPlanTemplatesPaginator
(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest) This is a variant oflistBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation.default 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 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 ListBackupPlanVersionsIterable
listBackupPlanVersionsPaginator
(Consumer<ListBackupPlanVersionsRequest.Builder> listBackupPlanVersionsRequest) This is a variant oflistBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)
operation.default ListBackupPlanVersionsIterable
listBackupPlanVersionsPaginator
(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest) This is a variant oflistBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)
operation.default ListBackupSelectionsResponse
listBackupSelections
(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest) Returns an array containing metadata of the resources associated with the target backup plan.default ListBackupSelectionsResponse
listBackupSelections
(ListBackupSelectionsRequest listBackupSelectionsRequest) Returns an array containing metadata of the resources associated with the target backup plan.default ListBackupSelectionsIterable
listBackupSelectionsPaginator
(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest) This is a variant oflistBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)
operation.default ListBackupSelectionsIterable
listBackupSelectionsPaginator
(ListBackupSelectionsRequest listBackupSelectionsRequest) This is a variant oflistBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)
operation.default ListBackupVaultsResponse
Returns a list of recovery point storage containers along with information about them.default ListBackupVaultsResponse
listBackupVaults
(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest) Returns a list of recovery point storage containers along with information about them.default ListBackupVaultsResponse
listBackupVaults
(ListBackupVaultsRequest listBackupVaultsRequest) Returns a list of recovery point storage containers along with information about them.default ListBackupVaultsIterable
This is a variant oflistBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation.default ListBackupVaultsIterable
listBackupVaultsPaginator
(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest) This is a variant oflistBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation.default ListBackupVaultsIterable
listBackupVaultsPaginator
(ListBackupVaultsRequest listBackupVaultsRequest) This is a variant oflistBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation.default ListCopyJobsResponse
listCopyJobs
(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest) Returns metadata about your copy jobs.default ListCopyJobsResponse
listCopyJobs
(ListCopyJobsRequest listCopyJobsRequest) Returns metadata about your copy jobs.default ListCopyJobsIterable
listCopyJobsPaginator
(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest) This is a variant oflistCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)
operation.default ListCopyJobsIterable
listCopyJobsPaginator
(ListCopyJobsRequest listCopyJobsRequest) This is a variant oflistCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)
operation.default ListCopyJobSummariesResponse
listCopyJobSummaries
(Consumer<ListCopyJobSummariesRequest.Builder> listCopyJobSummariesRequest) This request obtains a list of copy jobs created or running within the the most recent 30 days.default ListCopyJobSummariesResponse
listCopyJobSummaries
(ListCopyJobSummariesRequest listCopyJobSummariesRequest) This request obtains a list of copy jobs created or running within the the most recent 30 days.default ListCopyJobSummariesIterable
listCopyJobSummariesPaginator
(Consumer<ListCopyJobSummariesRequest.Builder> listCopyJobSummariesRequest) This is a variant oflistCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)
operation.default ListCopyJobSummariesIterable
listCopyJobSummariesPaginator
(ListCopyJobSummariesRequest listCopyJobSummariesRequest) This is a variant oflistCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)
operation.default ListFrameworksResponse
listFrameworks
(Consumer<ListFrameworksRequest.Builder> listFrameworksRequest) Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.default ListFrameworksResponse
listFrameworks
(ListFrameworksRequest listFrameworksRequest) Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.default ListFrameworksIterable
listFrameworksPaginator
(Consumer<ListFrameworksRequest.Builder> listFrameworksRequest) This is a variant oflistFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)
operation.default ListFrameworksIterable
listFrameworksPaginator
(ListFrameworksRequest listFrameworksRequest) This is a variant oflistFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)
operation.default ListLegalHoldsResponse
listLegalHolds
(Consumer<ListLegalHoldsRequest.Builder> listLegalHoldsRequest) This action returns metadata about active and previous legal holds.default ListLegalHoldsResponse
listLegalHolds
(ListLegalHoldsRequest listLegalHoldsRequest) This action returns metadata about active and previous legal holds.default ListLegalHoldsIterable
listLegalHoldsPaginator
(Consumer<ListLegalHoldsRequest.Builder> listLegalHoldsRequest) This is a variant oflistLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation.default ListLegalHoldsIterable
listLegalHoldsPaginator
(ListLegalHoldsRequest listLegalHoldsRequest) This is a variant oflistLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation.default ListProtectedResourcesResponse
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 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 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.listProtectedResourcesByBackupVault
(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest) This request lists the protected resources corresponding to each backup vault.listProtectedResourcesByBackupVault
(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest) This request lists the protected resources corresponding to each backup vault.listProtectedResourcesByBackupVaultPaginator
(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest) This is a variant oflistProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)
operation.listProtectedResourcesByBackupVaultPaginator
(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest) This is a variant oflistProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)
operation.default ListProtectedResourcesIterable
This is a variant oflistProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation.default ListProtectedResourcesIterable
listProtectedResourcesPaginator
(Consumer<ListProtectedResourcesRequest.Builder> listProtectedResourcesRequest) This is a variant oflistProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation.default ListProtectedResourcesIterable
listProtectedResourcesPaginator
(ListProtectedResourcesRequest listProtectedResourcesRequest) This is a variant oflistProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation.listRecoveryPointsByBackupVault
(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest) Returns detailed information about the recovery points stored in a backup vault.listRecoveryPointsByBackupVault
(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) Returns detailed information about the recovery points stored in a backup vault.listRecoveryPointsByBackupVaultPaginator
(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest) This is a variant oflistRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)
operation.listRecoveryPointsByBackupVaultPaginator
(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) This is a variant oflistRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)
operation.listRecoveryPointsByLegalHold
(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest) This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.listRecoveryPointsByLegalHold
(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest) This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.listRecoveryPointsByLegalHoldPaginator
(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest) This is a variant oflistRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)
operation.listRecoveryPointsByLegalHoldPaginator
(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest) This is a variant oflistRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)
operation.listRecoveryPointsByResource
(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest) Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).listRecoveryPointsByResource
(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest) Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).listRecoveryPointsByResourcePaginator
(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest) This is a variant oflistRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)
operation.listRecoveryPointsByResourcePaginator
(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest) This is a variant oflistRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)
operation.default ListReportJobsResponse
listReportJobs
(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest) Returns details about your report jobs.default ListReportJobsResponse
listReportJobs
(ListReportJobsRequest listReportJobsRequest) Returns details about your report jobs.default ListReportJobsIterable
listReportJobsPaginator
(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest) This is a variant oflistReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)
operation.default ListReportJobsIterable
listReportJobsPaginator
(ListReportJobsRequest listReportJobsRequest) This is a variant oflistReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)
operation.default ListReportPlansResponse
listReportPlans
(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest) Returns a list of your report plans.default ListReportPlansResponse
listReportPlans
(ListReportPlansRequest listReportPlansRequest) Returns a list of your report plans.default ListReportPlansIterable
listReportPlansPaginator
(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest) This is a variant oflistReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)
operation.default ListReportPlansIterable
listReportPlansPaginator
(ListReportPlansRequest listReportPlansRequest) This is a variant oflistReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)
operation.default ListRestoreJobsResponse
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.default 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 ListRestoreJobsResponse
listRestoreJobs
(ListRestoreJobsRequest listRestoreJobsRequest) Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.listRestoreJobsByProtectedResource
(Consumer<ListRestoreJobsByProtectedResourceRequest.Builder> listRestoreJobsByProtectedResourceRequest) This returns restore jobs that contain the specified protected resource.listRestoreJobsByProtectedResource
(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest) This returns restore jobs that contain the specified protected resource.listRestoreJobsByProtectedResourcePaginator
(Consumer<ListRestoreJobsByProtectedResourceRequest.Builder> listRestoreJobsByProtectedResourceRequest) This is a variant oflistRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)
operation.listRestoreJobsByProtectedResourcePaginator
(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest) This is a variant oflistRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)
operation.default ListRestoreJobsIterable
This is a variant oflistRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation.default ListRestoreJobsIterable
listRestoreJobsPaginator
(Consumer<ListRestoreJobsRequest.Builder> listRestoreJobsRequest) This is a variant oflistRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation.default ListRestoreJobsIterable
listRestoreJobsPaginator
(ListRestoreJobsRequest listRestoreJobsRequest) This is a variant oflistRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation.default ListRestoreJobSummariesResponse
listRestoreJobSummaries
(Consumer<ListRestoreJobSummariesRequest.Builder> listRestoreJobSummariesRequest) This request obtains a summary of restore jobs created or running within the the most recent 30 days.default ListRestoreJobSummariesResponse
listRestoreJobSummaries
(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest) This request obtains a summary of restore jobs created or running within the the most recent 30 days.default ListRestoreJobSummariesIterable
listRestoreJobSummariesPaginator
(Consumer<ListRestoreJobSummariesRequest.Builder> listRestoreJobSummariesRequest) This is a variant oflistRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)
operation.default ListRestoreJobSummariesIterable
listRestoreJobSummariesPaginator
(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest) This is a variant oflistRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)
operation.default ListRestoreTestingPlansResponse
listRestoreTestingPlans
(Consumer<ListRestoreTestingPlansRequest.Builder> listRestoreTestingPlansRequest) Returns a list of restore testing plans.default ListRestoreTestingPlansResponse
listRestoreTestingPlans
(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest) Returns a list of restore testing plans.default ListRestoreTestingPlansIterable
listRestoreTestingPlansPaginator
(Consumer<ListRestoreTestingPlansRequest.Builder> listRestoreTestingPlansRequest) This is a variant oflistRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)
operation.default ListRestoreTestingPlansIterable
listRestoreTestingPlansPaginator
(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest) This is a variant oflistRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)
operation.listRestoreTestingSelections
(Consumer<ListRestoreTestingSelectionsRequest.Builder> listRestoreTestingSelectionsRequest) Returns a list of restore testing selections.listRestoreTestingSelections
(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest) Returns a list of restore testing selections.listRestoreTestingSelectionsPaginator
(Consumer<ListRestoreTestingSelectionsRequest.Builder> listRestoreTestingSelectionsRequest) This is a variant oflistRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)
operation.listRestoreTestingSelectionsPaginator
(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest) This is a variant oflistRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)
operation.default 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 ListTagsResponse
listTags
(ListTagsRequest listTagsRequest) Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.default ListTagsIterable
listTagsPaginator
(Consumer<ListTagsRequest.Builder> listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)
operation.default ListTagsIterable
listTagsPaginator
(ListTagsRequest listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)
operation.putBackupVaultAccessPolicy
(Consumer<PutBackupVaultAccessPolicyRequest.Builder> putBackupVaultAccessPolicyRequest) Sets a resource-based policy that is used to manage access permissions on the target backup vault.putBackupVaultAccessPolicy
(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest) Sets a resource-based policy that is used to manage access permissions on the target backup vault.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.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.putBackupVaultNotifications
(Consumer<PutBackupVaultNotificationsRequest.Builder> putBackupVaultNotificationsRequest) Turns on notifications on a backup vault for the specified topic and events.putBackupVaultNotifications
(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest) Turns on notifications on a backup vault for the specified topic and events.putRestoreValidationResult
(Consumer<PutRestoreValidationResultRequest.Builder> putRestoreValidationResultRequest) This request allows you to send your independent self-run restore test validation results.putRestoreValidationResult
(PutRestoreValidationResultRequest putRestoreValidationResultRequest) This request allows you to send your independent self-run restore test validation results.default BackupServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartBackupJobResponse
startBackupJob
(Consumer<StartBackupJobRequest.Builder> startBackupJobRequest) Starts an on-demand backup job for the specified resource.default StartBackupJobResponse
startBackupJob
(StartBackupJobRequest startBackupJobRequest) Starts an on-demand backup job for the specified resource.default StartCopyJobResponse
startCopyJob
(Consumer<StartCopyJobRequest.Builder> startCopyJobRequest) Starts a job to create a one-time copy of the specified resource.default StartCopyJobResponse
startCopyJob
(StartCopyJobRequest startCopyJobRequest) Starts a job to create a one-time copy of the specified resource.default StartReportJobResponse
startReportJob
(Consumer<StartReportJobRequest.Builder> startReportJobRequest) Starts an on-demand report job for the specified report plan.default StartReportJobResponse
startReportJob
(StartReportJobRequest startReportJobRequest) Starts an on-demand report job for the specified report plan.default StartRestoreJobResponse
startRestoreJob
(Consumer<StartRestoreJobRequest.Builder> startRestoreJobRequest) Recovers the saved resource identified by an Amazon Resource Name (ARN).default StartRestoreJobResponse
startRestoreJob
(StartRestoreJobRequest startRestoreJobRequest) Recovers the saved resource identified by an Amazon Resource Name (ARN).default StopBackupJobResponse
stopBackupJob
(Consumer<StopBackupJobRequest.Builder> stopBackupJobRequest) Attempts to cancel a job to create a one-time backup of a resource.default StopBackupJobResponse
stopBackupJob
(StopBackupJobRequest stopBackupJobRequest) Attempts to cancel a job to create a one-time backup of a resource.default 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 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 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 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 UpdateBackupPlanResponse
updateBackupPlan
(Consumer<UpdateBackupPlanRequest.Builder> updateBackupPlanRequest) Updates an existing backup plan identified by itsbackupPlanId
with the input document in JSON format.default UpdateBackupPlanResponse
updateBackupPlan
(UpdateBackupPlanRequest updateBackupPlanRequest) Updates an existing backup plan identified by itsbackupPlanId
with the input document in JSON format.default UpdateFrameworkResponse
updateFramework
(Consumer<UpdateFrameworkRequest.Builder> updateFrameworkRequest) Updates an existing framework identified by itsFrameworkName
with the input document in JSON format.default UpdateFrameworkResponse
updateFramework
(UpdateFrameworkRequest updateFrameworkRequest) Updates an existing framework identified by itsFrameworkName
with the input document in JSON format.default UpdateGlobalSettingsResponse
updateGlobalSettings
(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) Updates whether the Amazon Web Services account is opted in to cross-account backup.default UpdateGlobalSettingsResponse
updateGlobalSettings
(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) Updates whether the Amazon Web Services account is opted in to cross-account backup.updateRecoveryPointLifecycle
(Consumer<UpdateRecoveryPointLifecycleRequest.Builder> updateRecoveryPointLifecycleRequest) Sets the transition lifecycle of a recovery point.updateRecoveryPointLifecycle
(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest) Sets the transition lifecycle of a recovery point.default UpdateRegionSettingsResponse
updateRegionSettings
(Consumer<UpdateRegionSettingsRequest.Builder> updateRegionSettingsRequest) Updates the current service opt-in settings for the Region.default UpdateRegionSettingsResponse
updateRegionSettings
(UpdateRegionSettingsRequest updateRegionSettingsRequest) Updates the current service opt-in settings for the Region.default UpdateReportPlanResponse
updateReportPlan
(Consumer<UpdateReportPlanRequest.Builder> updateReportPlanRequest) Updates an existing report plan identified by itsReportPlanName
with the input document in JSON format.default UpdateReportPlanResponse
updateReportPlan
(UpdateReportPlanRequest updateReportPlanRequest) Updates an existing report plan identified by itsReportPlanName
with the input document in JSON format.default UpdateRestoreTestingPlanResponse
updateRestoreTestingPlan
(Consumer<UpdateRestoreTestingPlanRequest.Builder> updateRestoreTestingPlanRequest) This request will send changes to your specified restore testing plan.default UpdateRestoreTestingPlanResponse
updateRestoreTestingPlan
(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest) This request will send changes to your specified restore testing plan.updateRestoreTestingSelection
(Consumer<UpdateRestoreTestingSelectionRequest.Builder> updateRestoreTestingSelectionRequest) Most elements except theRestoreTestingSelectionName
can be updated with this request.updateRestoreTestingSelection
(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest) Most elements except theRestoreTestingSelectionName
can be updated with this request.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelLegalHold
default CancelLegalHoldResponse cancelLegalHold(CancelLegalHoldRequest cancelLegalHoldRequest) throws InvalidParameterValueException, InvalidResourceStateException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
- Parameters:
cancelLegalHoldRequest
-- Returns:
- Result of the CancelLegalHold operation returned by the service.
- See Also:
-
cancelLegalHold
default CancelLegalHoldResponse cancelLegalHold(Consumer<CancelLegalHoldRequest.Builder> cancelLegalHoldRequest) throws InvalidParameterValueException, InvalidResourceStateException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
This is a convenience which creates an instance of the
CancelLegalHoldRequest.Builder
avoiding the need to create one manually viaCancelLegalHoldRequest.builder()
- Parameters:
cancelLegalHoldRequest
- AConsumer
that will call methods onCancelLegalHoldRequest.Builder
to create a request.- Returns:
- Result of the CancelLegalHold operation returned by the service.
- See Also:
-
createBackupPlan
default CreateBackupPlanResponse createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest) throws LimitExceededException, AlreadyExistsException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 anAlreadyExistsException
exception.- Parameters:
createBackupPlanRequest
-- Returns:
- Result of the CreateBackupPlan operation returned by the service.
- See Also:
-
createBackupPlan
default CreateBackupPlanResponse createBackupPlan(Consumer<CreateBackupPlanRequest.Builder> createBackupPlanRequest) throws LimitExceededException, AlreadyExistsException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 anAlreadyExistsException
exception.
This is a convenience which creates an instance of the
CreateBackupPlanRequest.Builder
avoiding the need to create one manually viaCreateBackupPlanRequest.builder()
- Parameters:
createBackupPlanRequest
- AConsumer
that will call methods onCreateBackupPlanRequest.Builder
to create a request.- Returns:
- Result of the CreateBackupPlan operation returned by the service.
- See Also:
-
createBackupSelection
default CreateBackupSelectionResponse createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest) throws LimitExceededException, AlreadyExistsException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
- Parameters:
createBackupSelectionRequest
-- Returns:
- Result of the CreateBackupSelection operation returned by the service.
- See Also:
-
createBackupSelection
default CreateBackupSelectionResponse createBackupSelection(Consumer<CreateBackupSelectionRequest.Builder> createBackupSelectionRequest) throws LimitExceededException, AlreadyExistsException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaCreateBackupSelectionRequest.builder()
- Parameters:
createBackupSelectionRequest
- AConsumer
that will call methods onCreateBackupSelectionRequest.Builder
to create a request.- Returns:
- Result of the CreateBackupSelection operation returned by the service.
- See Also:
-
createBackupVault
default CreateBackupVaultResponse createBackupVault(CreateBackupVaultRequest createBackupVaultRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, AlreadyExistsException, AwsServiceException, SdkClientException, BackupException Creates a logical container where backups are stored. A
CreateBackupVault
request includes a name, optionally one or more resource tags, an encryption key, and a request ID.Do not include sensitive data, such as passport numbers, in the name of a backup vault.
- Parameters:
createBackupVaultRequest
-- Returns:
- Result of the CreateBackupVault operation returned by the service.
- See Also:
-
createBackupVault
default CreateBackupVaultResponse createBackupVault(Consumer<CreateBackupVaultRequest.Builder> createBackupVaultRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, AlreadyExistsException, AwsServiceException, SdkClientException, BackupException 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 viaCreateBackupVaultRequest.builder()
- Parameters:
createBackupVaultRequest
- AConsumer
that will call methods onCreateBackupVaultRequest.Builder
to create a request.- Returns:
- Result of the CreateBackupVault operation returned by the service.
- See Also:
-
createFramework
default CreateFrameworkResponse createFramework(CreateFrameworkRequest createFrameworkRequest) throws AlreadyExistsException, LimitExceededException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
- Parameters:
createFrameworkRequest
-- Returns:
- Result of the CreateFramework operation returned by the service.
- See Also:
-
createFramework
default CreateFrameworkResponse createFramework(Consumer<CreateFrameworkRequest.Builder> createFrameworkRequest) throws AlreadyExistsException, LimitExceededException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaCreateFrameworkRequest.builder()
- Parameters:
createFrameworkRequest
- AConsumer
that will call methods onCreateFrameworkRequest.Builder
to create a request.- Returns:
- Result of the CreateFramework operation returned by the service.
- See Also:
-
createLegalHold
default CreateLegalHoldResponse createLegalHold(CreateLegalHoldRequest createLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
- Parameters:
createLegalHoldRequest
-- Returns:
- Result of the CreateLegalHold operation returned by the service.
- See Also:
-
createLegalHold
default CreateLegalHoldResponse createLegalHold(Consumer<CreateLegalHoldRequest.Builder> createLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
This is a convenience which creates an instance of the
CreateLegalHoldRequest.Builder
avoiding the need to create one manually viaCreateLegalHoldRequest.builder()
- Parameters:
createLegalHoldRequest
- AConsumer
that will call methods onCreateLegalHoldRequest.Builder
to create a request.- Returns:
- Result of the CreateLegalHold operation returned by the service.
- See Also:
-
createLogicallyAirGappedBackupVault
default CreateLogicallyAirGappedBackupVaultResponse createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest) throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException This request creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
- Parameters:
createLogicallyAirGappedBackupVaultRequest
-- Returns:
- Result of the CreateLogicallyAirGappedBackupVault operation returned by the service.
- See Also:
-
createLogicallyAirGappedBackupVault
default CreateLogicallyAirGappedBackupVaultResponse createLogicallyAirGappedBackupVault(Consumer<CreateLogicallyAirGappedBackupVaultRequest.Builder> createLogicallyAirGappedBackupVaultRequest) throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException This request creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
This is a convenience which creates an instance of the
CreateLogicallyAirGappedBackupVaultRequest.Builder
avoiding the need to create one manually viaCreateLogicallyAirGappedBackupVaultRequest.builder()
- Parameters:
createLogicallyAirGappedBackupVaultRequest
- AConsumer
that will call methods onCreateLogicallyAirGappedBackupVaultRequest.Builder
to create a request.- Returns:
- Result of the CreateLogicallyAirGappedBackupVault operation returned by the service.
- See Also:
-
createReportPlan
default CreateReportPlanResponse createReportPlan(CreateReportPlanRequest createReportPlanRequest) throws AlreadyExistsException, LimitExceededException, InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException, AwsServiceException, SdkClientException, BackupException 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 anAlreadyExistsException
exception.- Parameters:
createReportPlanRequest
-- Returns:
- Result of the CreateReportPlan operation returned by the service.
- See Also:
-
createReportPlan
default CreateReportPlanResponse createReportPlan(Consumer<CreateReportPlanRequest.Builder> createReportPlanRequest) throws AlreadyExistsException, LimitExceededException, InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException, AwsServiceException, SdkClientException, BackupException 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 anAlreadyExistsException
exception.
This is a convenience which creates an instance of the
CreateReportPlanRequest.Builder
avoiding the need to create one manually viaCreateReportPlanRequest.builder()
- Parameters:
createReportPlanRequest
- AConsumer
that will call methods onCreateReportPlanRequest.Builder
to create a request.- Returns:
- Result of the CreateReportPlan operation returned by the service.
- See Also:
-
createRestoreTestingPlan
default CreateRestoreTestingPlanResponse createRestoreTestingPlan(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest) throws AlreadyExistsException, ConflictException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
- Parameters:
createRestoreTestingPlanRequest
-- Returns:
- Result of the CreateRestoreTestingPlan operation returned by the service.
- See Also:
-
createRestoreTestingPlan
default CreateRestoreTestingPlanResponse createRestoreTestingPlan(Consumer<CreateRestoreTestingPlanRequest.Builder> createRestoreTestingPlanRequest) throws AlreadyExistsException, ConflictException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
This is a convenience which creates an instance of the
CreateRestoreTestingPlanRequest.Builder
avoiding the need to create one manually viaCreateRestoreTestingPlanRequest.builder()
- Parameters:
createRestoreTestingPlanRequest
- AConsumer
that will call methods onCreateRestoreTestingPlanRequest.Builder
to create a request.- Returns:
- Result of the CreateRestoreTestingPlan operation returned by the service.
- See Also:
-
createRestoreTestingSelection
default CreateRestoreTestingSelectionResponse createRestoreTestingSelection(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest) throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of
RestoreTestingSelectionName
,ProtectedResourceType
, and one of the following:-
ProtectedResourceArns
-
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for
ProtectedResourceArns
along withProtectedResourceConditions
. Alternatively, you can include up to 30 specific protected resource ARNs inProtectedResourceArns
.Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
- Parameters:
createRestoreTestingSelectionRequest
-- Returns:
- Result of the CreateRestoreTestingSelection operation returned by the service.
- See Also:
-
-
createRestoreTestingSelection
default CreateRestoreTestingSelectionResponse createRestoreTestingSelection(Consumer<CreateRestoreTestingSelectionRequest.Builder> createRestoreTestingSelectionRequest) throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of
RestoreTestingSelectionName
,ProtectedResourceType
, and one of the following:-
ProtectedResourceArns
-
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for
ProtectedResourceArns
along withProtectedResourceConditions
. Alternatively, you can include up to 30 specific protected resource ARNs inProtectedResourceArns
.Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
This is a convenience which creates an instance of the
CreateRestoreTestingSelectionRequest.Builder
avoiding the need to create one manually viaCreateRestoreTestingSelectionRequest.builder()
- Parameters:
createRestoreTestingSelectionRequest
- AConsumer
that will call methods onCreateRestoreTestingSelectionRequest.Builder
to create a request.- Returns:
- Result of the CreateRestoreTestingSelection operation returned by the service.
- See Also:
-
-
deleteBackupPlan
default DeleteBackupPlanResponse deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
- Parameters:
deleteBackupPlanRequest
-- Returns:
- Result of the DeleteBackupPlan operation returned by the service.
- See Also:
-
deleteBackupPlan
default DeleteBackupPlanResponse deleteBackupPlan(Consumer<DeleteBackupPlanRequest.Builder> deleteBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteBackupPlanRequest.builder()
- Parameters:
deleteBackupPlanRequest
- AConsumer
that will call methods onDeleteBackupPlanRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackupPlan operation returned by the service.
- See Also:
-
deleteBackupSelection
default DeleteBackupSelectionResponse deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Deletes the resource selection associated with a backup plan that is specified by the
SelectionId
.- Parameters:
deleteBackupSelectionRequest
-- Returns:
- Result of the DeleteBackupSelection operation returned by the service.
- See Also:
-
deleteBackupSelection
default DeleteBackupSelectionResponse deleteBackupSelection(Consumer<DeleteBackupSelectionRequest.Builder> deleteBackupSelectionRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteBackupSelectionRequest.builder()
- Parameters:
deleteBackupSelectionRequest
- AConsumer
that will call methods onDeleteBackupSelectionRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackupSelection operation returned by the service.
- See Also:
-
deleteBackupVault
default DeleteBackupVaultResponse deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
- Parameters:
deleteBackupVaultRequest
-- Returns:
- Result of the DeleteBackupVault operation returned by the service.
- See Also:
-
deleteBackupVault
default DeleteBackupVaultResponse deleteBackupVault(Consumer<DeleteBackupVaultRequest.Builder> deleteBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteBackupVaultRequest.builder()
- Parameters:
deleteBackupVaultRequest
- AConsumer
that will call methods onDeleteBackupVaultRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackupVault operation returned by the service.
- See Also:
-
deleteBackupVaultAccessPolicy
default DeleteBackupVaultAccessPolicyResponse deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Deletes the policy document that manages permissions on a backup vault.
- Parameters:
deleteBackupVaultAccessPolicyRequest
-- Returns:
- Result of the DeleteBackupVaultAccessPolicy operation returned by the service.
- See Also:
-
deleteBackupVaultAccessPolicy
default DeleteBackupVaultAccessPolicyResponse deleteBackupVaultAccessPolicy(Consumer<DeleteBackupVaultAccessPolicyRequest.Builder> deleteBackupVaultAccessPolicyRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteBackupVaultAccessPolicyRequest.builder()
- Parameters:
deleteBackupVaultAccessPolicyRequest
- AConsumer
that will call methods onDeleteBackupVaultAccessPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackupVaultAccessPolicy operation returned by the service.
- See Also:
-
deleteBackupVaultLockConfiguration
default DeleteBackupVaultLockConfigurationResponse deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an
InvalidRequestException
if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.- Parameters:
deleteBackupVaultLockConfigurationRequest
-- Returns:
- Result of the DeleteBackupVaultLockConfiguration operation returned by the service.
- See Also:
-
deleteBackupVaultLockConfiguration
default DeleteBackupVaultLockConfigurationResponse deleteBackupVaultLockConfiguration(Consumer<DeleteBackupVaultLockConfigurationRequest.Builder> deleteBackupVaultLockConfigurationRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteBackupVaultLockConfigurationRequest.builder()
- Parameters:
deleteBackupVaultLockConfigurationRequest
- AConsumer
that will call methods onDeleteBackupVaultLockConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackupVaultLockConfiguration operation returned by the service.
- See Also:
-
deleteBackupVaultNotifications
default DeleteBackupVaultNotificationsResponse deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Deletes event notifications for the specified backup vault.
- Parameters:
deleteBackupVaultNotificationsRequest
-- Returns:
- Result of the DeleteBackupVaultNotifications operation returned by the service.
- See Also:
-
deleteBackupVaultNotifications
default DeleteBackupVaultNotificationsResponse deleteBackupVaultNotifications(Consumer<DeleteBackupVaultNotificationsRequest.Builder> deleteBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteBackupVaultNotificationsRequest.builder()
- Parameters:
deleteBackupVaultNotificationsRequest
- AConsumer
that will call methods onDeleteBackupVaultNotificationsRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackupVaultNotifications operation returned by the service.
- See Also:
-
deleteFramework
default DeleteFrameworkResponse deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest) throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Deletes the framework specified by a framework name.
- Parameters:
deleteFrameworkRequest
-- Returns:
- Result of the DeleteFramework operation returned by the service.
- See Also:
-
deleteFramework
default DeleteFrameworkResponse deleteFramework(Consumer<DeleteFrameworkRequest.Builder> deleteFrameworkRequest) throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteFrameworkRequest.builder()
- Parameters:
deleteFrameworkRequest
- AConsumer
that will call methods onDeleteFrameworkRequest.Builder
to create a request.- Returns:
- Result of the DeleteFramework operation returned by the service.
- See Also:
-
deleteRecoveryPoint
default DeleteRecoveryPointResponse deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidResourceStateException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Deletes the recovery point specified by a recovery point ID.
If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an
EXPIRED
state.EXPIRED
recovery points can be deleted with this API once the IAM role has theiam:CreateServiceLinkedRole
action. To learn more about adding this role, see Troubleshooting manual deletions.If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an
EXPIRED
state.- Parameters:
deleteRecoveryPointRequest
-- Returns:
- Result of the DeleteRecoveryPoint operation returned by the service.
- See Also:
-
deleteRecoveryPoint
default DeleteRecoveryPointResponse deleteRecoveryPoint(Consumer<DeleteRecoveryPointRequest.Builder> deleteRecoveryPointRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidResourceStateException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Deletes the recovery point specified by a recovery point ID.
If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an
EXPIRED
state.EXPIRED
recovery points can be deleted with this API once the IAM role has theiam:CreateServiceLinkedRole
action. To learn more about adding this role, see Troubleshooting manual deletions.If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an
EXPIRED
state.
This is a convenience which creates an instance of the
DeleteRecoveryPointRequest.Builder
avoiding the need to create one manually viaDeleteRecoveryPointRequest.builder()
- Parameters:
deleteRecoveryPointRequest
- AConsumer
that will call methods onDeleteRecoveryPointRequest.Builder
to create a request.- Returns:
- Result of the DeleteRecoveryPoint operation returned by the service.
- See Also:
-
deleteReportPlan
default DeleteReportPlanResponse deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest) throws MissingParameterValueException, InvalidParameterValueException, ConflictException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Deletes the report plan specified by a report plan name.
- Parameters:
deleteReportPlanRequest
-- Returns:
- Result of the DeleteReportPlan operation returned by the service.
- See Also:
-
deleteReportPlan
default DeleteReportPlanResponse deleteReportPlan(Consumer<DeleteReportPlanRequest.Builder> deleteReportPlanRequest) throws MissingParameterValueException, InvalidParameterValueException, ConflictException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaDeleteReportPlanRequest.builder()
- Parameters:
deleteReportPlanRequest
- AConsumer
that will call methods onDeleteReportPlanRequest.Builder
to create a request.- Returns:
- Result of the DeleteReportPlan operation returned by the service.
- See Also:
-
deleteRestoreTestingPlan
default DeleteRestoreTestingPlanResponse deleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest) throws InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
- Parameters:
deleteRestoreTestingPlanRequest
-- Returns:
- Result of the DeleteRestoreTestingPlan operation returned by the service.
- See Also:
-
deleteRestoreTestingPlan
default DeleteRestoreTestingPlanResponse deleteRestoreTestingPlan(Consumer<DeleteRestoreTestingPlanRequest.Builder> deleteRestoreTestingPlanRequest) throws InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
This is a convenience which creates an instance of the
DeleteRestoreTestingPlanRequest.Builder
avoiding the need to create one manually viaDeleteRestoreTestingPlanRequest.builder()
- Parameters:
deleteRestoreTestingPlanRequest
- AConsumer
that will call methods onDeleteRestoreTestingPlanRequest.Builder
to create a request.- Returns:
- Result of the DeleteRestoreTestingPlan operation returned by the service.
- See Also:
-
deleteRestoreTestingSelection
default DeleteRestoreTestingSelectionResponse deleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Input the Restore Testing Plan name and Restore Testing Selection name.
All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
- Parameters:
deleteRestoreTestingSelectionRequest
-- Returns:
- Result of the DeleteRestoreTestingSelection operation returned by the service.
- See Also:
-
deleteRestoreTestingSelection
default DeleteRestoreTestingSelectionResponse deleteRestoreTestingSelection(Consumer<DeleteRestoreTestingSelectionRequest.Builder> deleteRestoreTestingSelectionRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Input the Restore Testing Plan name and Restore Testing Selection name.
All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
This is a convenience which creates an instance of the
DeleteRestoreTestingSelectionRequest.Builder
avoiding the need to create one manually viaDeleteRestoreTestingSelectionRequest.builder()
- Parameters:
deleteRestoreTestingSelectionRequest
- AConsumer
that will call methods onDeleteRestoreTestingSelectionRequest.Builder
to create a request.- Returns:
- Result of the DeleteRestoreTestingSelection operation returned by the service.
- See Also:
-
describeBackupJob
default DescribeBackupJobResponse describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException Returns backup job details for the specified
BackupJobId
.- Parameters:
describeBackupJobRequest
-- Returns:
- Result of the DescribeBackupJob operation returned by the service.
- See Also:
-
describeBackupJob
default DescribeBackupJobResponse describeBackupJob(Consumer<DescribeBackupJobRequest.Builder> describeBackupJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeBackupJobRequest.builder()
- Parameters:
describeBackupJobRequest
- AConsumer
that will call methods onDescribeBackupJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeBackupJob operation returned by the service.
- See Also:
-
describeBackupVault
default DescribeBackupVaultResponse describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns metadata about a backup vault specified by its name.
- Parameters:
describeBackupVaultRequest
-- Returns:
- Result of the DescribeBackupVault operation returned by the service.
- See Also:
-
describeBackupVault
default DescribeBackupVaultResponse describeBackupVault(Consumer<DescribeBackupVaultRequest.Builder> describeBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeBackupVaultRequest.builder()
- Parameters:
describeBackupVaultRequest
- AConsumer
that will call methods onDescribeBackupVaultRequest.Builder
to create a request.- Returns:
- Result of the DescribeBackupVault operation returned by the service.
- See Also:
-
describeCopyJob
default DescribeCopyJobResponse describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns metadata associated with creating a copy of a resource.
- Parameters:
describeCopyJobRequest
-- Returns:
- Result of the DescribeCopyJob operation returned by the service.
- See Also:
-
describeCopyJob
default DescribeCopyJobResponse describeCopyJob(Consumer<DescribeCopyJobRequest.Builder> describeCopyJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeCopyJobRequest.builder()
- Parameters:
describeCopyJobRequest
- AConsumer
that will call methods onDescribeCopyJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeCopyJob operation returned by the service.
- See Also:
-
describeFramework
default DescribeFrameworkResponse describeFramework(DescribeFrameworkRequest describeFrameworkRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns the framework details for the specified
FrameworkName
.- Parameters:
describeFrameworkRequest
-- Returns:
- Result of the DescribeFramework operation returned by the service.
- See Also:
-
describeFramework
default DescribeFrameworkResponse describeFramework(Consumer<DescribeFrameworkRequest.Builder> describeFrameworkRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeFrameworkRequest.builder()
- Parameters:
describeFrameworkRequest
- AConsumer
that will call methods onDescribeFrameworkRequest.Builder
to create a request.- Returns:
- Result of the DescribeFramework operation returned by the service.
- See Also:
-
describeGlobalSettings
default DescribeGlobalSettingsResponse describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest) throws InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example:
describe-global-settings --region us-west-2
- Parameters:
describeGlobalSettingsRequest
-- Returns:
- Result of the DescribeGlobalSettings operation returned by the service.
- See Also:
-
describeGlobalSettings
default DescribeGlobalSettingsResponse describeGlobalSettings(Consumer<DescribeGlobalSettingsRequest.Builder> describeGlobalSettingsRequest) throws InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeGlobalSettingsRequest.builder()
- Parameters:
describeGlobalSettingsRequest
- AConsumer
that will call methods onDescribeGlobalSettingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeGlobalSettings operation returned by the service.
- See Also:
-
describeProtectedResource
default DescribeProtectedResourceResponse describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest) throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
- Parameters:
describeProtectedResourceRequest
-- Returns:
- Result of the DescribeProtectedResource operation returned by the service.
- See Also:
-
describeProtectedResource
default DescribeProtectedResourceResponse describeProtectedResource(Consumer<DescribeProtectedResourceRequest.Builder> describeProtectedResourceRequest) throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeProtectedResourceRequest.builder()
- Parameters:
describeProtectedResourceRequest
- AConsumer
that will call methods onDescribeProtectedResourceRequest.Builder
to create a request.- Returns:
- Result of the DescribeProtectedResource operation returned by the service.
- See Also:
-
describeRecoveryPoint
default DescribeRecoveryPointResponse describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
- Parameters:
describeRecoveryPointRequest
-- Returns:
- Result of the DescribeRecoveryPoint operation returned by the service.
- See Also:
-
describeRecoveryPoint
default DescribeRecoveryPointResponse describeRecoveryPoint(Consumer<DescribeRecoveryPointRequest.Builder> describeRecoveryPointRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeRecoveryPointRequest.builder()
- Parameters:
describeRecoveryPointRequest
- AConsumer
that will call methods onDescribeRecoveryPointRequest.Builder
to create a request.- Returns:
- Result of the DescribeRecoveryPoint operation returned by the service.
- See Also:
-
describeRegionSettings
default DescribeRegionSettingsResponse describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest) throws ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
- Parameters:
describeRegionSettingsRequest
-- Returns:
- Result of the DescribeRegionSettings operation returned by the service.
- See Also:
-
describeRegionSettings
default DescribeRegionSettingsResponse describeRegionSettings(Consumer<DescribeRegionSettingsRequest.Builder> describeRegionSettingsRequest) throws ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeRegionSettingsRequest.builder()
- Parameters:
describeRegionSettingsRequest
- AConsumer
that will call methods onDescribeRegionSettingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeRegionSettings operation returned by the service.
- See Also:
-
describeReportJob
default DescribeReportJobResponse describeReportJob(DescribeReportJobRequest describeReportJobRequest) throws ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Returns the details associated with creating a report as specified by its
ReportJobId
.- Parameters:
describeReportJobRequest
-- Returns:
- Result of the DescribeReportJob operation returned by the service.
- See Also:
-
describeReportJob
default DescribeReportJobResponse describeReportJob(Consumer<DescribeReportJobRequest.Builder> describeReportJobRequest) throws ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeReportJobRequest.builder()
- Parameters:
describeReportJobRequest
- AConsumer
that will call methods onDescribeReportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeReportJob operation returned by the service.
- See Also:
-
describeReportPlan
default DescribeReportPlanResponse describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest) throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
- Parameters:
describeReportPlanRequest
-- Returns:
- Result of the DescribeReportPlan operation returned by the service.
- See Also:
-
describeReportPlan
default DescribeReportPlanResponse describeReportPlan(Consumer<DescribeReportPlanRequest.Builder> describeReportPlanRequest) throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeReportPlanRequest.builder()
- Parameters:
describeReportPlanRequest
- AConsumer
that will call methods onDescribeReportPlanRequest.Builder
to create a request.- Returns:
- Result of the DescribeReportPlan operation returned by the service.
- See Also:
-
describeRestoreJob
default DescribeRestoreJobResponse describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException Returns metadata associated with a restore job that is specified by a job ID.
- Parameters:
describeRestoreJobRequest
-- Returns:
- Result of the DescribeRestoreJob operation returned by the service.
- See Also:
-
describeRestoreJob
default DescribeRestoreJobResponse describeRestoreJob(Consumer<DescribeRestoreJobRequest.Builder> describeRestoreJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException 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 viaDescribeRestoreJobRequest.builder()
- Parameters:
describeRestoreJobRequest
- AConsumer
that will call methods onDescribeRestoreJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeRestoreJob operation returned by the service.
- See Also:
-
disassociateRecoveryPoint
default DisassociateRecoveryPointResponse disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidResourceStateException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.
Does not support snapshot backup recovery points.
- Parameters:
disassociateRecoveryPointRequest
-- Returns:
- Result of the DisassociateRecoveryPoint operation returned by the service.
- See Also:
-
disassociateRecoveryPoint
default DisassociateRecoveryPointResponse disassociateRecoveryPoint(Consumer<DisassociateRecoveryPointRequest.Builder> disassociateRecoveryPointRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidResourceStateException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException 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 viaDisassociateRecoveryPointRequest.builder()
- Parameters:
disassociateRecoveryPointRequest
- AConsumer
that will call methods onDisassociateRecoveryPointRequest.Builder
to create a request.- Returns:
- Result of the DisassociateRecoveryPoint operation returned by the service.
- See Also:
-
disassociateRecoveryPointFromParent
default DisassociateRecoveryPointFromParentResponse disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
- Parameters:
disassociateRecoveryPointFromParentRequest
-- Returns:
- Result of the DisassociateRecoveryPointFromParent operation returned by the service.
- See Also:
-
disassociateRecoveryPointFromParent
default DisassociateRecoveryPointFromParentResponse disassociateRecoveryPointFromParent(Consumer<DisassociateRecoveryPointFromParentRequest.Builder> disassociateRecoveryPointFromParentRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
This is a convenience which creates an instance of the
DisassociateRecoveryPointFromParentRequest.Builder
avoiding the need to create one manually viaDisassociateRecoveryPointFromParentRequest.builder()
- Parameters:
disassociateRecoveryPointFromParentRequest
- AConsumer
that will call methods onDisassociateRecoveryPointFromParentRequest.Builder
to create a request.- Returns:
- Result of the DisassociateRecoveryPointFromParent operation returned by the service.
- See Also:
-
exportBackupPlanTemplate
default ExportBackupPlanTemplateResponse exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Returns the backup plan that is specified by the plan ID as a backup template.
- Parameters:
exportBackupPlanTemplateRequest
-- Returns:
- Result of the ExportBackupPlanTemplate operation returned by the service.
- See Also:
-
exportBackupPlanTemplate
default ExportBackupPlanTemplateResponse exportBackupPlanTemplate(Consumer<ExportBackupPlanTemplateRequest.Builder> exportBackupPlanTemplateRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaExportBackupPlanTemplateRequest.builder()
- Parameters:
exportBackupPlanTemplateRequest
- AConsumer
that will call methods onExportBackupPlanTemplateRequest.Builder
to create a request.- Returns:
- Result of the ExportBackupPlanTemplate operation returned by the service.
- See Also:
-
getBackupPlan
default GetBackupPlanResponse getBackupPlan(GetBackupPlanRequest getBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns
BackupPlan
details for the specifiedBackupPlanId
. The details are the body of a backup plan in JSON format, in addition to plan metadata.- Parameters:
getBackupPlanRequest
-- Returns:
- Result of the GetBackupPlan operation returned by the service.
- See Also:
-
getBackupPlan
default GetBackupPlanResponse getBackupPlan(Consumer<GetBackupPlanRequest.Builder> getBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns
BackupPlan
details for the specifiedBackupPlanId
. 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 viaGetBackupPlanRequest.builder()
- Parameters:
getBackupPlanRequest
- AConsumer
that will call methods onGetBackupPlanRequest.Builder
to create a request.- Returns:
- Result of the GetBackupPlan operation returned by the service.
- See Also:
-
getBackupPlanFromJSON
default GetBackupPlanFromJsonResponse getBackupPlanFromJSON(GetBackupPlanFromJsonRequest getBackupPlanFromJsonRequest) throws LimitExceededException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Returns a valid JSON document specifying a backup plan or an error.
- Parameters:
getBackupPlanFromJsonRequest
-- Returns:
- Result of the GetBackupPlanFromJSON operation returned by the service.
- See Also:
-
getBackupPlanFromJSON
default GetBackupPlanFromJsonResponse getBackupPlanFromJSON(Consumer<GetBackupPlanFromJsonRequest.Builder> getBackupPlanFromJsonRequest) throws LimitExceededException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException 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 viaGetBackupPlanFromJsonRequest.builder()
- Parameters:
getBackupPlanFromJsonRequest
- AConsumer
that will call methods onGetBackupPlanFromJsonRequest.Builder
to create a request.- Returns:
- Result of the GetBackupPlanFromJSON operation returned by the service.
- See Also:
-
getBackupPlanFromTemplate
default GetBackupPlanFromTemplateResponse getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Returns the template specified by its
templateId
as a backup plan.- Parameters:
getBackupPlanFromTemplateRequest
-- Returns:
- Result of the GetBackupPlanFromTemplate operation returned by the service.
- See Also:
-
getBackupPlanFromTemplate
default GetBackupPlanFromTemplateResponse getBackupPlanFromTemplate(Consumer<GetBackupPlanFromTemplateRequest.Builder> getBackupPlanFromTemplateRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaGetBackupPlanFromTemplateRequest.builder()
- Parameters:
getBackupPlanFromTemplateRequest
- AConsumer
that will call methods onGetBackupPlanFromTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetBackupPlanFromTemplate operation returned by the service.
- See Also:
-
getBackupSelection
default GetBackupSelectionResponse getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
- Parameters:
getBackupSelectionRequest
-- Returns:
- Result of the GetBackupSelection operation returned by the service.
- See Also:
-
getBackupSelection
default GetBackupSelectionResponse getBackupSelection(Consumer<GetBackupSelectionRequest.Builder> getBackupSelectionRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaGetBackupSelectionRequest.builder()
- Parameters:
getBackupSelectionRequest
- AConsumer
that will call methods onGetBackupSelectionRequest.Builder
to create a request.- Returns:
- Result of the GetBackupSelection operation returned by the service.
- See Also:
-
getBackupVaultAccessPolicy
default GetBackupVaultAccessPolicyResponse getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns the access policy document that is associated with the named backup vault.
- Parameters:
getBackupVaultAccessPolicyRequest
-- Returns:
- Result of the GetBackupVaultAccessPolicy operation returned by the service.
- See Also:
-
getBackupVaultAccessPolicy
default GetBackupVaultAccessPolicyResponse getBackupVaultAccessPolicy(Consumer<GetBackupVaultAccessPolicyRequest.Builder> getBackupVaultAccessPolicyRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaGetBackupVaultAccessPolicyRequest.builder()
- Parameters:
getBackupVaultAccessPolicyRequest
- AConsumer
that will call methods onGetBackupVaultAccessPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetBackupVaultAccessPolicy operation returned by the service.
- See Also:
-
getBackupVaultNotifications
default GetBackupVaultNotificationsResponse getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns event notifications for the specified backup vault.
- Parameters:
getBackupVaultNotificationsRequest
-- Returns:
- Result of the GetBackupVaultNotifications operation returned by the service.
- See Also:
-
getBackupVaultNotifications
default GetBackupVaultNotificationsResponse getBackupVaultNotifications(Consumer<GetBackupVaultNotificationsRequest.Builder> getBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaGetBackupVaultNotificationsRequest.builder()
- Parameters:
getBackupVaultNotificationsRequest
- AConsumer
that will call methods onGetBackupVaultNotificationsRequest.Builder
to create a request.- Returns:
- Result of the GetBackupVaultNotifications operation returned by the service.
- See Also:
-
getLegalHold
default GetLegalHoldResponse getLegalHold(GetLegalHoldRequest getLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
- Parameters:
getLegalHoldRequest
-- Returns:
- Result of the GetLegalHold operation returned by the service.
- See Also:
-
getLegalHold
default GetLegalHoldResponse getLegalHold(Consumer<GetLegalHoldRequest.Builder> getLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
This is a convenience which creates an instance of the
GetLegalHoldRequest.Builder
avoiding the need to create one manually viaGetLegalHoldRequest.builder()
- Parameters:
getLegalHoldRequest
- AConsumer
that will call methods onGetLegalHoldRequest.Builder
to create a request.- Returns:
- Result of the GetLegalHold operation returned by the service.
- See Also:
-
getRecoveryPointRestoreMetadata
default GetRecoveryPointRestoreMetadataResponse getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a set of metadata key-value pairs that were used to create the backup.
- Parameters:
getRecoveryPointRestoreMetadataRequest
-- Returns:
- Result of the GetRecoveryPointRestoreMetadata operation returned by the service.
- See Also:
-
getRecoveryPointRestoreMetadata
default GetRecoveryPointRestoreMetadataResponse getRecoveryPointRestoreMetadata(Consumer<GetRecoveryPointRestoreMetadataRequest.Builder> getRecoveryPointRestoreMetadataRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaGetRecoveryPointRestoreMetadataRequest.builder()
- Parameters:
getRecoveryPointRestoreMetadataRequest
- AConsumer
that will call methods onGetRecoveryPointRestoreMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetRecoveryPointRestoreMetadata operation returned by the service.
- See Also:
-
getRestoreJobMetadata
default GetRestoreJobMetadataResponse getRestoreJobMetadata(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request returns the metadata for the specified restore job.
- Parameters:
getRestoreJobMetadataRequest
-- Returns:
- Result of the GetRestoreJobMetadata operation returned by the service.
- See Also:
-
getRestoreJobMetadata
default GetRestoreJobMetadataResponse getRestoreJobMetadata(Consumer<GetRestoreJobMetadataRequest.Builder> getRestoreJobMetadataRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request returns the metadata for the specified restore job.
This is a convenience which creates an instance of the
GetRestoreJobMetadataRequest.Builder
avoiding the need to create one manually viaGetRestoreJobMetadataRequest.builder()
- Parameters:
getRestoreJobMetadataRequest
- AConsumer
that will call methods onGetRestoreJobMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetRestoreJobMetadata operation returned by the service.
- See Also:
-
getRestoreTestingInferredMetadata
default GetRestoreTestingInferredMetadataResponse getRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest) throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request returns the minimal required set of metadata needed to start a restore job with secure default settings.
BackupVaultName
andRecoveryPointArn
are required parameters.BackupVaultAccountId
is an optional parameter.- Parameters:
getRestoreTestingInferredMetadataRequest
-- Returns:
- Result of the GetRestoreTestingInferredMetadata operation returned by the service.
- See Also:
-
getRestoreTestingInferredMetadata
default GetRestoreTestingInferredMetadataResponse getRestoreTestingInferredMetadata(Consumer<GetRestoreTestingInferredMetadataRequest.Builder> getRestoreTestingInferredMetadataRequest) throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request returns the minimal required set of metadata needed to start a restore job with secure default settings.
BackupVaultName
andRecoveryPointArn
are required parameters.BackupVaultAccountId
is an optional parameter.
This is a convenience which creates an instance of the
GetRestoreTestingInferredMetadataRequest.Builder
avoiding the need to create one manually viaGetRestoreTestingInferredMetadataRequest.builder()
- Parameters:
getRestoreTestingInferredMetadataRequest
- AConsumer
that will call methods onGetRestoreTestingInferredMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetRestoreTestingInferredMetadata operation returned by the service.
- See Also:
-
getRestoreTestingPlan
default GetRestoreTestingPlanResponse getRestoreTestingPlan(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns
RestoreTestingPlan
details for the specifiedRestoreTestingPlanName
. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.- Parameters:
getRestoreTestingPlanRequest
-- Returns:
- Result of the GetRestoreTestingPlan operation returned by the service.
- See Also:
-
getRestoreTestingPlan
default GetRestoreTestingPlanResponse getRestoreTestingPlan(Consumer<GetRestoreTestingPlanRequest.Builder> getRestoreTestingPlanRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns
RestoreTestingPlan
details for the specifiedRestoreTestingPlanName
. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.
This is a convenience which creates an instance of the
GetRestoreTestingPlanRequest.Builder
avoiding the need to create one manually viaGetRestoreTestingPlanRequest.builder()
- Parameters:
getRestoreTestingPlanRequest
- AConsumer
that will call methods onGetRestoreTestingPlanRequest.Builder
to create a request.- Returns:
- Result of the GetRestoreTestingPlan operation returned by the service.
- See Also:
-
getRestoreTestingSelection
default GetRestoreTestingSelectionResponse getRestoreTestingSelection(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
- Parameters:
getRestoreTestingSelectionRequest
-- Returns:
- Result of the GetRestoreTestingSelection operation returned by the service.
- See Also:
-
getRestoreTestingSelection
default GetRestoreTestingSelectionResponse getRestoreTestingSelection(Consumer<GetRestoreTestingSelectionRequest.Builder> getRestoreTestingSelectionRequest) throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
This is a convenience which creates an instance of the
GetRestoreTestingSelectionRequest.Builder
avoiding the need to create one manually viaGetRestoreTestingSelectionRequest.builder()
- Parameters:
getRestoreTestingSelectionRequest
- AConsumer
that will call methods onGetRestoreTestingSelectionRequest.Builder
to create a request.- Returns:
- Result of the GetRestoreTestingSelection operation returned by the service.
- See Also:
-
getSupportedResourceTypes
default GetSupportedResourceTypesResponse getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest) throws ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns the Amazon Web Services resource types supported by Backup.
- Parameters:
getSupportedResourceTypesRequest
-- Returns:
- Result of the GetSupportedResourceTypes operation returned by the service.
- See Also:
-
getSupportedResourceTypes
default GetSupportedResourceTypesResponse getSupportedResourceTypes(Consumer<GetSupportedResourceTypesRequest.Builder> getSupportedResourceTypesRequest) throws ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaGetSupportedResourceTypesRequest.builder()
- Parameters:
getSupportedResourceTypesRequest
- AConsumer
that will call methods onGetSupportedResourceTypesRequest.Builder
to create a request.- Returns:
- Result of the GetSupportedResourceTypes operation returned by the service.
- See Also:
-
listBackupJobSummaries
default ListBackupJobSummariesResponse listBackupJobSummaries(ListBackupJobSummariesRequest listBackupJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
- Parameters:
listBackupJobSummariesRequest
-- Returns:
- Result of the ListBackupJobSummaries operation returned by the service.
- See Also:
-
listBackupJobSummaries
default ListBackupJobSummariesResponse listBackupJobSummaries(Consumer<ListBackupJobSummariesRequest.Builder> listBackupJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
This is a convenience which creates an instance of the
ListBackupJobSummariesRequest.Builder
avoiding the need to create one manually viaListBackupJobSummariesRequest.builder()
- Parameters:
listBackupJobSummariesRequest
- AConsumer
that will call methods onListBackupJobSummariesRequest.Builder
to create a request.- Returns:
- Result of the ListBackupJobSummaries operation returned by the service.
- See Also:
-
listBackupJobSummariesPaginator
default ListBackupJobSummariesIterable listBackupJobSummariesPaginator(ListBackupJobSummariesRequest listBackupJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client .listBackupJobSummariesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupJobSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)
operation.- Parameters:
listBackupJobSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupJobSummariesPaginator
default ListBackupJobSummariesIterable listBackupJobSummariesPaginator(Consumer<ListBackupJobSummariesRequest.Builder> listBackupJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client .listBackupJobSummariesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupJobSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)
operation.
This is a convenience which creates an instance of the
ListBackupJobSummariesRequest.Builder
avoiding the need to create one manually viaListBackupJobSummariesRequest.builder()
- Parameters:
listBackupJobSummariesRequest
- AConsumer
that will call methods onListBackupJobSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupJobs
default ListBackupJobsResponse listBackupJobs(ListBackupJobsRequest listBackupJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
- Parameters:
listBackupJobsRequest
-- Returns:
- Result of the ListBackupJobs operation returned by the service.
- See Also:
-
listBackupJobs
default ListBackupJobsResponse listBackupJobs(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListBackupJobsRequest.builder()
- Parameters:
listBackupJobsRequest
- AConsumer
that will call methods onListBackupJobsRequest.Builder
to create a request.- Returns:
- Result of the ListBackupJobs operation returned by the service.
- See Also:
-
listBackupJobs
default ListBackupJobsResponse listBackupJobs() throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionReturns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
- Returns:
- Result of the ListBackupJobs operation returned by the service.
- See Also:
-
listBackupJobsPaginator
default ListBackupJobsIterable listBackupJobsPaginator() throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionThis is a variant of
listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupJobsPaginator
default ListBackupJobsIterable listBackupJobsPaginator(ListBackupJobsRequest listBackupJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation.- Parameters:
listBackupJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupJobsPaginator
default ListBackupJobsIterable listBackupJobsPaginator(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListBackupJobsRequest.builder()
- Parameters:
listBackupJobsRequest
- AConsumer
that will call methods onListBackupJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlanTemplates
default ListBackupPlanTemplatesResponse listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
- Parameters:
listBackupPlanTemplatesRequest
-- Returns:
- Result of the ListBackupPlanTemplates operation returned by the service.
- See Also:
-
listBackupPlanTemplates
default ListBackupPlanTemplatesResponse listBackupPlanTemplates(Consumer<ListBackupPlanTemplatesRequest.Builder> listBackupPlanTemplatesRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaListBackupPlanTemplatesRequest.builder()
- Parameters:
listBackupPlanTemplatesRequest
- AConsumer
that will call methods onListBackupPlanTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListBackupPlanTemplates operation returned by the service.
- See Also:
-
listBackupPlanTemplates
default ListBackupPlanTemplatesResponse listBackupPlanTemplates() throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupExceptionReturns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
- Returns:
- Result of the ListBackupPlanTemplates operation returned by the service.
- See Also:
-
listBackupPlanTemplatesPaginator
default ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator() throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupExceptionThis is a variant of
listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client .listBackupPlanTemplatesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlanTemplatesPaginator
default ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client .listBackupPlanTemplatesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation.- Parameters:
listBackupPlanTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlanTemplatesPaginator
default ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator(Consumer<ListBackupPlanTemplatesRequest.Builder> listBackupPlanTemplatesRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client .listBackupPlanTemplatesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListBackupPlanTemplatesRequest.builder()
- Parameters:
listBackupPlanTemplatesRequest
- AConsumer
that will call methods onListBackupPlanTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlanVersions
default ListBackupPlanVersionsResponse listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
- Parameters:
listBackupPlanVersionsRequest
-- Returns:
- Result of the ListBackupPlanVersions operation returned by the service.
- See Also:
-
listBackupPlanVersions
default ListBackupPlanVersionsResponse listBackupPlanVersions(Consumer<ListBackupPlanVersionsRequest.Builder> listBackupPlanVersionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListBackupPlanVersionsRequest.builder()
- Parameters:
listBackupPlanVersionsRequest
- AConsumer
that will call methods onListBackupPlanVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListBackupPlanVersions operation returned by the service.
- See Also:
-
listBackupPlanVersionsPaginator
default ListBackupPlanVersionsIterable listBackupPlanVersionsPaginator(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client .listBackupPlanVersionsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)
operation.- Parameters:
listBackupPlanVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlanVersionsPaginator
default ListBackupPlanVersionsIterable listBackupPlanVersionsPaginator(Consumer<ListBackupPlanVersionsRequest.Builder> listBackupPlanVersionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client .listBackupPlanVersionsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListBackupPlanVersionsRequest.builder()
- Parameters:
listBackupPlanVersionsRequest
- AConsumer
that will call methods onListBackupPlanVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlans
default ListBackupPlansResponse listBackupPlans(ListBackupPlansRequest listBackupPlansRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
- Parameters:
listBackupPlansRequest
-- Returns:
- Result of the ListBackupPlans operation returned by the service.
- See Also:
-
listBackupPlans
default ListBackupPlansResponse listBackupPlans(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListBackupPlansRequest.builder()
- Parameters:
listBackupPlansRequest
- AConsumer
that will call methods onListBackupPlansRequest.Builder
to create a request.- Returns:
- Result of the ListBackupPlans operation returned by the service.
- See Also:
-
listBackupPlans
default ListBackupPlansResponse listBackupPlans() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionReturns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
- Returns:
- Result of the ListBackupPlans operation returned by the service.
- See Also:
-
listBackupPlansPaginator
default ListBackupPlansIterable listBackupPlansPaginator() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionThis is a variant of
listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client .listBackupPlansPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlansPaginator
default ListBackupPlansIterable listBackupPlansPaginator(ListBackupPlansRequest listBackupPlansRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client .listBackupPlansPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation.- Parameters:
listBackupPlansRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupPlansPaginator
default ListBackupPlansIterable listBackupPlansPaginator(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client .listBackupPlansPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListBackupPlansRequest.builder()
- Parameters:
listBackupPlansRequest
- AConsumer
that will call methods onListBackupPlansRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupSelections
default ListBackupSelectionsResponse listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns an array containing metadata of the resources associated with the target backup plan.
- Parameters:
listBackupSelectionsRequest
-- Returns:
- Result of the ListBackupSelections operation returned by the service.
- See Also:
-
listBackupSelections
default ListBackupSelectionsResponse listBackupSelections(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListBackupSelectionsRequest.builder()
- Parameters:
listBackupSelectionsRequest
- AConsumer
that will call methods onListBackupSelectionsRequest.Builder
to create a request.- Returns:
- Result of the ListBackupSelections operation returned by the service.
- See Also:
-
listBackupSelectionsPaginator
default ListBackupSelectionsIterable listBackupSelectionsPaginator(ListBackupSelectionsRequest listBackupSelectionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client .listBackupSelectionsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)
operation.- Parameters:
listBackupSelectionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupSelectionsPaginator
default ListBackupSelectionsIterable listBackupSelectionsPaginator(Consumer<ListBackupSelectionsRequest.Builder> listBackupSelectionsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client .listBackupSelectionsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListBackupSelectionsRequest.builder()
- Parameters:
listBackupSelectionsRequest
- AConsumer
that will call methods onListBackupSelectionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupVaults
default ListBackupVaultsResponse listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of recovery point storage containers along with information about them.
- Parameters:
listBackupVaultsRequest
-- Returns:
- Result of the ListBackupVaults operation returned by the service.
- See Also:
-
listBackupVaults
default ListBackupVaultsResponse listBackupVaults(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListBackupVaultsRequest.builder()
- Parameters:
listBackupVaultsRequest
- AConsumer
that will call methods onListBackupVaultsRequest.Builder
to create a request.- Returns:
- Result of the ListBackupVaults operation returned by the service.
- See Also:
-
listBackupVaults
default ListBackupVaultsResponse listBackupVaults() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionReturns a list of recovery point storage containers along with information about them.
- Returns:
- Result of the ListBackupVaults operation returned by the service.
- See Also:
-
listBackupVaultsPaginator
default ListBackupVaultsIterable listBackupVaultsPaginator() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionThis is a variant of
listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client .listBackupVaultsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupVaultsPaginator
default ListBackupVaultsIterable listBackupVaultsPaginator(ListBackupVaultsRequest listBackupVaultsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client .listBackupVaultsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation.- Parameters:
listBackupVaultsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackupVaultsPaginator
default ListBackupVaultsIterable listBackupVaultsPaginator(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client .listBackupVaultsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListBackupVaultsRequest.builder()
- Parameters:
listBackupVaultsRequest
- AConsumer
that will call methods onListBackupVaultsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCopyJobSummaries
default ListCopyJobSummariesResponse listCopyJobSummaries(ListCopyJobSummariesRequest listCopyJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
- Parameters:
listCopyJobSummariesRequest
-- Returns:
- Result of the ListCopyJobSummaries operation returned by the service.
- See Also:
-
listCopyJobSummaries
default ListCopyJobSummariesResponse listCopyJobSummaries(Consumer<ListCopyJobSummariesRequest.Builder> listCopyJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
This is a convenience which creates an instance of the
ListCopyJobSummariesRequest.Builder
avoiding the need to create one manually viaListCopyJobSummariesRequest.builder()
- Parameters:
listCopyJobSummariesRequest
- AConsumer
that will call methods onListCopyJobSummariesRequest.Builder
to create a request.- Returns:
- Result of the ListCopyJobSummaries operation returned by the service.
- See Also:
-
listCopyJobSummariesPaginator
default ListCopyJobSummariesIterable listCopyJobSummariesPaginator(ListCopyJobSummariesRequest listCopyJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client .listCopyJobSummariesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListCopyJobSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)
operation.- Parameters:
listCopyJobSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCopyJobSummariesPaginator
default ListCopyJobSummariesIterable listCopyJobSummariesPaginator(Consumer<ListCopyJobSummariesRequest.Builder> listCopyJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client .listCopyJobSummariesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListCopyJobSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)
operation.
This is a convenience which creates an instance of the
ListCopyJobSummariesRequest.Builder
avoiding the need to create one manually viaListCopyJobSummariesRequest.builder()
- Parameters:
listCopyJobSummariesRequest
- AConsumer
that will call methods onListCopyJobSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCopyJobs
default ListCopyJobsResponse listCopyJobs(ListCopyJobsRequest listCopyJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns metadata about your copy jobs.
- Parameters:
listCopyJobsRequest
-- Returns:
- Result of the ListCopyJobs operation returned by the service.
- See Also:
-
listCopyJobs
default ListCopyJobsResponse listCopyJobs(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListCopyJobsRequest.builder()
- Parameters:
listCopyJobsRequest
- AConsumer
that will call methods onListCopyJobsRequest.Builder
to create a request.- Returns:
- Result of the ListCopyJobs operation returned by the service.
- See Also:
-
listCopyJobsPaginator
default ListCopyJobsIterable listCopyJobsPaginator(ListCopyJobsRequest listCopyJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListCopyJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)
operation.- Parameters:
listCopyJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCopyJobsPaginator
default ListCopyJobsIterable listCopyJobsPaginator(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListCopyJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListCopyJobsRequest.builder()
- Parameters:
listCopyJobsRequest
- AConsumer
that will call methods onListCopyJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFrameworks
default ListFrameworksResponse listFrameworks(ListFrameworksRequest listFrameworksRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
- Parameters:
listFrameworksRequest
-- Returns:
- Result of the ListFrameworks operation returned by the service.
- See Also:
-
listFrameworks
default ListFrameworksResponse listFrameworks(Consumer<ListFrameworksRequest.Builder> listFrameworksRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListFrameworksRequest.builder()
- Parameters:
listFrameworksRequest
- AConsumer
that will call methods onListFrameworksRequest.Builder
to create a request.- Returns:
- Result of the ListFrameworks operation returned by the service.
- See Also:
-
listFrameworksPaginator
default ListFrameworksIterable listFrameworksPaginator(ListFrameworksRequest listFrameworksRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request); for (software.amazon.awssdk.services.backup.model.ListFrameworksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)
operation.- Parameters:
listFrameworksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFrameworksPaginator
default ListFrameworksIterable listFrameworksPaginator(Consumer<ListFrameworksRequest.Builder> listFrameworksRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request); for (software.amazon.awssdk.services.backup.model.ListFrameworksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListFrameworksRequest.builder()
- Parameters:
listFrameworksRequest
- AConsumer
that will call methods onListFrameworksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLegalHolds
default ListLegalHoldsResponse listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This action returns metadata about active and previous legal holds.
- Parameters:
listLegalHoldsRequest
-- Returns:
- Result of the ListLegalHolds operation returned by the service.
- See Also:
-
listLegalHolds
default ListLegalHoldsResponse listLegalHolds(Consumer<ListLegalHoldsRequest.Builder> listLegalHoldsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This action returns metadata about active and previous legal holds.
This is a convenience which creates an instance of the
ListLegalHoldsRequest.Builder
avoiding the need to create one manually viaListLegalHoldsRequest.builder()
- Parameters:
listLegalHoldsRequest
- AConsumer
that will call methods onListLegalHoldsRequest.Builder
to create a request.- Returns:
- Result of the ListLegalHolds operation returned by the service.
- See Also:
-
listLegalHoldsPaginator
default ListLegalHoldsIterable listLegalHoldsPaginator(ListLegalHoldsRequest listLegalHoldsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation.- Parameters:
listLegalHoldsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLegalHoldsPaginator
default ListLegalHoldsIterable listLegalHoldsPaginator(Consumer<ListLegalHoldsRequest.Builder> listLegalHoldsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation.
This is a convenience which creates an instance of the
ListLegalHoldsRequest.Builder
avoiding the need to create one manually viaListLegalHoldsRequest.builder()
- Parameters:
listLegalHoldsRequest
- AConsumer
that will call methods onListLegalHoldsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectedResources
default ListProtectedResourcesResponse listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
- Parameters:
listProtectedResourcesRequest
-- Returns:
- Result of the ListProtectedResources operation returned by the service.
- See Also:
-
listProtectedResources
default ListProtectedResourcesResponse listProtectedResources(Consumer<ListProtectedResourcesRequest.Builder> listProtectedResourcesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListProtectedResourcesRequest.builder()
- Parameters:
listProtectedResourcesRequest
- AConsumer
that will call methods onListProtectedResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListProtectedResources operation returned by the service.
- See Also:
-
listProtectedResources
default ListProtectedResourcesResponse listProtectedResources() throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionReturns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
- Returns:
- Result of the ListProtectedResources operation returned by the service.
- See Also:
-
listProtectedResourcesPaginator
default ListProtectedResourcesIterable listProtectedResourcesPaginator() throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionThis is a variant of
listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client .listProtectedResourcesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectedResourcesPaginator
default ListProtectedResourcesIterable listProtectedResourcesPaginator(ListProtectedResourcesRequest listProtectedResourcesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client .listProtectedResourcesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation.- Parameters:
listProtectedResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectedResourcesPaginator
default ListProtectedResourcesIterable listProtectedResourcesPaginator(Consumer<ListProtectedResourcesRequest.Builder> listProtectedResourcesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client .listProtectedResourcesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListProtectedResourcesRequest.builder()
- Parameters:
listProtectedResourcesRequest
- AConsumer
that will call methods onListProtectedResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectedResourcesByBackupVault
default ListProtectedResourcesByBackupVaultResponse listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request lists the protected resources corresponding to each backup vault.
- Parameters:
listProtectedResourcesByBackupVaultRequest
-- Returns:
- Result of the ListProtectedResourcesByBackupVault operation returned by the service.
- See Also:
-
listProtectedResourcesByBackupVault
default ListProtectedResourcesByBackupVaultResponse listProtectedResourcesByBackupVault(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request lists the protected resources corresponding to each backup vault.
This is a convenience which creates an instance of the
ListProtectedResourcesByBackupVaultRequest.Builder
avoiding the need to create one manually viaListProtectedResourcesByBackupVaultRequest.builder()
- Parameters:
listProtectedResourcesByBackupVaultRequest
- AConsumer
that will call methods onListProtectedResourcesByBackupVaultRequest.Builder
to create a request.- Returns:
- Result of the ListProtectedResourcesByBackupVault operation returned by the service.
- See Also:
-
listProtectedResourcesByBackupVaultPaginator
default ListProtectedResourcesByBackupVaultIterable listProtectedResourcesByBackupVaultPaginator(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client .listProtectedResourcesByBackupVaultPaginator(request); for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)
operation.- Parameters:
listProtectedResourcesByBackupVaultRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectedResourcesByBackupVaultPaginator
default ListProtectedResourcesByBackupVaultIterable listProtectedResourcesByBackupVaultPaginator(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client .listProtectedResourcesByBackupVaultPaginator(request); for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)
operation.
This is a convenience which creates an instance of the
ListProtectedResourcesByBackupVaultRequest.Builder
avoiding the need to create one manually viaListProtectedResourcesByBackupVaultRequest.builder()
- Parameters:
listProtectedResourcesByBackupVaultRequest
- AConsumer
that will call methods onListProtectedResourcesByBackupVaultRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecoveryPointsByBackupVault
default ListRecoveryPointsByBackupVaultResponse listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns detailed information about the recovery points stored in a backup vault.
- Parameters:
listRecoveryPointsByBackupVaultRequest
-- Returns:
- Result of the ListRecoveryPointsByBackupVault operation returned by the service.
- See Also:
-
listRecoveryPointsByBackupVault
default ListRecoveryPointsByBackupVaultResponse listRecoveryPointsByBackupVault(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListRecoveryPointsByBackupVaultRequest.builder()
- Parameters:
listRecoveryPointsByBackupVaultRequest
- AConsumer
that will call methods onListRecoveryPointsByBackupVaultRequest.Builder
to create a request.- Returns:
- Result of the ListRecoveryPointsByBackupVault operation returned by the service.
- See Also:
-
listRecoveryPointsByBackupVaultPaginator
default ListRecoveryPointsByBackupVaultIterable listRecoveryPointsByBackupVaultPaginator(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client .listRecoveryPointsByBackupVaultPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)
operation.- Parameters:
listRecoveryPointsByBackupVaultRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecoveryPointsByBackupVaultPaginator
default ListRecoveryPointsByBackupVaultIterable listRecoveryPointsByBackupVaultPaginator(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client .listRecoveryPointsByBackupVaultPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListRecoveryPointsByBackupVaultRequest.builder()
- Parameters:
listRecoveryPointsByBackupVaultRequest
- AConsumer
that will call methods onListRecoveryPointsByBackupVaultRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecoveryPointsByLegalHold
default ListRecoveryPointsByLegalHoldResponse listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
- Parameters:
listRecoveryPointsByLegalHoldRequest
-- Returns:
- Result of the ListRecoveryPointsByLegalHold operation returned by the service.
- See Also:
-
listRecoveryPointsByLegalHold
default ListRecoveryPointsByLegalHoldResponse listRecoveryPointsByLegalHold(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
This is a convenience which creates an instance of the
ListRecoveryPointsByLegalHoldRequest.Builder
avoiding the need to create one manually viaListRecoveryPointsByLegalHoldRequest.builder()
- Parameters:
listRecoveryPointsByLegalHoldRequest
- AConsumer
that will call methods onListRecoveryPointsByLegalHoldRequest.Builder
to create a request.- Returns:
- Result of the ListRecoveryPointsByLegalHold operation returned by the service.
- See Also:
-
listRecoveryPointsByLegalHoldPaginator
default ListRecoveryPointsByLegalHoldIterable listRecoveryPointsByLegalHoldPaginator(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client .listRecoveryPointsByLegalHoldPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)
operation.- Parameters:
listRecoveryPointsByLegalHoldRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecoveryPointsByLegalHoldPaginator
default ListRecoveryPointsByLegalHoldIterable listRecoveryPointsByLegalHoldPaginator(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client .listRecoveryPointsByLegalHoldPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)
operation.
This is a convenience which creates an instance of the
ListRecoveryPointsByLegalHoldRequest.Builder
avoiding the need to create one manually viaListRecoveryPointsByLegalHoldRequest.builder()
- Parameters:
listRecoveryPointsByLegalHoldRequest
- AConsumer
that will call methods onListRecoveryPointsByLegalHoldRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecoveryPointsByResource
default ListRecoveryPointsByResourceResponse listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
- Parameters:
listRecoveryPointsByResourceRequest
-- Returns:
- Result of the ListRecoveryPointsByResource operation returned by the service.
- See Also:
-
listRecoveryPointsByResource
default ListRecoveryPointsByResourceResponse listRecoveryPointsByResource(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListRecoveryPointsByResourceRequest.builder()
- Parameters:
listRecoveryPointsByResourceRequest
- AConsumer
that will call methods onListRecoveryPointsByResourceRequest.Builder
to create a request.- Returns:
- Result of the ListRecoveryPointsByResource operation returned by the service.
- See Also:
-
listRecoveryPointsByResourcePaginator
default ListRecoveryPointsByResourceIterable listRecoveryPointsByResourcePaginator(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client .listRecoveryPointsByResourcePaginator(request); for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)
operation.- Parameters:
listRecoveryPointsByResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecoveryPointsByResourcePaginator
default ListRecoveryPointsByResourceIterable listRecoveryPointsByResourcePaginator(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client .listRecoveryPointsByResourcePaginator(request); for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListRecoveryPointsByResourceRequest.builder()
- Parameters:
listRecoveryPointsByResourceRequest
- AConsumer
that will call methods onListRecoveryPointsByResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReportJobs
default ListReportJobsResponse listReportJobs(ListReportJobsRequest listReportJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Returns details about your report jobs.
- Parameters:
listReportJobsRequest
-- Returns:
- Result of the ListReportJobs operation returned by the service.
- See Also:
-
listReportJobs
default ListReportJobsResponse listReportJobs(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaListReportJobsRequest.builder()
- Parameters:
listReportJobsRequest
- AConsumer
that will call methods onListReportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListReportJobs operation returned by the service.
- See Also:
-
listReportJobsPaginator
default ListReportJobsIterable listReportJobsPaginator(ListReportJobsRequest listReportJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This is a variant of
listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListReportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)
operation.- Parameters:
listReportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReportJobsPaginator
default ListReportJobsIterable listReportJobsPaginator(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException This is a variant of
listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListReportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListReportJobsRequest.builder()
- Parameters:
listReportJobsRequest
- AConsumer
that will call methods onListReportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReportPlans
default ListReportPlansResponse listReportPlans(ListReportPlansRequest listReportPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of your report plans. For detailed information about a single report plan, use
DescribeReportPlan
.- Parameters:
listReportPlansRequest
-- Returns:
- Result of the ListReportPlans operation returned by the service.
- See Also:
-
listReportPlans
default ListReportPlansResponse listReportPlans(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListReportPlansRequest.builder()
- Parameters:
listReportPlansRequest
- AConsumer
that will call methods onListReportPlansRequest.Builder
to create a request.- Returns:
- Result of the ListReportPlans operation returned by the service.
- See Also:
-
listReportPlansPaginator
default ListReportPlansIterable listReportPlansPaginator(ListReportPlansRequest listReportPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client .listReportPlansPaginator(request); for (software.amazon.awssdk.services.backup.model.ListReportPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)
operation.- Parameters:
listReportPlansRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReportPlansPaginator
default ListReportPlansIterable listReportPlansPaginator(Consumer<ListReportPlansRequest.Builder> listReportPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client .listReportPlansPaginator(request); for (software.amazon.awssdk.services.backup.model.ListReportPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListReportPlansRequest.builder()
- Parameters:
listReportPlansRequest
- AConsumer
that will call methods onListReportPlansRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreJobSummaries
default ListRestoreJobSummariesResponse listRestoreJobSummaries(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
- Parameters:
listRestoreJobSummariesRequest
-- Returns:
- Result of the ListRestoreJobSummaries operation returned by the service.
- See Also:
-
listRestoreJobSummaries
default ListRestoreJobSummariesResponse listRestoreJobSummaries(Consumer<ListRestoreJobSummariesRequest.Builder> listRestoreJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
This is a convenience which creates an instance of the
ListRestoreJobSummariesRequest.Builder
avoiding the need to create one manually viaListRestoreJobSummariesRequest.builder()
- Parameters:
listRestoreJobSummariesRequest
- AConsumer
that will call methods onListRestoreJobSummariesRequest.Builder
to create a request.- Returns:
- Result of the ListRestoreJobSummaries operation returned by the service.
- See Also:
-
listRestoreJobSummariesPaginator
default ListRestoreJobSummariesIterable listRestoreJobSummariesPaginator(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client .listRestoreJobSummariesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)
operation.- Parameters:
listRestoreJobSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreJobSummariesPaginator
default ListRestoreJobSummariesIterable listRestoreJobSummariesPaginator(Consumer<ListRestoreJobSummariesRequest.Builder> listRestoreJobSummariesRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client .listRestoreJobSummariesPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)
operation.
This is a convenience which creates an instance of the
ListRestoreJobSummariesRequest.Builder
avoiding the need to create one manually viaListRestoreJobSummariesRequest.builder()
- Parameters:
listRestoreJobSummariesRequest
- AConsumer
that will call methods onListRestoreJobSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreJobs
default ListRestoreJobsResponse listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
- Parameters:
listRestoreJobsRequest
-- Returns:
- Result of the ListRestoreJobs operation returned by the service.
- See Also:
-
listRestoreJobs
default ListRestoreJobsResponse listRestoreJobs(Consumer<ListRestoreJobsRequest.Builder> listRestoreJobsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListRestoreJobsRequest.builder()
- Parameters:
listRestoreJobsRequest
- AConsumer
that will call methods onListRestoreJobsRequest.Builder
to create a request.- Returns:
- Result of the ListRestoreJobs operation returned by the service.
- See Also:
-
listRestoreJobs
default ListRestoreJobsResponse listRestoreJobs() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionReturns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
- Returns:
- Result of the ListRestoreJobs operation returned by the service.
- See Also:
-
listRestoreJobsPaginator
default ListRestoreJobsIterable listRestoreJobsPaginator() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupExceptionThis is a variant of
listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client .listRestoreJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreJobsPaginator
default ListRestoreJobsIterable listRestoreJobsPaginator(ListRestoreJobsRequest listRestoreJobsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client .listRestoreJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation.- Parameters:
listRestoreJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreJobsPaginator
default ListRestoreJobsIterable listRestoreJobsPaginator(Consumer<ListRestoreJobsRequest.Builder> listRestoreJobsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client .listRestoreJobsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListRestoreJobsRequest.builder()
- Parameters:
listRestoreJobsRequest
- AConsumer
that will call methods onListRestoreJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreJobsByProtectedResource
default ListRestoreJobsByProtectedResourceResponse listRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This returns restore jobs that contain the specified protected resource.
You must include
ResourceArn
. You can optionally includeNextToken
,ByStatus
,MaxResults
,ByRecoveryPointCreationDateAfter
, andByRecoveryPointCreationDateBefore
.- Parameters:
listRestoreJobsByProtectedResourceRequest
-- Returns:
- Result of the ListRestoreJobsByProtectedResource operation returned by the service.
- See Also:
-
listRestoreJobsByProtectedResource
default ListRestoreJobsByProtectedResourceResponse listRestoreJobsByProtectedResource(Consumer<ListRestoreJobsByProtectedResourceRequest.Builder> listRestoreJobsByProtectedResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This returns restore jobs that contain the specified protected resource.
You must include
ResourceArn
. You can optionally includeNextToken
,ByStatus
,MaxResults
,ByRecoveryPointCreationDateAfter
, andByRecoveryPointCreationDateBefore
.
This is a convenience which creates an instance of the
ListRestoreJobsByProtectedResourceRequest.Builder
avoiding the need to create one manually viaListRestoreJobsByProtectedResourceRequest.builder()
- Parameters:
listRestoreJobsByProtectedResourceRequest
- AConsumer
that will call methods onListRestoreJobsByProtectedResourceRequest.Builder
to create a request.- Returns:
- Result of the ListRestoreJobsByProtectedResource operation returned by the service.
- See Also:
-
listRestoreJobsByProtectedResourcePaginator
default ListRestoreJobsByProtectedResourceIterable listRestoreJobsByProtectedResourcePaginator(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client .listRestoreJobsByProtectedResourcePaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)
operation.- Parameters:
listRestoreJobsByProtectedResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreJobsByProtectedResourcePaginator
default ListRestoreJobsByProtectedResourceIterable listRestoreJobsByProtectedResourcePaginator(Consumer<ListRestoreJobsByProtectedResourceRequest.Builder> listRestoreJobsByProtectedResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client .listRestoreJobsByProtectedResourcePaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)
operation.
This is a convenience which creates an instance of the
ListRestoreJobsByProtectedResourceRequest.Builder
avoiding the need to create one manually viaListRestoreJobsByProtectedResourceRequest.builder()
- Parameters:
listRestoreJobsByProtectedResourceRequest
- AConsumer
that will call methods onListRestoreJobsByProtectedResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreTestingPlans
default ListRestoreTestingPlansResponse listRestoreTestingPlans(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of restore testing plans.
- Parameters:
listRestoreTestingPlansRequest
-- Returns:
- Result of the ListRestoreTestingPlans operation returned by the service.
- See Also:
-
listRestoreTestingPlans
default ListRestoreTestingPlansResponse listRestoreTestingPlans(Consumer<ListRestoreTestingPlansRequest.Builder> listRestoreTestingPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of restore testing plans.
This is a convenience which creates an instance of the
ListRestoreTestingPlansRequest.Builder
avoiding the need to create one manually viaListRestoreTestingPlansRequest.builder()
- Parameters:
listRestoreTestingPlansRequest
- AConsumer
that will call methods onListRestoreTestingPlansRequest.Builder
to create a request.- Returns:
- Result of the ListRestoreTestingPlans operation returned by the service.
- See Also:
-
listRestoreTestingPlansPaginator
default ListRestoreTestingPlansIterable listRestoreTestingPlansPaginator(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client .listRestoreTestingPlansPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)
operation.- Parameters:
listRestoreTestingPlansRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreTestingPlansPaginator
default ListRestoreTestingPlansIterable listRestoreTestingPlansPaginator(Consumer<ListRestoreTestingPlansRequest.Builder> listRestoreTestingPlansRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client .listRestoreTestingPlansPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)
operation.
This is a convenience which creates an instance of the
ListRestoreTestingPlansRequest.Builder
avoiding the need to create one manually viaListRestoreTestingPlansRequest.builder()
- Parameters:
listRestoreTestingPlansRequest
- AConsumer
that will call methods onListRestoreTestingPlansRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreTestingSelections
default ListRestoreTestingSelectionsResponse listRestoreTestingSelections(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of restore testing selections. Can be filtered by
MaxResults
andRestoreTestingPlanName
.- Parameters:
listRestoreTestingSelectionsRequest
-- Returns:
- Result of the ListRestoreTestingSelections operation returned by the service.
- See Also:
-
listRestoreTestingSelections
default ListRestoreTestingSelectionsResponse listRestoreTestingSelections(Consumer<ListRestoreTestingSelectionsRequest.Builder> listRestoreTestingSelectionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of restore testing selections. Can be filtered by
MaxResults
andRestoreTestingPlanName
.
This is a convenience which creates an instance of the
ListRestoreTestingSelectionsRequest.Builder
avoiding the need to create one manually viaListRestoreTestingSelectionsRequest.builder()
- Parameters:
listRestoreTestingSelectionsRequest
- AConsumer
that will call methods onListRestoreTestingSelectionsRequest.Builder
to create a request.- Returns:
- Result of the ListRestoreTestingSelections operation returned by the service.
- See Also:
-
listRestoreTestingSelectionsPaginator
default ListRestoreTestingSelectionsIterable listRestoreTestingSelectionsPaginator(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client .listRestoreTestingSelectionsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)
operation.- Parameters:
listRestoreTestingSelectionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRestoreTestingSelectionsPaginator
default ListRestoreTestingSelectionsIterable listRestoreTestingSelectionsPaginator(Consumer<ListRestoreTestingSelectionsRequest.Builder> listRestoreTestingSelectionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client .listRestoreTestingSelectionsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)
operation.
This is a convenience which creates an instance of the
ListRestoreTestingSelectionsRequest.Builder
avoiding the need to create one manually viaListRestoreTestingSelectionsRequest.builder()
- Parameters:
listRestoreTestingSelectionsRequest
- AConsumer
that will call methods onListRestoreTestingSelectionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags
only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.- Parameters:
listTagsRequest
-- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)
operation.- Parameters:
listTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This is a variant of
listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.backup.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putBackupVaultAccessPolicy
default PutBackupVaultAccessPolicyResponse putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
- Parameters:
putBackupVaultAccessPolicyRequest
-- Returns:
- Result of the PutBackupVaultAccessPolicy operation returned by the service.
- See Also:
-
putBackupVaultAccessPolicy
default PutBackupVaultAccessPolicyResponse putBackupVaultAccessPolicy(Consumer<PutBackupVaultAccessPolicyRequest.Builder> putBackupVaultAccessPolicyRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaPutBackupVaultAccessPolicyRequest.builder()
- Parameters:
putBackupVaultAccessPolicyRequest
- AConsumer
that will call methods onPutBackupVaultAccessPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutBackupVaultAccessPolicy operation returned by the service.
- See Also:
-
putBackupVaultLockConfiguration
default PutBackupVaultLockConfigurationResponse putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
- Parameters:
putBackupVaultLockConfigurationRequest
-- Returns:
- Result of the PutBackupVaultLockConfiguration operation returned by the service.
- See Also:
-
putBackupVaultLockConfiguration
default PutBackupVaultLockConfigurationResponse putBackupVaultLockConfiguration(Consumer<PutBackupVaultLockConfigurationRequest.Builder> putBackupVaultLockConfigurationRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
This is a convenience which creates an instance of the
PutBackupVaultLockConfigurationRequest.Builder
avoiding the need to create one manually viaPutBackupVaultLockConfigurationRequest.builder()
- Parameters:
putBackupVaultLockConfigurationRequest
- AConsumer
that will call methods onPutBackupVaultLockConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutBackupVaultLockConfiguration operation returned by the service.
- See Also:
-
putBackupVaultNotifications
default PutBackupVaultNotificationsResponse putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Turns on notifications on a backup vault for the specified topic and events.
- Parameters:
putBackupVaultNotificationsRequest
-- Returns:
- Result of the PutBackupVaultNotifications operation returned by the service.
- See Also:
-
putBackupVaultNotifications
default PutBackupVaultNotificationsResponse putBackupVaultNotifications(Consumer<PutBackupVaultNotificationsRequest.Builder> putBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaPutBackupVaultNotificationsRequest.builder()
- Parameters:
putBackupVaultNotificationsRequest
- AConsumer
that will call methods onPutBackupVaultNotificationsRequest.Builder
to create a request.- Returns:
- Result of the PutBackupVaultNotifications operation returned by the service.
- See Also:
-
putRestoreValidationResult
default PutRestoreValidationResultResponse putRestoreValidationResult(PutRestoreValidationResultRequest putRestoreValidationResultRequest) throws InvalidParameterValueException, InvalidRequestException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request allows you to send your independent self-run restore test validation results.
RestoreJobId
andValidationStatus
are required. Optionally, you can input aValidationStatusMessage
.- Parameters:
putRestoreValidationResultRequest
-- Returns:
- Result of the PutRestoreValidationResult operation returned by the service.
- See Also:
-
putRestoreValidationResult
default PutRestoreValidationResultResponse putRestoreValidationResult(Consumer<PutRestoreValidationResultRequest.Builder> putRestoreValidationResultRequest) throws InvalidParameterValueException, InvalidRequestException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request allows you to send your independent self-run restore test validation results.
RestoreJobId
andValidationStatus
are required. Optionally, you can input aValidationStatusMessage
.
This is a convenience which creates an instance of the
PutRestoreValidationResultRequest.Builder
avoiding the need to create one manually viaPutRestoreValidationResultRequest.builder()
- Parameters:
putRestoreValidationResultRequest
- AConsumer
that will call methods onPutRestoreValidationResultRequest.Builder
to create a request.- Returns:
- Result of the PutRestoreValidationResult operation returned by the service.
- See Also:
-
startBackupJob
default StartBackupJobResponse startBackupJob(StartBackupJobRequest startBackupJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException Starts an on-demand backup job for the specified resource.
- Parameters:
startBackupJobRequest
-- Returns:
- Result of the StartBackupJob operation returned by the service.
- See Also:
-
startBackupJob
default StartBackupJobResponse startBackupJob(Consumer<StartBackupJobRequest.Builder> startBackupJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException 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 viaStartBackupJobRequest.builder()
- Parameters:
startBackupJobRequest
- AConsumer
that will call methods onStartBackupJobRequest.Builder
to create a request.- Returns:
- Result of the StartBackupJob operation returned by the service.
- See Also:
-
startCopyJob
default StartCopyJobResponse startCopyJob(StartCopyJobRequest startCopyJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
- Parameters:
startCopyJobRequest
-- Returns:
- Result of the StartCopyJob operation returned by the service.
- See Also:
-
startCopyJob
default StartCopyJobResponse startCopyJob(Consumer<StartCopyJobRequest.Builder> startCopyJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException 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 viaStartCopyJobRequest.builder()
- Parameters:
startCopyJobRequest
- AConsumer
that will call methods onStartCopyJobRequest.Builder
to create a request.- Returns:
- Result of the StartCopyJob operation returned by the service.
- See Also:
-
startReportJob
default StartReportJobResponse startReportJob(StartReportJobRequest startReportJobRequest) throws InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException Starts an on-demand report job for the specified report plan.
- Parameters:
startReportJobRequest
-- Returns:
- Result of the StartReportJob operation returned by the service.
- See Also:
-
startReportJob
default StartReportJobResponse startReportJob(Consumer<StartReportJobRequest.Builder> startReportJobRequest) throws InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException 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 viaStartReportJobRequest.builder()
- Parameters:
startReportJobRequest
- AConsumer
that will call methods onStartReportJobRequest.Builder
to create a request.- Returns:
- Result of the StartReportJob operation returned by the service.
- See Also:
-
startRestoreJob
default StartRestoreJobResponse startRestoreJob(StartRestoreJobRequest startRestoreJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Recovers the saved resource identified by an Amazon Resource Name (ARN).
- Parameters:
startRestoreJobRequest
-- Returns:
- Result of the StartRestoreJob operation returned by the service.
- See Also:
-
startRestoreJob
default StartRestoreJobResponse startRestoreJob(Consumer<StartRestoreJobRequest.Builder> startRestoreJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException 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 viaStartRestoreJobRequest.builder()
- Parameters:
startRestoreJobRequest
- AConsumer
that will call methods onStartRestoreJobRequest.Builder
to create a request.- Returns:
- Result of the StartRestoreJob operation returned by the service.
- See Also:
-
stopBackupJob
default StopBackupJobResponse stopBackupJob(StopBackupJobRequest stopBackupJobRequest) throws MissingParameterValueException, ResourceNotFoundException, InvalidParameterValueException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
- Parameters:
stopBackupJobRequest
-- Returns:
- Result of the StopBackupJob operation returned by the service.
- See Also:
-
stopBackupJob
default StopBackupJobResponse stopBackupJob(Consumer<StopBackupJobRequest.Builder> stopBackupJobRequest) throws MissingParameterValueException, ResourceNotFoundException, InvalidParameterValueException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
This is a convenience which creates an instance of the
StopBackupJobRequest.Builder
avoiding the need to create one manually viaStopBackupJobRequest.builder()
- Parameters:
stopBackupJobRequest
- AConsumer
that will call methods onStopBackupJobRequest.Builder
to create a request.- Returns:
- Result of the StopBackupJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateBackupPlan
default UpdateBackupPlanResponse updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Updates an existing backup plan identified by its
backupPlanId
with the input document in JSON format. The new version is uniquely identified by aVersionId
.- Parameters:
updateBackupPlanRequest
-- Returns:
- Result of the UpdateBackupPlan operation returned by the service.
- See Also:
-
updateBackupPlan
default UpdateBackupPlanResponse updateBackupPlan(Consumer<UpdateBackupPlanRequest.Builder> updateBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Updates an existing backup plan identified by its
backupPlanId
with the input document in JSON format. The new version is uniquely identified by aVersionId
.
This is a convenience which creates an instance of the
UpdateBackupPlanRequest.Builder
avoiding the need to create one manually viaUpdateBackupPlanRequest.builder()
- Parameters:
updateBackupPlanRequest
- AConsumer
that will call methods onUpdateBackupPlanRequest.Builder
to create a request.- Returns:
- Result of the UpdateBackupPlan operation returned by the service.
- See Also:
-
updateFramework
default UpdateFrameworkResponse updateFramework(UpdateFrameworkRequest updateFrameworkRequest) throws AlreadyExistsException, ResourceNotFoundException, LimitExceededException, InvalidParameterValueException, MissingParameterValueException, ConflictException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Updates an existing framework identified by its
FrameworkName
with the input document in JSON format.- Parameters:
updateFrameworkRequest
-- Returns:
- Result of the UpdateFramework operation returned by the service.
- See Also:
-
updateFramework
default UpdateFrameworkResponse updateFramework(Consumer<UpdateFrameworkRequest.Builder> updateFrameworkRequest) throws AlreadyExistsException, ResourceNotFoundException, LimitExceededException, InvalidParameterValueException, MissingParameterValueException, ConflictException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaUpdateFrameworkRequest.builder()
- Parameters:
updateFrameworkRequest
- AConsumer
that will call methods onUpdateFrameworkRequest.Builder
to create a request.- Returns:
- Result of the UpdateFramework operation returned by the service.
- See Also:
-
updateGlobalSettings
default UpdateGlobalSettingsResponse updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the
DescribeGlobalSettings
API to determine the current settings.- Parameters:
updateGlobalSettingsRequest
-- Returns:
- Result of the UpdateGlobalSettings operation returned by the service.
- See Also:
-
updateGlobalSettings
default UpdateGlobalSettingsResponse updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException 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 viaUpdateGlobalSettingsRequest.builder()
- Parameters:
updateGlobalSettingsRequest
- AConsumer
that will call methods onUpdateGlobalSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateGlobalSettings operation returned by the service.
- See Also:
-
updateRecoveryPointLifecycle
default UpdateRecoveryPointLifecycleResponse updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest) throws ResourceNotFoundException, InvalidParameterValueException, InvalidRequestException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.
- Parameters:
updateRecoveryPointLifecycleRequest
-- Returns:
- Result of the UpdateRecoveryPointLifecycle operation returned by the service.
- See Also:
-
updateRecoveryPointLifecycle
default UpdateRecoveryPointLifecycleResponse updateRecoveryPointLifecycle(Consumer<UpdateRecoveryPointLifecycleRequest.Builder> updateRecoveryPointLifecycleRequest) throws ResourceNotFoundException, InvalidParameterValueException, InvalidRequestException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException 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 viaUpdateRecoveryPointLifecycleRequest.builder()
- Parameters:
updateRecoveryPointLifecycleRequest
- AConsumer
that will call methods onUpdateRecoveryPointLifecycleRequest.Builder
to create a request.- Returns:
- Result of the UpdateRecoveryPointLifecycle operation returned by the service.
- See Also:
-
updateRegionSettings
default UpdateRegionSettingsResponse updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest) throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException, AwsServiceException, SdkClientException, BackupException Updates the current service opt-in settings for the Region.
Use the
DescribeRegionSettings
API to determine the resource types that are supported.- Parameters:
updateRegionSettingsRequest
-- Returns:
- Result of the UpdateRegionSettings operation returned by the service.
- See Also:
-
updateRegionSettings
default UpdateRegionSettingsResponse updateRegionSettings(Consumer<UpdateRegionSettingsRequest.Builder> updateRegionSettingsRequest) throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException, AwsServiceException, SdkClientException, BackupException Updates the current service opt-in settings for the 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 viaUpdateRegionSettingsRequest.builder()
- Parameters:
updateRegionSettingsRequest
- AConsumer
that will call methods onUpdateRegionSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateRegionSettings operation returned by the service.
- See Also:
-
updateReportPlan
default UpdateReportPlanResponse updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException, ConflictException, AwsServiceException, SdkClientException, BackupException Updates an existing report plan identified by its
ReportPlanName
with the input document in JSON format.- Parameters:
updateReportPlanRequest
-- Returns:
- Result of the UpdateReportPlan operation returned by the service.
- See Also:
-
updateReportPlan
default UpdateReportPlanResponse updateReportPlan(Consumer<UpdateReportPlanRequest.Builder> updateReportPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException, ConflictException, AwsServiceException, SdkClientException, BackupException 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 viaUpdateReportPlanRequest.builder()
- Parameters:
updateReportPlanRequest
- AConsumer
that will call methods onUpdateReportPlanRequest.Builder
to create a request.- Returns:
- Result of the UpdateReportPlan operation returned by the service.
- See Also:
-
updateRestoreTestingPlan
default UpdateRestoreTestingPlanResponse updateRestoreTestingPlan(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest) throws ConflictException, InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request will send changes to your specified restore testing plan.
RestoreTestingPlanName
cannot be updated after it is created.RecoveryPointSelection
can contain:-
Algorithm
-
ExcludeVaults
-
IncludeVaults
-
RecoveryPointTypes
-
SelectionWindowDays
- Parameters:
updateRestoreTestingPlanRequest
-- Returns:
- Result of the UpdateRestoreTestingPlan operation returned by the service.
- See Also:
-
-
updateRestoreTestingPlan
default UpdateRestoreTestingPlanResponse updateRestoreTestingPlan(Consumer<UpdateRestoreTestingPlanRequest.Builder> updateRestoreTestingPlanRequest) throws ConflictException, InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException This request will send changes to your specified restore testing plan.
RestoreTestingPlanName
cannot be updated after it is created.RecoveryPointSelection
can contain:-
Algorithm
-
ExcludeVaults
-
IncludeVaults
-
RecoveryPointTypes
-
SelectionWindowDays
This is a convenience which creates an instance of the
UpdateRestoreTestingPlanRequest.Builder
avoiding the need to create one manually viaUpdateRestoreTestingPlanRequest.builder()
- Parameters:
updateRestoreTestingPlanRequest
- AConsumer
that will call methods onUpdateRestoreTestingPlanRequest.Builder
to create a request.- Returns:
- Result of the UpdateRestoreTestingPlan operation returned by the service.
- See Also:
-
-
updateRestoreTestingSelection
default UpdateRestoreTestingSelectionResponse updateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest) throws ConflictException, InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Most elements except the
RestoreTestingSelectionName
can be updated with this request.RestoreTestingSelection
can use either protected resource ARNs or conditions, but not both. That is, if your selection hasProtectedResourceArns
, requesting an update with the parameterProtectedResourceConditions
will be unsuccessful.- Parameters:
updateRestoreTestingSelectionRequest
-- Returns:
- Result of the UpdateRestoreTestingSelection operation returned by the service.
- See Also:
-
updateRestoreTestingSelection
default UpdateRestoreTestingSelectionResponse updateRestoreTestingSelection(Consumer<UpdateRestoreTestingSelectionRequest.Builder> updateRestoreTestingSelectionRequest) throws ConflictException, InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException Most elements except the
RestoreTestingSelectionName
can be updated with this request.RestoreTestingSelection
can use either protected resource ARNs or conditions, but not both. That is, if your selection hasProtectedResourceArns
, requesting an update with the parameterProtectedResourceConditions
will be unsuccessful.
This is a convenience which creates an instance of the
UpdateRestoreTestingSelectionRequest.Builder
avoiding the need to create one manually viaUpdateRestoreTestingSelectionRequest.builder()
- Parameters:
updateRestoreTestingSelectionRequest
- AConsumer
that will call methods onUpdateRestoreTestingSelectionRequest.Builder
to create a request.- Returns:
- Result of the UpdateRestoreTestingSelection operation returned by the service.
- See Also:
-
create
Create aBackupClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aBackupClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-