Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
GetLegalHold
Esta acción devuelve los detalles de una retención legal concreta. Los detalles son el cuerpo de una retención legal en cuanto al JSON formato, además de los metadatos.
Sintaxis de la solicitud
GET /legal-holds/legalHoldId
/ HTTP/1.1
URIParámetros de solicitud
La solicitud utiliza los siguientes URI parámetros.
- legalHoldId
-
El identificador de la retención legal.
Obligatorio: sí
Cuerpo de la solicitud
La solicitud no tiene un cuerpo de la solicitud.
Sintaxis de la respuesta
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"
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.
El servicio devuelve los siguientes datos en JSON formato.
- CancelDescription
-
El motivo de la eliminación de la retención legal.
Tipo: cadena
- CancellationDate
-
La hora en que se canceló la suspensión legal.
Tipo: marca temporal
- CreationDate
-
El momento en que se creó la retención legal.
Tipo: marca temporal
- Description
-
La descripción de la retención legal.
Tipo: cadena
- LegalHoldArn
-
El marco ARN de la retención legal especificada. El formato de ARN depende del tipo de recurso.
Tipo: cadena
- LegalHoldId
-
El identificador de la retención legal.
Tipo: cadena
- RecoveryPointSelection
-
Los criterios para asignar un conjunto de recursos, como los tipos de recursos o las bóvedas de respaldo.
Tipo: objeto RecoveryPointSelection
- RetainRecordUntil
-
La fecha y la hora hasta las que se conserva el registro de retenciones legales.
Tipo: marca temporal
- Status
-
El estado de la retención legal.
Tipo: cadena
Valores válidos:
CREATING | ACTIVE | CANCELING | CANCELED
- Title
-
El título de la retención legal.
Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterValueException
-
Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.
HTTPCódigo de estado: 400
- MissingParameterValueException
-
Indica que falta un parámetro obligatorio.
HTTPCódigo de estado: 400
- ResourceNotFoundException
-
No existe un recurso necesario para la acción.
HTTPCódigo de estado: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
HTTPCódigo de estado: 500
Véase también
Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: