Amazon SNS メッセージ属性 - Amazon Simple Notification Service

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon SNS メッセージ属性

Amazon SNS では、メッセージに関する構造化メタデータ項目(タイムスタンプ、地理空間データ、署名、識別子など)を指定できるメッセージ属性の配信をサポートしています。Amazon SNS と Amazon SQS の間の属性マッピングでは、各メッセージには最大 10 個の属性を指定できます。raw モードまたは Amazon SQS 以外のエンドポイントを使用する場合、メッセージには 10 を超える属性を指定できます。

メッセージ属性はオプションであり、メッセージ本文とは別個のものですが、同時に送信されます。受信者は、この情報を使用して、メッセージ本文を最初に処理する必要なしでメッセージを処理する方法を決定できます。

AWS Management Console または AWS SDK for Java を使用して、属性を使ってメッセージを送信する詳細については、「を使用して Amazon SNS トピックにメッセージを発行するには、AWS Management Console」チュートリアルを参照してください。

注記

メッセージ属性は、メッセージ構造が JSON ではなく String である場合にのみ送信されます。

また、モバイルエンドポイント用のプッシュ通知メッセージを構築するためにメッセージ属性を使用することもできます。このシナリオでは、メッセージ属性はプッシュ通知メッセージの構築のみに使用されます。属性は、Amazon SQS エンドポイントにメッセージ属性とともにメッセージを送信する場合とは異なります。

メッセージ属性を使用して、サブスクリプションフィルタポリシーでメッセージをフィルタリング可能にすることもできます。フィルタポリシーは、トピックのサブスクリプションに適用もできます。フィルタポリシーを適用すると、サブスクリプションは、ポリシーが受け入れる属性を持つメッセージのみを受信します。詳細については、「Amazon SNS メッセージフィルタリング」を参照してください。

メッセージ属性の項目および検証

各メッセージ属性は、次の項目で構成されています。

  • 名前— メッセージ属性名には以下の文字を含めることができます。A〜Z、a〜z、0〜9、アンダーバー (_)、ハイフン (-)、ピリオド (.)。名前の先頭と末尾をピリオドにすることはできず、ピリオドを連続して使用することはできません。名前では大文字と小文字が区別され、メッセージのすべての属性名間で一意にする必要があります。名前の長さは最大 256 文字です。名前の先頭をにすることはできません。AWS.またはAmazon.(または、大文字と小文字が異なるあらゆる変化形)。これらのプレフィックスは、Amazon Web Services で使用するために予約されているからです。

  • タイプ— サポートされるメッセージ属性のデータ型はString,String.Array,Number, およびBinary。データ型のコンテンツには、メッセージ本文と同じ制限があります。データ型では大文字と小文字が区別され、長さは最大 256 バイトです。詳細については、「メッセージ属性のデータ型と検証」セクションを参照してください。

  • — ユーザー指定のメッセージ属性値です。文字列データ型の場合、値属性のコンテンツにはメッセージ本文と同じ制限があります。詳細については、「」を参照してください。発行のアクションをAmazon Simple Notification Service API リファレンス

名前、型、値を空または Null にすることはできません。さらに、メッセージ本文を空または Null にすることもできません。メッセージ属性のすべての部分 (名前、型、値を含む) は、メッセージサイズの制限に含められます。制限は 256 KB です。

メッセージ属性のデータ型と検証

メッセージ属性のデータ型は、Amazon SNS によるメッセージ属性の処理方法を特定します。たとえば、型が数値の場合、Amazon SNS はその属性が数値であることを検証します。

Amazon SNS は、記載されている場合を除き、すべてのエンドポイントについて、次の論理データ型をサポートしています。

  • 文字列— 文字列は、UTF-8 バイナリエンコードされた Unicode です。コードの値のリストについては、http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters を参照してください。

  • 文字列配列— 複数の値を含むことができる文字列としてフォーマットされる配列です。この値は、文字列、数値、またはキーワード (truefalsenull) とすることができます。

    このデータ型は、AWS Lambdaサブスクリプション。このデータ型を Lambda エンドポイントに指定すると、Stringデータ型を、Amazon SNS が Lambda に配信する JSON ペイロードに格納します。

  • 数値— 数値は正または負の整数か、浮動小数点数です。数値には、整数、浮動小数点数、倍精度浮動小数点数が通常サポートするほとんどの値を包含できる十分な範囲と精度があります。数値は -109~109 までの値とすることができ、小数点以下 5 桁の精度を持ちます。先頭と末尾の 0 は切り捨てられます。

    このデータ型は、AWS Lambdaサブスクリプション。このデータ型を Lambda エンドポイントに指定すると、Stringデータ型を、Amazon SNS が Lambda に配信する JSON ペイロードに格納します。

  • バイナリ— バイナリ型の属性には、圧縮データ、暗号化データ、イメージなど、任意のバイナリデータが保存されます。

モバイルプッシュ通知の予約済みメッセージ属性

次の表は、プッシュ通知メッセージを構築するために使用できるモバイルプッシュ通知サービスの予約済みメッセージ属性の一覧です。

プッシュ通知サービス 予約済みメッセージ属性
ADM AWS.SNS.MOBILE.ADM.TTL
APNS AWS.SNS.MOBILE.APNS_MDM.TTL
AWS.SNS.MOBILE.APNS_MDM_SANDBOX.TTL
AWS.SNS.MOBILE.APNS_PASSBOOK.TTL
AWS.SNS.MOBILE.APNS_PASSBOOK_SANDBOX.TTL
AWS.SNS.MOBILE.APNS_SANDBOX.TTL
AWS.SNS.MOBILE.APNS_VOIP.TTL
AWS.SNS.MOBILE.APNS_VOIP_SANDBOX.TTL
AWS.SNS.MOBILE.APNS.COLLAPSE_ID
AWS.SNS.MOBILE.APNS.PRIORITY
AWS.SNS.MOBILE.APNS.PUSH_TYPE
AWS.SNS.MOBILE.APNS.TOPIC
AWS.SNS.MOBILE.APNS.TTL
AWS.SNS.MOBILE.PREFERRED_AUTHENTICATION_METHOD

Baidu

AWS.SNS.MOBILE.BAIDU.DeployStatus
AWS.SNS.MOBILE.BAIDU.MessageKey
AWS.SNS.MOBILE.BAIDU.MessageType
AWS.SNS.MOBILE.BAIDU.TTL
FCM AWS.SNS.MOBILE.FCM.TTL
AWS.SNS.MOBILE.GCM.TTL
macOS AWS.SNS.MOBILE.MACOS_SANDBOX.TTL
AWS.SNS.MOBILE.MACOS.TTL

MPNS

AWS.SNS.MOBILE.MPNS.NotificationClass
AWS.SNS.MOBILE.MPNS.TTL

AWS.SNS.MOBILE.MPNS.Type

WNS AWS.SNS.MOBILE.WNS.CachePolicy
AWS.SNS.MOBILE.WNS.Group
AWS.SNS.MOBILE.WNS.Match
AWS.SNS.MOBILE.WNS.SuppressPopup
AWS.SNS.MOBILE.WNS.Tag
AWS.SNS.MOBILE.WNS.TTL
AWS.SNS.MOBILE.WNS.Type