1.16. バケット通知

手順

1. 以下の要求形式でトピックを作成します。

   構文

   POST
   Action=CreateTopic
   &Name=TOPIC_NAME
   [&Attributes.entry.1.key=amqp-exchange&Attributes.entry.1.value=EXCHANGE]
   [&Attributes.entry.2.key=amqp-ack-level&Attributes.entry.2.value=none|broker|routable]
   [&Attributes.entry.3.key=verify-ssl&Attributes.entry.3.value=true|false]
   [&Attributes.entry.4.key=kafka-ack-level&Attributes.entry.4.value=none|broker]
   [&Attributes.entry.5.key=use-ssl&Attributes.entry.5.value=true|false]
   [&Attributes.entry.6.key=ca-location&Attributes.entry.6.value=FILE_PATH]
   [&Attributes.entry.7.key=OpaqueData&Attributes.entry.7.value=OPAQUE_DATA]
   [&Attributes.entry.8.key=push-endpoint&Attributes.entry.8.value=ENDPOINT]

   リクエストパラメーターを以下に示します。

   • Endpoint: 通知を送信するエンドポイントの URL。
   • OpaqueData: 不透明なデータはトピック設定で設定され、トピックによって発生するすべての通知に追加されます。

   • HTTP エンドポイント:

     • URL: http[s]://FQDN[: PORT ]
     • ポートのデフォルト: HTTP または HTTPS にそれぞれ 80 または 443 を使用します。
     • verify-ssl: サーバー証明書がクライアントによって検証されているかどうかを示します。デフォルトでは true です。

   • AMQP0.9.1 エンドポイント:

     • URL: amqp://[USER : PASSWORD @] FQDN [: PORT][/VHOST].
     • ユーザーおよびグループのデフォルト値はそれぞれ guest と guest です。
     • ユーザーおよびパスワードは、HTTPS でのみ提供できます。そうしないと、トピック作成要求は拒否されます。
     • Port のデフォルト値 は 5672 です。
     • vhost のデフォルトは/です。
     • amqp-exchange: 交換は存在し、トピックに基づいてメッセージをルーティングできる必要があります。これは AMQP0.9.1 の必須パラメーターです。同じエンドポイントを参照するさまざまなトピックが同じ交換を使用する必要があります。

     • amqp-ack-level: 最終宛先に送信される前にメッセージがブローカーで永続化される可能性があるため、終了確認は不要です。確認方法は 3 つあります。

       • none: ブローカーに送信された場合にメッセージが 配信されている と見なされます。
       • broker: デフォルトでは、メッセージはブローカーによって確認応答されると 配信されている と見なされます。

       • routable: ブローカーがコンシューマーにルーティングできる場合、メッセージは 配信されている と見なされます。

         注記

         特定のパラメーターのキーと値は、同じ行または特定の順序で存在する必要はありませんが、同じインデックスを使用する必要があります。属性インデックスは、特定の値から順番にしたり、開始したりする必要はありません。

         注記

         topic-name は AMQP トピックに使用されます。

   • Kafka エンドポイント:

     • URL: kafka://[USER: PASSWORD @] FQDN[: PORT].
     • use-ssl がデフォルトで false に設定される場合。use-ssl が true に設定されている場合は、ブローカーへの接続にセキュアな接続が使用されます。
     • ca-location が指定され、セキュアな接続が使用される場合は、ブローカーを認証するために、デフォルトの CA ではなく、指定された CA が使用されます。
     • ユーザーおよびパスワードは HTTP[S] でのみ提供できます。そうでない場合、トピック作成リクエストは拒否されます。
     • ユーザーおよびパスワードは use-ssl とのみ提供でき、ブローカーへの接続に失敗していました。
     • Port のデフォルト値 は 9092 です。

     • kafka-ack-level: 最終宛先に送信される前にメッセージがブローカーで永続化される可能性があるため、終了確認は不要です。確認方法は 2 つあります。

       • none: ブローカーに送信された場合にメッセージが 配信されている と見なされます。
       • broker: デフォルトでは、メッセージはブローカーによって確認応答されると 配信されている と見なされます。

2. 次の形式でレスポンスを作成します。

   構文

   <CreateTopicResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
       <CreateTopicResult>
           <TopicArn></TopicArn>
       </CreateTopicResult>
       <ResponseMetadata>
           <RequestId></RequestId>
       </ResponseMetadata>
   </CreateTopicResponse>

   注記

   レスポンスのトピックの Amazon Resource Name (ARN) の形式は、arn:aws:sns:ZONE_GROUP:TENANT:TOPIC になります。

   以下は AMQP0.9.1 エンドポイントの例になります。

   構文

   "client.create_topic(Name='my-topic' , Attributes={'push-endpoint': 'amqp://127.0.0.1:5672', 'amqp-exchange': 'ex1', 'amqp-ack-level': 'broker'})"

手順

1. 以下の要求形式でトピック情報を取得します。

   構文

   POST
   Action=GetTopic
   &TopicArn=TOPIC_ARN

   レスポンスフォーマットの例を以下に示します。

   <GetTopicResponse>
     <GetTopicRersult>
       <Topic>
         <User>
         </User>
         <Name>
         </Name>
         <EndPoint>
           <EndpointAddress>
           </EndpointAddress>
           <EndpointArgs>
           </EndpointArgs>
           <EndpointTopic>
           </EndpointTopic>
         </EndPoint>
         <TopicArn>
         </TopicArn>
         <OpaqueData>
         </OpaqueData>
       </Topic>
     </GetTopicResult>
     <ResponseMetadata>
       <RequestId>
       </RequestId>
     </ResponseMetadata>
   </GetTopicResponse>

   タグおよびその定義を以下に示します。

   • User: トピックを作成したユーザーの名前。
   • Name: トピックの名前。
   • EndpointAddress: エンドポイントの URL。エンドポイント URL にユーザーおよびパスワード情報が含まれる場合、リクエストは HTTPS 経由で行う必要があります。そうでない場合、トピックの取得要求は拒否されます。
   • EndPointArgs: エンドポイント引数。
   • EndpointTopic: エンドポイントに送信されるトピック名は、上記のトピック名とは異なる場合があります。
   • TopicArn: Topic ARN。

手順

1. 以下の要求形式でトピック情報を一覧表示します。

   POST
   Action=ListTopics

   レスポンスフォーマットの例を以下に示します。

   <ListTopicdResponse xmlns="https://sns.amazonaws.com/doc/2020-03-31/">
     <ListTopicsRersult>
       <Topics>
         <member>
           <User>
           </User>
           <Name>
           </Name>
           <EndPoint>
             <EndpointAddress>
             </EndpointAddress>
             <EndpointArgs>
             </EndpointArgs>
             <EndpointTopic>
             </EndpointTopic>
           </EndPoint>
           <TopicArn>
           </TopicArn>
           <OpaqueData>
           </OpaqueData>
         </member>
       </Topics>
     </ListTopicsResult>
     <ResponseMetadata>
       <RequestId>
       </RequestId>
     </ResponseMetadata>
   </ListTopicsResponse>

   注記

   エンドポイント URL にユーザーおよびパスワード情報が含まれる場合は、トピックのいずれかで要求を行う必要があります。そうでない場合、トピック一覧の要求は拒否されます。

手順

1. 以下の要求形式でトピックを削除します。

   構文

   POST
   Action=DeleteTopic
   &TopicArn=TOPIC_ARN

   レスポンスフォーマットの例を以下に示します。

   <DeleteTopicResponse xmlns="https://sns.amazonaws.com/doc/2020-03-31/">
     <ResponseMetadata>
       <RequestId>
       </RequestId>
     </ResponseMetadata>
   </DeleteTopicResponse>