Menu
AWS Snowball
API Reference

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.

Contents

JobStatesToNotify

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

Type: Array of strings

Valid Values: New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWS | InProgress | Complete | Cancelled | Listing | Pending

Required: No

NotifyAll

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

Type: Boolean

Required: No

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

Type: String

Length Constraints: Maximum length of 255.

Pattern: arn:aws.*:sns:.*:[0-9]{12}:.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: