Interprétation des réponses de l'API XML Amazon SQS

Lorsque vous envoyez une demande à Amazon SQS, celui-ci renvoie une réponse XML contenant les résultats de la demande. Pour comprendre la structure et les détails de ces réponses, reportez-vous aux actions d'API spécifiques dans le manuel Amazon Simple Queue Service API Reference.

Structure d'une réponse XML positive

Si la requête a abouti, l'élément de réponse principal porte le nom de l'action, mais avec Response ajouté (par exemple, ActionNameResponse).

Il contient les éléments enfants suivants :

• ActionNameResult : contient un élément spécifique à l'action. Par exemple, l'élément CreateQueueResult contient l'élément QueueUrl, qui contient à son tour l'URL de la file d'attente créée.

• ResponseMetadata : contient le RequestId qui contient à son tour l'UUID (Universal Unique Identifier) de la requête.

Voici un exemple de réponse ayant abouti au format XML :

<CreateQueueResponse
   xmlns=https://sqs.us-east-2.amazonaws.com/doc/2012-11-05/
   xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
   xsi:type=CreateQueueResponse>
   <CreateQueueResult>
      <QueueUrl>https://sqs.us-east-2.amazonaws.com/770098461991/queue2</QueueUrl>
   </CreateQueueResult>
   <ResponseMetadata>
      <RequestId>cb919c0a-9bce-4afe-9b48-9bdf2412bb67</RequestId>
   </ResponseMetadata>
</CreateQueueResponse>

Structure d'une réponse d'erreur XML

Si une requête échoue, Amazon SQS renvoie toujours l'élément de réponse principal ErrorResponse. Il contient un élément Error et un élément RequestId.

L'élément Error contient les éléments enfants suivants :

• Type : indique si l'erreur est survenue au niveau du producteur ou du consommateur.

• Code : spécifie le type d'erreur.

• Message : spécifie la condition d'erreur dans un format lisible.

• Detail : (facultatif) spécifie des détails supplémentaires sur l'erreur.

L'élément RequestId contient l'UUID de la requête.

Voici un exemple de réponse d'erreur au format XML :

<ErrorResponse>
   <Error>
      <Type>Sender</Type>
      <Code>InvalidParameterValue</Code>
      <Message>
         Value (quename_nonalpha) for parameter QueueName is invalid.
         Must be an alphanumeric String of 1 to 80 in length.
      </Message>
   </Error>
   <RequestId>42d59b56-7407-4c4a-be0f-4c88daeea257</RequestId>
</ErrorResponse>