amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.Lens

Contents

Description

 
Synopsis

Operations

CancelLegalHold

cancelLegalHold_retainRecordInDays :: Lens' CancelLegalHold (Maybe Integer) Source #

The integer amount in days specifying amount of days after this API operation to remove legal hold.

cancelLegalHold_legalHoldId :: Lens' CancelLegalHold Text Source #

Legal hold ID required to remove the specified legal hold on a recovery point.

cancelLegalHold_cancelDescription :: Lens' CancelLegalHold Text Source #

String describing the reason for removing the legal hold.

CreateBackupPlan

createBackupPlan_backupPlanTags :: Lens' CreateBackupPlan (Maybe (HashMap Text Text)) Source #

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

createBackupPlan_creatorRequestId :: Lens' CreateBackupPlan (Maybe Text) Source #

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

createBackupPlan_backupPlan :: Lens' CreateBackupPlan BackupPlanInput Source #

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

createBackupPlanResponse_advancedBackupSettings :: Lens' CreateBackupPlanResponse (Maybe [AdvancedBackupSetting]) Source #

A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

createBackupPlanResponse_backupPlanArn :: Lens' CreateBackupPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

createBackupPlanResponse_creationDate :: Lens' CreateBackupPlanResponse (Maybe UTCTime) Source #

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

createBackupPlanResponse_versionId :: Lens' CreateBackupPlanResponse (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

CreateBackupSelection

createBackupSelection_creatorRequestId :: Lens' CreateBackupSelection (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

createBackupSelection_backupPlanId :: Lens' CreateBackupSelection Text Source #

Uniquely identifies the backup plan to be associated with the selection of resources.

createBackupSelection_backupSelection :: Lens' CreateBackupSelection BackupSelection Source #

Specifies the body of a request to assign a set of resources to a backup plan.

createBackupSelectionResponse_creationDate :: Lens' CreateBackupSelectionResponse (Maybe UTCTime) Source #

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

createBackupSelectionResponse_selectionId :: Lens' CreateBackupSelectionResponse (Maybe Text) Source #

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

CreateBackupVault

createBackupVault_backupVaultTags :: Lens' CreateBackupVault (Maybe (HashMap Text Text)) Source #

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

createBackupVault_creatorRequestId :: Lens' CreateBackupVault (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

createBackupVault_encryptionKeyArn :: Lens' CreateBackupVault (Maybe Text) Source #

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

createBackupVault_backupVaultName :: Lens' CreateBackupVault Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

createBackupVaultResponse_backupVaultArn :: Lens' CreateBackupVaultResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

createBackupVaultResponse_backupVaultName :: Lens' CreateBackupVaultResponse (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

createBackupVaultResponse_creationDate :: Lens' CreateBackupVaultResponse (Maybe UTCTime) Source #

The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreateFramework

createFramework_frameworkDescription :: Lens' CreateFramework (Maybe Text) Source #

An optional description of the framework with a maximum of 1,024 characters.

createFramework_frameworkTags :: Lens' CreateFramework (Maybe (HashMap Text Text)) Source #

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

createFramework_idempotencyToken :: Lens' CreateFramework (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

createFramework_frameworkName :: Lens' CreateFramework Text Source #

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

createFramework_frameworkControls :: Lens' CreateFramework [FrameworkControl] Source #

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

createFrameworkResponse_frameworkArn :: Lens' CreateFrameworkResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

createFrameworkResponse_frameworkName :: Lens' CreateFrameworkResponse (Maybe Text) Source #

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

CreateLegalHold

createLegalHold_idempotencyToken :: Lens' CreateLegalHold (Maybe Text) Source #

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

createLegalHold_recoveryPointSelection :: Lens' CreateLegalHold (Maybe RecoveryPointSelection) Source #

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

createLegalHold_tags :: Lens' CreateLegalHold (Maybe (HashMap Text Text)) Source #

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

createLegalHold_title :: Lens' CreateLegalHold Text Source #

This is the string title of the legal hold.

createLegalHold_description :: Lens' CreateLegalHold Text Source #

This is the string description of the legal hold.

createLegalHoldResponse_creationDate :: Lens' CreateLegalHoldResponse (Maybe UTCTime) Source #

Time in number format when legal hold was created.

createLegalHoldResponse_description :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

This is the returned string description of the legal hold.

createLegalHoldResponse_legalHoldArn :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

This is the ARN (Amazon Resource Number) of the created legal hold.

createLegalHoldResponse_legalHoldId :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

Legal hold ID returned for the specified legal hold on a recovery point.

createLegalHoldResponse_recoveryPointSelection :: Lens' CreateLegalHoldResponse (Maybe RecoveryPointSelection) Source #

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

createLegalHoldResponse_status :: Lens' CreateLegalHoldResponse (Maybe LegalHoldStatus) Source #

This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

createLegalHoldResponse_title :: Lens' CreateLegalHoldResponse (Maybe Text) Source #

This is the string title of the legal hold returned after creating the legal hold.

CreateReportPlan

createReportPlan_idempotencyToken :: Lens' CreateReportPlan (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

createReportPlan_reportPlanDescription :: Lens' CreateReportPlan (Maybe Text) Source #

An optional description of the report plan with a maximum of 1,024 characters.

createReportPlan_reportPlanTags :: Lens' CreateReportPlan (Maybe (HashMap Text Text)) Source #

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

createReportPlan_reportPlanName :: Lens' CreateReportPlan Text Source #

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

createReportPlan_reportDeliveryChannel :: Lens' CreateReportPlan ReportDeliveryChannel Source #

A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

createReportPlan_reportSetting :: Lens' CreateReportPlan ReportSetting Source #

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

createReportPlanResponse_creationTime :: Lens' CreateReportPlanResponse (Maybe UTCTime) Source #

The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

createReportPlanResponse_reportPlanArn :: Lens' CreateReportPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

DeleteBackupPlan

deleteBackupPlan_backupPlanId :: Lens' DeleteBackupPlan Text Source #

Uniquely identifies a backup plan.

deleteBackupPlanResponse_backupPlanArn :: Lens' DeleteBackupPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

deleteBackupPlanResponse_deletionDate :: Lens' DeleteBackupPlanResponse (Maybe UTCTime) Source #

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

deleteBackupPlanResponse_versionId :: Lens' DeleteBackupPlanResponse (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

DeleteBackupSelection

deleteBackupSelection_selectionId :: Lens' DeleteBackupSelection Text Source #

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

DeleteBackupVault

deleteBackupVault_backupVaultName :: Lens' DeleteBackupVault Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

DeleteBackupVaultAccessPolicy

deleteBackupVaultAccessPolicy_backupVaultName :: Lens' DeleteBackupVaultAccessPolicy Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

DeleteBackupVaultLockConfiguration

deleteBackupVaultLockConfiguration_backupVaultName :: Lens' DeleteBackupVaultLockConfiguration Text Source #

The name of the backup vault from which to delete Backup Vault Lock.

DeleteBackupVaultNotifications

deleteBackupVaultNotifications_backupVaultName :: Lens' DeleteBackupVaultNotifications Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

DeleteFramework

DeleteRecoveryPoint

deleteRecoveryPoint_backupVaultName :: Lens' DeleteRecoveryPoint Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

deleteRecoveryPoint_recoveryPointArn :: Lens' DeleteRecoveryPoint Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

DeleteReportPlan

DescribeBackupJob

describeBackupJob_backupJobId :: Lens' DescribeBackupJob Text Source #

Uniquely identifies a request to Backup to back up a resource.

describeBackupJobResponse_accountId :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

Returns the account ID that owns the backup job.

describeBackupJobResponse_backupJobId :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

Uniquely identifies a request to Backup to back up a resource.

describeBackupJobResponse_backupOptions :: Lens' DescribeBackupJobResponse (Maybe (HashMap Text Text)) Source #

Represents the options specified as part of backup plan or on-demand backup job.

describeBackupJobResponse_backupType :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

describeBackupJobResponse_backupVaultArn :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

describeBackupJobResponse_backupVaultName :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

describeBackupJobResponse_bytesTransferred :: Lens' DescribeBackupJobResponse (Maybe Integer) Source #

The size in bytes transferred to a backup vault at the time that the job status was queried.

describeBackupJobResponse_childJobsInState :: Lens' DescribeBackupJobResponse (Maybe (HashMap BackupJobState Integer)) Source #

This returns the statistics of the included child (nested) backup jobs.

describeBackupJobResponse_completionDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeBackupJobResponse_createdBy :: Lens' DescribeBackupJobResponse (Maybe RecoveryPointCreator) Source #

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

describeBackupJobResponse_creationDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeBackupJobResponse_expectedCompletionDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #

The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeBackupJobResponse_iamRoleArn :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

describeBackupJobResponse_isParent :: Lens' DescribeBackupJobResponse (Maybe Bool) Source #

This returns the boolean value that a backup job is a parent (composite) job.

describeBackupJobResponse_numberOfChildJobs :: Lens' DescribeBackupJobResponse (Maybe Integer) Source #

This returns the number of child (nested) backup jobs.

describeBackupJobResponse_parentJobId :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

This returns the parent (composite) resource backup job ID.

describeBackupJobResponse_percentDone :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

Contains an estimated percentage that is complete of a job at the time the job status was queried.

describeBackupJobResponse_recoveryPointArn :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

describeBackupJobResponse_resourceArn :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

describeBackupJobResponse_resourceType :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

describeBackupJobResponse_startBy :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeBackupJobResponse_state :: Lens' DescribeBackupJobResponse (Maybe BackupJobState) Source #

The current state of a resource recovery point.

describeBackupJobResponse_statusMessage :: Lens' DescribeBackupJobResponse (Maybe Text) Source #

A detailed message explaining the status of the job to back up a resource.

DescribeBackupVault

describeBackupVault_backupVaultName :: Lens' DescribeBackupVault Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

describeBackupVaultResponse_backupVaultArn :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

describeBackupVaultResponse_backupVaultName :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

describeBackupVaultResponse_creationDate :: Lens' DescribeBackupVaultResponse (Maybe UTCTime) Source #

The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeBackupVaultResponse_creatorRequestId :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

describeBackupVaultResponse_encryptionKeyArn :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

describeBackupVaultResponse_lockDate :: Lens' DescribeBackupVaultResponse (Maybe UTCTime) Source #

The date and time when Backup Vault Lock configuration cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeBackupVaultResponse_locked :: Lens' DescribeBackupVaultResponse (Maybe Bool) Source #

A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.

describeBackupVaultResponse_maxRetentionDays :: Lens' DescribeBackupVaultResponse (Maybe Integer) Source #

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

describeBackupVaultResponse_minRetentionDays :: Lens' DescribeBackupVaultResponse (Maybe Integer) Source #

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

describeBackupVaultResponse_numberOfRecoveryPoints :: Lens' DescribeBackupVaultResponse (Maybe Integer) Source #

The number of recovery points that are stored in a backup vault.

DescribeCopyJob

describeCopyJob_copyJobId :: Lens' DescribeCopyJob Text Source #

Uniquely identifies a copy job.

describeCopyJobResponse_copyJob :: Lens' DescribeCopyJobResponse (Maybe CopyJob) Source #

Contains detailed information about a copy job.

DescribeFramework

describeFrameworkResponse_creationTime :: Lens' DescribeFrameworkResponse (Maybe UTCTime) Source #

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

describeFrameworkResponse_deploymentStatus :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

describeFrameworkResponse_frameworkArn :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

describeFrameworkResponse_frameworkControls :: Lens' DescribeFrameworkResponse (Maybe [FrameworkControl]) Source #

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

describeFrameworkResponse_frameworkStatus :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

  • ACTIVE when recording is turned on for all resources governed by the framework.
  • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
  • INACTIVE when recording is turned off for all resources governed by the framework.
  • UNAVAILABLE when Backup is unable to validate recording status at this time.

describeFrameworkResponse_idempotencyToken :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

DescribeGlobalSettings

describeGlobalSettingsResponse_lastUpdateTime :: Lens' DescribeGlobalSettingsResponse (Maybe UTCTime) Source #

The date and time that the flag isCrossAccountBackupEnabled was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

DescribeProtectedResource

describeProtectedResource_resourceArn :: Lens' DescribeProtectedResource Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

describeProtectedResourceResponse_lastBackupTime :: Lens' DescribeProtectedResourceResponse (Maybe UTCTime) Source #

The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeProtectedResourceResponse_resourceArn :: Lens' DescribeProtectedResourceResponse (Maybe Text) Source #

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

describeProtectedResourceResponse_resourceType :: Lens' DescribeProtectedResourceResponse (Maybe Text) Source #

The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.

DescribeRecoveryPoint

describeRecoveryPoint_backupVaultName :: Lens' DescribeRecoveryPoint Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

describeRecoveryPoint_recoveryPointArn :: Lens' DescribeRecoveryPoint Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

describeRecoveryPointResponse_backupVaultArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

describeRecoveryPointResponse_backupVaultName :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

describeRecoveryPointResponse_calculatedLifecycle :: Lens' DescribeRecoveryPointResponse (Maybe CalculatedLifecycle) Source #

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

describeRecoveryPointResponse_completionDate :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime) Source #

The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeRecoveryPointResponse_compositeMemberIdentifier :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

describeRecoveryPointResponse_createdBy :: Lens' DescribeRecoveryPointResponse (Maybe RecoveryPointCreator) Source #

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

describeRecoveryPointResponse_creationDate :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime) Source #

The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeRecoveryPointResponse_encryptionKeyArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

describeRecoveryPointResponse_iamRoleArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

describeRecoveryPointResponse_isEncrypted :: Lens' DescribeRecoveryPointResponse (Maybe Bool) Source #

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

describeRecoveryPointResponse_isParent :: Lens' DescribeRecoveryPointResponse (Maybe Bool) Source #

This returns the boolean value that a recovery point is a parent (composite) job.

describeRecoveryPointResponse_lastRestoreTime :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime) Source #

The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeRecoveryPointResponse_lifecycle :: Lens' DescribeRecoveryPointResponse (Maybe Lifecycle) Source #

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 that are 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.

describeRecoveryPointResponse_parentRecoveryPointArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

describeRecoveryPointResponse_recoveryPointArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

describeRecoveryPointResponse_resourceArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

describeRecoveryPointResponse_resourceType :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

describeRecoveryPointResponse_sourceBackupVaultArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.

describeRecoveryPointResponse_status :: Lens' DescribeRecoveryPointResponse (Maybe RecoveryPointStatus) Source #

A status code specifying the state of the recovery point.

PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.

To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.

describeRecoveryPointResponse_statusMessage :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #

A status message explaining the reason for the recovery point deletion failure.

describeRecoveryPointResponse_storageClass :: Lens' DescribeRecoveryPointResponse (Maybe StorageClass) Source #

Specifies the storage class of the recovery point. Valid values are WARM or COLD.

DescribeRegionSettings

describeRegionSettingsResponse_resourceTypeManagementPreference :: Lens' DescribeRegionSettingsResponse (Maybe (HashMap Text Bool)) Source #

Returns whether Backup fully manages the backups for a resource type.

For the benefits of full Backup management, see Full Backup management.

For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.

If "DynamoDB":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.

describeRegionSettingsResponse_resourceTypeOptInPreference :: Lens' DescribeRegionSettingsResponse (Maybe (HashMap Text Bool)) Source #

Returns a list of all services along with the opt-in preferences in the Region.

DescribeReportJob

describeReportJob_reportJobId :: Lens' DescribeReportJob Text Source #

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

describeReportJobResponse_reportJob :: Lens' DescribeReportJobResponse (Maybe ReportJob) Source #

A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

DescribeReportPlan

describeReportPlanResponse_reportPlan :: Lens' DescribeReportPlanResponse (Maybe ReportPlan) Source #

Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.

DescribeRestoreJob

describeRestoreJob_restoreJobId :: Lens' DescribeRestoreJob Text Source #

Uniquely identifies the job that restores a recovery point.

describeRestoreJobResponse_accountId :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Returns the account ID that owns the restore job.

describeRestoreJobResponse_completionDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime) Source #

The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeRestoreJobResponse_createdResourceArn :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

describeRestoreJobResponse_creationDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime) Source #

The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeRestoreJobResponse_expectedCompletionTimeMinutes :: Lens' DescribeRestoreJobResponse (Maybe Integer) Source #

The amount of time in minutes that a job restoring a recovery point is expected to take.

describeRestoreJobResponse_iamRoleArn :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

describeRestoreJobResponse_percentDone :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Contains an estimated percentage that is complete of a job at the time the job status was queried.

describeRestoreJobResponse_recoveryPointArn :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

describeRestoreJobResponse_resourceType :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Returns metadata associated with a restore job listed by resource type.

describeRestoreJobResponse_restoreJobId :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Uniquely identifies the job that restores a recovery point.

describeRestoreJobResponse_status :: Lens' DescribeRestoreJobResponse (Maybe RestoreJobStatus) Source #

Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

describeRestoreJobResponse_statusMessage :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

A message showing the status of a job to restore a recovery point.

DisassociateRecoveryPoint

disassociateRecoveryPoint_recoveryPointArn :: Lens' DisassociateRecoveryPoint Text Source #

An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.

DisassociateRecoveryPointFromParent

disassociateRecoveryPointFromParent_backupVaultName :: Lens' DisassociateRecoveryPointFromParent Text Source #

This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

disassociateRecoveryPointFromParent_recoveryPointArn :: Lens' DisassociateRecoveryPointFromParent Text Source #

This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ExportBackupPlanTemplate

exportBackupPlanTemplateResponse_backupPlanTemplateJson :: Lens' ExportBackupPlanTemplateResponse (Maybe Text) Source #

The body of a backup plan template in JSON format.

This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

GetBackupPlan

getBackupPlan_versionId :: Lens' GetBackupPlan (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

getBackupPlan_backupPlanId :: Lens' GetBackupPlan Text Source #

Uniquely identifies a backup plan.

getBackupPlanResponse_advancedBackupSettings :: Lens' GetBackupPlanResponse (Maybe [AdvancedBackupSetting]) Source #

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

getBackupPlanResponse_backupPlan :: Lens' GetBackupPlanResponse (Maybe BackupPlan) Source #

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

getBackupPlanResponse_backupPlanArn :: Lens' GetBackupPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

getBackupPlanResponse_creationDate :: Lens' GetBackupPlanResponse (Maybe UTCTime) Source #

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

getBackupPlanResponse_creatorRequestId :: Lens' GetBackupPlanResponse (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

getBackupPlanResponse_deletionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime) Source #

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

getBackupPlanResponse_lastExecutionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime) Source #

The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

getBackupPlanResponse_versionId :: Lens' GetBackupPlanResponse (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

GetBackupPlanFromJSON

getBackupPlanFromJSON_backupPlanTemplateJson :: Lens' GetBackupPlanFromJSON Text Source #

A customer-supplied backup plan document in JSON format.

getBackupPlanFromJSONResponse_backupPlan :: Lens' GetBackupPlanFromJSONResponse (Maybe BackupPlan) Source #

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

GetBackupPlanFromTemplate

getBackupPlanFromTemplate_backupPlanTemplateId :: Lens' GetBackupPlanFromTemplate Text Source #

Uniquely identifies a stored backup plan template.

getBackupPlanFromTemplateResponse_backupPlanDocument :: Lens' GetBackupPlanFromTemplateResponse (Maybe BackupPlan) Source #

Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

GetBackupSelection

getBackupSelection_selectionId :: Lens' GetBackupSelection Text Source #

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

getBackupSelectionResponse_backupSelection :: Lens' GetBackupSelectionResponse (Maybe BackupSelection) Source #

Specifies the body of a request to assign a set of resources to a backup plan.

getBackupSelectionResponse_creationDate :: Lens' GetBackupSelectionResponse (Maybe UTCTime) Source #

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

getBackupSelectionResponse_creatorRequestId :: Lens' GetBackupSelectionResponse (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

getBackupSelectionResponse_selectionId :: Lens' GetBackupSelectionResponse (Maybe Text) Source #

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

GetBackupVaultAccessPolicy

getBackupVaultAccessPolicy_backupVaultName :: Lens' GetBackupVaultAccessPolicy Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

getBackupVaultAccessPolicyResponse_backupVaultArn :: Lens' GetBackupVaultAccessPolicyResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

getBackupVaultAccessPolicyResponse_backupVaultName :: Lens' GetBackupVaultAccessPolicyResponse (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

getBackupVaultAccessPolicyResponse_policy :: Lens' GetBackupVaultAccessPolicyResponse (Maybe Text) Source #

The backup vault access policy document in JSON format.

GetBackupVaultNotifications

getBackupVaultNotifications_backupVaultName :: Lens' GetBackupVaultNotifications Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

getBackupVaultNotificationsResponse_backupVaultArn :: Lens' GetBackupVaultNotificationsResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

getBackupVaultNotificationsResponse_backupVaultEvents :: Lens' GetBackupVaultNotificationsResponse (Maybe [BackupVaultEvent]) Source #

An array of events that indicate the status of jobs to back up resources to the backup vault.

getBackupVaultNotificationsResponse_backupVaultName :: Lens' GetBackupVaultNotificationsResponse (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

getBackupVaultNotificationsResponse_sNSTopicArn :: Lens' GetBackupVaultNotificationsResponse (Maybe Text) Source #

An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

GetLegalHold

getLegalHold_legalHoldId :: Lens' GetLegalHold Text Source #

This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

getLegalHoldResponse_cancelDescription :: Lens' GetLegalHoldResponse (Maybe Text) Source #

String describing the reason for removing the legal hold.

getLegalHoldResponse_cancellationDate :: Lens' GetLegalHoldResponse (Maybe UTCTime) Source #

Time in number when legal hold was cancelled.

getLegalHoldResponse_creationDate :: Lens' GetLegalHoldResponse (Maybe UTCTime) Source #

Time in number format when legal hold was created.

getLegalHoldResponse_description :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the returned string description of the legal hold.

getLegalHoldResponse_legalHoldArn :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

getLegalHoldResponse_legalHoldId :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the returned ID associated with a specified legal hold.

getLegalHoldResponse_recoveryPointSelection :: Lens' GetLegalHoldResponse (Maybe RecoveryPointSelection) Source #

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

getLegalHoldResponse_retainRecordUntil :: Lens' GetLegalHoldResponse (Maybe UTCTime) Source #

This is the date and time until which the legal hold record will be retained.

getLegalHoldResponse_status :: Lens' GetLegalHoldResponse (Maybe LegalHoldStatus) Source #

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

getLegalHoldResponse_title :: Lens' GetLegalHoldResponse (Maybe Text) Source #

This is the string title of the legal hold.

GetRecoveryPointRestoreMetadata

getRecoveryPointRestoreMetadata_backupVaultName :: Lens' GetRecoveryPointRestoreMetadata Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

getRecoveryPointRestoreMetadata_recoveryPointArn :: Lens' GetRecoveryPointRestoreMetadata Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

getRecoveryPointRestoreMetadataResponse_backupVaultArn :: Lens' GetRecoveryPointRestoreMetadataResponse (Maybe Text) Source #

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

getRecoveryPointRestoreMetadataResponse_recoveryPointArn :: Lens' GetRecoveryPointRestoreMetadataResponse (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

getRecoveryPointRestoreMetadataResponse_restoreMetadata :: Lens' GetRecoveryPointRestoreMetadataResponse (Maybe (HashMap Text Text)) Source #

The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

GetSupportedResourceTypes

getSupportedResourceTypesResponse_resourceTypes :: Lens' GetSupportedResourceTypesResponse (Maybe [Text]) Source #

Contains a string with the supported Amazon Web Services resource types:

  • Aurora for Amazon Aurora
  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • FSX for Amazon FSx
  • RDS for Amazon Relational Database Service
  • Storage Gateway for Storage Gateway
  • DocDB for Amazon DocumentDB (with MongoDB compatibility)
  • Neptune for Amazon Neptune

ListBackupJobs

listBackupJobs_byAccountId :: Lens' ListBackupJobs (Maybe Text) Source #

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an Organizations management account, passing * returns all jobs across the organization.

listBackupJobs_byBackupVaultName :: Lens' ListBackupJobs (Maybe Text) Source #

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

listBackupJobs_byCompleteAfter :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

listBackupJobs_byCompleteBefore :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

listBackupJobs_byCreatedAfter :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs that were created after the specified date.

listBackupJobs_byCreatedBefore :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs that were created before the specified date.

listBackupJobs_byParentJobId :: Lens' ListBackupJobs (Maybe Text) Source #

This is a filter to list child (nested) jobs based on parent job ID.

listBackupJobs_byResourceArn :: Lens' ListBackupJobs (Maybe Text) Source #

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

listBackupJobs_byResourceType :: Lens' ListBackupJobs (Maybe Text) Source #

Returns only backup jobs for the specified resources:

  • Aurora for Amazon Aurora
  • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • FSx for Amazon FSx
  • Neptune for Amazon Neptune
  • RDS for Amazon Relational Database Service
  • Storage Gateway for Storage Gateway
  • S3 for Amazon S3
  • VirtualMachine for virtual machines

listBackupJobs_byState :: Lens' ListBackupJobs (Maybe BackupJobState) Source #

Returns only backup jobs that are in the specified state.

listBackupJobs_maxResults :: Lens' ListBackupJobs (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupJobs_nextToken :: Lens' ListBackupJobs (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupJobsResponse_backupJobs :: Lens' ListBackupJobsResponse (Maybe [BackupJob]) Source #

An array of structures containing metadata about your backup jobs returned in JSON format.

listBackupJobsResponse_nextToken :: Lens' ListBackupJobsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListBackupPlanTemplates

listBackupPlanTemplates_maxResults :: Lens' ListBackupPlanTemplates (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupPlanTemplates_nextToken :: Lens' ListBackupPlanTemplates (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupPlanTemplatesResponse_backupPlanTemplatesList :: Lens' ListBackupPlanTemplatesResponse (Maybe [BackupPlanTemplatesListMember]) Source #

An array of template list items containing metadata about your saved templates.

listBackupPlanTemplatesResponse_nextToken :: Lens' ListBackupPlanTemplatesResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListBackupPlanVersions

listBackupPlanVersions_maxResults :: Lens' ListBackupPlanVersions (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupPlanVersions_nextToken :: Lens' ListBackupPlanVersions (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupPlanVersionsResponse_backupPlanVersionsList :: Lens' ListBackupPlanVersionsResponse (Maybe [BackupPlansListMember]) Source #

An array of version list items containing metadata about your backup plans.

listBackupPlanVersionsResponse_nextToken :: Lens' ListBackupPlanVersionsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListBackupPlans

listBackupPlans_includeDeleted :: Lens' ListBackupPlans (Maybe Bool) Source #

A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

listBackupPlans_maxResults :: Lens' ListBackupPlans (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupPlans_nextToken :: Lens' ListBackupPlans (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupPlansResponse_backupPlansList :: Lens' ListBackupPlansResponse (Maybe [BackupPlansListMember]) Source #

An array of backup plan list items containing metadata about your saved backup plans.

listBackupPlansResponse_nextToken :: Lens' ListBackupPlansResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListBackupSelections

listBackupSelections_maxResults :: Lens' ListBackupSelections (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupSelections_nextToken :: Lens' ListBackupSelections (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupSelectionsResponse_backupSelectionsList :: Lens' ListBackupSelectionsResponse (Maybe [BackupSelectionsListMember]) Source #

An array of backup selection list items containing metadata about each resource in the list.

listBackupSelectionsResponse_nextToken :: Lens' ListBackupSelectionsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListBackupVaults

listBackupVaults_maxResults :: Lens' ListBackupVaults (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupVaults_nextToken :: Lens' ListBackupVaults (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupVaultsResponse_backupVaultList :: Lens' ListBackupVaultsResponse (Maybe [BackupVaultListMember]) Source #

An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

listBackupVaultsResponse_nextToken :: Lens' ListBackupVaultsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListCopyJobs

listCopyJobs_byAccountId :: Lens' ListCopyJobs (Maybe Text) Source #

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

listCopyJobs_byCompleteAfter :: Lens' ListCopyJobs (Maybe UTCTime) Source #

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

listCopyJobs_byCompleteBefore :: Lens' ListCopyJobs (Maybe UTCTime) Source #

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

listCopyJobs_byCreatedAfter :: Lens' ListCopyJobs (Maybe UTCTime) Source #

Returns only copy jobs that were created after the specified date.

listCopyJobs_byCreatedBefore :: Lens' ListCopyJobs (Maybe UTCTime) Source #

Returns only copy jobs that were created before the specified date.

listCopyJobs_byDestinationVaultArn :: Lens' ListCopyJobs (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

listCopyJobs_byParentJobId :: Lens' ListCopyJobs (Maybe Text) Source #

This is a filter to list child (nested) jobs based on parent job ID.

listCopyJobs_byResourceArn :: Lens' ListCopyJobs (Maybe Text) Source #

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

listCopyJobs_byResourceType :: Lens' ListCopyJobs (Maybe Text) Source #

Returns only backup jobs for the specified resources:

  • Aurora for Amazon Aurora
  • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • FSx for Amazon FSx
  • Neptune for Amazon Neptune
  • RDS for Amazon Relational Database Service
  • Storage Gateway for Storage Gateway
  • S3 for Amazon S3
  • VirtualMachine for virtual machines

listCopyJobs_byState :: Lens' ListCopyJobs (Maybe CopyJobState) Source #

Returns only copy jobs that are in the specified state.

listCopyJobs_maxResults :: Lens' ListCopyJobs (Maybe Natural) Source #

The maximum number of items to be returned.

listCopyJobs_nextToken :: Lens' ListCopyJobs (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listCopyJobsResponse_copyJobs :: Lens' ListCopyJobsResponse (Maybe [CopyJob]) Source #

An array of structures containing metadata about your copy jobs returned in JSON format.

listCopyJobsResponse_nextToken :: Lens' ListCopyJobsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListFrameworks

listFrameworks_maxResults :: Lens' ListFrameworks (Maybe Natural) Source #

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

listFrameworks_nextToken :: Lens' ListFrameworks (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listFrameworksResponse_frameworks :: Lens' ListFrameworksResponse (Maybe [Framework]) Source #

A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.

listFrameworksResponse_nextToken :: Lens' ListFrameworksResponse (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

ListLegalHolds

listLegalHolds_maxResults :: Lens' ListLegalHolds (Maybe Natural) Source #

The maximum number of resource list items to be returned.

listLegalHolds_nextToken :: Lens' ListLegalHolds (Maybe Text) Source #

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listLegalHoldsResponse_legalHolds :: Lens' ListLegalHoldsResponse (Maybe [LegalHold]) Source #

This is an array of returned legal holds, both active and previous.

listLegalHoldsResponse_nextToken :: Lens' ListLegalHoldsResponse (Maybe Text) Source #

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListProtectedResources

listProtectedResources_maxResults :: Lens' ListProtectedResources (Maybe Natural) Source #

The maximum number of items to be returned.

listProtectedResources_nextToken :: Lens' ListProtectedResources (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listProtectedResourcesResponse_nextToken :: Lens' ListProtectedResourcesResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listProtectedResourcesResponse_results :: Lens' ListProtectedResourcesResponse (Maybe [ProtectedResource]) Source #

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.

ListRecoveryPointsByBackupVault

listRecoveryPointsByBackupVault_byBackupPlanId :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

Returns only recovery points that match the specified backup plan ID.

listRecoveryPointsByBackupVault_byCreatedAfter :: Lens' ListRecoveryPointsByBackupVault (Maybe UTCTime) Source #

Returns only recovery points that were created after the specified timestamp.

listRecoveryPointsByBackupVault_byCreatedBefore :: Lens' ListRecoveryPointsByBackupVault (Maybe UTCTime) Source #

Returns only recovery points that were created before the specified timestamp.

listRecoveryPointsByBackupVault_byParentRecoveryPointArn :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

listRecoveryPointsByBackupVault_byResourceArn :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

listRecoveryPointsByBackupVault_byResourceType :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

Returns only recovery points that match the specified resource type.

listRecoveryPointsByBackupVault_nextToken :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRecoveryPointsByBackupVault_backupVaultName :: Lens' ListRecoveryPointsByBackupVault Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Backup vault name might not be available when a supported service creates the backup.

listRecoveryPointsByBackupVaultResponse_nextToken :: Lens' ListRecoveryPointsByBackupVaultResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRecoveryPointsByBackupVaultResponse_recoveryPoints :: Lens' ListRecoveryPointsByBackupVaultResponse (Maybe [RecoveryPointByBackupVault]) Source #

An array of objects that contain detailed information about recovery points saved in a backup vault.

ListRecoveryPointsByLegalHold

listRecoveryPointsByLegalHold_maxResults :: Lens' ListRecoveryPointsByLegalHold (Maybe Natural) Source #

This is the maximum number of resource list items to be returned.

listRecoveryPointsByLegalHold_nextToken :: Lens' ListRecoveryPointsByLegalHold (Maybe Text) Source #

This is the next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRecoveryPointsByLegalHoldResponse_nextToken :: Lens' ListRecoveryPointsByLegalHoldResponse (Maybe Text) Source #

This return is the next item following a partial list of returned resources.

listRecoveryPointsByLegalHoldResponse_recoveryPoints :: Lens' ListRecoveryPointsByLegalHoldResponse (Maybe [RecoveryPointMember]) Source #

This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.

ListRecoveryPointsByResource

listRecoveryPointsByResource_maxResults :: Lens' ListRecoveryPointsByResource (Maybe Natural) Source #

The maximum number of items to be returned.

Amazon RDS requires a value of at least 20.

listRecoveryPointsByResource_nextToken :: Lens' ListRecoveryPointsByResource (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRecoveryPointsByResource_resourceArn :: Lens' ListRecoveryPointsByResource Text Source #

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

listRecoveryPointsByResourceResponse_nextToken :: Lens' ListRecoveryPointsByResourceResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRecoveryPointsByResourceResponse_recoveryPoints :: Lens' ListRecoveryPointsByResourceResponse (Maybe [RecoveryPointByResource]) Source #

An array of objects that contain detailed information about recovery points of the specified resource type.

Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.

ListReportJobs

listReportJobs_byCreationAfter :: Lens' ListReportJobs (Maybe UTCTime) Source #

Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

listReportJobs_byCreationBefore :: Lens' ListReportJobs (Maybe UTCTime) Source #

Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

listReportJobs_byReportPlanName :: Lens' ListReportJobs (Maybe Text) Source #

Returns only report jobs with the specified report plan name.

listReportJobs_byStatus :: Lens' ListReportJobs (Maybe Text) Source #

Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

listReportJobs_maxResults :: Lens' ListReportJobs (Maybe Natural) Source #

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

listReportJobs_nextToken :: Lens' ListReportJobs (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listReportJobsResponse_nextToken :: Lens' ListReportJobsResponse (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listReportJobsResponse_reportJobs :: Lens' ListReportJobsResponse (Maybe [ReportJob]) Source #

Details about your report jobs in JSON format.

ListReportPlans

listReportPlans_maxResults :: Lens' ListReportPlans (Maybe Natural) Source #

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

listReportPlans_nextToken :: Lens' ListReportPlans (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listReportPlansResponse_nextToken :: Lens' ListReportPlansResponse (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listReportPlansResponse_reportPlans :: Lens' ListReportPlansResponse (Maybe [ReportPlan]) Source #

A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

ListRestoreJobs

listRestoreJobs_byAccountId :: Lens' ListRestoreJobs (Maybe Text) Source #

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

listRestoreJobs_byCompleteAfter :: Lens' ListRestoreJobs (Maybe UTCTime) Source #

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

listRestoreJobs_byCompleteBefore :: Lens' ListRestoreJobs (Maybe UTCTime) Source #

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

listRestoreJobs_byCreatedAfter :: Lens' ListRestoreJobs (Maybe UTCTime) Source #

Returns only restore jobs that were created after the specified date.

listRestoreJobs_byCreatedBefore :: Lens' ListRestoreJobs (Maybe UTCTime) Source #

Returns only restore jobs that were created before the specified date.

listRestoreJobs_byStatus :: Lens' ListRestoreJobs (Maybe RestoreJobStatus) Source #

Returns only restore jobs associated with the specified job status.

listRestoreJobs_maxResults :: Lens' ListRestoreJobs (Maybe Natural) Source #

The maximum number of items to be returned.

listRestoreJobs_nextToken :: Lens' ListRestoreJobs (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRestoreJobsResponse_nextToken :: Lens' ListRestoreJobsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRestoreJobsResponse_restoreJobs :: Lens' ListRestoreJobsResponse (Maybe [RestoreJobsListMember]) Source #

An array of objects that contain detailed information about jobs to restore saved resources.

ListTags

listTags_maxResults :: Lens' ListTags (Maybe Natural) Source #

The maximum number of items to be returned.

listTags_nextToken :: Lens' ListTags (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listTags_resourceArn :: Lens' ListTags Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listTagsResponse_tags :: Lens' ListTagsResponse (Maybe (HashMap Text Text)) Source #

To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

PutBackupVaultAccessPolicy

putBackupVaultAccessPolicy_policy :: Lens' PutBackupVaultAccessPolicy (Maybe Text) Source #

The backup vault access policy document in JSON format.

putBackupVaultAccessPolicy_backupVaultName :: Lens' PutBackupVaultAccessPolicy Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

PutBackupVaultLockConfiguration

putBackupVaultLockConfiguration_changeableForDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer) Source #

The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.

Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.

If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.

putBackupVaultLockConfiguration_maxRetentionDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer) Source #

The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).

If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.

If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.

putBackupVaultLockConfiguration_minRetentionDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer) Source #

The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).

If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.

putBackupVaultLockConfiguration_backupVaultName :: Lens' PutBackupVaultLockConfiguration Text Source #

The Backup Vault Lock configuration that specifies the name of the backup vault it protects.

PutBackupVaultNotifications

putBackupVaultNotifications_backupVaultName :: Lens' PutBackupVaultNotifications Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

putBackupVaultNotifications_sNSTopicArn :: Lens' PutBackupVaultNotifications Text Source #

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

putBackupVaultNotifications_backupVaultEvents :: Lens' PutBackupVaultNotifications [BackupVaultEvent] Source #

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

  • BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
  • COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
  • RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
  • S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

StartBackupJob

startBackupJob_backupOptions :: Lens' StartBackupJob (Maybe (HashMap Text Text)) Source #

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

startBackupJob_completeWindowMinutes :: Lens' StartBackupJob (Maybe Integer) Source #

A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

startBackupJob_idempotencyToken :: Lens' StartBackupJob (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

startBackupJob_lifecycle :: Lens' StartBackupJob (Maybe Lifecycle) Source #

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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.

startBackupJob_recoveryPointTags :: Lens' StartBackupJob (Maybe (HashMap Text Text)) Source #

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

startBackupJob_startWindowMinutes :: Lens' StartBackupJob (Maybe Integer) Source #

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

startBackupJob_backupVaultName :: Lens' StartBackupJob Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

startBackupJob_resourceArn :: Lens' StartBackupJob Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

startBackupJob_iamRoleArn :: Lens' StartBackupJob Text Source #

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

startBackupJobResponse_backupJobId :: Lens' StartBackupJobResponse (Maybe Text) Source #

Uniquely identifies a request to Backup to back up a resource.

startBackupJobResponse_creationDate :: Lens' StartBackupJobResponse (Maybe UTCTime) Source #

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

startBackupJobResponse_isParent :: Lens' StartBackupJobResponse (Maybe Bool) Source #

This is a returned boolean value indicating this is a parent (composite) backup job.

startBackupJobResponse_recoveryPointArn :: Lens' StartBackupJobResponse (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

StartCopyJob

startCopyJob_idempotencyToken :: Lens' StartCopyJob (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

startCopyJob_recoveryPointArn :: Lens' StartCopyJob Text Source #

An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

startCopyJob_sourceBackupVaultName :: Lens' StartCopyJob Text Source #

The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

startCopyJob_destinationBackupVaultArn :: Lens' StartCopyJob Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

startCopyJob_iamRoleArn :: Lens' StartCopyJob Text Source #

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

startCopyJobResponse_creationDate :: Lens' StartCopyJobResponse (Maybe UTCTime) Source #

The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

startCopyJobResponse_isParent :: Lens' StartCopyJobResponse (Maybe Bool) Source #

This is a returned boolean value indicating this is a parent (composite) copy job.

StartReportJob

startReportJob_idempotencyToken :: Lens' StartReportJob (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

startReportJob_reportPlanName :: Lens' StartReportJob Text Source #

The unique name of a report plan.

startReportJobResponse_reportJobId :: Lens' StartReportJobResponse (Maybe Text) Source #

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

StartRestoreJob

startRestoreJob_iamRoleArn :: Lens' StartRestoreJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

startRestoreJob_idempotencyToken :: Lens' StartRestoreJob (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

startRestoreJob_resourceType :: Lens' StartRestoreJob (Maybe Text) Source #

Starts a job to restore a recovery point for one of the following resources:

  • Aurora for Amazon Aurora
  • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • FSx for Amazon FSx
  • Neptune for Amazon Neptune
  • RDS for Amazon Relational Database Service
  • Storage Gateway for Storage Gateway
  • S3 for Amazon S3
  • VirtualMachine for virtual machines

startRestoreJob_recoveryPointArn :: Lens' StartRestoreJob Text Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

startRestoreJob_metadata :: Lens' StartRestoreJob (HashMap Text Text) Source #

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
  • KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
  • PerformanceMode: Specifies the throughput mode of the file system.
  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
  • ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".

startRestoreJobResponse_restoreJobId :: Lens' StartRestoreJobResponse (Maybe Text) Source #

Uniquely identifies the job that restores a recovery point.

StopBackupJob

stopBackupJob_backupJobId :: Lens' StopBackupJob Text Source #

Uniquely identifies a request to Backup to back up a resource.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{"Key":"string","Value":"string"}].

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

untagResource_tagKeyList :: Lens' UntagResource [Text] Source #

A list of keys to identify which key-value tags to remove from a resource.

UpdateBackupPlan

updateBackupPlan_backupPlanId :: Lens' UpdateBackupPlan Text Source #

Uniquely identifies a backup plan.

updateBackupPlan_backupPlan :: Lens' UpdateBackupPlan BackupPlanInput Source #

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

updateBackupPlanResponse_backupPlanArn :: Lens' UpdateBackupPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

updateBackupPlanResponse_creationDate :: Lens' UpdateBackupPlanResponse (Maybe UTCTime) Source #

The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

updateBackupPlanResponse_versionId :: Lens' UpdateBackupPlanResponse (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

UpdateFramework

updateFramework_frameworkControls :: Lens' UpdateFramework (Maybe [FrameworkControl]) Source #

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

updateFramework_frameworkDescription :: Lens' UpdateFramework (Maybe Text) Source #

An optional description of the framework with a maximum 1,024 characters.

updateFramework_idempotencyToken :: Lens' UpdateFramework (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

updateFramework_frameworkName :: Lens' UpdateFramework Text Source #

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

updateFrameworkResponse_creationTime :: Lens' UpdateFrameworkResponse (Maybe UTCTime) Source #

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

updateFrameworkResponse_frameworkArn :: Lens' UpdateFrameworkResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

updateFrameworkResponse_frameworkName :: Lens' UpdateFrameworkResponse (Maybe Text) Source #

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

UpdateGlobalSettings

updateGlobalSettings_globalSettings :: Lens' UpdateGlobalSettings (Maybe (HashMap Text Text)) Source #

A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2.

UpdateRecoveryPointLifecycle

updateRecoveryPointLifecycle_lifecycle :: Lens' UpdateRecoveryPointLifecycle (Maybe Lifecycle) Source #

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.

updateRecoveryPointLifecycle_backupVaultName :: Lens' UpdateRecoveryPointLifecycle Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

updateRecoveryPointLifecycle_recoveryPointArn :: Lens' UpdateRecoveryPointLifecycle Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

updateRecoveryPointLifecycleResponse_backupVaultArn :: Lens' UpdateRecoveryPointLifecycleResponse (Maybe Text) Source #

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

updateRecoveryPointLifecycleResponse_calculatedLifecycle :: Lens' UpdateRecoveryPointLifecycleResponse (Maybe CalculatedLifecycle) Source #

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

updateRecoveryPointLifecycleResponse_lifecycle :: Lens' UpdateRecoveryPointLifecycleResponse (Maybe Lifecycle) Source #

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.

updateRecoveryPointLifecycleResponse_recoveryPointArn :: Lens' UpdateRecoveryPointLifecycleResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

UpdateRegionSettings

updateRegionSettings_resourceTypeManagementPreference :: Lens' UpdateRegionSettings (Maybe (HashMap Text Bool)) Source #

Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with Backup's advanced DynamoDB backup features, follow the procedure to enable advanced DynamoDB backup programmatically.

updateRegionSettings_resourceTypeOptInPreference :: Lens' UpdateRegionSettings (Maybe (HashMap Text Bool)) Source #

Updates the list of services along with the opt-in preferences for the Region.

UpdateReportPlan

updateReportPlan_idempotencyToken :: Lens' UpdateReportPlan (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

updateReportPlan_reportDeliveryChannel :: Lens' UpdateReportPlan (Maybe ReportDeliveryChannel) Source #

A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

updateReportPlan_reportPlanDescription :: Lens' UpdateReportPlan (Maybe Text) Source #

An optional description of the report plan with a maximum 1,024 characters.

updateReportPlan_reportSetting :: Lens' UpdateReportPlan (Maybe ReportSetting) Source #

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

updateReportPlan_reportPlanName :: Lens' UpdateReportPlan Text Source #

The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

updateReportPlanResponse_creationTime :: Lens' UpdateReportPlanResponse (Maybe UTCTime) Source #

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

updateReportPlanResponse_reportPlanArn :: Lens' UpdateReportPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Types

AdvancedBackupSetting

advancedBackupSetting_backupOptions :: Lens' AdvancedBackupSetting (Maybe (HashMap Text Text)) Source #

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values:

Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

advancedBackupSetting_resourceType :: Lens' AdvancedBackupSetting (Maybe Text) Source #

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

Valid values: EC2.

BackupJob

backupJob_accountId :: Lens' BackupJob (Maybe Text) Source #

The account ID that owns the backup job.

backupJob_backupJobId :: Lens' BackupJob (Maybe Text) Source #

Uniquely identifies a request to Backup to back up a resource.

backupJob_backupOptions :: Lens' BackupJob (Maybe (HashMap Text Text)) Source #

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

backupJob_backupSizeInBytes :: Lens' BackupJob (Maybe Integer) Source #

The size, in bytes, of a backup.

backupJob_backupType :: Lens' BackupJob (Maybe Text) Source #

Represents the type of backup for a backup job.

backupJob_backupVaultArn :: Lens' BackupJob (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

backupJob_backupVaultName :: Lens' BackupJob (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

backupJob_bytesTransferred :: Lens' BackupJob (Maybe Integer) Source #

The size in bytes transferred to a backup vault at the time that the job status was queried.

backupJob_completionDate :: Lens' BackupJob (Maybe UTCTime) Source #

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupJob_createdBy :: Lens' BackupJob (Maybe RecoveryPointCreator) Source #

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

backupJob_creationDate :: Lens' BackupJob (Maybe UTCTime) Source #

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupJob_expectedCompletionDate :: Lens' BackupJob (Maybe UTCTime) Source #

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupJob_iamRoleArn :: Lens' BackupJob (Maybe Text) Source #

Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

backupJob_isParent :: Lens' BackupJob (Maybe Bool) Source #

This is a boolean value indicating this is a parent (composite) backup job.

backupJob_parentJobId :: Lens' BackupJob (Maybe Text) Source #

This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

backupJob_percentDone :: Lens' BackupJob (Maybe Text) Source #

Contains an estimated percentage complete of a job at the time the job status was queried.

backupJob_recoveryPointArn :: Lens' BackupJob (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

backupJob_resourceArn :: Lens' BackupJob (Maybe Text) Source #

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

backupJob_resourceType :: Lens' BackupJob (Maybe Text) Source #

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

backupJob_startBy :: Lens' BackupJob (Maybe UTCTime) Source #

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupJob_state :: Lens' BackupJob (Maybe BackupJobState) Source #

The current state of a resource recovery point.

backupJob_statusMessage :: Lens' BackupJob (Maybe Text) Source #

A detailed message explaining the status of the job to back up a resource.

BackupPlan

backupPlan_advancedBackupSettings :: Lens' BackupPlan (Maybe [AdvancedBackupSetting]) Source #

Contains a list of BackupOptions for each resource type.

backupPlan_backupPlanName :: Lens' BackupPlan Text Source #

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

backupPlan_rules :: Lens' BackupPlan [BackupRule] Source #

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

BackupPlanInput

backupPlanInput_advancedBackupSettings :: Lens' BackupPlanInput (Maybe [AdvancedBackupSetting]) Source #

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

backupPlanInput_backupPlanName :: Lens' BackupPlanInput Text Source #

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

backupPlanInput_rules :: Lens' BackupPlanInput [BackupRuleInput] Source #

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

BackupPlanTemplatesListMember

BackupPlansListMember

backupPlansListMember_backupPlanArn :: Lens' BackupPlansListMember (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

backupPlansListMember_creationDate :: Lens' BackupPlansListMember (Maybe UTCTime) Source #

The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupPlansListMember_creatorRequestId :: Lens' BackupPlansListMember (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

backupPlansListMember_deletionDate :: Lens' BackupPlansListMember (Maybe UTCTime) Source #

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupPlansListMember_lastExecutionDate :: Lens' BackupPlansListMember (Maybe UTCTime) Source #

The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupPlansListMember_versionId :: Lens' BackupPlansListMember (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

BackupRule

backupRule_completionWindowMinutes :: Lens' BackupRule (Maybe Integer) Source #

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

backupRule_copyActions :: Lens' BackupRule (Maybe [CopyAction]) Source #

An array of CopyAction objects, which contains the details of the copy operation.

backupRule_enableContinuousBackup :: Lens' BackupRule (Maybe Bool) Source #

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

backupRule_lifecycle :: Lens' BackupRule (Maybe Lifecycle) Source #

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.

backupRule_recoveryPointTags :: Lens' BackupRule (Maybe (HashMap Text Text)) Source #

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

backupRule_ruleId :: Lens' BackupRule (Maybe Text) Source #

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

backupRule_scheduleExpression :: Lens' BackupRule (Maybe Text) Source #

A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

backupRule_startWindowMinutes :: Lens' BackupRule (Maybe Integer) Source #

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

backupRule_ruleName :: Lens' BackupRule Text Source #

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

backupRule_targetBackupVaultName :: Lens' BackupRule Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

BackupRuleInput

backupRuleInput_completionWindowMinutes :: Lens' BackupRuleInput (Maybe Integer) Source #

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

backupRuleInput_copyActions :: Lens' BackupRuleInput (Maybe [CopyAction]) Source #

An array of CopyAction objects, which contains the details of the copy operation.

backupRuleInput_enableContinuousBackup :: Lens' BackupRuleInput (Maybe Bool) Source #

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

backupRuleInput_lifecycle :: Lens' BackupRuleInput (Maybe Lifecycle) Source #

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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.

backupRuleInput_recoveryPointTags :: Lens' BackupRuleInput (Maybe (HashMap Text Text)) Source #

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

backupRuleInput_scheduleExpression :: Lens' BackupRuleInput (Maybe Text) Source #

A CRON expression in UTC specifying when Backup initiates a backup job.

backupRuleInput_startWindowMinutes :: Lens' BackupRuleInput (Maybe Integer) Source #

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

backupRuleInput_ruleName :: Lens' BackupRuleInput Text Source #

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

backupRuleInput_targetBackupVaultName :: Lens' BackupRuleInput Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

BackupSelection

backupSelection_conditions :: Lens' BackupSelection (Maybe Conditions) Source #

A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

Conditions differs from ListOfTags as follows:

  • When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
  • Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.

backupSelection_listOfTags :: Lens' BackupSelection (Maybe [Condition]) Source #

A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

ListOfTags differs from Conditions as follows:

  • When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
  • ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.

backupSelection_notResources :: Lens' BackupSelection (Maybe [Text]) Source #

A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.

backupSelection_resources :: Lens' BackupSelection (Maybe [Text]) Source #

A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.

backupSelection_selectionName :: Lens' BackupSelection Text Source #

The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.

backupSelection_iamRoleArn :: Lens' BackupSelection Text Source #

The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

BackupSelectionsListMember

backupSelectionsListMember_creationDate :: Lens' BackupSelectionsListMember (Maybe UTCTime) Source #

The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupSelectionsListMember_creatorRequestId :: Lens' BackupSelectionsListMember (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

backupSelectionsListMember_iamRoleArn :: Lens' BackupSelectionsListMember (Maybe Text) Source #

Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

backupSelectionsListMember_selectionId :: Lens' BackupSelectionsListMember (Maybe Text) Source #

Uniquely identifies a request to assign a set of resources to a backup plan.

backupSelectionsListMember_selectionName :: Lens' BackupSelectionsListMember (Maybe Text) Source #

The display name of a resource selection document.

BackupVaultListMember

backupVaultListMember_backupVaultArn :: Lens' BackupVaultListMember (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

backupVaultListMember_backupVaultName :: Lens' BackupVaultListMember (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

backupVaultListMember_creationDate :: Lens' BackupVaultListMember (Maybe UTCTime) Source #

The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupVaultListMember_creatorRequestId :: Lens' BackupVaultListMember (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

backupVaultListMember_encryptionKeyArn :: Lens' BackupVaultListMember (Maybe Text) Source #

A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.

To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup

backupVaultListMember_lockDate :: Lens' BackupVaultListMember (Maybe UTCTime) Source #

The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backupVaultListMember_locked :: Lens' BackupVaultListMember (Maybe Bool) Source #

A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.

backupVaultListMember_maxRetentionDays :: Lens' BackupVaultListMember (Maybe Integer) Source #

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

backupVaultListMember_minRetentionDays :: Lens' BackupVaultListMember (Maybe Integer) Source #

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

backupVaultListMember_numberOfRecoveryPoints :: Lens' BackupVaultListMember (Maybe Integer) Source #

The number of recovery points that are stored in a backup vault.

CalculatedLifecycle

calculatedLifecycle_deleteAt :: Lens' CalculatedLifecycle (Maybe UTCTime) Source #

A timestamp that specifies when to delete a recovery point.

calculatedLifecycle_moveToColdStorageAt :: Lens' CalculatedLifecycle (Maybe UTCTime) Source #

A timestamp that specifies when to transition a recovery point to cold storage.

Condition

condition_conditionType :: Lens' Condition ConditionType Source #

An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports StringEquals. For more flexible assignment options, including StringLike and the ability to exclude resources from your backup plan, use Conditions (with an "s" on the end) for your BackupSelection .

condition_conditionKey :: Lens' Condition Text Source #

The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

condition_conditionValue :: Lens' Condition Text Source #

The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

ConditionParameter

conditionParameter_conditionKey :: Lens' ConditionParameter (Maybe Text) Source #

The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

conditionParameter_conditionValue :: Lens' ConditionParameter (Maybe Text) Source #

The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

Conditions

conditions_stringEquals :: Lens' Conditions (Maybe [ConditionParameter]) Source #

Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."

conditions_stringLike :: Lens' Conditions (Maybe [ConditionParameter]) Source #

Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the tag value "production".

conditions_stringNotEquals :: Lens' Conditions (Maybe [ConditionParameter]) Source #

Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."

conditions_stringNotLike :: Lens' Conditions (Maybe [ConditionParameter]) Source #

Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

ControlInputParameter

controlInputParameter_parameterName :: Lens' ControlInputParameter (Maybe Text) Source #

The name of a parameter, for example, BackupPlanFrequency.

controlInputParameter_parameterValue :: Lens' ControlInputParameter (Maybe Text) Source #

The value of parameter, for example, hourly.

ControlScope

controlScope_complianceResourceIds :: Lens' ControlScope (Maybe (NonEmpty Text)) Source #

The ID of the only Amazon Web Services resource that you want your control scope to contain.

controlScope_complianceResourceTypes :: Lens' ControlScope (Maybe [Text]) Source #

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

controlScope_tags :: Lens' ControlScope (Maybe (HashMap Text Text)) Source #

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].

CopyAction

copyAction_destinationBackupVaultArn :: Lens' CopyAction Text Source #

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

CopyJob

copyJob_accountId :: Lens' CopyJob (Maybe Text) Source #

The account ID that owns the copy job.

copyJob_backupSizeInBytes :: Lens' CopyJob (Maybe Integer) Source #

The size, in bytes, of a copy job.

copyJob_childJobsInState :: Lens' CopyJob (Maybe (HashMap CopyJobState Integer)) Source #

This returns the statistics of the included child (nested) copy jobs.

copyJob_completionDate :: Lens' CopyJob (Maybe UTCTime) Source #

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

copyJob_compositeMemberIdentifier :: Lens' CopyJob (Maybe Text) Source #

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

copyJob_copyJobId :: Lens' CopyJob (Maybe Text) Source #

Uniquely identifies a copy job.

copyJob_creationDate :: Lens' CopyJob (Maybe UTCTime) Source #

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

copyJob_destinationBackupVaultArn :: Lens' CopyJob (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

copyJob_destinationRecoveryPointArn :: Lens' CopyJob (Maybe Text) Source #

An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

copyJob_iamRoleArn :: Lens' CopyJob (Maybe Text) Source #

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

copyJob_isParent :: Lens' CopyJob (Maybe Bool) Source #

This is a boolean value indicating this is a parent (composite) copy job.

copyJob_numberOfChildJobs :: Lens' CopyJob (Maybe Integer) Source #

This is the number of child (nested) copy jobs.

copyJob_parentJobId :: Lens' CopyJob (Maybe Text) Source #

This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

copyJob_resourceArn :: Lens' CopyJob (Maybe Text) Source #

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

copyJob_resourceType :: Lens' CopyJob (Maybe Text) Source #

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

copyJob_sourceBackupVaultArn :: Lens' CopyJob (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

copyJob_sourceRecoveryPointArn :: Lens' CopyJob (Maybe Text) Source #

An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

copyJob_state :: Lens' CopyJob (Maybe CopyJobState) Source #

The current state of a copy job.

copyJob_statusMessage :: Lens' CopyJob (Maybe Text) Source #

A detailed message explaining the status of the job to copy a resource.

DateRange

dateRange_fromDate :: Lens' DateRange UTCTime Source #

This value is the beginning date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

dateRange_toDate :: Lens' DateRange UTCTime Source #

This value is the end date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

Framework

framework_creationTime :: Lens' Framework (Maybe UTCTime) Source #

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

framework_deploymentStatus :: Lens' Framework (Maybe Text) Source #

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

framework_frameworkArn :: Lens' Framework (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

framework_frameworkDescription :: Lens' Framework (Maybe Text) Source #

An optional description of the framework with a maximum 1,024 characters.

framework_frameworkName :: Lens' Framework (Maybe Text) Source #

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

framework_numberOfControls :: Lens' Framework (Maybe Int) Source #

The number of controls contained by the framework.

FrameworkControl

frameworkControl_controlInputParameters :: Lens' FrameworkControl (Maybe [ControlInputParameter]) Source #

A list of ParameterName and ParameterValue pairs.

frameworkControl_controlScope :: Lens' FrameworkControl (Maybe ControlScope) Source #

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more information, see ControlScope.

frameworkControl_controlName :: Lens' FrameworkControl Text Source #

The name of a control. This name is between 1 and 256 characters.

LegalHold

legalHold_cancellationDate :: Lens' LegalHold (Maybe UTCTime) Source #

This is the time in number format when legal hold was cancelled.

legalHold_creationDate :: Lens' LegalHold (Maybe UTCTime) Source #

This is the time in number format when legal hold was created.

legalHold_description :: Lens' LegalHold (Maybe Text) Source #

This is the description of a legal hold.

legalHold_legalHoldArn :: Lens' LegalHold (Maybe Text) Source #

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

legalHold_legalHoldId :: Lens' LegalHold (Maybe Text) Source #

ID of specific legal hold on one or more recovery points.

legalHold_status :: Lens' LegalHold (Maybe LegalHoldStatus) Source #

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

legalHold_title :: Lens' LegalHold (Maybe Text) Source #

This is the title of a legal hold.

Lifecycle

lifecycle_deleteAfterDays :: Lens' Lifecycle (Maybe Integer) Source #

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

lifecycle_moveToColdStorageAfterDays :: Lens' Lifecycle (Maybe Integer) Source #

Specifies the number of days after creation that a recovery point is moved to cold storage.

ProtectedResource

protectedResource_lastBackupTime :: Lens' ProtectedResource (Maybe UTCTime) Source #

The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

protectedResource_resourceArn :: Lens' ProtectedResource (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

protectedResource_resourceType :: Lens' ProtectedResource (Maybe Text) Source #

The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

RecoveryPointByBackupVault

recoveryPointByBackupVault_backupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

recoveryPointByBackupVault_backupVaultName :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

recoveryPointByBackupVault_calculatedLifecycle :: Lens' RecoveryPointByBackupVault (Maybe CalculatedLifecycle) Source #

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

recoveryPointByBackupVault_completionDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #

The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

recoveryPointByBackupVault_compositeMemberIdentifier :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

recoveryPointByBackupVault_createdBy :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointCreator) Source #

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

recoveryPointByBackupVault_creationDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #

The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

recoveryPointByBackupVault_encryptionKeyArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

recoveryPointByBackupVault_iamRoleArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

recoveryPointByBackupVault_isEncrypted :: Lens' RecoveryPointByBackupVault (Maybe Bool) Source #

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

recoveryPointByBackupVault_isParent :: Lens' RecoveryPointByBackupVault (Maybe Bool) Source #

This is a boolean value indicating this is a parent (composite) recovery point.

recoveryPointByBackupVault_lastRestoreTime :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #

The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

recoveryPointByBackupVault_lifecycle :: Lens' RecoveryPointByBackupVault (Maybe Lifecycle) Source #

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.

recoveryPointByBackupVault_parentRecoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

recoveryPointByBackupVault_recoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

recoveryPointByBackupVault_resourceArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

recoveryPointByBackupVault_resourceType :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

recoveryPointByBackupVault_sourceBackupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

recoveryPointByBackupVault_status :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointStatus) Source #

A status code specifying the state of the recovery point.

recoveryPointByBackupVault_statusMessage :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #

A message explaining the reason of the recovery point deletion failure.

RecoveryPointByResource

recoveryPointByResource_backupVaultName :: Lens' RecoveryPointByResource (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

recoveryPointByResource_creationDate :: Lens' RecoveryPointByResource (Maybe UTCTime) Source #

The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

recoveryPointByResource_encryptionKeyArn :: Lens' RecoveryPointByResource (Maybe Text) Source #

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

recoveryPointByResource_isParent :: Lens' RecoveryPointByResource (Maybe Bool) Source #

This is a boolean value indicating this is a parent (composite) recovery point.

recoveryPointByResource_parentRecoveryPointArn :: Lens' RecoveryPointByResource (Maybe Text) Source #

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

recoveryPointByResource_recoveryPointArn :: Lens' RecoveryPointByResource (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

recoveryPointByResource_status :: Lens' RecoveryPointByResource (Maybe RecoveryPointStatus) Source #

A status code specifying the state of the recovery point.

recoveryPointByResource_statusMessage :: Lens' RecoveryPointByResource (Maybe Text) Source #

A message explaining the reason of the recovery point deletion failure.

RecoveryPointCreator

recoveryPointCreator_backupPlanArn :: Lens' RecoveryPointCreator (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

recoveryPointCreator_backupPlanVersion :: Lens' RecoveryPointCreator (Maybe Text) Source #

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

recoveryPointCreator_backupRuleId :: Lens' RecoveryPointCreator (Maybe Text) Source #

Uniquely identifies a rule used to schedule the backup of a selection of resources.

RecoveryPointMember

recoveryPointMember_recoveryPointArn :: Lens' RecoveryPointMember (Maybe Text) Source #

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

RecoveryPointSelection

recoveryPointSelection_resourceIdentifiers :: Lens' RecoveryPointSelection (Maybe [Text]) Source #

These are the resources included in the resource selection (including type of resources and vaults).

recoveryPointSelection_vaultNames :: Lens' RecoveryPointSelection (Maybe [Text]) Source #

These are the names of the vaults in which the selected recovery points are contained.

ReportDeliveryChannel

reportDeliveryChannel_formats :: Lens' ReportDeliveryChannel (Maybe [Text]) Source #

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

reportDeliveryChannel_s3KeyPrefix :: Lens' ReportDeliveryChannel (Maybe Text) Source #

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

reportDeliveryChannel_s3BucketName :: Lens' ReportDeliveryChannel Text Source #

The unique name of the S3 bucket that receives your reports.

ReportDestination

reportDestination_s3BucketName :: Lens' ReportDestination (Maybe Text) Source #

The unique name of the Amazon S3 bucket that receives your reports.

reportDestination_s3Keys :: Lens' ReportDestination (Maybe [Text]) Source #

The object key that uniquely identifies your reports in your S3 bucket.

ReportJob

reportJob_completionTime :: Lens' ReportJob (Maybe UTCTime) Source #

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

reportJob_creationTime :: Lens' ReportJob (Maybe UTCTime) Source #

The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

reportJob_reportDestination :: Lens' ReportJob (Maybe ReportDestination) Source #

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

reportJob_reportJobId :: Lens' ReportJob (Maybe Text) Source #

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

reportJob_reportPlanArn :: Lens' ReportJob (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

reportJob_reportTemplate :: Lens' ReportJob (Maybe Text) Source #

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

reportJob_status :: Lens' ReportJob (Maybe Text) Source #

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

reportJob_statusMessage :: Lens' ReportJob (Maybe Text) Source #

A message explaining the status of the report job.

ReportPlan

reportPlan_creationTime :: Lens' ReportPlan (Maybe UTCTime) Source #

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

reportPlan_deploymentStatus :: Lens' ReportPlan (Maybe Text) Source #

The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

reportPlan_lastAttemptedExecutionTime :: Lens' ReportPlan (Maybe UTCTime) Source #

The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

reportPlan_lastSuccessfulExecutionTime :: Lens' ReportPlan (Maybe UTCTime) Source #

The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

reportPlan_reportDeliveryChannel :: Lens' ReportPlan (Maybe ReportDeliveryChannel) Source #

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

reportPlan_reportPlanArn :: Lens' ReportPlan (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

reportPlan_reportPlanDescription :: Lens' ReportPlan (Maybe Text) Source #

An optional description of the report plan with a maximum 1,024 characters.

reportPlan_reportPlanName :: Lens' ReportPlan (Maybe Text) Source #

The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

reportPlan_reportSetting :: Lens' ReportPlan (Maybe ReportSetting) Source #

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

ReportSetting

reportSetting_accounts :: Lens' ReportSetting (Maybe [Text]) Source #

These are the accounts to be included in the report.

reportSetting_frameworkArns :: Lens' ReportSetting (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) of the frameworks a report covers.

reportSetting_numberOfFrameworks :: Lens' ReportSetting (Maybe Int) Source #

The number of frameworks a report covers.

reportSetting_organizationUnits :: Lens' ReportSetting (Maybe [Text]) Source #

These are the Organizational Units to be included in the report.

reportSetting_regions :: Lens' ReportSetting (Maybe [Text]) Source #

These are the Regions to be included in the report.

reportSetting_reportTemplate :: Lens' ReportSetting Text Source #

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

RestoreJobsListMember

restoreJobsListMember_accountId :: Lens' RestoreJobsListMember (Maybe Text) Source #

The account ID that owns the restore job.

restoreJobsListMember_backupSizeInBytes :: Lens' RestoreJobsListMember (Maybe Integer) Source #

The size, in bytes, of the restored resource.

restoreJobsListMember_completionDate :: Lens' RestoreJobsListMember (Maybe UTCTime) Source #

The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

restoreJobsListMember_createdResourceArn :: Lens' RestoreJobsListMember (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

restoreJobsListMember_creationDate :: Lens' RestoreJobsListMember (Maybe UTCTime) Source #

The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

restoreJobsListMember_expectedCompletionTimeMinutes :: Lens' RestoreJobsListMember (Maybe Integer) Source #

The amount of time in minutes that a job restoring a recovery point is expected to take.

restoreJobsListMember_iamRoleArn :: Lens' RestoreJobsListMember (Maybe Text) Source #

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

restoreJobsListMember_percentDone :: Lens' RestoreJobsListMember (Maybe Text) Source #

Contains an estimated percentage complete of a job at the time the job status was queried.

restoreJobsListMember_recoveryPointArn :: Lens' RestoreJobsListMember (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

restoreJobsListMember_resourceType :: Lens' RestoreJobsListMember (Maybe Text) Source #

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

restoreJobsListMember_restoreJobId :: Lens' RestoreJobsListMember (Maybe Text) Source #

Uniquely identifies the job that restores a recovery point.

restoreJobsListMember_status :: Lens' RestoreJobsListMember (Maybe RestoreJobStatus) Source #

A status code specifying the state of the job initiated by Backup to restore a recovery point.

restoreJobsListMember_statusMessage :: Lens' RestoreJobsListMember (Maybe Text) Source #

A detailed message explaining the status of the job to restore a recovery point.