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.
StartSearchResultExportJob
Cette opération lance une tâche pour exporter les résultats de la tâche de recherche vers un compartiment S3 désigné.
Syntaxe de la demande
PUT /export-search-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"ExportSpecification": { ... },
"RoleArn": "string",
"SearchJobIdentifier": "string",
"Tags": {
"string" : "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.
- ClientToken
-
Incluez ce paramètre pour autoriser plusieurs appels identiques à des fins d'idempuissance.
Un jeton client est valide pendant 8 heures après la fin de la première demande l'utilisant. Passé ce délai, toute demande comportant le même jeton est traitée comme une nouvelle demande.
Type : chaîne
Obligatoire : non
- ExportSpecification
-
Cette spécification contient une chaîne obligatoire du compartiment de destination ; vous pouvez éventuellement inclure le préfixe de destination.
Type : objet ExportSpecification
Remarque : Cet objet est une union. Un seul membre de cet objet peut être spécifié ou renvoyé.
Obligatoire : oui
- RoleArn
-
Ce paramètre spécifie le rôle ARN utilisé pour démarrer les tâches d'exportation des résultats de recherche.
Type : String
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.
Modèle :
arn:(?:aws|aws-cn|aws-us-gov):iam::[a-z0-9-]+:role/(.+)Obligatoire : non
- SearchJobIdentifier
-
Chaîne unique qui spécifie la tâche de recherche.
Type : String
Obligatoire : oui
- Tags
-
Balises facultatives à inclure. Une balise est une paire clé-valeur que vous pouvez utiliser pour gérer, filtrer et rechercher vos ressources. Les caractères autorisés incluent les lettres, les espaces et les chiffres représentables en UTF-8, ainsi que les caractères spéciaux suivants : + - = . _ : /.
Type : mappage chaîne/chaîne
Obligatoire : non
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"ExportJobArn": "string",
"ExportJobIdentifier": "string"
}
Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
- ExportJobArn
-
Il s'agit de l'ARN (Amazon Resource Name) unique qui appartient à la nouvelle tâche d'exportation.
Type : String
- ExportJobIdentifier
-
Il s'agit de l'identifiant unique qui spécifie la nouvelle tâche d'exportation.
Type : String
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- AccessDeniedException
-
Vous ne disposez pas d’un accès suffisant pour effectuer cette action.
- message
-
L'utilisateur ne dispose pas d'un accès suffisant pour effectuer cette action.
Code d’état HTTP : 403
- ConflictException
-
Cette exception se produit lorsqu'un conflit avec une opération précédente réussie est détecté. Cela se produit généralement lorsque l'opération précédente n'a pas eu le temps de se propager à l'hôte qui répond à la demande en cours.
Une nouvelle tentative (avec une logique d'interruption appropriée) est la réponse recommandée à cette exception.
- message
-
La mise à jour ou la suppression d'une ressource peut entraîner un état incohérent.
- resourceId
-
Identifiant de la ressource affectée.
- resourceType
-
Type de ressource affectée.
Code d’état HTTP : 409
- InternalServerException
-
Une erreur interne du serveur s'est produite. Réessayez votre demande.
- message
-
Erreur inattendue lors du traitement de la demande.
- retryAfterSeconds
-
Réessayez l'appel au bout de quelques secondes.
Code d’état HTTP : 500
- ResourceNotFoundException
-
La ressource n'a pas été trouvée pour cette demande.
Vérifiez que les informations sur la ressource, telles que l'ARN ou le type, sont correctes et existent, puis réessayez la demande.
- message
-
La requête fait référence à une ressource qui n'existe pas.
- resourceId
-
Identifiant hypothétique de la ressource affectée.
- resourceType
-
Type hypothétique de la ressource affectée.
Code d’état HTTP : 404
- ServiceQuotaExceededException
-
La demande a été refusée en raison du dépassement des limites de quotas autorisées.
- message
-
Cette demande n'a pas abouti en raison d'un quota de service dépassant les limites.
- quotaCode
-
Il s'agit du code spécifique au type de quota.
- resourceId
-
Identifiant de la ressource.
- resourceType
-
Type de ressource.
- serviceCode
-
Il s'agit du code propre au service d'origine avec le quota.
Code d'état HTTP : 402
- ThrottlingException
-
La demande a été refusée suite à une limitation des demandes.
- message
-
La demande n'a pas abouti en raison d'une limitation des demandes.
- quotaCode
-
Il s'agit du code propre au service d'origine avec le quota.
- retryAfterSeconds
-
Réessayez l'appel au bout de quelques secondes.
- serviceCode
-
Il s'agit du code propre au service d'origine.
Code d’état HTTP : 429
- ValidationException
-
L'entrée ne satisfait pas les contraintes spécifiées par un service.
- message
-
L'entrée ne répond pas aux contraintes spécifiées par un service Amazon.
Code d’état HTTP : 400
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 :