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.
StartScanJob
Comienza a escanear trabajos en busca de recursos específicos.
Sintaxis de la solicitud
PUT /scan/job HTTP/1.1
Content-type: application/json
{
"BackupVaultName": "string",
"IamRoleArn": "string",
"IdempotencyToken": "string",
"MalwareScanner": "string",
"RecoveryPointArn": "string",
"ScanBaseRecoveryPointArn": "string",
"ScanMode": "string",
"ScannerRoleArn": "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.
- BackupVaultName
-
El nombre de un contenedor lógico donde se almacenan las copias de seguridad. Los almacenes de Backup se identifican con nombres que son exclusivos de la cuenta utilizada para crearlos y de la AWS región en la que se crearon.
Patrón:
^[a-zA-Z0-9\-\_]{2,50}$Tipo: cadena
Obligatorio: sí
- IamRoleArn
-
Especifica el ARN del rol de IAM utilizado para crear el punto de recuperación de destino; por ejemplo,
arn:aws:iam::123456789012:role/S3Access.Tipo: cadena
Obligatorio: sí
- IdempotencyToken
-
Una cadena elegida por el cliente que puede utilizar para distinguir entre llamadas a
StartScanJobque, 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
- MalwareScanner
-
Especifica el escáner de malware utilizado durante el trabajo de escaneo. Actualmente solo es compatible
GUARDDUTY.Tipo: cadena
Valores válidos:
GUARDDUTYObligatorio: sí
- RecoveryPointArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un punto de recuperación. Este es el punto de recuperación objetivo para un análisis completo. Si está realizando un análisis incremental, este será el punto de recuperación que se haya creado después de seleccionar el punto de recuperación base.
Tipo: cadena
Obligatorio: sí
- ScanBaseRecoveryPointArn
-
Un ARN que identifica de forma exclusiva el punto de recuperación base que se utilizará para el escaneo incremental.
Tipo: cadena
Requerido: no
- ScanMode
-
Especifica el tipo de escaneo que se utilizará para el trabajo de escaneo.
Incluye:
-
FULL_SCANescaneará todo el linaje de datos de la copia de seguridad. -
INCREMENTAL_SCANescaneará la diferencia de datos entre el punto de recuperación objetivo y el ARN del punto de recuperación base.
Tipo: cadena
Valores válidos:
FULL_SCAN | INCREMENTAL_SCANObligatorio: sí
-
- ScannerRoleArn
-
Especificó el ARN del rol del escáner de IAM.
Tipo: cadena
Obligatorio: sí
Sintaxis de la respuesta
HTTP/1.1 201
Content-type: application/json
{
"CreationDate": number,
"ScanJobId": "string"
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 201.
El servicio devuelve los datos siguientes en formato JSON.
- CreationDate
-
La fecha y la hora en que se creó el trabajo de copia de seguridad, en formato Unix y horario universal coordinado (UTC). El valor de
CreationDatetiene una precisión de milisegundos. Por ejemplo, el valor 1516925490.087 representa el viernes 26 de enero de 2018 a las 12:11:30.087 h.Tipo: marca temporal
- ScanJobId
-
Identifica de forma exclusiva una solicitud para AWS Backup hacer una copia de seguridad de un recurso.
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.
- Context
- Type
Código de estado HTTP: 400
- InvalidRequestException
-
Indica que hay algún problema con la entrada de la solicitud. Por ejemplo, un parámetro es del tipo incorrecto.
- Context
- Type
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.
- Context
- Type
Código de estado HTTP: 400
- MissingParameterValueException
-
Indica que falta un parámetro obligatorio.
- Context
- Type
Código de estado HTTP: 400
- ResourceNotFoundException
-
No existe un recurso necesario para la acción.
- Context
- Type
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
- Context
- Type
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 idiomas específicos AWS SDKs, consulta lo siguiente: