GetLegalHold
This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
Request Syntax
GET /legal-holds/legalHoldId/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- legalHoldId
-
The ID of the legal hold.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
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"
}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.
- CancelDescription
-
The reason for removing the legal hold.
Type: String
- CancellationDate
-
The time when the legal hold was cancelled.
Type: Timestamp
- CreationDate
-
The time when the legal hold was created.
Type: Timestamp
- Description
-
The description of the legal hold.
Type: String
- LegalHoldArn
-
The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.
Type: String
- LegalHoldId
-
The ID of the legal hold.
Type: String
- RecoveryPointSelection
-
The criteria to assign a set of resources, such as resource types or backup vaults.
Type: RecoveryPointSelection object
- RetainRecordUntil
-
The date and time until which the legal hold record is retained.
Type: Timestamp
- Status
-
The status of the legal hold.
Type: String
Valid Values:
CREATING | ACTIVE | CANCELING | CANCELED - Title
-
The title of the legal hold.
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
- MissingParameterValueException
-
Indicates that a required parameter is missing.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource that is required for the action doesn't exist.
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 AWS SDKs, see the following:
