を使用した Amazon SQS の例 AWS CLI

次のコード例は、Amazon SQS AWS Command Line Interface でを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

次の例は、add-permission を使用する方法を説明しています。

AWS CLI

キューへのアクセス許可を追加するには

この例では、指定された AWS アカウントが指定されたキューにメッセージを送信できるようにします。

コマンド:


aws sqs add-permission --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --label SendMessagesFromMyQueue --aws-account-ids 12345EXAMPLE --actions SendMessage

出力:


None.

API の詳細については、「AWS CLI コマンドリファレンス」の「AddPermission」を参照してください。

次の例は、cancel-message-move-task を使用する方法を説明しています。

AWS CLI

メッセージ移動タスクをキャンセルするには

次の cancel-message-move-task の例では、指定されたメッセージ移動タスクをキャンセルします。


aws sqs cancel-message-move-task \
    --task-handle AQEB6nR4...HzlvZQ==

出力:


{
    "ApproximateNumberOfMessagesMoved": 102
}

詳細については、「デベロッパーガイド」の「Amazon SQS API permissions: Actions and resource reference」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CancelMessageMoveTask」を参照してください。

次の例は、change-message-visibility-batch を使用する方法を説明しています。

AWS CLI

複数のメッセージの可視性タイムアウトをバッチで変更するには

この例では、2 件の指定されたメッセージの可視性タイムアウトを 10 時間 (10 時間 × 60 分 × 60 秒) に変更します。

コマンド:


aws sqs change-message-visibility-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://change-message-visibility-batch.json

入力ファイル (change-message-visibility-batch.json):


[
  {
    "Id": "FirstMessage",
        "ReceiptHandle": "AQEBhz2q...Jf3kaw==",
        "VisibilityTimeout": 36000
  },
  {
    "Id": "SecondMessage",
        "ReceiptHandle": "AQEBkTUH...HifSnw==",
        "VisibilityTimeout": 36000
  }
]

出力:


{
  "Successful": [
    {
      "Id": "SecondMessage"
    },
    {
      "Id": "FirstMessage"
    }
  ]
}

API の詳細については、「AWS CLI コマンドリファレンス」の「ChangeMessageVisibilityBatch」を参照してください。

次の例は、change-message-visibility を使用する方法を説明しています。

AWS CLI

メッセージのタイムアウトの可視性を変更するには

この例は、指定されたメッセージのタイムアウトの可視性を 10 時間 (10 時間 × 60 分 × 60 秒) に変更します。

コマンド:


aws sqs change-message-visibility --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --receipt-handle AQEBTpyI...t6HyQg== --visibility-timeout 36000

出力:


None.

API の詳細については、AWS CLI コマンドリファレンスの「ChangeMessageVisibility」を参照してください。

次の例は、create-queue を使用する方法を説明しています。

AWS CLI

キューを作成するには

この例は、指定された名前のキューを作成して、メッセージの保持期間を 3 日間 (3 日 × 24 時間 × 60 分 × 60 秒) に設定します。またキューのデッドレターキューを、最大受信数 1,000 件のメッセージを含む指定されたキューに設定します。

コマンド:


aws sqs create-queue --queue-name MyQueue --attributes file://create-queue.json

入力ファイル (create-queue.json):


{
  "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":\"1000\"}",
  "MessageRetentionPeriod": "259200"
}

出力:


{
  "QueueUrl": "https://queue.amazonaws.com/80398EXAMPLE/MyQueue"
}

API の詳細については、AWS CLI コマンドリファレンスの「CreateQueue」を参照してください。

次の例は、delete-message-batch を使用する方法を説明しています。

AWS CLI

複数のメッセージを一括削除するには

この例は、指定されたメッセージを削除します。

コマンド:


aws sqs delete-message-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://delete-message-batch.json

入力ファイル (delete-message-batch.json):


[
  {
        "Id": "FirstMessage",
        "ReceiptHandle": "AQEB1mgl...Z4GuLw=="
  },
  {
    "Id": "SecondMessage",
        "ReceiptHandle": "AQEBLsYM...VQubAA=="
  }
]

出力:


{
  "Successful": [
    {
      "Id": "FirstMessage"
    },
    {
      "Id": "SecondMessage"
    }
  ]
}

API の詳細については、AWS CLI コマンドリファレンスの「DeleteMessageBatch」を参照してください。

次の例は、delete-message を使用する方法を説明しています。

AWS CLI

単一のメッセージを削除するには

この例は、指定された単一のメッセージを削除します。

コマンド:


aws sqs delete-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --receipt-handle AQEBRXTo...q2doVA==

出力:


None.

API の詳細については、AWS CLI コマンドリファレンスの「DeleteMessage」を参照してください。

次の例は、delete-queue を使用する方法を説明しています。

AWS CLI

キューを削除するには

この例は、指定されたキューを削除します。

コマンド:


aws sqs delete-queue --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewerQueue

出力:


None.

API の詳細については、AWS CLI コマンドリファレンスの「DeleteQueue」を参照してください。

次の例は、get-queue-attributes を使用する方法を説明しています。

AWS CLI

キューの属性を取得するには

この例では、指定されたキューの属性をすべて取得します。

コマンド:


aws sqs get-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --attribute-names All

出力:


{
  "Attributes": {
    "ApproximateNumberOfMessagesNotVisible": "0",
    "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":1000}",
    "MessageRetentionPeriod": "345600",
    "ApproximateNumberOfMessagesDelayed": "0",
    "MaximumMessageSize": "262144",
    "CreatedTimestamp": "1442426968",
    "ApproximateNumberOfMessages": "0",
    "ReceiveMessageWaitTimeSeconds": "0",
    "DelaySeconds": "0",
    "VisibilityTimeout": "30",
    "LastModifiedTimestamp": "1442426968",
    "QueueArn": "arn:aws:sqs:us-east-1:80398EXAMPLE:MyNewQueue"
  }
}

この例は、指定されたキューの最大メッセージサイズと可視性タイムアウト属性のみを取得します。

コマンド:


aws sqs get-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewQueue --attribute-names MaximumMessageSize VisibilityTimeout

出力:


{
  "Attributes": {
    "VisibilityTimeout": "30",
    "MaximumMessageSize": "262144"
  }
}

API の詳細については、AWS CLI コマンドリファレンスの「GetQueueAttributes」を参照してください。

次の例は、get-queue-url を使用する方法を説明しています。

AWS CLI

キューの URL を取得するには

この例は、指定されたキューの URL を取得します。

コマンド:


aws sqs get-queue-url --queue-name MyQueue

出力:


{
  "QueueUrl": "https://queue.amazonaws.com/80398EXAMPLE/MyQueue"
}

API の詳細については、AWS CLI コマンドリファレンスの「GetQueueUrl」を参照してください。

次の例は、list-dead-letter-source-queues を使用する方法を説明しています。

AWS CLI

デッドレターソースキューを一覧表示するには

この例では、指定されたデッドレターソースキューに関連付けられているキューを一覧表示します。

コマンド:


aws sqs list-dead-letter-source-queues --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue

出力:


{
  "queueUrls": [
    "https://queue.amazonaws.com/80398EXAMPLE/MyQueue",
    "https://queue.amazonaws.com/80398EXAMPLE/MyOtherQueue"
  ]
}

API の詳細については、「AWS CLI コマンドリファレンス」の「ListDeadLetterSourceQueues」を参照してください。

次の例は、list-message-move-tasks を使用する方法を説明しています。

AWS CLI

メッセージ移動タスクを一覧表示するには

次の list-message-move-tasks の例では、指定されたキュー内の最新のメッセージ移動タスクを 2 件、一覧表示します。


aws sqs list-message-move-tasks \
    --source-arn arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue \
    --max-results 2

出力:


{
    "Results": [
        {
            "TaskHandle": "AQEB6nR4...HzlvZQ==",
            "Status": "RUNNING",
            "SourceArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue1",
            "DestinationArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue2",
            "MaxNumberOfMessagesPerSecond": 50,
            "ApproximateNumberOfMessagesMoved": 203,
            "ApproximateNumberOfMessagesToMove": 30,
            "StartedTimestamp": 1442428276921
         },

         {
            "Status": "COMPLETED",
            "SourceArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue1",
            "DestinationArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue2",
            "ApproximateNumberOfMessagesMoved": 29,
            "ApproximateNumberOfMessagesToMove": 0,
            "StartedTimestamp": 1342428272093
         }
    ]
}

詳細については、「デベロッパーガイド」の「Amazon SQS API permissions: Actions and resource reference」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListMessageMoveTasks」を参照してください。

次の例は、list-queue-tags を使用する方法を説明しています。

AWS CLI

キューのすべてのコスト配分タグを一覧表示するには

次の list-queue-tags の例では、指定されたキューに関連付けられているすべてのコスト配分タグを表示します。


aws sqs list-queue-tags \
    --queue-url https://sqs.us-west-2.amazonaws.com/123456789012/MyQueue

出力:


{
    "Tags": {
        "Team": "Alpha"
    }
}

詳細については、「Amazon Simple Queue Service 開発者ガイド」の「コスト配分タグの一覧表示」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListQueueTags」を参照してください。

次の例は、list-queues を使用する方法を説明しています。

AWS CLI

キューを一覧表示するには

この例は、すべてのキューを一覧表示します。

コマンド:


aws sqs list-queues

出力:


{
  "QueueUrls": [
    "https://queue.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue",
    "https://queue.amazonaws.com/80398EXAMPLE/MyQueue",
    "https://queue.amazonaws.com/80398EXAMPLE/MyOtherQueue",
    "https://queue.amazonaws.com/80398EXAMPLE/TestQueue1",
        "https://queue.amazonaws.com/80398EXAMPLE/TestQueue2"
  ]
}

この例は、「My」で始まるキューのみを一覧表示します。

コマンド:


aws sqs list-queues --queue-name-prefix My

出力:


{
  "QueueUrls": [
    "https://queue.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue",
    "https://queue.amazonaws.com/80398EXAMPLE/MyQueue",
    "https://queue.amazonaws.com/80398EXAMPLE/MyOtherQueue"
  ]
}

API の詳細については、AWS CLI コマンドリファレンスの「ListQueues」を参照してください。

次の例は、purge-queue を使用する方法を説明しています。

AWS CLI

キューをクリアするには

この例では、指定されたキューのすべてのメッセージを削除します。

コマンド:


aws sqs purge-queue --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewQueue

出力:


None.

API の詳細については、「AWS CLI コマンドリファレンス」の「PurgeQueue」を参照してください。

次の例は、receive-message を使用する方法を説明しています。

AWS CLI

メッセージを受信するには

この例は、最大 10 件のメッセージを受信し、使用可能なすべての属性を返します。

コマンド:


aws sqs receive-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --attribute-names All --message-attribute-names All --max-number-of-messages 10

出力:


{
  "Messages": [
    {
      "Body": "My first message.",
      "ReceiptHandle": "AQEBzbVv...fqNzFw==",
      "MD5OfBody": "1000f835...a35411fa",
      "MD5OfMessageAttributes": "9424c491...26bc3ae7",
      "MessageId": "d6790f8d-d575-4f01-bc51-40122EXAMPLE",
      "Attributes": {
        "ApproximateFirstReceiveTimestamp": "1442428276921",
        "SenderId": "AIDAIAZKMSNQ7TEXAMPLE",
        "ApproximateReceiveCount": "5",
        "SentTimestamp": "1442428276921"
      },
      "MessageAttributes": {
        "PostalCode": {
          "DataType": "String",
          "StringValue": "ABC123"
        },
        "City": {
          "DataType": "String",
          "StringValue": "Any City"
        }
      }
    }
  ]
}

この例は、次に受信可能なメッセージを受信し、PostalCode メッセージ属性に加えて、SenderId 属性と SentTimestamp 属性のみを返します。

コマンド:


aws sqs receive-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --attribute-names SenderId SentTimestamp --message-attribute-names PostalCode

出力:


{
  "Messages": [
    {
      "Body": "My first message.",
      "ReceiptHandle": "AQEB6nR4...HzlvZQ==",
      "MD5OfBody": "1000f835...a35411fa",
      "MD5OfMessageAttributes": "b8e89563...e088e74f",
      "MessageId": "d6790f8d-d575-4f01-bc51-40122EXAMPLE",
      "Attributes": {
        "SenderId": "AIDAIAZKMSNQ7TEXAMPLE",
        "SentTimestamp": "1442428276921"
      },
      "MessageAttributes": {
        "PostalCode": {
          "DataType": "String",
          "StringValue": "ABC123"
        }
      }
    }
  ]
}

API の詳細については、AWS CLI コマンドリファレンスの「ReceiveMessage」を参照してください。

次の例は、remove-permission を使用する方法を説明しています。

AWS CLI

アクセス許可を削除するには

この例では、指定されたキューから指定されたラベルを持つアクセス許可を削除します。

コマンド:


aws sqs remove-permission --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --label SendMessagesFromMyQueue

出力:


None.

API の詳細については、「AWS CLI コマンドリファレンス」の「RemovePermission」を参照してください。

次の例は、send-message-batch を使用する方法を説明しています。

AWS CLI

複数のメッセージを一括送信するには

この例は、メッセージ本文、遅延期間、およびメッセージ属性を指定した 2 つのメッセージを指定されたキューに送信します。

コマンド:


aws sqs send-message-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://send-message-batch.json

入力ファイル (send-message-batch.json):


[
  {
    "Id": "FuelReport-0001-2015-09-16T140731Z",
        "MessageBody": "Fuel report for account 0001 on 2015-09-16 at 02:07:31 PM.",
        "DelaySeconds": 10,
        "MessageAttributes": {
          "SellerName": {
            "DataType": "String",
                "StringValue": "Example Store"
      },
          "City": {
        "DataType": "String",
        "StringValue": "Any City"
      },
          "Region": {
            "DataType": "String",
                "StringValue": "WA"
      },
          "PostalCode": {
            "DataType": "String",
                "StringValue": "99065"
          },
          "PricePerGallon": {
            "DataType": "Number",
                "StringValue": "1.99"
      }
        }
  },
  {
    "Id": "FuelReport-0002-2015-09-16T140930Z",
        "MessageBody": "Fuel report for account 0002 on 2015-09-16 at 02:09:30 PM.",
        "DelaySeconds": 10,
        "MessageAttributes": {
          "SellerName": {
            "DataType": "String",
                "StringValue": "Example Fuels"
      },
          "City": {
        "DataType": "String",
        "StringValue": "North Town"
      },
          "Region": {
            "DataType": "String",
                "StringValue": "WA"
      },
          "PostalCode": {
            "DataType": "String",
                "StringValue": "99123"
          },
          "PricePerGallon": {
            "DataType": "Number",
                "StringValue": "1.87"
      }
        }
  }
]

出力:


{
  "Successful": [
    {
      "MD5OfMessageBody": "203c4a38...7943237e",
      "MD5OfMessageAttributes": "10809b55...baf283ef",
      "Id": "FuelReport-0001-2015-09-16T140731Z",
      "MessageId": "d175070c-d6b8-4101-861d-adeb3EXAMPLE"
    },
    {
      "MD5OfMessageBody": "2cf0159a...c1980595",
      "MD5OfMessageAttributes": "55623928...ae354a25",
      "Id": "FuelReport-0002-2015-09-16T140930Z",
      "MessageId": "f9b7d55d-0570-413e-b9c5-a9264EXAMPLE"
    }
  ]
}

API の詳細については、AWS CLI コマンドリファレンスの「SendMessageBatch」を参照してください。

次の例は、send-message を使用する方法を説明しています。

AWS CLI

単一のメッセージを送信するには

この例は、指定された単一のメッセージ本文、遅延期間、メッセージ属性を含むメッセージを指定されたキューに送信します。

コマンド:


aws sqs send-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --message-body "Information about the largest city in Any Region." --delay-seconds 10 --message-attributes file://send-message.json

入力ファイル (send-message.json):


{
  "City": {
    "DataType": "String",
    "StringValue": "Any City"
  },
  "Greeting": {
    "DataType": "Binary",
    "BinaryValue": "Hello, World!"
  },
  "Population": {
    "DataType": "Number",
    "StringValue": "1250800"
  }
}

出力:


{
  "MD5OfMessageBody": "51b0a325...39163aa0",
  "MD5OfMessageAttributes": "00484c68...59e48f06",
  "MessageId": "da68f62c-0c07-4bee-bf5f-7e856EXAMPLE"
}

API の詳細については、AWS CLI コマンドリファレンスの「SendMessage」を参照してください。

次の例は、set-queue-attributes を使用する方法を説明しています。

AWS CLI

キューの属性を設定するには

この例は、指定されたキューの配信遅延時間を 10 秒、最大メッセージサイズを 128 KB (128 KB × 1,024 バイト)、メッセージ保持期間を 3 日間 (3 日 × 24 時間 × 60 分 × 60 秒)、受信メッセージ待機時間を 20 秒、デフォルトの可視性タイムアウトを 60 秒に設定します。また、この例では、指定されたデッドレターキューの最大受信数を 1,000 メッセージと関連付けます。

コマンド:


aws sqs set-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewQueue --attributes file://set-queue-attributes.json

入力ファイル (set-queue-attributes.json):


{
  "DelaySeconds": "10",
  "MaximumMessageSize": "131072",
  "MessageRetentionPeriod": "259200",
  "ReceiveMessageWaitTimeSeconds": "20",
  "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":\"1000\"}",
  "VisibilityTimeout": "60"
}

出力:


None.

API の詳細については、AWS CLI コマンドリファレンスの「SetQueueAttributes」を参照してください。

次の例は、start-message-move-task を使用する方法を説明しています。

AWS CLI

例 1: *メッセージ移動タスクを開始するには*

次の start-message-move-task の例では、メッセージ移動タスクを開始して、指定されたデッドレターキューからソースキューにメッセージをリドライブします。


aws sqs start-message-move-task \
    --source-arn arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue

出力:


{
    "TaskHandle": "AQEB6nR4...HzlvZQ=="
}

詳細については、「ガイド名」の「トピックタイトル」を参照してください。

例 2: *最大速度でメッセージ移動タスクを開始するには*

次の start-message-move-task の例では、メッセージ移動タスクを開始して、指定されたデッドレターキューから指定された送信先キューに 1 秒あたり 50 件のメッセージという最大速度でメッセージをリドライブします。


aws sqs start-message-move-task \
    --source-arn arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue1 \
    --destination-arn arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue2 \
    --max-number-of-messages-per-second 50

出力:


{
    "TaskHandle": "AQEB6nR4...HzlvZQ=="
}

詳細については、「デベロッパーガイド」の「Amazon SQS API permissions: Actions and resource reference」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「StartMessageMoveTask」を参照してください。

次の例は、tag-queue を使用する方法を説明しています。

AWS CLI

コスト配分タグをキューに追加するには

次の tag-queue の例では、指定された Amazon SQS キューにコスト配分タグを追加します。


aws sqs tag-queue \
    --queue-url https://sqs.us-west-2.amazonaws.com/123456789012/MyQueue \
    --tags Priority=Highest

このコマンドでは何も出力されません。

詳細については、「Amazon Simple Queue Service 開発者ガイド」の「コスト配分タグの追加」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「TagQueue」を参照してください。

次の例は、untag-queue を使用する方法を説明しています。

AWS CLI

キューからコスト配分タグを削除するには

次の untag-queue の例では、指定された Amazon SQS キューからコスト配分タグを削除します。


aws sqs untag-queue \
    --queue-url https://sqs.us-west-2.amazonaws.com/123456789012/MyQueue \
    --tag-keys "Priority"

このコマンドでは何も出力されません。

詳細については、「Amazon Simple Queue Service 開発者ガイド」の「コスト配分タグの追加」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UntagQueue」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon SNS

Storage Gateway