SetHITTypeNotification

Description

The SetHITTypeNotification operation creates, updates, disables or re-enables notifications for a HIT type.

If you call the SetHITTypeNotification operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one.

Every time you change your secret access key ID (using the Access Identifiers section of Your Account at http://aws.amazon.com/account) you need to reset each of your HITType notifications. When you do, Amazon Mechanical Turk uses your new secret access key ID to sign all notifications for the specified HITType going forward. Until you reset your HITType notifications, Amazon Mechanical Turk will keep signing notifications using your old secret access key ID.

	Important
	If you deactivate or delete a secret access key ID used by a HITType notification, you will start receiving unsigned notifications for that HITType.

You can call the SetHITTypeNotification operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself.

You can call this operation at any time to change the value of the of the Active parameter of a HIT type. You can specify changes to the Active status without specifying a new notification specification (the Notification parameter).

To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to SetHITTypeNotification.

	Note
	After you make the call to `SetHITTypeNotification`, it can take up to five minutes for changes to a HIT type's notification specification to take effect.

Request Parameters

The SetHITTypeNotification operation accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the SetHITTypeNotification operation:

Name	Description	Required
`Operation`	The name of the operation Type: String Valid Values: SetHITTypeNotification Default: None	Yes
`HITTypeId`	The ID of the HIT type whose notification specification is being updated, as returned by the RegisterHITType operation. Type: String Default: None	Yes
`Notification`	The notification specification for the HIT type. Type: a Notification data structure. Default: None. Constraint: You must specify either the `Notification` parameter or the `Active` parameter for the call to `SetHITTypeNotification` to succeed.	Yes
`Active`	Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. Type: Boolean Valid Values: true \| false Default: None. If omitted, the active status of the HIT type's notification specification is unchanged Constraint: You must specify either the `Notification` parameter or the `Active` parameter for the call to `SetHITTypeNotification` to succeed.	No

Response Elements

A successful request for the SetHITTypeNotification operation returns with no errors. The response includes the elements described in the following table. The operation returns no other data.

Name	Description
`SetHITTypeNotificationResult`	Contains a `Request` element if the `Request` `ResposeGroup` is specified.

Examples

The following example shows how to use the SetHITTypeNotification operation.

Sample Request

The following example sets the notification specification for a HIT type to send the Requester an e-mail whenever a Worker submits an assignment for a HIT of the specified type.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Operation=SetHITTypeNotification
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&HITTypeId=T100CN9P324W00EXAMPLE
&Notification.1.Destination=requester-email@example.com
&Notification.1.Transport=Email
&Notification.1.Version=2006-05-05
&Notification.1.EventType=AssignmentSubmitted

Sample Response

The following is an example response.

<SetHITTypeNotificationResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
</SetHITTypeNotificationResult>