Interpretar as respostas da API XML do Amazon SQS

Em resposta a uma solicitação de ação, o Amazon SQS retorna uma estrutura de dados XML que contém os resultados da solicitação. Para obter mais informações, consulte ações individuais na Referência da API do Amazon Simple Queue Service.

Estrutura de resposta de XML bem-sucedida

Se a solicitação for bem-sucedida, o elemento de resposta principal receberá o nome da ação, com Response anexada (por exemplo, ActionNameResponse).

Esse elemento contém os seguintes elementos filho:

• ActionNameResult: contém um elemento específico à ação. Por exemplo, o elemento CreateQueueResult contém o elemento QueueUrl que, por sua vez, contém o URL da fila criada.

• ResponseMetadata: contém o RequestId, que, por sua vez, contém o Universal Unique Identifier (UUID) da solicitação.

Veja a seguir um exemplo de uma resposta bem-sucedida no formato 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>

Estrutura de resposta de erro de XML

Se uma solicitação não tiver êxito, o Amazon SQS retornará o elemento de resposta principal ErrorResponse. Esse elemento contém um elemento Error e um elemento RequestId.

O elemento Error contém os seguintes elementos filhos:

• Type: especifica se o erro foi de um produtor ou de um consumidor.

• Code: especifica o tipo de erro.

• Message: especifica a condição do erro em um formato legível.

• Detail: (opcional) especifica detalhes adicionais sobre o erro.

O elemento RequestId contém o UUID do pedido.

Veja a seguir um exemplo de uma resposta com erro no formato 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>