DescribeBackupJob

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

必須: はい

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

タイプ: 文字列

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

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

タイプ: 文字列

バックアッププランまたはオンデマンドバックアップジョブの一部として指定されたオプションを表します。

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

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

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

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

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

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

型: 長整数

バックアップジョブに対して選択された実際のバックアップタイプを表します。たとえば、Windows ボリュームシャドウコピーサービス (VSS) バックアップが正常に実行された場合、BackupType は "WindowsVSS" を返します。BackupTypeが空の場合、バックアップタイプは通常のバックアップでした。

タイプ: 文字列

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

タイプ: 文字列

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

タイプ: 文字列

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

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

型: 長整数

これにより、含まれている子 (ネストされた) バックアップジョブの統計が返されます。

タイプ: 文字列を long にマッピング

有効なキー: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

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

タイプ: タイムスタンプ

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

型: RecoveryPointCreator オブジェクト

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

タイプ: タイムスタンプ

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

タイプ: 文字列

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

タイプ: タイムスタンプ

たとえば、arn:aws:iam::123456789012:role/S3Accessなどのターゲットリカバリポイントの作成に使用する IAM ロール ARN を指定します。

タイプ: 文字列

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

タイプ: タイムスタンプ

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

型: ブール値

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

型: ブール値

指定されたメッセージカテゴリのジョブ数。

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

タイプ: 文字列

これにより、子 (ネストされた) バックアップジョブの数が返されます。

型: 長整数

これにより、親 (複合) リソースのバックアップジョブ ID が返されます。

タイプ: 文字列

ジョブのステータスが照会された時点でジョブが完了した推定パーセンテージが含まれます。

タイプ: 文字列

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

タイプ: 文字列

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

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

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

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

型: Lifecycle オブジェクト

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

タイプ: 文字列

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

タイプ: 文字列

バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。

タイプ: 文字列

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

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

タイプ: タイムスタンプ

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

型: 文字列

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

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

タイプ: 文字列

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

タイプ: 文字列

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

タイプ: 文字列

依存 AWS サービスまたはリソースが AWS Backup サービスにエラーを返したため、アクションを完了できません。

HTTP ステータスコード: 500

パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。

HTTP ステータスコード: 400

必須パラメータがないことを示します。

HTTP ステータスコード: 400

アクションに必要なリソースは存在しません。

HTTP ステータスコード: 400

サーバーの一時的障害のため、リクエストは失敗しました。

HTTP ステータスコード: 500