ListLegalHolds
This action returns metadata about active and previous legal holds.
Request Syntax
GET /legal-holds/?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
- NextToken
-
The next item following a partial list of returned resources. For example, if a request is made to return
MaxResults
number of resources,NextToken
allows you to return more items in your list starting at the location pointed to by the next token.
Request Body
The request does not have a request body.
Response Syntax
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"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LegalHolds
-
This is an array of returned legal holds, both active and previous.
Type: Array of LegalHold objects
- NextToken
-
The next item following a partial list of returned resources. For example, if a request is made to return
MaxResults
number of resources,NextToken
allows you to return more items in your list starting at the location pointed to by the next token.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: