Amazon Simple Queue Service
開発者ガイド

レスポンスの解釈

アクションリクエストに対するレスポンスで、Amazon SQS はリクエスト結果を含む XML データ構造を返します。詳細については、『Amazon Simple Queue Service API Reference』で個々の アクションを参照してください。

正常なレスポンス構造

リクエストが正常に行われた場合、主レスポンスの要素には、Response で終わる、アクションに関連する名前が付きます (ActionNameResponse)。

この要素には、以下の子要素が含まれています。

  • ActionNameResult – アクション固有の要素が含まれています。たとえば、CreateQueueResult 要素には QueueUrl 要素が含まれています。つまり、作成されたキューの URL が含まれています。

  • ResponseMetadataRequestId が含まれています。つまり、リクエストの UUID が含まれています。

以下に、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>

エラーレスポンス構造

リクエストが正常に行われなかった場合、Amazon SQS は常に主レスポンスの要素 ErrorResponse を返します。この要素には Error 要素と RequestId 要素が含まれます。

Error 要素には、以下の子要素が含まれています。

  • Type – エラーがプロデューサーエラーかコンシューマーエラーのどちらかを指定します。

  • Code – エラーのタイプを指定します。

  • Message – 読み取り可能な形式でエラー状況を指定します。

  • Detail – (オプション) エラーに関する追加の詳細を指定します。

RequestId 要素には、リクエストの UUID が含まれています。

以下に、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>