Amazon Simple Notification Service
開発者ガイド (API バージョン 2010-03-31)

Amazon SNS モバイルプッシュ API の使用

Amazon SNS モバイルプッシュ API を使用するには、まず、プッシュ通知サービス (Apple Push Notification Service (APNS)、Android 用 Google クラウドメッセージング (GCM) など) の前提条件を満たす必要があります。前提条件の詳細については、「前提条件」を参照してください。

API を使用してモバイルアプリケーションおよびデバイスにプッシュ通知メッセージを送信するには、まず、CreatePlatformApplication アクションを使用する必要があります。このアクションは、PlatformApplicationArn 属性を返します。この PlatformApplicationArn 属性は、CreatePlatformEndpoint によって使用され、EndpointArn 属性が返されます。この EndpointArn 属性と Publish アクションを使用して、モバイルアプリやデバイスに通知メッセージを送信することができます。また、EndpointArn 属性と Subscribe アクションを使って、トピックへのサブスクリプションを行うこともできます。詳細については、「Amazon SNS モバイルプッシュを使用するために必要な手順の概要」を参照してください。

Amazon SNS モバイルプッシュ API は次のとおりです。

CreatePlatformApplication

デバイスやモバイルアプリケーションを登録できる、サポートされているプッシュ通知サービス (APNS、GCM など) のいずれかのプラットフォームアプリケーションオブジェクトを作成します。PlatformApplicationArn 属性を返します。この属性は、CreatePlatformEndpoint アクションで使用されます。

CreatePlatformEndpoint

サポートされているプッシュ通知サービスのいずれかでデバイスおよびモバイルアプリケーションのエンドポイントを作成します。CreatePlatformEndpoint は、CreatePlatformApplication アクションから返される PlatformApplicationArn 属性を使用します。CreatePlatformEndpoint を使用したときに返される EndpointArn 属性は、モバイルアプリケーションとデバイスに通知メッセージを送信するために Publish アクションで使用されます。

CreateTopic

メッセージが発行されるトピックを作成します。

DeleteEndpoint

サポートされているプッシュ通知サービスのいずれかでデバイスおよびモバイルアプリケーションのエンドポイントを削除します。

DeletePlatformApplication

プラットフォームアプリケーションオブジェクトを削除します。

DeleteTopic

トピックとすべてのサブスクリプションを削除します。

GetEndpointAttributes

デバイスおよびモバイルアプリケーションのエンドポイント属性を取得します。

GetPlatformApplicationAttributes

プラットフォームアプリケーションオブジェクトの属性を取得します。

ListEndpointsByPlatformApplication

サポートされているプッシュ通知サービスでのデバイスおよびモバイルアプリケーションのエンドポイントとエンドポイント属性を一覧表示します。

ListPlatformApplications

サポートされているプッシュ通知サービス用のプラットフォームアプリケーションオブジェクトを一覧表示します。

Publish

トピックのサブスクライブされたエンドポイントすべてに通知メッセージを送信します。

SetEndpointAttributes

デバイスおよびモバイルアプリケーションのエンドポイントの属性を設定します。

SetPlatformApplicationAttributes

プラットフォームアプリケーションオブジェクトの属性を設定します。

Subscribe

エンドポイントに確認メッセージを送信して、エンドポイントのサブスクライブに備えます。 実際にサブスクリプションを作成するには、エンドポイントの所有者は確認メッセージからトークンと共に ConfirmSubscription アクションを呼び出す必要があります。

Unsubscribe

サブスクリプションを削除します。