You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Snowball::Types::Notification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb

Overview

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,
}

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:

Instance Attribute Summary collapse

Instance Attribute Details

#job_states_to_notify ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1735
1736
1737
1738
1739
1740
 
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1735

class Notification < Struct.new(
  :sns_topic_arn,
  :job_states_to_notify,
  :notify_all)
  include Aws::Structure
end

#notify_all ⇒ Boolean

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

Returns:

  • (Boolean) 


1735
1736
1737
1738
1739
1740
 
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1735

class Notification < Struct.new(
  :sns_topic_arn,
  :job_states_to_notify,
  :notify_all)
  include Aws::Structure
end

#sns_topic_arn ⇒ String

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.

Returns:

  • (String) 


1735
1736
1737
1738
1739
1740
 
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1735

class Notification < Struct.new(
  :sns_topic_arn,
  :job_states_to_notify,
  :notify_all)
  include Aws::Structure
end