Skip to content

/AWS1/CL_SNBNOTIFICATION

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_SNSTOPICARN TYPE /AWS1/SNBSNSTOPICARN /AWS1/SNBSNSTOPICARN

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.

IT_JOBSTATESTONOTIFY TYPE /AWS1/CL_SNBJOBSTATELIST_W=>TT_JOBSTATELIST TT_JOBSTATELIST

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

IV_NOTIFYALL TYPE /AWS1/SNBBOOLEAN /AWS1/SNBBOOLEAN

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

IV_DEVICEPICKUPSNSTOPICARN TYPE /AWS1/SNBSNSTOPICARN /AWS1/SNBSNSTOPICARN

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


Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_SNSTOPICARN() Getter for SNSTOPICARN, with configurable default
ASK_SNSTOPICARN() Getter for SNSTOPICARN w/ exceptions if field has no value
HAS_SNSTOPICARN() Determine if SNSTOPICARN has a value

JobStatesToNotify

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

Accessible with the following methods

Method Description
GET_JOBSTATESTONOTIFY() Getter for JOBSTATESTONOTIFY, with configurable default
ASK_JOBSTATESTONOTIFY() Getter for JOBSTATESTONOTIFY w/ exceptions if field has no v
HAS_JOBSTATESTONOTIFY() Determine if JOBSTATESTONOTIFY has a value

NotifyAll

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

Accessible with the following methods

Method Description
GET_NOTIFYALL() Getter for NOTIFYALL

DevicePickupSnsTopicARN

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

Accessible with the following methods

Method Description
GET_DEVICEPICKUPSNSTOPICARN() Getter for DEVICEPICKUPSNSTOPICARN, with configurable defaul
ASK_DEVICEPICKUPSNSTOPICARN() Getter for DEVICEPICKUPSNSTOPICARN w/ exceptions if field ha
HAS_DEVICEPICKUPSNSTOPICARN() Determine if DEVICEPICKUPSNSTOPICARN has a value