AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | List of all members
Aws::Snowball::Model::Notification Class Reference

#include <Notification.h>

Public Member Functions

 Notification ()
 
 Notification (Aws::Utils::Json::JsonView jsonValue)
 
Notificationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetSnsTopicARN () const
 
bool SnsTopicARNHasBeenSet () const
 
void SetSnsTopicARN (const Aws::String &value)
 
void SetSnsTopicARN (Aws::String &&value)
 
void SetSnsTopicARN (const char *value)
 
NotificationWithSnsTopicARN (const Aws::String &value)
 
NotificationWithSnsTopicARN (Aws::String &&value)
 
NotificationWithSnsTopicARN (const char *value)
 
const Aws::Vector< JobState > & GetJobStatesToNotify () const
 
bool JobStatesToNotifyHasBeenSet () const
 
void SetJobStatesToNotify (const Aws::Vector< JobState > &value)
 
void SetJobStatesToNotify (Aws::Vector< JobState > &&value)
 
NotificationWithJobStatesToNotify (const Aws::Vector< JobState > &value)
 
NotificationWithJobStatesToNotify (Aws::Vector< JobState > &&value)
 
NotificationAddJobStatesToNotify (const JobState &value)
 
NotificationAddJobStatesToNotify (JobState &&value)
 
bool GetNotifyAll () const
 
bool NotifyAllHasBeenSet () const
 
void SetNotifyAll (bool value)
 
NotificationWithNotifyAll (bool value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 40 of file Notification.h.

Constructor & Destructor Documentation

◆ Notification() [1/2]

Aws::Snowball::Model::Notification::Notification ( )

◆ Notification() [2/2]

Aws::Snowball::Model::Notification::Notification ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddJobStatesToNotify() [1/2]

Notification& Aws::Snowball::Model::Notification::AddJobStatesToNotify ( const JobState value)
inline

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

Definition at line 171 of file Notification.h.

◆ AddJobStatesToNotify() [2/2]

Notification& Aws::Snowball::Model::Notification::AddJobStatesToNotify ( JobState &&  value)
inline

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

Definition at line 176 of file Notification.h.

◆ GetJobStatesToNotify()

const Aws::Vector<JobState>& Aws::Snowball::Model::Notification::GetJobStatesToNotify ( ) const
inline

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

Definition at line 141 of file Notification.h.

◆ GetNotifyAll()

bool Aws::Snowball::Model::Notification::GetNotifyAll ( ) const
inline

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

Definition at line 182 of file Notification.h.

◆ GetSnsTopicARN()

const Aws::String& Aws::Snowball::Model::Notification::GetSnsTopicARN ( ) const
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 58 of file Notification.h.

◆ JobStatesToNotifyHasBeenSet()

bool Aws::Snowball::Model::Notification::JobStatesToNotifyHasBeenSet ( ) const
inline

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

Definition at line 146 of file Notification.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Snowball::Model::Notification::Jsonize ( ) const

◆ NotifyAllHasBeenSet()

bool Aws::Snowball::Model::Notification::NotifyAllHasBeenSet ( ) const
inline

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

Definition at line 187 of file Notification.h.

◆ operator=()

Notification& Aws::Snowball::Model::Notification::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetJobStatesToNotify() [1/2]

void Aws::Snowball::Model::Notification::SetJobStatesToNotify ( const Aws::Vector< JobState > &  value)
inline

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

Definition at line 151 of file Notification.h.

◆ SetJobStatesToNotify() [2/2]

void Aws::Snowball::Model::Notification::SetJobStatesToNotify ( Aws::Vector< JobState > &&  value)
inline

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

Definition at line 156 of file Notification.h.

◆ SetNotifyAll()

void Aws::Snowball::Model::Notification::SetNotifyAll ( bool  value)
inline

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

Definition at line 192 of file Notification.h.

◆ SetSnsTopicARN() [1/3]

void Aws::Snowball::Model::Notification::SetSnsTopicARN ( const Aws::String value)
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 80 of file Notification.h.

◆ SetSnsTopicARN() [2/3]

void Aws::Snowball::Model::Notification::SetSnsTopicARN ( Aws::String &&  value)
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 91 of file Notification.h.

◆ SetSnsTopicARN() [3/3]

void Aws::Snowball::Model::Notification::SetSnsTopicARN ( const char *  value)
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 102 of file Notification.h.

◆ SnsTopicARNHasBeenSet()

bool Aws::Snowball::Model::Notification::SnsTopicARNHasBeenSet ( ) const
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 69 of file Notification.h.

◆ WithJobStatesToNotify() [1/2]

Notification& Aws::Snowball::Model::Notification::WithJobStatesToNotify ( const Aws::Vector< JobState > &  value)
inline

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

Definition at line 161 of file Notification.h.

◆ WithJobStatesToNotify() [2/2]

Notification& Aws::Snowball::Model::Notification::WithJobStatesToNotify ( Aws::Vector< JobState > &&  value)
inline

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

Definition at line 166 of file Notification.h.

◆ WithNotifyAll()

Notification& Aws::Snowball::Model::Notification::WithNotifyAll ( bool  value)
inline

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

Definition at line 197 of file Notification.h.

◆ WithSnsTopicARN() [1/3]

Notification& Aws::Snowball::Model::Notification::WithSnsTopicARN ( const Aws::String value)
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 113 of file Notification.h.

◆ WithSnsTopicARN() [2/3]

Notification& Aws::Snowball::Model::Notification::WithSnsTopicARN ( Aws::String &&  value)
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 124 of file Notification.h.

◆ WithSnsTopicARN() [3/3]

Notification& Aws::Snowball::Model::Notification::WithSnsTopicARN ( const char *  value)
inline

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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

Definition at line 135 of file Notification.h.


The documentation for this class was generated from the following file: