BackupJob

バックアップジョブに関する詳細情報が含まれています。

内容

AccountId

バックアップジョブを所有する アカウント ID です。

タイプ: 文字列

パターン: ^[0-9]{12}$

必須: いいえ

BackupJobId

リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。

タイプ: 文字列

必須: いいえ

BackupOptions

選択したリソースのバックアップオプションを指定します。このオプションは、Windows ボリュームシャドウコピーサービス (VSS) バックアップジョブでのみ使用できます。

有効な値:"WindowsVSS":"enabled" に設定してWindowsVSS バックアップオプションをを有効にし、Windows VSS バックアップを作成します。"WindowsVSS":"disabled" に設定すると、定期的にバックアップを作成します。無効なオプションを指定すると、InvalidParameterValueException の例外が発生します。

型: 文字列から文字列へのマッピング

キーパターン: ^[a-zA-Z0-9\-\_\.]{1,50}$

値パターン:^[a-zA-Z0-9\-\_\.]{1,50}$

必須: いいえ

BackupSizeInBytes

バックアップ (復旧ポイント) のサイズをバイト単位で指定します。

この値は、他の AWS サービスからデータ情報を AWS Backup プルするときに、リソースタイプに応じてレンダリングが異なる場合があります。たとえば、返される値は の値を示す場合があり0、これは予想される値とは異なる場合があります。

リソースタイプ別の値の予想される動作を以下に示します。

• Amazon Aurora、Amazon DocumentDB、および Amazon Neptune では、この値はオペレーション から入力されませんGetBackupJobStatus。

• 高度な機能を備えた Amazon DynamoDB の場合、この値は復旧ポイント (バックアップ) のサイズを参照します。

• Amazon EC2 と Amazon EBS は、この値の一部として返されるボリュームサイズ (プロビジョンドストレージ) を表示します。Amazon EBS はバックアップサイズ情報を返しません。スナップショットサイズは、バックアップされた元のリソースと同じ値になります。

• Amazon EFS の場合、この値はバックアップ中に転送されたデルタバイト数を参照します。

• Amazon FSx は、GetBackupJobStatusFSx ファイルシステムの オペレーションからこの値を入力しません。

• Amazon RDS インスタンスは として表示されます0。

• VMware を実行している仮想マシンの場合、この値は非同期ワークフローを介して に渡 AWS Backup されます。これは、この表示される値が実際のバックアップサイズを過小表す可能性があることを意味します。

型: Long

必須: いいえ

BackupType

バックアップジョブのバックアップのタイプを表します。

タイプ: 文字列

必須: いいえ

BackupVaultArn

arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVaultなどのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。

タイプ: 文字列

必須: いいえ

BackupVaultName

バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。

タイプ: 文字列

パターン: ^[a-zA-Z0-9\-\_]{2,50}$

必須: いいえ

BytesTransferred

ジョブステータスの照会時にバックアップボールトに転送されたバイト単位のサイズ。

型: Long

必須: いいえ

CompletionDate

バックアップジョブを作成するジョブが完了した日時 をUnix 形式および協定世界時 (UTC)で表示します。CompletionDate の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

必須: いいえ

CreatedBy

バックアップジョブの作成に使用されたバックアッププランの BackupPlanArn,BackupPlanId,BackupPlanVersion, およびBackupRuleId 含む、バックアップジョブの作成に関する識別情報がまれています。

型: RecoveryPointCreator オブジェクト

必須: いいえ

CreationDate

バックアップジョブが作成された日時をUnix形式および協定世界時（UTC）で表示します。CreationDate の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

必須: いいえ

EncryptionKeyArn

バックアップの暗号化に使用される KMS キーの Amazon リソースネーム (ARN)。これは、ボールト設定に応じて、カスタマーマネージドキーでも AWS マネージドキーでもかまいません。

タイプ: 文字列

必須: いいえ

ExpectedCompletionDate

リソースのバックアップを行うジョブが完了する予定の日時を、Unix形式および協定世界時（UTC）で表示します。ExpectedCompletionDate の値は,ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

必須: いいえ

IamRoleArn

対象となるリカバリーポイントの作成に使用する IAM ロール ARN を指定します。デフォルトロール以外の IAM ロールには、ロール名に AWSBackup または AwsBackup のいずれかを含める必要があります。例えば、arn:aws:iam::123456789012:role/AWSBackupRDSAccess。これらの文字列のないロール名には、バックアップジョブを実行する権限がありません。

タイプ: 文字列

必須: いいえ

InitiationDate

バックアップジョブが開始された日付。

型: タイムスタンプ

必須: いいえ

IsEncrypted

バックアップが暗号化されているかどうかを示すブール値。のすべてのバックアップ AWS Backup は暗号化されますが、このフィールドは透明性のために暗号化ステータスを示します。

型: ブール値

必須: いいえ

IsParent

これは、これが親 (複合) バックアップジョブであることを示すブール値です。

型: ブール値

必須: いいえ

MessageCategory

このパラメータは、指定されたメッセージカテゴリのジョブ数です。

文字列の例としては AccessDenied、SUCCESS、AGGREGATE_ALL、および INVALIDPARAMETERS があります。MessageCategory 文字列のリストについては、「モニタリング」を参照してください。

値 ANY は、すべてのメッセージカテゴリの数を返します。

AGGREGATE_ALL は、すべてのメッセージカテゴリのジョブ数を集計し、その合計を返します。

タイプ: 文字列

必須: いいえ

ParentJobId

これは、リソースをバックアップするための AWS Backup へのリクエストを一意に識別します。戻り値は親 (複合) ジョブ ID になります。

タイプ: 文字列

必須: いいえ

PercentDone

ジョブのステータスが照会された時点でのジョブの完了見込み率が含まれます。

タイプ: 文字列

必須: いいえ

RecoveryPointArn

リカバリーポイントを一意に識別する ARN、たとえば、arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 です。

タイプ: 文字列

必須: いいえ

RecoveryPointLifecycle

復旧ポイントがコールドストレージに移行するまでの期間、または削除されるまでの期間を日数で指定します。

コールドストレージに移行されたバックアップは、そこに最低 90 日保存される必要があります。したがって、コンソール上での保持期間の設定は、コールドへの移行 (日数) 設定から 90 日長くする必要があります。バックアップがコールドに移行された後で、コールドへの移行 (日数) の設定を変更することはできません。

コールドストレージに移行できるリソースタイプは、「Feature availability by resource table. AWS Backup ignores this expression for other resource types」に記載されています。

既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、MoveToColdStorageAfterDays と DeleteAfterDays に -1 を指定します。

型: Lifecycle オブジェクト

必須: いいえ

ResourceArn

リソースを一意に識別するためのARN。ARN の形式は、リソースタイプによって異なります。

タイプ: 文字列

必須: いいえ

ResourceName

指定されたバックアップに属するリソースの一意ではない名前。

タイプ: 文字列

必須: いいえ

ResourceType

バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。Windows Volume Shadow Copy Service (VSS) バックアップでは、サポートされているリソースタイプは Amazon EC2 のみです。

タイプ: 文字列

パターン: ^[a-zA-Z0-9\-\_\.]{1,50}$

必須: いいえ

StartBy

バックアップジョブがキャンセルされる前に開始しなければならない時刻を Unix 形式および協定世界時 (UTC)) で指定します。この値は、スケジュールされた時刻に開始ウィンドウを追加して計算されます。そのため、予定時刻が午後6時でスタートウィンドウが2時間であれば、StartBy時刻は指定された日付の午後 8:00 になります。StartByの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

必須: いいえ

State

バックアップジョブの現在の状態です。

型: 文字列

有効な値：CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

必須：いいえ

StatusMessage

リソースをバックアップするジョブのステータスを説明する詳細なメッセージ。　

タイプ: 文字列

必須: いいえ

VaultLockState

バックアップボールトのロック状態。論理エアギャップボールトの場合、これはボールトがコンプライアンスモードでロックされているかどうかを示します。有効な値は、LOCKED および UNLOCKED です。

タイプ: 文字列

必須: いいえ

VaultType

復旧ポイントが保存されているバックアップボールトのタイプ。有効な値はBACKUP_VAULT、標準バックアップボールトの場合と論理エアギャップボールトLOGICALLY_AIR_GAPPED_BACKUP_VAULTの場合です。

タイプ: 文字列

必須: いいえ

以下の資料も参照してください。

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3