GetLegalHold - AWS Backup

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

GetLegalHold

このアクションは、指定されたリーガルホールドの詳細を返します。詳細は、メタデータに加えて、JSON 形式のリーガルホールドの本文です。

リクエストの構文

GET /legal-holds/legalHoldId/ HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

legalHoldId

リーガルホールドの ID。

必須: はい

リクエストボディ

リクエストにリクエスト本文がありません。

レスポンスの構文

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

レスポンス要素

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

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

CancelDescription

リーガルホールドを削除する理由。

型: 文字列

CancellationDate

リーガルホールドがキャンセルされた時刻。

型: タイムスタンプ

CreationDate

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

型: タイムスタンプ

Description

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

型: 文字列

LegalHoldArn

指定されたリーガルホールドのフレームワーク ARN。ARN の形式は、リソースタイプによって異なります。

型: 文字列

LegalHoldId

リーガルホールドの ID。

型: 文字列

RecoveryPointSelection

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

タイプ:RecoveryPointSelection オブジェクト

RetainRecordUntil

リーガルホールドレコードが保持される日時。

型: タイムスタンプ

Status

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

型: 文字列

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

Title

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

型: 文字列

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード:400

MissingParameterValueException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

ServiceUnavailableException

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

HTTP ステータスコード:500

その他の参照資料

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