AWSBackup
public struct AWSBackup
Client object for interacting with AWS AWSBackup service.
AWS Backup AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the AWSBackup client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources. If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.
Declaration
Swift
public func createBackupPlan(_ input: CreateBackupPlanInput) -> EventLoopFuture<CreateBackupPlanOutput>
-
Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources. For example, consider the following patterns: Resources: “arn:aws:ec2:region:account-id:volume/volume-id” ConditionKey:“department” ConditionValue:“finance” ConditionType:“StringEquals” ConditionKey:“importance” ConditionValue:“critical” ConditionType:“StringEquals” Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as “department=finance”, “importance=critical”, in addition to an EBS volume with the specified volume Id. Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn’t be confused with a logical AND, where all conditions must match. The matching patterns are logically ‘put together using the OR operator. In other words, all patterns that match are selected for backup.
Declaration
Swift
public func createBackupSelection(_ input: CreateBackupSelectionInput) -> EventLoopFuture<CreateBackupSelectionOutput>
-
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. Sensitive data, such as passport numbers, should not be included the name of a backup vault.
Declaration
Swift
public func createBackupVault(_ input: CreateBackupVaultInput) -> EventLoopFuture<CreateBackupVaultOutput>
-
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.
Declaration
Swift
public func deleteBackupPlan(_ input: DeleteBackupPlanInput) -> EventLoopFuture<DeleteBackupPlanOutput>
-
Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
Declaration
Swift
@discardableResult public func deleteBackupSelection(_ input: DeleteBackupSelectionInput) -> EventLoopFuture<Void>
-
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
Declaration
Swift
@discardableResult public func deleteBackupVault(_ input: DeleteBackupVaultInput) -> EventLoopFuture<Void>
-
Deletes the policy document that manages permissions on a backup vault.
Declaration
Swift
@discardableResult public func deleteBackupVaultAccessPolicy(_ input: DeleteBackupVaultAccessPolicyInput) -> EventLoopFuture<Void>
-
Deletes event notifications for the specified backup vault.
Declaration
Swift
@discardableResult public func deleteBackupVaultNotifications(_ input: DeleteBackupVaultNotificationsInput) -> EventLoopFuture<Void>
-
Deletes the recovery point specified by a recovery point ID.
Declaration
Swift
@discardableResult public func deleteRecoveryPoint(_ input: DeleteRecoveryPointInput) -> EventLoopFuture<Void>
-
Returns metadata associated with creating a backup of a resource.
Declaration
Swift
public func describeBackupJob(_ input: DescribeBackupJobInput) -> EventLoopFuture<DescribeBackupJobOutput>
-
Returns metadata about a backup vault specified by its name.
Declaration
Swift
public func describeBackupVault(_ input: DescribeBackupVaultInput) -> EventLoopFuture<DescribeBackupVaultOutput>
-
Returns metadata associated with creating a copy of a resource.
Declaration
Swift
public func describeCopyJob(_ input: DescribeCopyJobInput) -> EventLoopFuture<DescribeCopyJobOutput>
-
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
Declaration
Swift
public func describeProtectedResource(_ input: DescribeProtectedResourceInput) -> EventLoopFuture<DescribeProtectedResourceOutput>
-
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
Declaration
Swift
public func describeRecoveryPoint(_ input: DescribeRecoveryPointInput) -> EventLoopFuture<DescribeRecoveryPointOutput>
-
Returns the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service’s resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service’s resources in this Region.
Declaration
Swift
public func describeRegionSettings(_ input: DescribeRegionSettingsInput) -> EventLoopFuture<DescribeRegionSettingsOutput>
-
Returns metadata associated with a restore job that is specified by a job ID.
Declaration
Swift
public func describeRestoreJob(_ input: DescribeRestoreJobInput) -> EventLoopFuture<DescribeRestoreJobOutput>
-
Returns the backup plan that is specified by the plan ID as a backup template.
Declaration
Swift
public func exportBackupPlanTemplate(_ input: ExportBackupPlanTemplateInput) -> EventLoopFuture<ExportBackupPlanTemplateOutput>
-
Returns the body of a backup plan in JSON format, in addition to plan metadata.
Declaration
Swift
public func getBackupPlan(_ input: GetBackupPlanInput) -> EventLoopFuture<GetBackupPlanOutput>
-
Returns a valid JSON document specifying a backup plan or an error.
Declaration
Swift
public func getBackupPlanFromJSON(_ input: GetBackupPlanFromJSONInput) -> EventLoopFuture<GetBackupPlanFromJSONOutput>
-
Returns the template specified by its templateId as a backup plan.
Declaration
Swift
public func getBackupPlanFromTemplate(_ input: GetBackupPlanFromTemplateInput) -> EventLoopFuture<GetBackupPlanFromTemplateOutput>
-
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
Declaration
Swift
public func getBackupSelection(_ input: GetBackupSelectionInput) -> EventLoopFuture<GetBackupSelectionOutput>
-
Returns the access policy document that is associated with the named backup vault.
Declaration
Swift
public func getBackupVaultAccessPolicy(_ input: GetBackupVaultAccessPolicyInput) -> EventLoopFuture<GetBackupVaultAccessPolicyOutput>
-
Returns event notifications for the specified backup vault.
Declaration
Swift
public func getBackupVaultNotifications(_ input: GetBackupVaultNotificationsInput) -> EventLoopFuture<GetBackupVaultNotificationsOutput>
-
Returns a set of metadata key-value pairs that were used to create the backup.
Declaration
Swift
public func getRecoveryPointRestoreMetadata(_ input: GetRecoveryPointRestoreMetadataInput) -> EventLoopFuture<GetRecoveryPointRestoreMetadataOutput>
-
Returns the AWS resource types supported by AWS Backup.
Declaration
Swift
public func getSupportedResourceTypes() -> EventLoopFuture<GetSupportedResourceTypesOutput>
-
Returns metadata about your backup jobs.
Declaration
Swift
public func listBackupJobs(_ input: ListBackupJobsInput) -> EventLoopFuture<ListBackupJobsOutput>
-
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
Declaration
Swift
public func listBackupPlanTemplates(_ input: ListBackupPlanTemplatesInput) -> EventLoopFuture<ListBackupPlanTemplatesOutput>
-
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
Declaration
Swift
public func listBackupPlanVersions(_ input: ListBackupPlanVersionsInput) -> EventLoopFuture<ListBackupPlanVersionsOutput>
-
Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
Declaration
Swift
public func listBackupPlans(_ input: ListBackupPlansInput) -> EventLoopFuture<ListBackupPlansOutput>
-
Returns an array containing metadata of the resources associated with the target backup plan.
Declaration
Swift
public func listBackupSelections(_ input: ListBackupSelectionsInput) -> EventLoopFuture<ListBackupSelectionsOutput>
-
Returns a list of recovery point storage containers along with information about them.
Declaration
Swift
public func listBackupVaults(_ input: ListBackupVaultsInput) -> EventLoopFuture<ListBackupVaultsOutput>
-
Returns metadata about your copy jobs.
Declaration
Swift
public func listCopyJobs(_ input: ListCopyJobsInput) -> EventLoopFuture<ListCopyJobsOutput>
-
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
Declaration
Swift
public func listProtectedResources(_ input: ListProtectedResourcesInput) -> EventLoopFuture<ListProtectedResourcesOutput>
-
Returns detailed information about the recovery points stored in a backup vault.
Declaration
Swift
public func listRecoveryPointsByBackupVault(_ input: ListRecoveryPointsByBackupVaultInput) -> EventLoopFuture<ListRecoveryPointsByBackupVaultOutput>
-
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
Declaration
Swift
public func listRecoveryPointsByResource(_ input: ListRecoveryPointsByResourceInput) -> EventLoopFuture<ListRecoveryPointsByResourceOutput>
-
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
Declaration
Swift
public func listRestoreJobs(_ input: ListRestoreJobsInput) -> EventLoopFuture<ListRestoreJobsOutput>
-
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. ListTags are currently only supported with Amazon EFS backups.
Declaration
Swift
public func listTags(_ input: ListTagsInput) -> EventLoopFuture<ListTagsOutput>
-
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.
Declaration
Swift
@discardableResult public func putBackupVaultAccessPolicy(_ input: PutBackupVaultAccessPolicyInput) -> EventLoopFuture<Void>
-
Turns on notifications on a backup vault for the specified topic and events.
Declaration
Swift
@discardableResult public func putBackupVaultNotifications(_ input: PutBackupVaultNotificationsInput) -> EventLoopFuture<Void>
-
Starts a job to create a one-time backup of the specified resource.
Declaration
Swift
public func startBackupJob(_ input: StartBackupJobInput) -> EventLoopFuture<StartBackupJobOutput>
-
Starts a job to create a one-time copy of the specified resource.
Declaration
Swift
public func startCopyJob(_ input: StartCopyJobInput) -> EventLoopFuture<StartCopyJobOutput>
-
Recovers the saved resource identified by an Amazon Resource Name (ARN). If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.
Declaration
Swift
public func startRestoreJob(_ input: StartRestoreJobInput) -> EventLoopFuture<StartRestoreJobOutput>
-
Attempts to cancel a job to create a one-time backup of a resource.
Declaration
Swift
@discardableResult public func stopBackupJob(_ input: StopBackupJobInput) -> EventLoopFuture<Void>
-
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
Declaration
Swift
@discardableResult public func tagResource(_ input: TagResourceInput) -> EventLoopFuture<Void>
-
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
Declaration
Swift
@discardableResult public func untagResource(_ input: UntagResourceInput) -> EventLoopFuture<Void>
-
Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
Declaration
Swift
public func updateBackupPlan(_ input: UpdateBackupPlanInput) -> EventLoopFuture<UpdateBackupPlanOutput>
-
Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.
Declaration
Swift
public func updateRecoveryPointLifecycle(_ input: UpdateRecoveryPointLifecycleInput) -> EventLoopFuture<UpdateRecoveryPointLifecycleOutput>
-
Updates the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service’s resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service’s resources in this Region.
Declaration
Swift
@discardableResult public func updateRegionSettings(_ input: UpdateRegionSettingsInput) -> EventLoopFuture<Void>
-
Returns metadata about your backup jobs.
Declaration
Swift
public func listBackupJobsPaginator(_ input: ListBackupJobsInput, onPage: @escaping (ListBackupJobsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
Declaration
Swift
public func listBackupPlanTemplatesPaginator(_ input: ListBackupPlanTemplatesInput, onPage: @escaping (ListBackupPlanTemplatesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
Declaration
Swift
public func listBackupPlanVersionsPaginator(_ input: ListBackupPlanVersionsInput, onPage: @escaping (ListBackupPlanVersionsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
Declaration
Swift
public func listBackupPlansPaginator(_ input: ListBackupPlansInput, onPage: @escaping (ListBackupPlansOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns an array containing metadata of the resources associated with the target backup plan.
Declaration
Swift
public func listBackupSelectionsPaginator(_ input: ListBackupSelectionsInput, onPage: @escaping (ListBackupSelectionsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of recovery point storage containers along with information about them.
Declaration
Swift
public func listBackupVaultsPaginator(_ input: ListBackupVaultsInput, onPage: @escaping (ListBackupVaultsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns metadata about your copy jobs.
Declaration
Swift
public func listCopyJobsPaginator(_ input: ListCopyJobsInput, onPage: @escaping (ListCopyJobsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
Declaration
Swift
public func listProtectedResourcesPaginator(_ input: ListProtectedResourcesInput, onPage: @escaping (ListProtectedResourcesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns detailed information about the recovery points stored in a backup vault.
Declaration
Swift
public func listRecoveryPointsByBackupVaultPaginator(_ input: ListRecoveryPointsByBackupVaultInput, onPage: @escaping (ListRecoveryPointsByBackupVaultOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
Declaration
Swift
public func listRecoveryPointsByResourcePaginator(_ input: ListRecoveryPointsByResourceInput, onPage: @escaping (ListRecoveryPointsByResourceOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
Declaration
Swift
public func listRestoreJobsPaginator(_ input: ListRestoreJobsInput, onPage: @escaping (ListRestoreJobsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. ListTags are currently only supported with Amazon EFS backups.
Declaration
Swift
public func listTagsPaginator(_ input: ListTagsInput, onPage: @escaping (ListTagsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListBackupJobsInput : AWSShape
extension AWSBackup.ListBackupJobsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBackupPlanTemplatesInput : AWSShape
extension AWSBackup.ListBackupPlanTemplatesInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBackupPlanVersionsInput : AWSShape
extension AWSBackup.ListBackupPlanVersionsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBackupPlansInput : AWSShape
extension AWSBackup.ListBackupPlansInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBackupSelectionsInput : AWSShape
extension AWSBackup.ListBackupSelectionsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListBackupVaultsInput : AWSShape
extension AWSBackup.ListBackupVaultsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListCopyJobsInput : AWSShape
extension AWSBackup.ListCopyJobsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListProtectedResourcesInput : AWSShape
extension AWSBackup.ListProtectedResourcesInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListRecoveryPointsByBackupVaultInput : AWSShape
extension AWSBackup.ListRecoveryPointsByBackupVaultInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListRecoveryPointsByResourceInput : AWSShape
extension AWSBackup.ListRecoveryPointsByResourceInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListRestoreJobsInput : AWSShape
extension AWSBackup.ListRestoreJobsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListTagsInput : AWSShape
extension AWSBackup.ListTagsInput: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum BackupJobState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum BackupVaultEvent : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ConditionType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum CopyJobState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RecoveryPointStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RestoreJobStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum StorageClass : String, CustomStringConvertible, Codable