Skip to content

Notification

Source code in docs_src/capo_snowball/types/notification.py
class Notification(TypedDict, closed=True):
    sns_topic_arn: NotRequired["capo_snowball.types.sns_topic_arn.SnsTopicARN"]
    """<p>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action.</p> <p>You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> Amazon Simple Notification Service (Amazon SNS) API action.</p>"""
    job_states_to_notify: NotRequired["capo_snowball.types.job_state_list.JobStateList"]
    """<p>The list of job states that will trigger a notification for this job.</p>"""
    notify_all: "capo_snowball.types.boolean.Boolean"
    """<p>Any change in job state will trigger a notification for this job.</p>"""
    device_pickup_sns_topic_arn: NotRequired[
        "capo_snowball.types.sns_topic_arn.SnsTopicARN"
    ]
    """<p>Used to send SNS notifications for the person picking up the device (identified during job creation).</p>"""

device_pickup_sns_topic_arn instance-attribute

device_pickup_sns_topic_arn: NotRequired[SnsTopicARN]

Used to send SNS notifications for the person picking up the device (identified during job creation).

job_states_to_notify instance-attribute

job_states_to_notify: NotRequired[JobStateList]

The list of job states that will trigger a notification for this job.

notify_all instance-attribute

notify_all: Boolean

Any change in job state will trigger a notification for this job.

sns_topic_arn instance-attribute

sns_topic_arn: NotRequired[SnsTopicARN]

The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.