

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# BackupJob
<a name="API_BackupJob"></a>

包含備份作業的相關詳細資訊。

## 目錄
<a name="API_BackupJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-BackupJob-AccountId"></a>
擁有備份作業的帳戶 ID。  
類型：字串  
模式：`^[0-9]{12}$`  
必要：否

 ** BackupJobId **   <a name="Backup-Type-BackupJob-BackupJobId"></a>
唯一識別 AWS Backup 對 備份資源的請求。  
類型：字串  
必要：否

 ** BackupOptions **   <a name="Backup-Type-BackupJob-BackupOptions"></a>
可指定所選資源的備份選項。此選項僅適用於 Windows 磁碟區陰影複製服務 (VSS) 備份作業。  
有效值：設定為 `"WindowsVSS":"enabled"` 即可啟用 `WindowsVSS` 備份選項，並建立 Windows VSS 備份。設定為 `"WindowsVSS":"disabled"` 即可建立一般備份。如果您指定了無效的選項，則會出現 `InvalidParameterValueException` 的例外狀況。  
類型：字串到字串映射  
金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
值模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必要：否

 ** BackupSizeInBytes **   <a name="Backup-Type-BackupJob-BackupSizeInBytes"></a>
備份的大小，以位元組為單位 （復原點）。  
根據資源類型，此值的轉譯方式可能不同，因為 會從其他 AWS 服務 AWS Backup 提取資料資訊。例如，傳回的值可能會顯示 的值`0`，這可能與預期的值不同。  
依資源類型列出的值預期行為如下所述：  
+ Amazon Aurora、Amazon DocumentDB 和 Amazon Neptune 不會從操作 填入此值`GetBackupJobStatus`。
+ 對於具有進階功能的 Amazon DynamoDB，此值是指復原點 （備份） 的大小。
+ Amazon EC2 和 Amazon EBS 會顯示在此值中傳回的磁碟區大小 （佈建儲存）。Amazon EBS 不會傳回備份大小資訊；快照大小的值將與已備份的原始資源相同。
+ 對於 Amazon EFS，此值是指備份期間傳輸的差異位元組。
+ 對於 Amazon EKS，此值是指巢狀 EKS 復原點的大小。
+ Amazon FSx 不會從 FSx 檔案系統的 `GetBackupJobStatus` 操作填入此值。
+ Amazon RDS 執行個體會顯示為 `0`。
+ 對於執行 VMware 的虛擬機器，此值會透過非同步工作流程傳遞至 AWS Backup ，這表示此顯示值可能表示實際備份大小不足。
類型：Long  
必要：否

 ** BackupType **   <a name="Backup-Type-BackupJob-BackupType"></a>
代表備份作業的備份類型。  
類型：字串  
必要：否

 ** BackupVaultArn **   <a name="Backup-Type-BackupJob-BackupVaultArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串  
必要：否

 ** BackupVaultName **   <a name="Backup-Type-BackupJob-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：否

 ** BytesTransferred **   <a name="Backup-Type-BackupJob-BytesTransferred"></a>
查詢作業狀態時傳輸至備份保存庫的大小 (以位元組為單位)。  
類型：Long  
必要：否

 ** CompletionDate **   <a name="Backup-Type-BackupJob-CompletionDate"></a>
建立備份作業的完成日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp  
必要：否

 ** CreatedBy **   <a name="Backup-Type-BackupJob-CreatedBy"></a>
含有建立備份作業的相關識別資訊，包括用於建立備份作業的備份計劃 `BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion` 和 `BackupRuleId`。  
類型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 物件  
必要：否

 ** CreationDate **   <a name="Backup-Type-BackupJob-CreationDate"></a>
建立備份作業的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp  
必要：否

 ** EncryptionKeyArn **   <a name="Backup-Type-BackupJob-EncryptionKeyArn"></a>
用來加密備份之 KMS 金鑰的 Amazon Resource Name (ARN)。這可以是客戶受管金鑰或 AWS 受管金鑰，取決於保存庫組態。  
類型：字串  
必要：否

 ** ExpectedCompletionDate **   <a name="Backup-Type-BackupJob-ExpectedCompletionDate"></a>
預期以 Unix 格式和國際標準時間 (UTC) 完成資源備份的日期和時間。`ExpectedCompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp  
必要：否

 ** IamRoleArn **   <a name="Backup-Type-BackupJob-IamRoleArn"></a>
指定用於建立目標復原點的 IAM 角色 ARN。預設角色以外的 IAM 角色，必須在角色名稱中包含 `AWSBackup` 或 `AwsBackup`。例如 `arn:aws:iam::123456789012:role/AWSBackupRDSAccess`。沒有這些字串的角色名稱，會缺乏執行備份作業的許可。  
類型：字串  
必要：否

 ** InitiationDate **   <a name="Backup-Type-BackupJob-InitiationDate"></a>
備份任務啟動的日期。  
類型：Timestamp  
必要：否

 ** IsEncrypted **   <a name="Backup-Type-BackupJob-IsEncrypted"></a>
指出備份是否已加密的布林值。中的所有備份 AWS Backup 都會加密，但此欄位會指出加密狀態以確保透明度。  
類型：布林值  
必要：否

 ** IsParent **   <a name="Backup-Type-BackupJob-IsParent"></a>
此為布林值，表示這是父系 (複合) 備份作業。  
類型：布林值  
必要：否

 ** MessageCategory **   <a name="Backup-Type-BackupJob-MessageCategory"></a>
此參數是指定訊息類別的任務計數。  
範例字串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `INVALIDPARAMETERS`。請參閱[監控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)以取得 MessageCategory 字串清單。  
該值 ANY 會傳回所有訊息類別的計數。  
 `AGGREGATE_ALL` 彙總所有訊息類別的任務計數，並傳回總和。  
類型：字串  
必要：否

 ** ParentJobId **   <a name="Backup-Type-BackupJob-ParentJobId"></a>
這可唯一識別要 AWS Backup 備份資源的請求。傳回的值將是父系 (複合) 作業 ID。  
類型：字串  
必要：否

 ** PercentDone **   <a name="Backup-Type-BackupJob-PercentDone"></a>
包含查詢作業狀態時，作業的預估完成百分比。  
類型：字串  
必要：否

 ** RecoveryPointArn **   <a name="Backup-Type-BackupJob-RecoveryPointArn"></a>
可唯一識別復原點的 ARN；例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
類型：字串  
必要：否

 ** RecoveryPointLifecycle **   <a name="Backup-Type-BackupJob-RecoveryPointLifecycle"></a>
指定復原點轉換為冷儲存或刪除之前的期間，以天為單位。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，在 主控台上，保留設定必須比轉換至冷的超過 90 天。備份轉換為冷後，就無法變更轉換為冷。  
可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。  
若要移除現有的生命週期和保留期並無限期保留復原點，請為 `MoveToColdStorageAfterDays`和 指定 -1`DeleteAfterDays`。  
類型：[Lifecycle](API_Lifecycle.md) 物件  
必要：否

 ** ResourceArn **   <a name="Backup-Type-BackupJob-ResourceArn"></a>
可唯一識別資源的 ARN。ARN 的格式取決於資源類型。  
類型：字串  
必要：否

 ** ResourceName **   <a name="Backup-Type-BackupJob-ResourceName"></a>
屬於指定備份之資源的非唯一名稱。  
類型：字串  
必要：否

 ** ResourceType **   <a name="Backup-Type-BackupJob-ResourceType"></a>
要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。對於 Windows 磁碟區陰影複製服務 (VSS) 備份，唯一支援的資源類型為 Amazon EC2。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必要：否

 ** StartBy **   <a name="Backup-Type-BackupJob-StartBy"></a>
指定在備份作業取消之前必須開始的時間，以 Unix 格式和國際標準時間 (UTC) 顯示。該值是透過將開始時段加至排定時間來計算。因此，如果排定的時間為下午 6 點，而開始時段為 2 小時，則 `StartBy` 時間將是指定日期的下午 8 點。`StartBy` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp  
必要：否

 ** State **   <a name="Backup-Type-BackupJob-State"></a>
備份作業的目前狀態。  
類型：字串  
有效值:`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`   
必要：否

 ** StatusMessage **   <a name="Backup-Type-BackupJob-StatusMessage"></a>
說明備份資源之作業狀態的詳細訊息。  
類型：字串  
必要：否

 ** VaultLockState **   <a name="Backup-Type-BackupJob-VaultLockState"></a>
備份保存庫的鎖定狀態。對於邏輯氣隙隔離保存庫，這表示保存庫是否在合規模式下鎖定。有效值包括 `LOCKED` 與 `UNLOCKED`。  
類型：字串  
必要：否

 ** VaultType **   <a name="Backup-Type-BackupJob-VaultType"></a>
存放復原點的備份保存庫類型。有效值`BACKUP_VAULT`適用於標準備份保存庫，`LOGICALLY_AIR_GAPPED_BACKUP_VAULT`而適用於邏輯氣隙隔離保存庫。  
類型：字串  
必要：否

## 另請參閱
<a name="API_BackupJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupJob) 