amazonka-mechanicalturk-2.0: Amazon Mechanical Turk SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MechanicalTurk.UpdateNotificationSettings

Description

The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. 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 UpdateNotificationSettings.

Synopsis

Creating a Request

data UpdateNotificationSettings Source #

See: newUpdateNotificationSettings smart constructor.

Constructors

UpdateNotificationSettings' 

Fields

  • active :: Maybe Bool

    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.

  • notification :: Maybe NotificationSpecification

    The notification specification for the HIT type.

  • hITTypeId :: Text

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

Instances

Instances details
ToJSON UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

ToHeaders UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

ToPath UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

ToQuery UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

AWSRequest UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Generic UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Associated Types

type Rep UpdateNotificationSettings :: Type -> Type #

Read UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Show UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

NFData UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Eq UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Hashable UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

type AWSResponse UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

type Rep UpdateNotificationSettings Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

type Rep UpdateNotificationSettings = D1 ('MetaData "UpdateNotificationSettings" "Amazonka.MechanicalTurk.UpdateNotificationSettings" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "UpdateNotificationSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "active") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationSpecification)) :*: S1 ('MetaSel ('Just "hITTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateNotificationSettings Source #

Create a value of UpdateNotificationSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:active:UpdateNotificationSettings', updateNotificationSettings_active - 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.

$sel:notification:UpdateNotificationSettings', updateNotificationSettings_notification - The notification specification for the HIT type.

UpdateNotificationSettings, updateNotificationSettings_hITTypeId - The ID of the HIT type whose notification specification is being updated.

Request Lenses

updateNotificationSettings_active :: Lens' UpdateNotificationSettings (Maybe Bool) Source #

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.

updateNotificationSettings_hITTypeId :: Lens' UpdateNotificationSettings Text Source #

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

Destructuring the Response

data UpdateNotificationSettingsResponse Source #

Constructors

UpdateNotificationSettingsResponse' 

Fields

Instances

Instances details
Generic UpdateNotificationSettingsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Associated Types

type Rep UpdateNotificationSettingsResponse :: Type -> Type #

Read UpdateNotificationSettingsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Show UpdateNotificationSettingsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

NFData UpdateNotificationSettingsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

Eq UpdateNotificationSettingsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

type Rep UpdateNotificationSettingsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings

type Rep UpdateNotificationSettingsResponse = D1 ('MetaData "UpdateNotificationSettingsResponse" "Amazonka.MechanicalTurk.UpdateNotificationSettings" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "UpdateNotificationSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateNotificationSettingsResponse Source #

Create a value of UpdateNotificationSettingsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateNotificationSettingsResponse', updateNotificationSettingsResponse_httpStatus - The response's http status code.

Response Lenses