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

Class: Aws::MTurk::Types::UpdateNotificationSettingsRequest

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

Overview

Note:

When making an API call, you may pass UpdateNotificationSettingsRequest data as a hash:

{
  hit_type_id: "EntityId", # required
  notification: {
    destination: "String", # required
    transport: "Email", # required, accepts Email, SQS, SNS
    version: "String", # required
    event_types: ["AssignmentAccepted"], # required, accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
  },
  active: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#activeBoolean

Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed.

Returns:

  • (Boolean)


2978
2979
2980
2981
2982
2983
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2978

class UpdateNotificationSettingsRequest < Struct.new(
  :hit_type_id,
  :notification,
  :active)
  include Aws::Structure
end

#hit_type_idString

The ID of the HIT type whose notification specification is being updated.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2978

class UpdateNotificationSettingsRequest < Struct.new(
  :hit_type_id,
  :notification,
  :active)
  include Aws::Structure
end

#notificationTypes::NotificationSpecification

The notification specification for the HIT type.



2978
2979
2980
2981
2982
2983
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2978

class UpdateNotificationSettingsRequest < Struct.new(
  :hit_type_id,
  :notification,
  :active)
  include Aws::Structure
end