amazonaws.com – backup

Tools (74)

Extracted live via the executor SDK.

• accountSettings.describeRegionSettings

  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.

• accountSettings.updateRegionSettings

  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.

• audit.createFramework

  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.

• audit.createReportPlan

  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.

• audit.deleteFramework

  Deletes the framework specified by a framework name.

• audit.deleteReportPlan

  Deletes the report plan specified by a report plan name.

• audit.describeFramework

  Returns the framework details for the specified FrameworkName.

• audit.describeReportJob

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

• audit.describeReportPlan

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

• audit.listFrameworks

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

• audit.listReportJobs

  Returns details about your report jobs.

• audit.listReportPlans

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

• audit.startReportJob

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

• audit.updateFramework

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

• audit.updateReportPlan

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

• backup.createBackupPlan

  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.

• backup.createBackupSelection

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

• backup.deleteBackupPlan

  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.

• backup.deleteBackupSelection

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

• backup.exportBackupPlanTemplate

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

• backup.getBackupPlan

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

• backup.getBackupPlanFromJson

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

• backup.getBackupPlanFromTemplate

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

• backup.getBackupSelection

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

• backup.listBackupPlans

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

• backup.listBackupPlanTemplates

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

• backup.listBackupPlanVersions

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

• backup.listBackupSelections

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

• backup.updateBackupPlan

  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.

• backupJobs.describeBackupJob

  Returns backup job details for the specified BackupJobId.

• backupJobs.listBackupJobs

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

• backupJobs.startBackupJob

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

• backupJobs.stopBackupJob

  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.

• backupVaults.createBackupVault

  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.

• backupVaults.deleteBackupVault

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

• backupVaults.deleteBackupVaultAccessPolicy

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

• backupVaults.deleteBackupVaultLockConfiguration

  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.

• backupVaults.deleteBackupVaultNotifications

  Deletes event notifications for the specified backup vault.

• backupVaults.deleteRecoveryPoint

  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.

• backupVaults.describeBackupVault

  Returns metadata about a backup vault specified by its name.

• backupVaults.describeRecoveryPoint

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

• backupVaults.disassociateRecoveryPoint

  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.

• backupVaults.disassociateRecoveryPointFromParent

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

• backupVaults.getBackupVaultAccessPolicy

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

• backupVaults.getBackupVaultNotifications

  Returns event notifications for the specified backup vault.

• backupVaults.getRecoveryPointRestoreMetadata

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

• backupVaults.listBackupVaults

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

• backupVaults.listRecoveryPointsByBackupVault

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

• backupVaults.putBackupVaultAccessPolicy

  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.

• backupVaults.putBackupVaultLockConfiguration

  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. [blocked]

• backupVaults.putBackupVaultNotifications

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

• backupVaults.updateRecoveryPointLifecycle

  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.

• copyJobs.describeCopyJob

  Returns metadata associated with creating a copy of a resource.

• copyJobs.listCopyJobs

  Returns metadata about your copy jobs.

• copyJobs.startCopyJob

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

  Does not support continuous backups.

• globalSettings.describeGlobalSettings

  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

• globalSettings.updateGlobalSettings

  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.

• legalHolds.cancelLegalHold

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

• legalHolds.createLegalHold

  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.

• legalHolds.getLegalHold

  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.

• legalHolds.listLegalHolds

  This action returns metadata about active and previous legal holds.

• legalHolds.listRecoveryPointsByLegalHold

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

• resources.describeProtectedResource

  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.

• resources.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.

• resources.listRecoveryPointsByResource

  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.

• restoreJobs.describeRestoreJob

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

• restoreJobs.listRestoreJobs

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

• restoreJobs.startRestoreJob

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

• supportedResourceTypes.getSupportedResourceTypes

  Returns the Amazon Web Services resource types supported by Backup.

• tags.listTags

  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.

• tags.tagResource

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

• untag.untagResource

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

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools