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.
DescribeScanJob
Devuelve los detalles del trabajo de escaneo para el ScanJob ID especificado.
Sintaxis de la solicitud
GET /scan/jobs/ScanJobId HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- ScanJobId
-
Identifica de forma exclusiva una solicitud AWS Backup para escanear un recurso.
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
{
"AccountId": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"IamRoleArn": "string",
"MalwareScanner": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"ScanBaseRecoveryPointArn": "string",
"ScanId": "string",
"ScanJobId": "string",
"ScanMode": "string",
"ScannerRoleArn": "string",
"ScanResult": {
"ScanResultStatus": "string"
},
"State": "string",
"StatusMessage": "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.
- AccountId
-
Devuelve el ID de cuenta propietario del trabajo de escaneo.
Patrón:
^[0-9]{12}$Tipo: cadena
- BackupVaultArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un almacén de copias de seguridad; por ejemplo,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVaultTipo: cadena
- 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
- CompletionDate
-
Es la fecha y la hora en que ha finalizado la creación del índice de copias de seguridad, expresadas en formato Unix y en horario universal coordinado (UTC). El valor de
CompletionDatetiene 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
- CreatedBy
-
Contiene información de identificación sobre la creación de un trabajo de escaneo, incluidos el plan de respaldo y la regla que inició el escaneo.
Tipo: objeto ScanJobCreator
- CreationDate
-
Es la fecha y la hora en que ha finalizado la creación del índice de copias de seguridad, expresadas en formato Unix y en 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
- IamRoleArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un almacén de copia de seguridad; por ejemplo,
arn:aws:iam::123456789012:role/S3Access.Tipo: cadena
- MalwareScanner
-
El motor de escaneo utilizado para el trabajo de escaneo correspondiente. En la actualidad, solo se admite
GUARDUTY.Tipo: cadena
Valores válidos:
GUARDDUTY - RecoveryPointArn
-
Un ARN que identifica de forma exclusiva el punto de recuperación objetivo para el escaneo.; por ejemplo,.
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45Tipo: cadena
- ResourceArn
-
Un ARN que identifica de forma exclusiva el recurso de origen del ARN del punto de recuperación correspondiente.
Tipo: cadena
- ResourceName
-
El nombre no exclusivo del recurso que pertenece a la copia de seguridad especificada.
Tipo: cadena
- ResourceType
-
El tipo de AWS recurso del que se va a hacer una copia de seguridad; por ejemplo, un volumen de Amazon Elastic Block Store (Amazon EBS).
Patrón:
^[a-zA-Z0-9\-\_\.]{1,50}$Tipo: cadena
Valores válidos:
EBS | EC2 | S3 - ScanBaseRecoveryPointArn
-
Un ARN que identifica de forma exclusiva el punto de recuperación base para el escaneo. Este campo solo se rellenará cuando se haya realizado un trabajo de escaneo incremental.
Tipo: cadena
- ScanId
-
El ID de escaneo generado por Amazon GuardDuty para la solicitud de Scan Job ID correspondiente desde AWS Backup.
Tipo: cadena
- ScanJobId
-
El identificador del trabajo de escaneo que identificó de forma exclusiva la solicitud AWS Backup.
Tipo: cadena
- ScanMode
-
Especifica el tipo de escaneo utilizado para el trabajo de escaneo.
Tipo: cadena
Valores válidos:
FULL_SCAN | INCREMENTAL_SCAN - ScannerRoleArn
-
Especifica la función de IAM del escáner (ARN) que se utiliza para el trabajo de digitalización.
Tipo: cadena
- ScanResult
-
Contiene el
ScanResultsStatuscorrespondiente al trabajo de digitalización y devuelveTHREATS_FOUNDoNO_THREATS_FOUNDcorresponde a los trabajos finalizados.Tipo: objeto ScanResultInfo
- State
-
El estado actual de un trabajo de escaneo.
Tipo: cadena
Valores válidos:
CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING - StatusMessage
-
Un mensaje detallado que explica el estado del trabajo de 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
- 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, consulte lo siguiente:
