ハンズオン(簡易版): SQS入門

2.2. SQSキューからのメッセージ受信 (handson-cli-sqs-novice-queue)

手順の目的 [why]

SQSキュー"handson-cli-sqs-novice-queue"のメッセージを受信します。

設定値の指定

設定値の指定

手順に必要な設定値を変数に格納をします。

0. リージョンの指定

リージョンを指定します。

環境変数の設定:

export AWS_DEFAULT_REGION='ap-northeast-1'

1. SQSキュー名の指定

SQSキュー名を指定します。

変数の設定:

SQS_QUEUE_NAME="handson-cli-sqs-novice-queue"

2. SQSメッセージ用ディレクトリの指定

SQSメッセージ用ディレクトリを指定します。

変数の設定:

DIR_SQS_MESSAGE="${HOME}/environment/tmp-handson-cli-sqs"

ディレクトリが存在することを確認し、存在しない場合は作成します。

コマンド:

ls -d ${DIR_SQS_MESSAGE} > /dev/null 2>&1 \
  || mkdir -p ${DIR_SQS_MESSAGE}

結果(例):

(出力なし)

3. SQSメッセージファイルの指定

SQSメッセージファイルを指定します。

変数の設定:

FILE_SQS_MESSAGE="${DIR_SQS_MESSAGE}/$(date +%Y-%m-%d)-${SQS_QUEUE_NAME}.json" \
  && echo ${FILE_SQS_MESSAGE}

結果(例):

${HOME}/environment/tmp-handson-cli-sqs/2022-04-29-handson-cli-sqs-novice-queue.json

設定値の確認

各変数に正しい設定値が格納されていることを確認しながら保存します。

変数の確認:

cat << END

  # 0. AWS_DEFAULT_REGION:"ap-northeast-1"
       AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 1. SQS_QUEUE_NAME:"handson-cli-sqs-novice-queue"
       SQS_QUEUE_NAME="${SQS_QUEUE_NAME}"
  # 2. DIR_SQS_MESSAGE:"${HOME}/environment/tmp-handson-cli-sqs"
       DIR_SQS_MESSAGE="${DIR_SQS_MESSAGE}"
  # 3. FILE_SQS_MESSAGE:"${HOME}/environment/tmp-handson-cli-sqs/2022-04-29-handson-cli-sqs-novice-queue.json"
       FILE_SQS_MESSAGE="${FILE_SQS_MESSAGE}"

END

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

処理の実行

SQSキューからのメッセージ受信

SQSキューからメッセージを受信します。

変数の確認:

cat << END

  # SQS_QUEUE_URL:"https://ap-northeast-1.queue.amazonaws.com/XXXXXXXXXXXX/handson-cli-sqs-novice-queue"
    SQS_QUEUE_URL="${SQS_QUEUE_URL}"
  # FILE_SQS_MESSAGE:"${HOME}/environment/tmp-handson-cli-sqs/2022-04-29-handson-cli-sqs-novice-queue.json"
    FILE_SQS_MESSAGE="${FILE_SQS_MESSAGE}"

END

コマンド:

aws sqs receive-message \
  --queue-url "${SQS_QUEUE_URL}" \
  > ${FILE_SQS_MESSAGE} \
    && cat ${FILE_SQS_MESSAGE}

結果(例):

{
    "Messages": [
        {
            "Body": "Hello World!",
            "ReceiptHandle": "AQEBUo4y+XVuRSe4jMv0QM6Ob1viUnPbZ64WI01+Kmj6erhv192m80m+wgyob+zBgL4OMT+bps4KR/q5WK+W3tnno6cCFuwKGRM4OQGM9omMkK1F+ZwBC49hbl7UlzqAqcSrHfxyDo5x+xEyrEyL+sFK2MxNV6d0mF+7WxXTboyAu7JxIiKLG6cUlkhWfk3W4/Kghagy5erwRhwTaKtmF+7hw3Y99b55JLFTrZjW+/Jrq9awLCedce0kBQ3d2+7pnlpEcoY42+7T1dRI2s7um+nj5TIUpx2oSd9BWBHCjd8UQjmyye645asrWMAl1VCvHZrHRIG/v3vgq776e1mmi9pGxN96IW1aDZCQ1CSeqTFASe4=",
            "MD5OfBody": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "MessageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
    ]
}

メッセージの削除

取得したメッセージは、「処理済み」としてキューから削除しておきます。

コマンド:

SQS_MESSAGE_RECEIPT_HANDLE=$( \
  cat ${FILE_SQS_MESSAGE} \
  | jp.py 'Messages[].ReceiptHandle' \
  | sed 's/[]\"\[]//g' \
) \
  && echo ${SQS_MESSAGE_RECEIPT_HANDLE}

結果(例):

AQEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=

変数の確認:

cat << END

  # SQS_QUEUE_URL:"https://ap-northeast-1.queue.amazonaws.com/XXXXXXXXXXXX/handson-cli-sqs-novice-queue"
    SQS_QUEUE_URL="${SQS_QUEUE_URL}"
  # SQS_MESSAGE_RECEIPT_HANDLE:"AQEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx="
    SQS_MESSAGE_RECEIPT_HANDLE="${SQS_MESSAGE_RECEIPT_HANDLE}"

END

コマンド:

aws sqs delete-message \
  --queue-url "${SQS_QUEUE_URL}" \
  --receipt-handle ${SQS_MESSAGE_RECEIPT_HANDLE}

結果(例):

(出力なし)

完了確認

「SQSキュー"handson-cli-sqs-novice-queue"のメッセージ数が"0"である。」ことを確認します。

コマンド:

aws sqs get-queue-attributes \
  --queue-url ${SQS_QUEUE_URL} \
  --attribute-names ApproximateNumberOfMessages \
  --query 'Attributes.ApproximateNumberOfMessages' \
  --output text

結果(例):

0

「SQSメッセージファイル"${HOME}/environment/tmp-handson-cli-sqs/2022-04-29-handson-cli-sqs-novice-queue.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SQS_MESSAGE}

結果(例):

${HOME}/environment/tmp-handson-cli-sqs/2022-04-29-handson-cli-sqs-novice-queue.json

メッセージボディを取り出します。

コマンド:

SQS_MESSAGE_BODY=$( \
  cat ${FILE_SQS_MESSAGE} \
  | jp.py 'Messages[].Body' \
  | sed 's/[]\"\[]//g' \
) \
  && echo ${SQS_MESSAGE_BODY}

結果(例):

Hello World!

手順の完了

(参考) マネジメントコンソールの確認

キュー一覧(画面)

  • 検索欄にキュー名"handson-cli-sqs-novice-queue"を入力します。

  • キュー名"handson-cli-sqs-novice-queue"(リンク)をクリックします。

キュー詳細(画面)

  • 詳細欄下部の"さらに表示"をクリックします。

  • "利用可能なメッセージ"が"0"であることを確認します。