翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
このアクションは、アクティブなリーガルホールドと以前のリーガルホールドに関するメタデータを返します。
リクエストの構文
GET /legal-holds/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- MaxResults
-
返されるリソースリストアイテムの最大数。
有効範囲: 最小値 1 最大値は 1000 です。
- NextToken
-
返されるリソースの部分的リストに続く次の項目です。例えば、
MaxResultsの数のリソースを返すようにリクエストが行われた場合、NextTokenを使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。
リクエスト本文
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"LegalHolds": [
{
"CancellationDate": number,
"CreationDate": number,
"Description": "string",
"LegalHoldArn": "string",
"LegalHoldId": "string",
"Status": "string",
"Title": "string"
}
],
"NextToken": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- LegalHolds
-
これは、返されたリーガルホールド (アクティブなリーガルホールドと以前のリーガルホールドの両方) の配列です。
型: LegalHold オブジェクトの配列
- NextToken
-
返されるリソースの部分的リストに続く次の項目です。例えば、
MaxResultsの数のリソースを返すようにリクエストが行われた場合、NextTokenを使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。タイプ: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
HTTP ステータスコード: 400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
HTTP ステータスコード: 500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
