DescribeIngestion - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la requêteSyntaxe de la réponseEléments de réponseErreursExemplesVoir aussi

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.

DescribeIngestion

Décrit une ingestion de SPICE.

Syntaxe de la demande

GET /accounts/AwsAccountId/data-sets/DataSetId/ingestions/IngestionId HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

L'ID de compte AWS.

Contraintes de longueur : Longueur fixe de 12.

Modèle : ^[0-9]{12}$

Obligatoire : Oui

DataSetId

ID du jeu de données utilisé lors de l'ingestion.

Obligatoire : Oui

IngestionId

Un identifiant pour l'ingestion.

Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 128.

Modèle : ^[a-zA-Z0-9-_]+$

Obligatoire : Oui

Corps de la requête

La demande n'a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

{
   "Ingestion": { 
      "Arn": "string",
      "CreatedTime": number,
      "ErrorInfo": { 
         "Message": "string",
         "Type": "string"
      },
      "IngestionId": "string",
      "IngestionSizeInBytes": number,
      "IngestionStatus": "string",
      "IngestionTimeInSeconds": number,
      "QueueInfo": { 
         "QueuedIngestion": "string",
         "WaitingOnIngestion": "string"
      },
      "RequestSource": "string",
      "RequestType": "string",
      "RowInfo": { 
         "RowsDropped": number,
         "RowsIngested": number,
         "TotalRowsInDataset": number
      }
   },
   "RequestId": "string"
}

Eléments de réponse

Si l'action aboutit, le service renvoie la réponse HTTP suivante.

Status

Le statut HTTP de la requête.

Les données suivantes sont renvoyées au format JSON par le service.

Ingestion

Informations sur l'ingestion.

Type : objet Ingestion

RequestId

LeAWSID de demande pour cette opération.

Type : Chaîne

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

AccessDeniedException

Vous n'avez pas accès à cet élément. Les informations d'identification fournies n'ont pas pu être validées. Il est possible que vous ne soyez pas autorisé à effectuer la demande. Assurez-vous que votre compte est autorisé à utiliser Amazon QuickSight service d'accès, que vos stratégies ont les autorisations appropriées et que vous utilisez les bonnes clés d'accès.

Code état état état état HTTP : 401

InternalFailureException

Une défaillance interne s'est produite.

Code état état état état HTTP : 500

InvalidParameterValueException

Un ou plusieurs paramètres ont une valeur non valide.

Code état état état état HTTP : 400

ResourceExistsException

La ressource spécifiée existe déjà.

Code état état état état HTTP : 409

ResourceNotFoundException

Une ou plusieurs ressources n'ont pas pu être trouvées.

Code état état état état HTTP : 404

ThrottlingException

L'accès est limité.

Code état état état état HTTP : 429

Exemples

Exemple

Cet exemple illustre une utilisation de DescribeIngestion.

Exemple de demande

GET /accounts/*AwsAccountId*/data-sets/*DataSetID*/ingestions/*IngestionID* HTTP/1.1

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :