Struct aws_sdk_snowball::types::Notification

#[non_exhaustive]
pub struct Notification {
    pub sns_topic_arn: Option<String>,
    pub job_states_to_notify: Option<Vec<JobState>>,
    pub notify_all: bool,
    pub device_pickup_sns_topic_arn: Option<String>,
}

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sns_topic_arn: Option<String>

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.

job_states_to_notify: Option<Vec<JobState>>

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

notify_all: bool

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

device_pickup_sns_topic_arn: Option<String>

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

Implementations

impl Notification

pub fn sns_topic_arn(&self) -> Option<&str>

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.

pub fn job_states_to_notify(&self) -> &[JobState]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .job_states_to_notify.is_none().

pub fn notify_all(&self) -> bool

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

pub fn device_pickup_sns_topic_arn(&self) -> Option<&str>

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

impl Notification

pub fn builder() -> NotificationBuilder

Creates a new builder-style object to manufacture Notification.

Trait Implementations

impl Clone for Notification

fn clone(&self) -> Notification

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Notification

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Notification

fn eq(&self, other: &Notification) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Notification