Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
StartScanJob
Lance les tâches de numérisation pour des ressources spécifiques.
Syntaxe de la demande
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"
}Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
Corps de la demande
Cette demande accepte les données suivantes au format JSON.
- BackupVaultName
-
Le nom d'un conteneur logique où les sauvegardes sont stockées. Les coffres-forts de sauvegarde sont identifiés par des noms propres au compte utilisé pour les créer et à la AWS région dans laquelle ils ont été créés.
Modèle :
^[a-zA-Z0-9\-\_]{2,50}$Type : Chaîne
Obligatoire : oui
- IamRoleArn
-
Spécifie l'ARN du rôle IAM utilisé pour créer le point de récupération cible ; par exemple,
arn:aws:iam::123456789012:role/S3Access.Type : Chaîne
Obligatoire : oui
- IdempotencyToken
-
Chaîne choisie par le client que vous pouvez utiliser pour faire la distinction entre des appels par ailleurs identiques à
StartScanJob. Toute nouvelle tentative d'une demande réussie avec le même jeton d'idempotence entraîne un message de réussite sans qu'aucune action ne soit entreprise.Type : chaîne
Obligatoire : non
- MalwareScanner
-
Spécifie le scanner de programmes malveillants utilisé lors de la tâche d'analyse. Actuellement, seuls les supports
GUARDDUTY.Type : Chaîne
Valeurs valides :
GUARDDUTYObligatoire : oui
- RecoveryPointArn
-
Un Amazon Resource Name (ARN) qui identifie de manière unique un point de récupération. Il s'agit de votre point de récupération cible pour une analyse complète. Si vous exécutez une analyse incrémentielle, il s'agira d'un point de récupération créé après la sélection de votre point de récupération de base.
Type : Chaîne
Obligatoire : oui
- ScanBaseRecoveryPointArn
-
Un ARN qui identifie de manière unique le point de récupération de base à utiliser pour le scan incrémentiel.
Type : chaîne
Obligatoire : non
- ScanMode
-
Spécifie le type de numérisation utilisé pour la tâche de numérisation.
Comprend :
-
FULL_SCANanalysera l'intégralité du lignage de données dans la sauvegarde. -
INCREMENTAL_SCANanalysera la différence de données entre le point de récupération cible et l'ARN du point de récupération de base.
Type : Chaîne
Valeurs valides :
FULL_SCAN | INCREMENTAL_SCANObligatoire : oui
-
- ScannerRoleArn
-
Spécifié l'ARN du rôle de scanner IAM.
Type : Chaîne
Obligatoire : oui
Syntaxe de la réponse
HTTP/1.1 201
Content-type: application/json
{
"CreationDate": number,
"ScanJobId": "string"
}Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 201.
Les données suivantes sont renvoyées au format JSON par le service.
- CreationDate
-
Date et heure de création d'une tâche de sauvegarde, au format Unix et au format UTC (temps universel coordonné). La valeur de
CreationDateest précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.Type : Timestamp
- ScanJobId
-
Identifie de manière unique une demande AWS Backup de sauvegarde d'une ressource.
Type : Chaîne
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- InvalidParameterValueException
-
Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée.
- Context
- Type
Code d’état HTTP : 400
- InvalidRequestException
-
Indique une erreur dans la saisie de la demande. Par exemple, un paramètre n'est pas du bon type.
- Context
- Type
Code d’état HTTP : 400
- LimitExceededException
-
Une limite de la demande a été dépassée ; par exemple, le nombre maximum d'éléments autorisés dans une demande.
- Context
- Type
Code d’état HTTP : 400
- MissingParameterValueException
-
Indique qu'un paramètre obligatoire est manquant.
- Context
- Type
Code d’état HTTP : 400
- ResourceNotFoundException
-
Aucune ressource requise pour l'action n'existe.
- Context
- Type
Code d’état HTTP : 400
- ServiceUnavailableException
-
La demande a échoué en raison d'une défaillance temporaire du serveur.
- Context
- Type
Code d’état HTTP : 500
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
