Aws::Snowball::Model::Notification Class Reference

#include <Notification.h>

Public Member Functions
	Notification ()
	Notification (const Aws::Utils::Json::JsonValue &jsonValue)
Notification &	operator= (const Aws::Utils::Json::JsonValue &jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const Aws::String &	GetSnsTopicARN () const
void	SetSnsTopicARN (const Aws::String &value)
void	SetSnsTopicARN (Aws::String &&value)
void	SetSnsTopicARN (const char *value)
Notification &	WithSnsTopicARN (const Aws::String &value)
Notification &	WithSnsTopicARN (Aws::String &&value)
Notification &	WithSnsTopicARN (const char *value)
const Aws::Vector< JobState > &	GetJobStatesToNotify () const
void	SetJobStatesToNotify (const Aws::Vector< JobState > &value)
void	SetJobStatesToNotify (Aws::Vector< JobState > &&value)
Notification &	WithJobStatesToNotify (const Aws::Vector< JobState > &value)
Notification &	WithJobStatesToNotify (Aws::Vector< JobState > &&value)
Notification &	AddJobStatesToNotify (const JobState &value)
Notification &	AddJobStatesToNotify (JobState &&value)
bool	GetNotifyAll () const
void	SetNotifyAll (bool value)
Notification &	WithNotifyAll (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.

Definition at line 45 of file Notification.h.

Constructor & Destructor Documentation

Aws::Snowball::Model::Notification::Notification

(

)

Aws::Snowball::Model::Notification::Notification

(

const Aws::Utils::Json::JsonValue &

jsonValue

)

Member Function Documentation

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 158 of file Notification.h.

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 163 of file Notification.h.

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 133 of file Notification.h.

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

inline

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

Definition at line 168 of file Notification.h.

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.

Note that 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 62 of file Notification.h.

Aws::Utils::Json::JsonValue Aws::Snowball::Model::Notification::Jsonize

(

)

const

Notification& Aws::Snowball::Model::Notification::operator=

(

const Aws::Utils::Json::JsonValue &

jsonValue

)

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 138 of file Notification.h.

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 143 of file Notification.h.

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

inline

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

Definition at line 173 of file Notification.h.

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.

Note that 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 73 of file Notification.h.

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.

Note that 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 84 of file Notification.h.

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.

Note that 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 95 of file Notification.h.

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 148 of file Notification.h.

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 153 of file Notification.h.

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

inline

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

Definition at line 178 of file Notification.h.

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.

Note that 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 106 of file Notification.h.

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.

Note that 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 117 of file Notification.h.

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.

Note that 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 128 of file Notification.h.

---

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

• aws-cpp-sdk-snowball/include/aws/snowball/model/Notification.h