リクエストの構文 URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

StartBackupJob

指定したリソースに対してオンデマンドバックアップジョブを開始します。

リクエストの構文


PUT /backup-jobs HTTP/1.1
Content-type: application/json

{
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupVaultName": "string",
   "CompleteWindowMinutes": number,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Index": "string",
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointTags": { 
      "string" : "string" 
   },
   "ResourceArn": "string",
   "StartWindowMinutes": number
}

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

BackupOptions

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

有効な値:"WindowsVSS":"enabled" に設定してWindowsVSS バックアップオプションをを有効にし、Windows VSS バックアップを作成します。"WindowsVSS""disabled" に設定して、通常のバックアップを作成します。デフォルトでは、WindowsVSS のオプションは有効になっていません。

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

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

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

必須: いいえ

BackupVaultName

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

タイプ: 文字列

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

必須: はい

CompleteWindowMinutes

正常に開始されたバックアップを完了する必要がある時間（分単位）、または AWS Backup がジョブをキャンセルします。この値はオプションです。この値は、バックアップがスケジュールされた時点からカウントダウンを開始します。StartWindowMinutes またはバックアップがスケジュールより遅れて開始された場合、追加時間は追加されません。

StartWindowMinutes と同様に、このパラメータの最大値は 100 年 (52,560,000 分) です。

型: Long

必須: いいえ

IamRoleArn

ターゲット復旧ポイントの作成に使用する IAM ロール ARN を指定します。例えば、arn:aws:iam::123456789012:role/S3Accessです。

タイプ: 文字列

必須: はい

IdempotencyToken

別の StartBackupJob への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。

タイプ: 文字列

必須: いいえ

Index

バックアップジョブにバックアップインデックスをサポートするリソースタイプがある場合は、このパラメータを含めてインデックスの作成を有効にします。

バックアップインデックスをサポートするリソースタイプは次のとおりです。

Amazon Elastic Block Store 用の EBS
Amazon Simple Storage Service (Amazon S3) 用の S3

インデックスには、 ENABLEDまたはの 2 つの値のいずれかを指定できますDISABLED。

バックアップインデックスがまだない対象ACTIVE復旧ポイントのバックアップインデックスを作成するには、値をに設定しますENABLED。

バックアップインデックスを削除するには、値をに設定しますDISABLED。

タイプ: 文字列

有効な値: ENABLED | DISABLED

必須: いいえ

Lifecycle

ライフサイクルは、保護されたリソースがいつコールドストレージに移行され、いつ期限切れになるかを定義します。 AWS Backup は、定義したライフサイクルに従ってバックアップを自動的に移行して期限切れにします。

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

コールドストレージに移行できるリソースタイプは、「リソース別の機能の可用性」表に記載されています。他のリソースタイプでは、この式は AWS Backup 無視されます。

このパラメータの最大値は 100 年 (36,500 日) です。

型: Lifecycle オブジェクト

必須: いいえ

RecoveryPointTags

リソースに割り当てるタグ。

型: 文字列から文字列へのマップ

必須: いいえ

ResourceArn

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

タイプ: 文字列

必須: はい

StartWindowMinutes

バックアップがスケジュールされてから、正常に開始されない場合にジョブがキャンセルされるまでの時間の分単位での値。この値はオプションであり、デフォルト値は 8時間です。この値を含める場合、エラーを避けるために少なくとも 60 分必要です。

このパラメータの最大値は 100 年 (52,560,000 分) です。

開始ウィンドウ中、バックアップジョブのステータスは、正常に開始されるか、開始ウィンドウの時間がなくなるまで CREATED ステータスのままになります。開始ウィンドウ時間内にジョブの再試行を許可するエラー AWS Backup を受け取った場合、 AWS Backup は、バックアップが正常に開始されるまで (ジョブステータスがに変わるまでRUNNING）、またはジョブステータスがに変わるまで EXPIRED (開始ウィンドウ時間が終了したときに発生することが予想される）、少なくとも 10 分ごとにジョブの開始を自動的に再試行します。

型: Long

必須: いいえ

レスポンスの構文


HTTP/1.1 200
Content-type: application/json

{
   "BackupJobId": "string",
   "CreationDate": number,
   "IsParent": boolean,
   "RecoveryPointArn": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

BackupJobId

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

タイプ: 文字列

CreationDate

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

タイプ: タイムスタンプ

IsParent

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

型: ブール値

RecoveryPointArn

注: このフィールドは Amazon EFS リソースと高度な DynamoDB リソースのみで返されます。

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

タイプ: 文字列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidParameterValueException

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

HTTP ステータスコード: 400

InvalidRequestException

リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。

HTTP ステータスコード: 400

LimitExceededException

たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。

HTTP ステータスコード: 400

MissingParameterValueException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 400

ServiceUnavailableException

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

HTTP ステータスコード: 500

その他の参照資料

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

PutRestoreValidationResult

StartCopyJob