Notification
特定のジョブに関連付けられている Amazon Simple Notification Service (Amazon SNS) の通知設定。Notification
オブジェクトは、DescribeJob
アクションのレスポンス構文の一部として JobMetadata
データ型で返されます。
ジョブ作成のときの通知設定で、文字列の JobStatesToNotify
配列を使用してジョブの状態の特定のセットに基づいて通知するように選択できます。または、NotifyAll
を true に設定すると、すべてのジョブの状態について Amazon SNS 通知を送信するように指定できます。
目次
- DevicePickupSnsTopicARN
-
デバイスを受け取る人に SNS 通知を送信するために使用されます (ジョブの作成時に識別されます)。
型: 文字列
長さの制限: 最大長は 255 です。
パターン:
arn:aws.*:sns:.*:[0-9]{12}:.*
必須: いいえ
- JobStatesToNotify
-
このジョブに対して通知をトリガーするジョブ状態のリスト。
型: 文字列の配列
有効な値:
New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending
必須: いいえ
- NotifyAll
-
ジョブの状態が変更されると、このジョブの通知がトリガーされます。
型: ブール
必須: いいえ
- SnsTopicARN
-
このジョブに関連付けたい新しいSNS
TopicArn
。CreateTopic Amazon SNS API アクションを使用して、トピックの Amazon リソースネーム (ARN) を作成できます。AWS Management Console からメールアドレスを登録して Amazon SNS トピック を受信できます。または、サブスクライブ Amazon Simple Notification Service (Amazon SNS) API アクションから受信登録できます。
型: 文字列
長さの制限: 最大長は 255 です。
パターン:
arn:aws.*:sns:.*:[0-9]{12}:.*
必須: いいえ
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。