翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # 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, "DeleteAfterEvent": "string", "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "LogicallyAirGappedBackupVaultArn": "string", "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number } ``` ## URI リクエストパラメータ リクエストでは URI パラメータを使用しません。 ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [BackupOptions](#API_StartBackupJob_RequestSyntax) ** 選択したリソースのバックアップオプション。このオプションは、Windows ボリュームシャドウコピーサービス (VSS) バックアップジョブでのみ使用できます。 有効な値:`"WindowsVSS":"enabled"` に設定して`WindowsVSS` バックアップオプションをを有効にし、Windows VSS バックアップを作成します。`"WindowsVSS""disabled"` に設定して、通常のバックアップを作成します。デフォルトでは、`WindowsVSS` のオプションは有効になっていません。 型: 文字列から文字列へのマッピング キーパターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 値パターン:`^[a-zA-Z0-9\-\_\.]{1,50}$` 必須: いいえ ** [BackupVaultName](#API_StartBackupJob_RequestSyntax) ** バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。 タイプ: 文字列 Pattern: `^[a-zA-Z0-9\-\_]{2,50}$` 必須: はい ** [CompleteWindowMinutes](#API_StartBackupJob_RequestSyntax) ** 正常に開始されたバックアップを完了する必要がある時間（分単位）、または AWS Backup がジョブをキャンセルします。この値はオプションです。この値は、バックアップがスケジュールされた時点からカウントダウンを開始します。`StartWindowMinutes` またはバックアップがスケジュールより遅れて開始された場合、追加時間は追加されません。 `StartWindowMinutes` と同様に、このパラメータの最大値は 100 年 (52,560,000 分) です。 タイプ: Long 必須: いいえ ** [IamRoleArn](#API_StartBackupJob_RequestSyntax) ** ターゲット復旧ポイントの作成に使用する IAM ロール ARN を指定します。例えば、`arn:aws:iam::123456789012:role/S3Access`です。 タイプ: 文字列 必須: はい ** [IdempotencyToken](#API_StartBackupJob_RequestSyntax) ** 別の `StartBackupJob` への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。 タイプ: 文字列 必須: いいえ ** [Index](#API_StartBackupJob_RequestSyntax) ** バックアップジョブにバックアップインデックスをサポートするリソースタイプがある場合は、このパラメータを含めてインデックスの作成を有効にします。 バックアップインデックスをサポートするリソースタイプは次のとおりです。 + Amazon Elastic Block Store 用の `EBS` + Amazon Simple Storage Service (Amazon S3) 用の `S3` インデックスには、`ENABLED` または `DISABLED` の 2 つの値のいずれかを指定できます。 バックアップインデックスがまだ作成されていない、対象となる `ACTIVE` 復旧ポイントのバックアップインデックスを作成するには、値を `ENABLED` に設定します。 バックアップインデックスを削除するには、値を `DISABLED` に設定します。 型: 文字列 有効な値：`ENABLED | DISABLED` 必須：いいえ ** [Lifecycle](#API_StartBackupJob_RequestSyntax) ** ライフサイクルは、保護されたリソースがコールドストレージに移行するタイミングと期限切れになるタイミングを定義します。 AWS Backup は、定義したライフサイクルに従ってバックアップを自動的に移行して期限切れにします。 コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、「保持期間」の設定は、「コールドへの移行 (日数)」設定から 90 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。 コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。 このパラメータの最大値は 100 年 (36,500 日) です。 型: [Lifecycle](API_Lifecycle.md) オブジェクト 必須: いいえ ** [LogicallyAirGappedBackupVaultArn](#API_StartBackupJob_RequestSyntax) ** 論理エアギャップボールトの ARN。ARN は同じアカウントとリージョンに存在する必要があります。提供されている場合、サポートされているフルマネージドリソースは論理エアギャップボールトに直接バックアップされ、他のサポートされているリソースはバックアップボールトに一時的な (請求可能な) スナップショットを作成し、それを論理エアギャップボールトにコピーします。サポートされていないリソースは、指定されたバックアップボールトにのみバックアップされます。 タイプ: 文字列 必須: いいえ ** [RecoveryPointTags](#API_StartBackupJob_RequestSyntax) ** リソースに割り当てるタグ。 タイプ: 文字列間のマッピング 必須: いいえ ** [ResourceArn](#API_StartBackupJob_RequestSyntax) ** リソースを一意に識別する Amazon リソースネーム (ARN)。ARN の形式は、リソースタイプによって異なります。 タイプ: 文字列 必須: はい ** [StartWindowMinutes](#API_StartBackupJob_RequestSyntax) ** バックアップがスケジュールされてから、正常に開始されない場合にジョブがキャンセルされるまでの時間の分単位での値。この値はオプションであり、デフォルト値は 8時間です。この値を含める場合、エラーを避けるために少なくとも 60 分必要です。 このパラメータの最大値は 100 年 (52,560,000 分) です。 開始ウィンドウ中、バックアップジョブのステータスは、正常に開始されるか、開始ウィンドウの時間がなくなるまで `CREATED` ステータスのままになります。開始ウィンドウ時間内にジョブの再試行を許可するエラー AWS Backup を受け取った場合、 AWS Backup は、バックアップが正常に開始されるまで (ジョブステータスが に変わる）、またはジョブステータスが に変わるまで `EXPIRED` (開始ウィンドウ時間が終了すると予想される`RUNNING`)、少なくとも 10 分ごとにジョブの開始を自動的に再試行します。 タイプ: Long 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "BackupJobId": "string", "CreationDate": number, "IsParent": boolean, "RecoveryPointArn": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [BackupJobId](#API_StartBackupJob_ResponseSyntax) ** リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。 タイプ: 文字列 ** [CreationDate](#API_StartBackupJob_ResponseSyntax) ** バックアップジョブが作成された日時 (Unix 時刻形式および協定世界時 (UTC))。`CreationDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。 タイプ: タイムスタンプ ** [IsParent](#API_StartBackupJob_ResponseSyntax) ** これは親 (複合) バックアップジョブであることを示す、返されたブール値です。 タイプ: ブール値 ** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) ** *注: このフィールドは Amazon EFS リソースと高度な DynamoDB リソースのみで返されます。* リカバリーポイントを一意に識別する ARN、たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45` です。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。 ** InvalidParameterValueException ** パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** InvalidRequestException ** リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** LimitExceededException ** たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** MissingParameterValueException ** 必須パラメータがないことを示します。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** ResourceNotFoundException ** アクションに必要なリソースは存在しません。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** ServiceUnavailableException ** サーバーの一時的障害のため、リクエストは失敗しました。 ** Context ** ** Type ** HTTP ステータスコード: 500 ## その他の参照資料 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartBackupJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartBackupJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartBackupJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartBackupJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartBackupJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartBackupJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartBackupJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartBackupJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartBackupJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartBackupJob)