CreateLegalHold - AWS Backup

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.

CreateLegalHold

Crea una retención legal en un punto de recuperación (copia de seguridad). Una retención legal es una restricción a la modificación o eliminación de una copia de seguridad hasta que un usuario autorizado cancele la retención legal. Toda acción que se lleve a cabo para eliminar o disociar un punto de recuperación dará lugar a un error si hay una o más retenciones legales activas en el punto de recuperación.

Sintaxis de la solicitud

POST /legal-holds/ HTTP/1.1 Content-type: application/json { "Description": "string", "IdempotencyToken": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Tags": { "string" : "string" }, "Title": "string" }

Parámetros de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

Description

La descripción de la retención legal.

Tipo: cadena

Obligatorio: sí

IdempotencyToken

Se trata de una cadena elegida por el usuario que se utiliza para distinguir entre llamadas que, de otro modo, serían idénticas. Si se vuelve a intentar una solicitud correcta con el mismo token de idempotencia, aparece un mensaje de confirmación y no se realiza ninguna acción.

Tipo: cadena

Requerido: no

RecoveryPointSelection

Los criterios para asignar un conjunto de recursos, como los tipos de recursos o las bóvedas de respaldo.

Tipo: objeto RecoveryPointSelection

Obligatorio: no

Tags

Etiquetas opcionales que se incluirán. Una etiqueta es un par clave-valor que puede utilizar para administrar, filtrar y buscar sus recursos. Los caracteres permitidos incluyen espacios, números y letras en UTF-8, además de los siguientes caracteres especiales: + - = . _ : /.

Tipo: mapa de cadena a cadena

Obligatorio: no

Title

El título de la retención legal.

Tipo: cadena

Obligatorio: sí

Sintaxis de la respuesta

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

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

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 nombre del recurso de Amazon (ARN) de la retención legal.

Tipo: cadena

LegalHoldId

El identificador de la retención legal.

Tipo: cadena

RecoveryPointSelection

Los criterios que se van a asignar a un conjunto de recursos, como los tipos de recursos o las bóvedas de respaldo.

Tipo: objeto RecoveryPointSelection

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.

Código de estado HTTP: 400

LimitExceededException

Se ha superado un límite en la solicitud; por ejemplo, el número máximo de elementos permitidos en una solicitud.

Código de estado HTTP: 400

MissingParameterValueException

Indica que falta un parámetro obligatorio.

Código de estado HTTP: 400

ServiceUnavailableException

La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.

Código de estado HTTP: 500

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: