@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface BackupClient extends AwsClient
builder() method.
Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static BackupClientBuilder |
builder()
Create a builder that can be used to configure and create a
BackupClient. |
default CancelLegalHoldResponse |
cancelLegalHold(CancelLegalHoldRequest cancelLegalHoldRequest)
This action removes the specified legal hold on a recovery point.
|
default CancelLegalHoldResponse |
cancelLegalHold(Consumer<CancelLegalHoldRequest.Builder> cancelLegalHoldRequest)
This action removes the specified legal hold on a recovery point.
|
static BackupClient |
create()
Create a
BackupClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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).
|
default CreateLogicallyAirGappedBackupVaultResponse |
createLogicallyAirGappedBackupVault(Consumer<CreateLogicallyAirGappedBackupVaultRequest.Builder> createLogicallyAirGappedBackupVaultRequest)
This request creates a logical container where backups are stored.
|
default CreateLogicallyAirGappedBackupVaultResponse |
createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest)
This request creates a logical container where backups are stored.
|
default CreateReportPlanResponse |
createReportPlan(Consumer<CreateReportPlanRequest.Builder> createReportPlanRequest)
Creates a report plan.
|
default CreateReportPlanResponse |
createReportPlan(CreateReportPlanRequest createReportPlanRequest)
Creates a report plan.
|
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 the
SelectionId. |
default DeleteBackupSelectionResponse |
deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId. |
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.
|
default DeleteBackupVaultAccessPolicyResponse |
deleteBackupVaultAccessPolicy(Consumer<DeleteBackupVaultAccessPolicyRequest.Builder> deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
|
default DeleteBackupVaultAccessPolicyResponse |
deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
|
default DeleteBackupVaultLockConfigurationResponse |
deleteBackupVaultLockConfiguration(Consumer<DeleteBackupVaultLockConfigurationRequest.Builder> deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
|
default DeleteBackupVaultLockConfigurationResponse |
deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
|
default DeleteBackupVaultNotificationsResponse |
deleteBackupVaultNotifications(Consumer<DeleteBackupVaultNotificationsRequest.Builder> deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
|
default DeleteBackupVaultNotificationsResponse |
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 DescribeBackupJobResponse |
describeBackupJob(Consumer<DescribeBackupJobRequest.Builder> describeBackupJobRequest)
Returns backup job details for the specified
BackupJobId. |
default DescribeBackupJobResponse |
describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
Returns backup job details for the specified
BackupJobId. |
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 specified
FrameworkName. |
default DescribeFrameworkResponse |
describeFramework(DescribeFrameworkRequest describeFrameworkRequest)
Returns the framework details for the specified
FrameworkName. |
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.
|
default DescribeProtectedResourceResponse |
describeProtectedResource(Consumer<DescribeProtectedResourceRequest.Builder> describeProtectedResourceRequest)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
(ARN), and the Amazon Web Services service type of the saved resource.
|
default DescribeProtectedResourceResponse |
describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
(ARN), and the Amazon Web Services service type of the saved resource.
|
default 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 its
ReportJobId. |
default DescribeReportJobResponse |
describeReportJob(DescribeReportJobRequest describeReportJobRequest)
Returns the details associated with creating a report as specified by its
ReportJobId. |
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.
|
default DisassociateRecoveryPointResponse |
disassociateRecoveryPoint(Consumer<DisassociateRecoveryPointRequest.Builder> disassociateRecoveryPointRequest)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
to the source service, such as Amazon RDS.
|
default DisassociateRecoveryPointResponse |
disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
to the source service, such as Amazon RDS.
|
default DisassociateRecoveryPointFromParentResponse |
disassociateRecoveryPointFromParent(Consumer<DisassociateRecoveryPointFromParentRequest.Builder> disassociateRecoveryPointFromParentRequest)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery
point and its parent (composite) recovery point.
|
default DisassociateRecoveryPointFromParentResponse |
disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery
point and its parent (composite) recovery point.
|
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)
Returns
BackupPlan details for the specified BackupPlanId. |
default GetBackupPlanResponse |
getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)
Returns
BackupPlan details for the specified BackupPlanId. |
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.
|
default GetBackupPlanFromTemplateResponse |
getBackupPlanFromTemplate(Consumer<GetBackupPlanFromTemplateRequest.Builder> getBackupPlanFromTemplateRequest)
Returns the template specified by its
templateId as a backup plan. |
default GetBackupPlanFromTemplateResponse |
getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its
templateId 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.
|
default GetBackupVaultAccessPolicyResponse |
getBackupVaultAccessPolicy(Consumer<GetBackupVaultAccessPolicyRequest.Builder> getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
|
default GetBackupVaultAccessPolicyResponse |
getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
|
default GetBackupVaultNotificationsResponse |
getBackupVaultNotifications(Consumer<GetBackupVaultNotificationsRequest.Builder> getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
|
default GetBackupVaultNotificationsResponse |
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.
|
default GetRecoveryPointRestoreMetadataResponse |
getRecoveryPointRestoreMetadata(Consumer<GetRecoveryPointRestoreMetadataRequest.Builder> getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
|
default GetRecoveryPointRestoreMetadataResponse |
getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
|
default GetSupportedResourceTypesResponse |
getSupportedResourceTypes(Consumer<GetSupportedResourceTypesRequest.Builder> getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
|
default GetSupportedResourceTypesResponse |
getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
|
default ListBackupJobsResponse |
listBackupJobs()
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 |
listBackupJobsPaginator()
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default ListBackupJobsIterable |
listBackupJobsPaginator(Consumer<ListBackupJobsRequest.Builder> listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default ListBackupJobsIterable |
listBackupJobsPaginator(ListBackupJobsRequest listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
default ListBackupPlansResponse |
listBackupPlans()
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 |
listBackupPlansPaginator()
Returns a list of all active backup plans for an authenticated account.
|
default ListBackupPlansIterable |
listBackupPlansPaginator(Consumer<ListBackupPlansRequest.Builder> listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
default ListBackupPlansIterable |
listBackupPlansPaginator(ListBackupPlansRequest listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
default ListBackupPlanTemplatesResponse |
listBackupPlanTemplates()
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 |
listBackupPlanTemplatesPaginator()
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
default ListBackupPlanTemplatesIterable |
listBackupPlanTemplatesPaginator(Consumer<ListBackupPlanTemplatesRequest.Builder> listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
default ListBackupPlanTemplatesIterable |
listBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
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)
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(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 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)
Returns an array containing metadata of the resources associated with the target backup plan.
|
default ListBackupSelectionsIterable |
listBackupSelectionsPaginator(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
default ListBackupVaultsResponse |
listBackupVaults()
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 |
listBackupVaultsPaginator()
Returns a list of recovery point storage containers along with information about them.
|
default ListBackupVaultsIterable |
listBackupVaultsPaginator(Consumer<ListBackupVaultsRequest.Builder> listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
default ListBackupVaultsIterable |
listBackupVaultsPaginator(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
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)
Returns metadata about your copy jobs.
|
default ListCopyJobsIterable |
listCopyJobsPaginator(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
|
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)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
default ListFrameworksIterable |
listFrameworksPaginator(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
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 action returns metadata about active and previous legal holds.
|
default ListLegalHoldsIterable |
listLegalHoldsPaginator(ListLegalHoldsRequest listLegalHoldsRequest)
This action returns metadata about active and previous legal holds.
|
default ListProtectedResourcesResponse |
listProtectedResources()
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
Amazon Resource Name (ARN) of the resource, and a resource type.
|
default 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.
|
default ListProtectedResourcesByBackupVaultResponse |
listProtectedResourcesByBackupVault(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
|
default ListProtectedResourcesByBackupVaultResponse |
listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
|
default ListProtectedResourcesByBackupVaultIterable |
listProtectedResourcesByBackupVaultPaginator(Consumer<ListProtectedResourcesByBackupVaultRequest.Builder> listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
|
default ListProtectedResourcesByBackupVaultIterable |
listProtectedResourcesByBackupVaultPaginator(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
|
default ListProtectedResourcesIterable |
listProtectedResourcesPaginator()
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
Amazon Resource Name (ARN) of the resource, and a resource type.
|
default ListProtectedResourcesIterable |
listProtectedResourcesPaginator(Consumer<ListProtectedResourcesRequest.Builder> listProtectedResourcesRequest)
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
Amazon Resource Name (ARN) of the resource, and a resource type.
|
default ListProtectedResourcesIterable |
listProtectedResourcesPaginator(ListProtectedResourcesRequest listProtectedResourcesRequest)
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
Amazon Resource Name (ARN) of the resource, and a resource type.
|
default ListRecoveryPointsByBackupVaultResponse |
listRecoveryPointsByBackupVault(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
default ListRecoveryPointsByBackupVaultResponse |
listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
default ListRecoveryPointsByBackupVaultIterable |
listRecoveryPointsByBackupVaultPaginator(Consumer<ListRecoveryPointsByBackupVaultRequest.Builder> listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
default ListRecoveryPointsByBackupVaultIterable |
listRecoveryPointsByBackupVaultPaginator(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
default ListRecoveryPointsByLegalHoldResponse |
listRecoveryPointsByLegalHold(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
default ListRecoveryPointsByLegalHoldResponse |
listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
default ListRecoveryPointsByLegalHoldIterable |
listRecoveryPointsByLegalHoldPaginator(Consumer<ListRecoveryPointsByLegalHoldRequest.Builder> listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
default ListRecoveryPointsByLegalHoldIterable |
listRecoveryPointsByLegalHoldPaginator(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
default ListRecoveryPointsByResourceResponse |
listRecoveryPointsByResource(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
default ListRecoveryPointsByResourceResponse |
listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
default ListRecoveryPointsByResourceIterable |
listRecoveryPointsByResourcePaginator(Consumer<ListRecoveryPointsByResourceRequest.Builder> listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
default ListRecoveryPointsByResourceIterable |
listRecoveryPointsByResourcePaginator(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
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)
Returns details about your report jobs.
|
default ListReportJobsIterable |
listReportJobsPaginator(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
|
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)
Returns a list of your report plans.
|
default ListReportPlansIterable |
listReportPlansPaginator(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans.
|
default ListRestoreJobsResponse |
listRestoreJobs()
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.
|
default ListRestoreJobsIterable |
listRestoreJobsPaginator()
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
default ListRestoreJobsIterable |
listRestoreJobsPaginator(Consumer<ListRestoreJobsRequest.Builder> listRestoreJobsRequest)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
default ListRestoreJobsIterable |
listRestoreJobsPaginator(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
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)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
default ListTagsIterable |
listTagsPaginator(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
default PutBackupVaultAccessPolicyResponse |
putBackupVaultAccessPolicy(Consumer<PutBackupVaultAccessPolicyRequest.Builder> putBackupVaultAccessPolicyRequest)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
default PutBackupVaultAccessPolicyResponse |
putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
default PutBackupVaultLockConfigurationResponse |
putBackupVaultLockConfiguration(Consumer<PutBackupVaultLockConfigurationRequest.Builder> putBackupVaultLockConfigurationRequest)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
created in a backup vault.
|
default PutBackupVaultLockConfigurationResponse |
putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
created in a backup vault.
|
default PutBackupVaultNotificationsResponse |
putBackupVaultNotifications(Consumer<PutBackupVaultNotificationsRequest.Builder> putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
|
default PutBackupVaultNotificationsResponse |
putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
|
default BackupServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
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 its
backupPlanId with the input document in JSON
format. |
default UpdateBackupPlanResponse |
updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
Updates an existing backup plan identified by its
backupPlanId with the input document in JSON
format. |
default UpdateFrameworkResponse |
updateFramework(Consumer<UpdateFrameworkRequest.Builder> updateFrameworkRequest)
Updates an existing framework identified by its
FrameworkName with the input document in JSON
format. |
default UpdateFrameworkResponse |
updateFramework(UpdateFrameworkRequest updateFrameworkRequest)
Updates an existing framework identified by its
FrameworkName 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.
|
default UpdateRecoveryPointLifecycleResponse |
updateRecoveryPointLifecycle(Consumer<UpdateRecoveryPointLifecycleRequest.Builder> updateRecoveryPointLifecycleRequest)
Sets the transition lifecycle of a recovery point.
|
default UpdateRecoveryPointLifecycleResponse |
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 its
ReportPlanName with the input document in JSON
format. |
default UpdateReportPlanResponse |
updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)
Updates an existing report plan identified by its
ReportPlanName with the input document in JSON
format. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
cancelLegalHoldRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CancelLegalHoldRequest.builder()
cancelLegalHoldRequest - A Consumer that will call methods on
CancelLegalHoldRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 an
AlreadyExistsException exception.
createBackupPlanRequest - LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException - The required resource already exists.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 an
AlreadyExistsException exception.
This is a convenience which creates an instance of the CreateBackupPlanRequest.Builder avoiding the need
to create one manually via CreateBackupPlanRequest.builder()
createBackupPlanRequest - A Consumer that will call methods on
CreateBackupPlanRequest.Builder to create a request.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException - The required resource already exists.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createBackupSelectionRequest - LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException - The required resource already exists.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateBackupSelectionRequest.builder()
createBackupSelectionRequest - A Consumer that will call methods on
CreateBackupSelectionRequest.Builder to create a
request.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException - The required resource already exists.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createBackupVaultRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException - The required resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateBackupVaultRequest.builder()
createBackupVaultRequest - A Consumer that will call methods on
CreateBackupVaultRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException - The required resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createFrameworkRequest - AlreadyExistsException - The required resource already exists.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateFrameworkRequest.builder()
createFrameworkRequest - A Consumer that will call methods on
CreateFrameworkRequest.Builder to create a request.AlreadyExistsException - The required resource already exists.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createLegalHoldRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateLegalHoldRequest.builder()
createLegalHoldRequest - A Consumer that will call methods on
CreateLegalHoldRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLogicallyAirGappedBackupVaultResponse createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest) throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException
This request creates a logical container where backups are stored.
This 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.
createLogicallyAirGappedBackupVaultRequest - AlreadyExistsException - The required resource already exists.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLogicallyAirGappedBackupVaultResponse createLogicallyAirGappedBackupVault(Consumer<CreateLogicallyAirGappedBackupVaultRequest.Builder> createLogicallyAirGappedBackupVaultRequest) throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException
This request creates a logical container where backups are stored.
This 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 CreateLogicallyAirGappedBackupVaultRequest.Builder
avoiding the need to create one manually via CreateLogicallyAirGappedBackupVaultRequest.builder()
createLogicallyAirGappedBackupVaultRequest - A Consumer that will call methods on
CreateLogicallyAirGappedBackupVaultRequest.Builder to
create a request.AlreadyExistsException - The required resource already exists.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 an
AlreadyExistsException exception.
createReportPlanRequest - AlreadyExistsException - The required resource already exists.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 an
AlreadyExistsException exception.
This is a convenience which creates an instance of the CreateReportPlanRequest.Builder avoiding the need
to create one manually via CreateReportPlanRequest.builder()
createReportPlanRequest - A Consumer that will call methods on
CreateReportPlanRequest.Builder to create a request.AlreadyExistsException - The required resource already exists.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteBackupPlanRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteBackupPlanRequest.builder()
deleteBackupPlanRequest - A Consumer that will call methods on
DeleteBackupPlanRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteBackupSelectionRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteBackupSelectionRequest.builder()
deleteBackupSelectionRequest - A Consumer that will call methods on
DeleteBackupSelectionRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteBackupVaultRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteBackupVaultRequest.builder()
deleteBackupVaultRequest - A Consumer that will call methods on
DeleteBackupVaultRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackupVaultAccessPolicyResponse deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicyRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteBackupVaultAccessPolicyRequest.builder()
deleteBackupVaultAccessPolicyRequest - A Consumer that will call methods on
DeleteBackupVaultAccessPolicyRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteBackupVaultLockConfigurationRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteBackupVaultLockConfigurationRequest.builder()
deleteBackupVaultLockConfigurationRequest - A Consumer that will call methods on
DeleteBackupVaultLockConfigurationRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackupVaultNotificationsResponse deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotificationsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteBackupVaultNotificationsRequest.builder()
deleteBackupVaultNotificationsRequest - A Consumer that will call methods on
DeleteBackupVaultNotificationsRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFrameworkResponse deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest) throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Deletes the framework specified by a framework name.
deleteFrameworkRequest - MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteFrameworkRequest.builder()
deleteFrameworkRequest - A Consumer that will call methods on
DeleteFrameworkRequest.Builder to create a request.MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the
iam:CreateServiceLinkedRole action. To learn more about adding this role, see
Troubleshooting manual deletions.
If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
and will enter an EXPIRED state.
deleteRecoveryPointRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the
iam:CreateServiceLinkedRole action. To learn more about adding this role, see
Troubleshooting manual deletions.
If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
and will enter an EXPIRED state.
This is a convenience which creates an instance of the DeleteRecoveryPointRequest.Builder avoiding the
need to create one manually via DeleteRecoveryPointRequest.builder()
deleteRecoveryPointRequest - A Consumer that will call methods on
DeleteRecoveryPointRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteReportPlanResponse deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest) throws MissingParameterValueException, InvalidParameterValueException, ConflictException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Deletes the report plan specified by a report plan name.
deleteReportPlanRequest - MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteReportPlanRequest.builder()
deleteReportPlanRequest - A Consumer that will call methods on
DeleteReportPlanRequest.Builder to create a request.MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBackupJobResponse describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException
Returns backup job details for the specified BackupJobId.
describeBackupJobRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
action cannot be completed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeBackupJobRequest.builder()
describeBackupJobRequest - A Consumer that will call methods on
DescribeBackupJobRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
action cannot be completed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBackupVaultResponse describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns metadata about a backup vault specified by its name.
describeBackupVaultRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeBackupVaultRequest.builder()
describeBackupVaultRequest - A Consumer that will call methods on
DescribeBackupVaultRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCopyJobResponse describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns metadata associated with creating a copy of a resource.
describeCopyJobRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeCopyJobRequest.builder()
describeCopyJobRequest - A Consumer that will call methods on
DescribeCopyJobRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFrameworkResponse describeFramework(DescribeFrameworkRequest describeFrameworkRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns the framework details for the specified FrameworkName.
describeFrameworkRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeFrameworkRequest.builder()
describeFrameworkRequest - A Consumer that will call methods on
DescribeFrameworkRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
describeGlobalSettingsRequest - InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeGlobalSettingsRequest.builder()
describeGlobalSettingsRequest - A Consumer that will call methods on
DescribeGlobalSettingsRequest.Builder to create a
request.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeProtectedResourceRequest - MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeProtectedResourceRequest.builder()
describeProtectedResourceRequest - A Consumer that will call methods on
DescribeProtectedResourceRequest.Builder to create a
request.MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeRecoveryPointRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeRecoveryPointRequest.builder()
describeRecoveryPointRequest - A Consumer that will call methods on
DescribeRecoveryPointRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeRegionSettingsRequest - ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeRegionSettingsRequest.builder()
describeRegionSettingsRequest - A Consumer that will call methods on
DescribeRegionSettingsRequest.Builder to create a
request.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReportJobResponse describeReportJob(DescribeReportJobRequest describeReportJobRequest) throws ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Returns the details associated with creating a report as specified by its ReportJobId.
describeReportJobRequest - ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeReportJobRequest.builder()
describeReportJobRequest - A Consumer that will call methods on
DescribeReportJobRequest.Builder to create a request.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeReportPlanRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeReportPlanRequest.builder()
describeReportPlanRequest - A Consumer that will call methods on
DescribeReportPlanRequest.Builder to create a
request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeRestoreJobRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
action cannot be completed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeRestoreJobRequest.builder()
describeRestoreJobRequest - A Consumer that will call methods on
DescribeRestoreJobRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
action cannot be completed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
disassociateRecoveryPointRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DisassociateRecoveryPointRequest.builder()
disassociateRecoveryPointRequest - A Consumer that will call methods on
DisassociateRecoveryPointRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
disassociateRecoveryPointFromParentRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DisassociateRecoveryPointFromParentRequest.builder()
disassociateRecoveryPointFromParentRequest - A Consumer that will call methods on
DisassociateRecoveryPointFromParentRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
exportBackupPlanTemplateRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ExportBackupPlanTemplateRequest.builder()
exportBackupPlanTemplateRequest - A Consumer that will call methods on
ExportBackupPlanTemplateRequest.Builder to create a
request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackupPlanResponse getBackupPlan(GetBackupPlanRequest getBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns BackupPlan details for the specified BackupPlanId. The details are the body of
a backup plan in JSON format, in addition to plan metadata.
getBackupPlanRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackupPlanResponse getBackupPlan(Consumer<GetBackupPlanRequest.Builder> getBackupPlanRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns BackupPlan details for the specified BackupPlanId. The details are the body of
a backup plan in JSON format, in addition to plan metadata.
This is a convenience which creates an instance of the GetBackupPlanRequest.Builder avoiding the need to
create one manually via GetBackupPlanRequest.builder()
getBackupPlanRequest - A Consumer that will call methods on
GetBackupPlanRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getBackupPlanFromJsonRequest - LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetBackupPlanFromJsonRequest.builder()
getBackupPlanFromJsonRequest - A Consumer that will call methods on
GetBackupPlanFromJsonRequest.Builder to create a
request.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackupPlanFromTemplateResponse getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest) throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Returns the template specified by its templateId as a backup plan.
getBackupPlanFromTemplateRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetBackupPlanFromTemplateRequest.builder()
getBackupPlanFromTemplateRequest - A Consumer that will call methods on
GetBackupPlanFromTemplateRequest.Builder to create a
request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getBackupSelectionRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetBackupSelectionRequest.builder()
getBackupSelectionRequest - A Consumer that will call methods on
GetBackupSelectionRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getBackupVaultAccessPolicyRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetBackupVaultAccessPolicyRequest.builder()
getBackupVaultAccessPolicyRequest - A Consumer that will call methods on
GetBackupVaultAccessPolicyRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackupVaultNotificationsResponse getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns event notifications for the specified backup vault.
getBackupVaultNotificationsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetBackupVaultNotificationsRequest.builder()
getBackupVaultNotificationsRequest - A Consumer that will call methods on
GetBackupVaultNotificationsRequest.Builder to create
a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getLegalHoldRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetLegalHoldRequest.builder()
getLegalHoldRequest - A Consumer that will call methods on
GetLegalHoldRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getRecoveryPointRestoreMetadataRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetRecoveryPointRestoreMetadataRequest.builder()
getRecoveryPointRestoreMetadataRequest - A Consumer that will call methods on
GetRecoveryPointRestoreMetadataRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSupportedResourceTypesResponse getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest) throws ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns the Amazon Web Services resource types supported by Backup.
getSupportedResourceTypesRequest - ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetSupportedResourceTypesRequest.builder()
getSupportedResourceTypesRequest - A Consumer that will call methods on
GetSupportedResourceTypesRequest.Builder to create a
request.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBackupJobsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBackupJobsRequest.builder()
listBackupJobsRequest - A Consumer that will call methods on
ListBackupJobsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupJobsResponse listBackupJobs() 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.
InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupJobs(ListBackupJobsRequest),
AWS API
Documentationdefault ListBackupJobsIterable listBackupJobsPaginator() 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupJobsPaginator(ListBackupJobsRequest),
AWS API
Documentationdefault ListBackupJobsIterable listBackupJobsPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBackupJobsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupJobsIterable listBackupJobsPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBackupJobsRequest.builder()
listBackupJobsRequest - A Consumer that will call methods on
ListBackupJobsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBackupPlanTemplatesRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBackupPlanTemplatesRequest.builder()
listBackupPlanTemplatesRequest - A Consumer that will call methods on
ListBackupPlanTemplatesRequest.Builder to create a
request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupPlanTemplatesResponse listBackupPlanTemplates() 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.
InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupPlanTemplates(ListBackupPlanTemplatesRequest),
AWS API Documentationdefault ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator() 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest),
AWS API Documentationdefault ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBackupPlanTemplatesRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBackupPlanTemplatesRequest.builder()
listBackupPlanTemplatesRequest - A Consumer that will call methods on
ListBackupPlanTemplatesRequest.Builder to create a
request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBackupPlanVersionsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBackupPlanVersionsRequest.builder()
listBackupPlanVersionsRequest - A Consumer that will call methods on
ListBackupPlanVersionsRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupPlanVersionsIterable listBackupPlanVersionsPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBackupPlanVersionsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupPlanVersionsIterable listBackupPlanVersionsPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBackupPlanVersionsRequest.builder()
listBackupPlanVersionsRequest - A Consumer that will call methods on
ListBackupPlanVersionsRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBackupPlansRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBackupPlansRequest.builder()
listBackupPlansRequest - A Consumer that will call methods on
ListBackupPlansRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupPlansResponse listBackupPlans() 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.
ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupPlans(ListBackupPlansRequest),
AWS API
Documentationdefault ListBackupPlansIterable listBackupPlansPaginator() 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupPlansPaginator(ListBackupPlansRequest),
AWS API
Documentationdefault ListBackupPlansIterable listBackupPlansPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBackupPlansRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupPlansIterable listBackupPlansPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBackupPlansRequest.builder()
listBackupPlansRequest - A Consumer that will call methods on
ListBackupPlansRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBackupSelectionsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBackupSelectionsRequest.builder()
listBackupSelectionsRequest - A Consumer that will call methods on
ListBackupSelectionsRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupSelectionsIterable listBackupSelectionsPaginator(ListBackupSelectionsRequest 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBackupSelectionsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupSelectionsIterable listBackupSelectionsPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBackupSelectionsRequest.builder()
listBackupSelectionsRequest - A Consumer that will call methods on
ListBackupSelectionsRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBackupVaultsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBackupVaultsRequest.builder()
listBackupVaultsRequest - A Consumer that will call methods on
ListBackupVaultsRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupVaultsResponse listBackupVaults() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns a list of recovery point storage containers along with information about them.
ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupVaults(ListBackupVaultsRequest),
AWS API
Documentationdefault ListBackupVaultsIterable listBackupVaultsPaginator() throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns a list of recovery point storage containers along with information about them.
This is a variant of
listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistBackupVaultsPaginator(ListBackupVaultsRequest),
AWS API
Documentationdefault ListBackupVaultsIterable listBackupVaultsPaginator(ListBackupVaultsRequest 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBackupVaultsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackupVaultsIterable listBackupVaultsPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBackupVaultsRequest.builder()
listBackupVaultsRequest - A Consumer that will call methods on
ListBackupVaultsRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCopyJobsResponse listCopyJobs(ListCopyJobsRequest listCopyJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns metadata about your copy jobs.
listCopyJobsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListCopyJobsRequest.builder()
listCopyJobsRequest - A Consumer that will call methods on
ListCopyJobsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCopyJobsIterable listCopyJobsPaginator(ListCopyJobsRequest listCopyJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns metadata about your copy jobs.
This is a variant of listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listCopyJobsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCopyJobsIterable listCopyJobsPaginator(Consumer<ListCopyJobsRequest.Builder> listCopyJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns metadata about your copy jobs.
This is a variant of listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListCopyJobsRequest.builder()
listCopyJobsRequest - A Consumer that will call methods on
ListCopyJobsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listFrameworksRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListFrameworksRequest.builder()
listFrameworksRequest - A Consumer that will call methods on
ListFrameworksRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFrameworksIterable listFrameworksPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listFrameworksRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFrameworksIterable listFrameworksPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListFrameworksRequest.builder()
listFrameworksRequest - A Consumer that will call methods on
ListFrameworksRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLegalHoldsResponse listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
This action returns metadata about active and previous legal holds.
listLegalHoldsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListLegalHoldsRequest.builder()
listLegalHoldsRequest - A Consumer that will call methods on
ListLegalHoldsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLegalHoldsIterable listLegalHoldsPaginator(ListLegalHoldsRequest listLegalHoldsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
This action returns metadata about active and previous legal holds.
This is a variant of listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listLegalHoldsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLegalHoldsIterable listLegalHoldsPaginator(Consumer<ListLegalHoldsRequest.Builder> listLegalHoldsRequest) throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
This action returns metadata about active and previous legal holds.
This is a variant of listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListLegalHoldsRequest.builder()
listLegalHoldsRequest - A Consumer that will call methods on
ListLegalHoldsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listProtectedResourcesRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListProtectedResourcesRequest.builder()
listProtectedResourcesRequest - A Consumer that will call methods on
ListProtectedResourcesRequest.Builder to create a
request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProtectedResourcesResponse listProtectedResources() 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.
InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistProtectedResources(ListProtectedResourcesRequest),
AWS
API Documentationdefault ListProtectedResourcesIterable listProtectedResourcesPaginator() 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistProtectedResourcesPaginator(ListProtectedResourcesRequest),
AWS
API Documentationdefault ListProtectedResourcesIterable listProtectedResourcesPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listProtectedResourcesRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProtectedResourcesIterable listProtectedResourcesPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListProtectedResourcesRequest.builder()
listProtectedResourcesRequest - A Consumer that will call methods on
ListProtectedResourcesRequest.Builder to create a
request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProtectedResourcesByBackupVaultResponse listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
This request lists the protected resources corresponding to each backup vault.
listProtectedResourcesByBackupVaultRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ResourceNotFoundException - A resource that is required for the action doesn't exist.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListProtectedResourcesByBackupVaultRequest.builder()
listProtectedResourcesByBackupVaultRequest - A Consumer that will call methods on
ListProtectedResourcesByBackupVaultRequest.Builder to
create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ResourceNotFoundException - A resource that is required for the action doesn't exist.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProtectedResourcesByBackupVaultIterable listProtectedResourcesByBackupVaultPaginator(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest) throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
This request lists the protected resources corresponding to each backup vault.
This is a variant of
listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listProtectedResourcesByBackupVaultRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ResourceNotFoundException - A resource that is required for the action doesn't exist.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProtectedResourcesByBackupVaultIterable listProtectedResourcesByBackupVaultPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListProtectedResourcesByBackupVaultRequest.builder()
listProtectedResourcesByBackupVaultRequest - A Consumer that will call methods on
ListProtectedResourcesByBackupVaultRequest.Builder to
create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ResourceNotFoundException - A resource that is required for the action doesn't exist.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecoveryPointsByBackupVaultResponse listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVaultRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListRecoveryPointsByBackupVaultRequest.builder()
listRecoveryPointsByBackupVaultRequest - A Consumer that will call methods on
ListRecoveryPointsByBackupVaultRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecoveryPointsByBackupVaultIterable listRecoveryPointsByBackupVaultPaginator(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException
Returns detailed information about the recovery points stored in a backup vault.
This is a variant of
listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listRecoveryPointsByBackupVaultRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecoveryPointsByBackupVaultIterable listRecoveryPointsByBackupVaultPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListRecoveryPointsByBackupVaultRequest.builder()
listRecoveryPointsByBackupVaultRequest - A Consumer that will call methods on
ListRecoveryPointsByBackupVaultRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listRecoveryPointsByLegalHoldRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListRecoveryPointsByLegalHoldRequest.builder()
listRecoveryPointsByLegalHoldRequest - A Consumer that will call methods on
ListRecoveryPointsByLegalHoldRequest.Builder to
create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecoveryPointsByLegalHoldIterable listRecoveryPointsByLegalHoldPaginator(ListRecoveryPointsByLegalHoldRequest 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listRecoveryPointsByLegalHoldRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecoveryPointsByLegalHoldIterable listRecoveryPointsByLegalHoldPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListRecoveryPointsByLegalHoldRequest.builder()
listRecoveryPointsByLegalHoldRequest - A Consumer that will call methods on
ListRecoveryPointsByLegalHoldRequest.Builder to
create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listRecoveryPointsByResourceRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListRecoveryPointsByResourceRequest.builder()
listRecoveryPointsByResourceRequest - A Consumer that will call methods on
ListRecoveryPointsByResourceRequest.Builder to create
a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecoveryPointsByResourceIterable listRecoveryPointsByResourcePaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listRecoveryPointsByResourceRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecoveryPointsByResourceIterable listRecoveryPointsByResourcePaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListRecoveryPointsByResourceRequest.builder()
listRecoveryPointsByResourceRequest - A Consumer that will call methods on
ListRecoveryPointsByResourceRequest.Builder to create
a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportJobsResponse listReportJobs(ListReportJobsRequest listReportJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Returns details about your report jobs.
listReportJobsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListReportJobsRequest.builder()
listReportJobsRequest - A Consumer that will call methods on
ListReportJobsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportJobsIterable listReportJobsPaginator(ListReportJobsRequest listReportJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Returns details about your report jobs.
This is a variant of listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listReportJobsRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportJobsIterable listReportJobsPaginator(Consumer<ListReportJobsRequest.Builder> listReportJobsRequest) throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Returns details about your report jobs.
This is a variant of listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListReportJobsRequest.builder()
listReportJobsRequest - A Consumer that will call methods on
ListReportJobsRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listReportPlansRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListReportPlansRequest.builder()
listReportPlansRequest - A Consumer that will call methods on
ListReportPlansRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportPlansIterable listReportPlansPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listReportPlansRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReportPlansIterable listReportPlansPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListReportPlansRequest.builder()
listReportPlansRequest - A Consumer that will call methods on
ListReportPlansRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listRestoreJobsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListRestoreJobsRequest.builder()
listRestoreJobsRequest - A Consumer that will call methods on
ListRestoreJobsRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRestoreJobsResponse listRestoreJobs() 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.
ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistRestoreJobs(ListRestoreJobsRequest),
AWS API
Documentationdefault ListRestoreJobsIterable listRestoreJobsPaginator() 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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistRestoreJobsPaginator(ListRestoreJobsRequest),
AWS API
Documentationdefault ListRestoreJobsIterable listRestoreJobsPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listRestoreJobsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRestoreJobsIterable listRestoreJobsPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListRestoreJobsRequest.builder()
listRestoreJobsRequest - A Consumer that will call methods on
ListRestoreJobsRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listTagsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on
ListTagsRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(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.
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 Stream
software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listTagsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(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 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 Stream
software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on
ListTagsRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
putBackupVaultAccessPolicyRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutBackupVaultAccessPolicyRequest.builder()
putBackupVaultAccessPolicyRequest - A Consumer that will call methods on
PutBackupVaultAccessPolicyRequest.Builder to create a
request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
putBackupVaultLockConfigurationRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutBackupVaultLockConfigurationRequest.builder()
putBackupVaultLockConfigurationRequest - A Consumer that will call methods on
PutBackupVaultLockConfigurationRequest.Builder to
create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
putBackupVaultNotificationsRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutBackupVaultNotificationsRequest.builder()
putBackupVaultNotificationsRequest - A Consumer that will call methods on
PutBackupVaultNotificationsRequest.Builder to create
a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartBackupJobResponse startBackupJob(StartBackupJobRequest startBackupJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException
Starts an on-demand backup job for the specified resource.
startBackupJobRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartBackupJobRequest.builder()
startBackupJobRequest - A Consumer that will call methods on
StartBackupJobRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
startCopyJobRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartCopyJobRequest.builder()
startCopyJobRequest - A Consumer that will call methods on
StartCopyJobRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartReportJobResponse startReportJob(StartReportJobRequest startReportJobRequest) throws InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException
Starts an on-demand report job for the specified report plan.
startReportJobRequest - InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartReportJobRequest.builder()
startReportJobRequest - A Consumer that will call methods on
StartReportJobRequest.Builder to create a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartRestoreJobResponse startRestoreJob(StartRestoreJobRequest startRestoreJobRequest) throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException
Recovers the saved resource identified by an Amazon Resource Name (ARN).
startRestoreJobRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartRestoreJobRequest.builder()
startRestoreJobRequest - A Consumer that will call methods on
StartRestoreJobRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
stopBackupJobRequest - MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
This is a convenience which creates an instance of the StopBackupJobRequest.Builder avoiding the need to
create one manually via StopBackupJobRequest.builder()
stopBackupJobRequest - A Consumer that will call methods on
StopBackupJobRequest.Builder to create a request.MissingParameterValueException - Indicates that a required parameter is missing.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
tagResourceRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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)
untagResourceRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a VersionId.
updateBackupPlanRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 a VersionId.
This is a convenience which creates an instance of the UpdateBackupPlanRequest.Builder avoiding the need
to create one manually via UpdateBackupPlanRequest.builder()
updateBackupPlanRequest - A Consumer that will call methods on
UpdateBackupPlanRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateFrameworkRequest - AlreadyExistsException - The required resource already exists.ResourceNotFoundException - A resource that is required for the action doesn't exist.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateFrameworkRequest.builder()
updateFrameworkRequest - A Consumer that will call methods on
UpdateFrameworkRequest.Builder to create a request.AlreadyExistsException - The required resource already exists.ResourceNotFoundException - A resource that is required for the action doesn't exist.LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException - Indicates that a required parameter is missing.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateGlobalSettingsRequest - ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateGlobalSettingsRequest.builder()
updateGlobalSettingsRequest - A Consumer that will call methods on
UpdateGlobalSettingsRequest.Builder to create a
request.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateRecoveryPointLifecycleRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateRecoveryPointLifecycleRequest.builder()
updateRecoveryPointLifecycleRequest - A Consumer that will call methods on
UpdateRecoveryPointLifecycleRequest.Builder to create
a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.MissingParameterValueException - Indicates that a required parameter is missing.ServiceUnavailableException - The request failed due to a temporary failure of the server.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRegionSettingsResponse updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest) throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException, AwsServiceException, SdkClientException, BackupException
Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup
tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or
scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the
DescribeRegionSettings API to determine the resource types that are supported.
updateRegionSettingsRequest - ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRegionSettingsResponse updateRegionSettings(Consumer<UpdateRegionSettingsRequest.Builder> updateRegionSettingsRequest) throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException, AwsServiceException, SdkClientException, BackupException
Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup
tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or
scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the
DescribeRegionSettings API to determine the resource types that are supported.
This is a convenience which creates an instance of the UpdateRegionSettingsRequest.Builder avoiding the
need to create one manually via UpdateRegionSettingsRequest.builder()
updateRegionSettingsRequest - A Consumer that will call methods on
UpdateRegionSettingsRequest.Builder to create a
request.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateReportPlanRequest - ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateReportPlanRequest.builder()
updateReportPlanRequest - A Consumer that will call methods on
UpdateReportPlanRequest.Builder to create a request.ResourceNotFoundException - A resource that is required for the action doesn't exist.InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException - The request failed due to a temporary failure of the server.MissingParameterValueException - Indicates that a required parameter is missing.ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic BackupClient create()
BackupClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BackupClientBuilder builder()
BackupClient.static ServiceMetadata serviceMetadata()
default BackupServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.