Amazon SNS 4.7 Connector リファレンス

設定


デフォルト設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Globally Defined Default Topic ARN (グローバルに定義されるデフォルトトピック ARN)。

String (文字列)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

接続種別

Basic (基本)
パラメーター
名前 説明 デフォルト値 必須

Session Token (セッショントークン)

String (文字列)

AWS Security Token Service (STS) が提供するセッショントークン。

Test Topic (トピックをテスト)

String (文字列)

接続のテストに使用するトピック。

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがギブアップまたはタイムアウトする前に、接続を最初に確立するのを待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Max Connections (最大接続数)

Number (数値)

許可される開いた HTTP 接続の最大数を設定します。

Socket Timeout (ソケットタイムアウト)

Number (数値)

接続がタイムアウトする前に、確立または開いた接続でのデータの転送を待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Access Key (アクセスキー)

String (文字列)

Amazon が提供するアクセスキー。

x

Secret Key (シークレットキー)

String (文字列)

Amazon が提供するシークレットキー。

x

Try Default AWSCredentials Provider Chain (デフォルトの AWSCredentials プロバイダーチェーンを試す)

Boolean (ブール)

AWS 環境からログイン情報を取得するには、この項目を ​true​ に設定します。 「SDK への一時的な認証情報の提供」​を参照してください。

false

Region Endpoint (リージョンエンドポイント)

String (文字列)

トピックリージョンエンドポイントを設定します。

US_EAST_1

Custom Service Endpoint (カスタムサービスエンドポイント)

String (文字列)

カスタムサービスエンドポイントを設定します。VPC エンドポイントなど、非標準のサービスエンドポイントが必要な場合に役立ちます。ローカル接続の場合、この項目を ​http://localhost:8000/​ に設定します。

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Host (ホスト)

String (文字列)

省略可能なプロキシホスト。

Port (ポート)

Number (数値)

省略可能なプロキシポート。

Username (ユーザー名)

String (文字列)

省略可能なプロキシユーザー名。

Password (パスワード)

String (文字列)

省略可能なプロキシパスワード。

Domain (ドメイン)

String (文字列)

省略可能なプロキシドメイン。

Workstation (ワークステーション)

String (文字列)

省略可能なプロキシワークステーション。

Role (ロール)
パラメーター
名前 説明 デフォルト値 必須

Role ARN (ロール ARN)

String (文字列)

ロール ARN は、クロスアカウントアクセスを取得することを前提とするロールを一意に特定します。

x

Custom STS Endpoint (カスタム SQS エンドポイント)

String (文字列)

カスタム STS エンドポイントを設定します。VPC エンドポイントなど、非標準のサービスエンドポイントが必要な場合に役立ちます。

Test Topic ARN (トピック ARN をテスト)

String (文字列)

接続のテストに使用するトピック。

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがギブアップまたはタイムアウトする前に、接続を最初に確立するのを待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Max Connections (最大接続数)

Number (数値)

許可される開いた HTTP 接続の最大数を設定します。

Socket Timeout (ソケットタイムアウト)

Number (数値)

接続がタイムアウトする前に、確立または開いた接続でのデータの転送を待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Access Key (アクセスキー)

String (文字列)

Amazon が提供するアクセスキー。

x

Secret Key (シークレットキー)

String (文字列)

Amazon が提供するシークレットキー。

x

Try Default AWSCredentials Provider Chain (デフォルトの AWSCredentials プロバイダーチェーンを試す)

Boolean (ブール)

AWS 環境からログイン情報を取得するには、この項目を ​true​ に設定します。 「SDK への一時的な認証情報の提供」​を参照してください。

false

Region Endpoint (リージョンエンドポイント)

String (文字列)

トピックリージョンエンドポイントを設定します。

US_EAST_1

Custom Service Endpoint (カスタムサービスエンドポイント)

String (文字列)

カスタムサービスエンドポイントを設定します。VPC エンドポイントなど、非標準のサービスエンドポイントが必要な場合に役立ちます。ローカル接続の場合、この項目を ​http://localhost:8000/​ に設定します。

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Host (ホスト)

String (文字列)

省略可能なプロキシホスト。

Port (ポート)

Number (数値)

省略可能なプロキシポート。

Username (ユーザー名)

String (文字列)

省略可能なプロキシユーザー名。

Password (パスワード)

String (文字列)

省略可能なプロキシパスワード。

Domain (ドメイン)

String (文字列)

省略可能なプロキシドメイン。

Workstation (ワークステーション)

String (文字列)

省略可能なプロキシワークステーション。

操作

Add Permission

<sns:add-permission>

ステートメントをトピックのアクセス制御ポリシーに追加し、指定されたアクションへのアクセス権を指定の AWS アカウントに付与します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Arn (トピック ARN)

String (文字列)

アクセス制御ポリシーを変更するトピックの ARN。

x

Label (表示ラベル)

String (文字列)

新しいポリシーステートメントの一意の識別子。

x

Account Ids (アカウント ID)

Array of String (文字列の配列)

指定されたアクションへのアクセス権を付与するユーザー (プリンシパル) の AWS アカウント ID。ユーザーには AWS アカウントが必要ですが、このサービスにサインアップする必要はありません。

x

Action Names (アクション名)

Array of String (文字列の配列)

指定されたプリンシパルに許可するアクション。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Confirm Subscription

<sns:confirm-subscription>

confirmSubscription アクションは、以前の Subscribe アクションでエンドポイントに送信されたトークンを検証して、エンドポイントのオーナーにメッセージを受信する意思があるかどうかを確認します。トークンが有効な場合、このアクションは新しいサブスクリプションを作成し、その Amazon リソース名 (ARN) を返します。AuthenticateOnUnsubscribe フラグが ​true​ に設定されている場合にのみ、このコールで AWS 署名が必要になります。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Arn (トピック ARN)

String (文字列)

サブスクリプションを確認するトピックの ARN。

x

Token (トークン)

String (文字列)

Subscribe​ アクション中にエンドポイントに送信される有効期間の短いトークン。

x

Authenticate On Unsubscribe (サブスクライブ解除時に認証)

String (文字列)

サブスクリプションの未認証のサブスクライブ解除を許可しません。このパラメーターの値が ​true​ で、要求に AWS 署名が含まれている場合、トピックのオーナーとサブスクリプションのオーナーのみがエンドポイントをサブスクライブ解除できます。unsubscribe アクションでは、AWS 認証が必要です。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Create Platform Application

<sns:create-platform-application>

デバイスやモバイルアプリケーションを登録できるいずれかのサポート対象プッシュ通知サービス (APNS (Apple Push Notification Service) や GCM (Google Cloud Messaging) など) のプラットフォームアプリケーションオブジェクトを作成します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Name (名前)

String (文字列)

アプリケーション名は、大文字と小文字の ASCII 文字、数値、アンダースコア、ハイフン、ピリオドで構成されている必要があり、1 ~ 256 文字にする必要があります。

x

プラットフォーム

String (文字列)

ADM (Amazon Device Messaging)、APNS (Apple Push Notification Service)、​APNS_SANDBOX​、GCM (Google Cloud Messaging) のプラットフォームがサポートされています。

x

Attributes (属性)

Object (オブジェクト)

属性のリスト。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Create Platform Endpoint

<sns:create-platform-endpoint>

いずれかのサポート対象プッシュ通知サービスのデバイスやモバイルアプリケーションのエンドポイントを作成します。CreatePlatformEndpoint では、CreatePlatformApplication から返される PlatformApplicationArn が必要です。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Platform Application Arn (プラットフォームアプリケーション ARN)

String (文字列)

CreatePlatformApplication から返される PlatformApplicationArn は、エンドポイントを作成するために使用されます。

x

Token (トークン)

String (文字列)

デバイスのアプリケーションの通知サービスによって作成される一意の識別子。トークンの特定の名前は、使用されている通知サービスによって異なります。たとえば、通知サービスとして APNS (Apple Push Notification Service) を使用する場合、デバイストークンが必要です。GCM (Google Cloud Messaging) または ADM (Amazon Device Messaging) を使用する場合、登録 ID がデバイストークンに相当します。

x

Custom User Data (カスタムユーザーデータ)

String (文字列)

エンドポイントに関連付ける任意のユーザーデータ。Amazon SNS はこのデータを使用しません。データは UTF-8 形式で 2KB 未満にする必要があります。

x

Attributes (属性)

Object (オブジェクト)

属性のリスト。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Create Topic

<sns:create-topic>

CreateTopic アクションは、通知をパブリッシュできるトピックを作成します。ユーザーは、最大 100 件のトピックを作成できます。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Name (トピック名)

String (文字列)

トピックの名前。最大 256 文字。英数字、ハイフン、およびアンダースコアのみを含めることができます。FIFO トピック名は ​.fifo​ で終わる必要があります。

x

Content Based Deduplication (内容ベースの重複排除)

Boolean (ブール)

FIFO トピックの内容ベースの重複排除を有効にします。FIFO トピックを作成し、このパラメーターを ​false​ に設定する場合、​[Publish]​ 操作の ​[Message Deduplication Id (メッセージ重複排除 ID)]​ パラメーターの値を指定する必要があります。このパラメーターを ​true​ に設定すると、Amazon SNS は SHA-256 ハッシュを使用し、メッセージの本文 (メッセージの属性ではない) を使用してメッセージ重複排除 ID を生成します。

true

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Delete Endpoint

<sns:delete-endpoint>

Amazon SNS からデバイスやモバイルアプリケーションのエンドポイントを削除します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Endpoint Arn (エンドポイント ARN)

String (文字列)

削除するエンドポイントの EndpointArn。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Delete Platform Application

<sns:delete-platform-application>

いずれかのサポート対象プッシュ通知サービス (APNS (Apple Push Notification Service) や GCM (Google Cloud Messaging) など) のプラットフォームアプリケーションオブジェクトを削除します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Platform Application Arn (プラットフォームアプリケーション ARN)

String (文字列)

削除するプラットフォームアプリケーションオブジェクトの PlatformApplicationArn。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Delete Topic

<sns:delete-topic>

DeleteTopic アクションは、トピックとそのすべてのサブスクリプションを削除します。トピックを削除すると、以前にトピックに送信された一部のメッセージがサブスクライバーに配信されなくなる可能性があります。このアクションは羃等であるため、存在しないトピックを削除しても、エラーにはなりません。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Arn (トピック ARN)

String (文字列)

削除するトピックの ARN。

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Get Endpoint Attributes

<sns:get-endpoint-attributes>

いずれかのサポート対象プッシュ通知サービス (GCM (Google Cloud Messaging) や APNS (Apple Push Notification Service) など) のデバイスのエンドポイント属性を取得します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Endpoint Arn (エンドポイント ARN)

String (文字列)

GetEndpointAttributes 入力の EndpointArn。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Get Platform Application Attributes

<sns:get-platform-application-attributes>

サポート対象プッシュ通知サービス (APNS (Apple Push Notification Service) や GCM (Google Cloud Messaging) など) のプラットフォームアプリケーションオブジェクトの属性を取得します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Platform Application Arn (プラットフォームアプリケーション ARN)

String (文字列)

GetPlatformApplicationAttributesInput の PlatformApplicationArn。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Get Subscription Attributes

<sns:get-subscription-attributes>

GetSubscriptionAttributes アクションは、サブスクリプションのすべてのプロパティを返します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription Arn (サブスクリプション ARN)

String (文字列)

取得するプロパティのサブスクリプションの ARN。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Get Topic Attributes

<sns:get-topic-attributes>

GetTopicAttributes アクションは、トピックのすべてのプロパティを返します。返されるトピックプロパティは、ユーザーの認証によって異なる可能性があります。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Arn (トピック ARN)

String (文字列)

取得するプロパティのトピックの ARN。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

List Endpoints By Platform Application

<sns:list-endpoints-by-platform-application>

サポート対象プッシュ通知サービス (GCM (Google Cloud Messaging) や APNS (Apple Push Notification Service) など) のデバイスのエンドポイントとエンドポイント属性をリストします。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Arn

String (文字列)

プラットフォームアプリケーションの ARN。

x

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

[​エンドポイント​] ペイロードと [​Request ID Attribute (要求 ID 属性)​] 属性のメッセージの配列

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:UNDEFINED_TOPIC

  • SNS:INTERNAL_ERROR

  • SNS:NOT_FOUND

  • SNS:THROTTLED

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:PLATFORM_APPLICATION_DISABLED

  • SNS:AUTHORIZATION_ERROR

List Platform Applications

<sns:list-platform-applications>

サポート対象プッシュ通知サービス (APNS (Apple Push Notification Service) や GCM (Google Cloud Messaging) など) のプラットフォームアプリケーションオブジェクトをリストします。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

[​Platform Application (プラットフォームアプリケーション)​] ペイロードと [​Request ID Attribute (要求 ID 属性)​] 属性のメッセージの配列

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:UNDEFINED_TOPIC

  • SNS:INTERNAL_ERROR

  • SNS:NOT_FOUND

  • SNS:THROTTLED

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:PLATFORM_APPLICATION_DISABLED

  • SNS:AUTHORIZATION_ERROR

List Subscriptions

<sns:list-subscriptions>

ListSubscriptions アクションは、リクエスターのサブスクリプションのリストを返します。各コールは、最大 100 件に制限されたサブスクリプションのリストを返します。それ以上のサブスクリプションがある場合、NextToken も返されます。新しい ListSubscriptions コールで NextToken パラメーターを使用して、さらに結果を取得します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

[​Subscription (サブスクリプション)​] ペイロードと [​Request ID Attribute (要求 ID 属性)​] 属性のメッセージの配列

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:UNDEFINED_TOPIC

  • SNS:INTERNAL_ERROR

  • SNS:NOT_FOUND

  • SNS:THROTTLED

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:PLATFORM_APPLICATION_DISABLED

  • SNS:AUTHORIZATION_ERROR

List Subscriptions By Topic

<sns:list-subscriptions-by-topic>

SubscriptionsByTopic アクションは、特定のトピックへのサブスクリプションのリストを返します。各コールは、最大 100 件に制限されたサブスクリプションのリストを返します。それ以上のサブスクリプションがある場合、NextToken も返されます。新しい SubscriptionsByTopic コールで NextToken パラメーターを使用して、さらに結果を取得します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Arn

String (文字列)

トピックの ARN。

x

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

[​Subscription (サブスクリプション)​] ペイロードと [​Request ID Attribute (要求 ID 属性)​] 属性のメッセージの配列

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:UNDEFINED_TOPIC

  • SNS:INTERNAL_ERROR

  • SNS:NOT_FOUND

  • SNS:THROTTLED

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:PLATFORM_APPLICATION_DISABLED

  • SNS:AUTHORIZATION_ERROR

List Topics

<sns:list-topics>

ListTopics アクションは、リクエスターのトピックのリストを返します。各コールは、最大 100 件に制限されたトピックのリストを返します。それ以上のトピックがある場合、NextToken も返されます。新しい ListTopics コールで NextToken パラメーターを使用して、さらに結果を取得します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

[String] ペイロードと [​Request ID Attribute (要求 ID 属性)​] 属性のメッセージの配列

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:UNDEFINED_TOPIC

  • SNS:INTERNAL_ERROR

  • SNS:NOT_FOUND

  • SNS:THROTTLED

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:PLATFORM_APPLICATION_DISABLED

  • SNS:AUTHORIZATION_ERROR

Publish

<sns:publish>

Publish アクションは、メッセージをすべてのトピックのサブスクライブされたエンドポイントに送信します。返された messageId はメッセージが保存されていることを示し、Amazon SNS はすぐにそのメッセージをトピックのサブスクライバーに配信しようとします。サブスクライブされた各エンドポイントへの送信メッセージの形式は、選択した通知プロトコルによって異なります。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

FIFO パラメーター

FIFO トピックに関連するパラメーター。

Message (メッセージ)

String (文字列)

トピックに送信するメッセージ。

#[payload]

Subject (件名)

String (文字列)

メッセージがメールエンドポイントに配信されるときの「件名」行として使用されるパラメーター (省略可能)。この項目は、他のエンドポイントに配信される標準 JSON メッセージにも含まれます (存在する場合)。

Message Structure (メッセージ構造)

String (文字列)

プロトコルごとに異なるメッセージを送信する場合、MessageStructure を ​json​ に設定します。

Message Attributes (メッセージ属性)

Object (オブジェクト)

Amazon Simple Notification Service の開発者ガイド​で説明されている Amazon SNS メッセージ属性。

Topic Arn (トピック ARN)

String (文字列)

パブリッシュするトピックの Amazon リソース名 (ARN)。この項目と [Target Arn (対象 ARN)] 項目は相互に排他的です。

Target Arn (対象 ARN)

String (文字列)

パブリッシュするプラットフォームエンドポイントの Amazon リソース名 (ARN)。この項目と [Topic Arn (トピック ARN)] 項目は相互に排他的です。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Remove Permission

<sns:remove-permission>

RemovePermission アクションは、トピックのアクセス制御ポリシーからステートメントを削除します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Arn (トピック ARN)

String (文字列)

アクセス制御ポリシーを変更するトピックの ARN。

x

Label (表示ラベル)

String (文字列)

削除するステートメントの一意の表示ラベル。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Set Endpoint Attributes

<sns:set-endpoint-attributes>

いずれかのサポート対象プッシュ通知サービス (GCM (Google Cloud Messaging) や APNS (Apple Push Notification Service) など) のデバイスのエンドポイント属性を設定します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

エンドポイント

SetEndpointAttributes 操作に対するパラメーターのコンテナ。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Set Platform Application Attributes

<sns:set-platform-application-attributes>

サポート対象プッシュ通知サービス (APNS (Apple Push Notification Service) や GCM (Google Cloud Messaging) など) のプラットフォームアプリケーションオブジェクトの属性を設定します。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Platform Application Attributes (プラットフォームアプリケーション属性)

SetPlatformApplicationAttributes 操作に対するパラメーターのコンテナ。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Set Subscription Attributes

<sns:set-subscription-attributes>

SubscriptionAttributes アクションは、サブスクリプションのオーナーがトピックの属性に新しい値を設定できるようにします。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription Arn (サブスクリプション ARN)

String (文字列)

サブスクリプションの ARN。

x

Attribute Name (属性名)

String (文字列)

属性の名前。

x

Attribute Value (属性値)

String (文字列)

属性の値。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Set Topic Attributes

<sns:set-topic-attributes>

TopicAttributes アクションは、トピックオーナーがトピックの属性に新しい値を設定できるようにします。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Arn (トピック ARN)

String (文字列)

トピックの ARN。

x

Attribute Name (属性名)

String (文字列)

属性の名前。

x

Attribute Value (属性値)

String (文字列)

属性の値。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Subscribe

<sns:subscribe>

Subscribe アクションは、エンドポイントに確認メッセージを送信してエンドポイントをサブスクライブする準備をします。実際にサブスクリプションを作成するには、エンドポイントのオーナーは確認メッセージのトークンを使用して confirmSubscription アクションをコールする必要があります。確認トークンは 3 日間有効です。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Topic Arn (トピック ARN)

String (文字列)

サブスクライブするトピックの ARN。

x

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

  • EMAIL

  • EMAIL_JSON​

  • SMS

  • SQS

  • APPLICATION

  • LAMBDA

使用するプロトコル。これが FIFO トピックの場合、Amazon SQS FIFO キューのみをサブスクライバーとすることができます。

x

エンドポイント

String (文字列)

通知を受信するエンドポイント。エンドポイントはプロトコルによって異なります。

  • HTTP - エンドポイントは ​http://​ で始まる URL になります。

  • HTTPS - エンドポイントは ​https://​ で始まる URL になります。

  • EMAIL - エンドポイントはメールアドレスになります。

  • EMAIL_JSON​ - エンドポイントはメールアドレスになります。

  • SMS - エンドポイントは SMS 対応デバイスの電話番号になります。

  • SQS - エンドポイントは Amazon SQS キューの ARN になります。

  • APPLICATION - エンドポイントはモバイルアプリケーションやデバイスのエンドポイントになります。

  • LAMBDA - エンドポイントは AWS Lambda 関数の ARN になります。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

Unsubscribe

<sns:unsubscribe>

Unsubscribe アクションは、サブスクリプションを削除します。サブスクリプションで削除の認証が必要な場合、サブスクリプションのオーナーまたはトピックのオーナーのみがサブスクライブ解除でき、AWS 署名が必要になります。Unsubscribe コールで認証が必要なく、リクエスターがサブスクリプションのオーナーでない場合、最終キャンセルメッセージがエンドポイントに配信されるため、Unsubscribe 要求が意図したものでなかった場合にエンドポイントのオーナーは簡単にトピックに再サブスクライブできます。 Amazon SNS API リファレンス​を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription Arn (サブスクリプション ARN)

String (文字列)

削除するサブスクリプションの ARN。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • SNS:INVALID_PARAMETER_VALUE

  • SNS:INVALID_PARAMETER

  • SNS:INTERNAL_ERROR

  • SNS:CONNECTIVITY

  • SNS:THROTTLED

  • SNS:TOPIC_LIMIT_EXCEEDED

  • SNS:AUTHORIZATION_ERROR

  • SNS:UNDEFINED_TOPIC

  • SNS:NOT_FOUND

  • SNS:SUBSCRIPTION_LIMIT_EXCEEDED

  • SNS:ENDPOINT_DISABLED

  • SNS:UNKNOWN

  • SNS:RETRY_EXHAUSTED

  • SNS:PLATFORM_APPLICATION_DISABLED

TLS

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

サーバーの場合、トラストストアには信頼済みのクライアントの証明書が格納されています。クライアントの場合、トラストストアには信頼済みサーバーの証明書が格納されています。

Key Store (キーストア)

サーバーの場合、キーストアにはサーバーの非公開キーと公開キーが格納されています。クライアントの場合、キーストアにはクライアントの非公開キーと公開キーが格納されています。

Revocation Check (取り消し確認)

証明書が失効したことを検証します。

トラストストア

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所。このパスは、可能であれば、現在のクラスパスとファイルシステムに対して解決されます。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true​ の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所。このパスは、可能であれば、現在のクラスパスとファイルシステムに対して解決されます。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、ファイルにある最初のキーがデフォルトで使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続を試みる回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

unsubscribe

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

Request ID Attribute (要求 ID 属性)

項目 説明 デフォルト値 必須

Request Id (要求 ID)

String (文字列)

エンドポイント

項目 説明 デフォルト値 必須

Attributes (属性)

Object (オブジェクト)

Endpoint Arn (エンドポイント ARN)

String (文字列)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームを使用し、ランダムアクセスを提供するために初期状態でメモリ内に保持が許容されるインスタンスの量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

メモリ内に保持されるインスタンスの最大数。これ以上の量が必要な場合、ディスク上のコンテンツがバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Platform Application (プラットフォームアプリケーション)

項目 説明 デフォルト値 必須

Attributes (属性)

Object (オブジェクト)

Platform Application Arn (プラットフォームアプリケーション ARN)

String (文字列)

Subscription (サブスクリプション)

項目 説明 デフォルト値 必須

エンドポイント

String (文字列)

Owner (オーナー)

String (文字列)

Protocol (プロトコル)

String (文字列)

Subscription Arn (サブスクリプション ARN)

String (文字列)

Topic Arn (トピック ARN)

String (文字列)

FIFO パラメーター

項目 説明 デフォルト値 必須

Message Group Id (メッセージグループ ID)

String (文字列)

メッセージが属している場所を指定するトークン。

x

Message Deduplication Id (メッセージ重複排除 ID)

String (文字列)

メッセージを重複排除するためのトークン。重複排除がトピックレベルで設定されていない場合、この ID は必須です。