class Aws::Snowball::Types::Notification
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.
@note When making an API call, you may pass Notification
data as a hash: { sns_topic_arn: "SnsTopicARN", job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWSSortingFacility, WithAWS, InProgress, Complete, Cancelled, Listing, Pending notify_all: false, }
@!attribute [rw] sns_topic_arn
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][1] Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the [Subscribe][2] Amazon Simple Notification Service (Amazon SNS) API action. [1]: https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html [2]: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html @return [String]
@!attribute [rw] job_states_to_notify
The list of job states that will trigger a notification for this job. @return [Array<String>]
@!attribute [rw] notify_all
Any change in job state will trigger a notification for this job. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Notification AWS API Documentation
Constants
- SENSITIVE