CreateLegalHold - AWS Backup

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateLegalHold

復旧ポイント (バックアップ) にリーガルホールドを作成します。リーガルホールドとは、権限のあるユーザーがリーガルホールドをキャンセルするまでの間の、バックアップの変更または削除の制限です。復旧ポイントに 1 つ以上の有効なリーガルホールドがある場合、復旧ポイントを削除するまたは関連付けを解除する操作はすべてエラーで失敗します。

リクエストの構文

POST /legal-holds/ HTTP/1.1 Content-type: application/json { "Description": "string", "IdempotencyToken": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Tags": { "string" : "string" }, "Title": "string" }

URI リクエストパラメータ

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

リクエスト本文

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

Description

リーガルホールドの説明。

型: 文字列

必須: はい

IdempotencyToken

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

型: 文字列

必須: いいえ

RecoveryPointSelection

リソースタイプやバックアップボールトなど、一連のリソースを割り当てる基準。

型: RecoveryPointSelection オブジェクト

必須:いいえ

Tags

追加するタグは任意です。タグは、リソースの管理、フィルタリング、検索に使用できるキーと値のペアです。使用できる文字には、UTF-8 文字、数字、スペース、および + - = . _ : / が含まれます。

型: 文字列間のマッピング

必須:いいえ

Title

リーガルホールドのタイトル。

型: 文字列

必須: はい

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "CreationDate": number, "Description": "string", "LegalHoldArn": "string", "LegalHoldId": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Status": "string", "Title": "string" }

レスポンス要素

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

次のデータは、 サービスによって JSON 形式で返されます。

CreationDate

リーガルホールドが作成された時刻。

型: タイムスタンプ

Description

リーガルホールドの説明。

型: 文字列

LegalHoldArn

リーガルホールドの Amazon リソースネーム (ARN)。

型: 文字列

LegalHoldId

リーガルホールドの ID。

型: 文字列

RecoveryPointSelection

リソースタイプやバックアップボールトなど、一連のリソースに割り当てる基準。

型: RecoveryPointSelection オブジェクト

Status

リーガルホールドのステータス。

型: 文字列

有効な値: CREATING | ACTIVE | CANCELING | CANCELED

Title

リーガルホールドのタイトル。

型: 文字列

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード: 400

LimitExceededException

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

HTTP ステータスコード: 400

MissingParameterValueException

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

HTTP ステータスコード: 400

ServiceUnavailableException

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

HTTP ステータスコード: 500

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

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