libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MechanicalTurk.DeleteWorkerBlock

Description

The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.

Synopsis

Creating a Request

data DeleteWorkerBlock Source #

See: newDeleteWorkerBlock smart constructor.

Constructors

DeleteWorkerBlock' 

Fields

  • reason :: Maybe Text

    A message that explains the reason for unblocking the Worker. The Worker does not see this message.

  • workerId :: Text

    The ID of the Worker to unblock.

Instances

Instances details
Eq DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

(==) :: DeleteWorkerBlock -> DeleteWorkerBlock -> Bool #

(/=) :: DeleteWorkerBlock -> DeleteWorkerBlock -> Bool #

Read DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

readsPrec :: Int -> ReadS DeleteWorkerBlock #

readList :: ReadS [DeleteWorkerBlock] #

readPrec :: ReadPrec DeleteWorkerBlock #

readListPrec :: ReadPrec [DeleteWorkerBlock] #

Show DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

showsPrec :: Int -> DeleteWorkerBlock -> ShowS #

show :: DeleteWorkerBlock -> String #

showList :: [DeleteWorkerBlock] -> ShowS #

Generic DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Associated Types

type Rep DeleteWorkerBlock :: Type -> Type #

Methods

from :: DeleteWorkerBlock -> Rep DeleteWorkerBlock x #

to :: Rep DeleteWorkerBlock x -> DeleteWorkerBlock #

NFData DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

rnf :: DeleteWorkerBlock -> () #

Hashable DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

hashWithSalt :: Int -> DeleteWorkerBlock -> Int #

hash :: DeleteWorkerBlock -> Int #

ToJSON DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

toJSON :: DeleteWorkerBlock -> Value #

toEncoding :: DeleteWorkerBlock -> Encoding #

toJSONList :: [DeleteWorkerBlock] -> Value #

toEncodingList :: [DeleteWorkerBlock] -> Encoding #

AWSRequest DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Associated Types

type AWSResponse DeleteWorkerBlock #

Methods

request :: DeleteWorkerBlock -> Request DeleteWorkerBlock #

response :: MonadResource m => Logger -> Service -> Proxy DeleteWorkerBlock -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteWorkerBlock))) #

ToHeaders DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

toHeaders :: DeleteWorkerBlock -> [Header] #

ToPath DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

toPath :: DeleteWorkerBlock -> ByteString #

ToQuery DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

toQuery :: DeleteWorkerBlock -> QueryString #

type Rep DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

type Rep DeleteWorkerBlock = D1 ('MetaData "DeleteWorkerBlock" "Amazonka.MechanicalTurk.DeleteWorkerBlock" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "DeleteWorkerBlock'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteWorkerBlock Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

type AWSResponse DeleteWorkerBlock = DeleteWorkerBlockResponse

newDeleteWorkerBlock Source #

Arguments

:: Text

$sel:workerId:DeleteWorkerBlock'

-> DeleteWorkerBlock 

Create a value of DeleteWorkerBlock 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:reason:DeleteWorkerBlock', deleteWorkerBlock_reason - A message that explains the reason for unblocking the Worker. The Worker does not see this message.

$sel:workerId:DeleteWorkerBlock', deleteWorkerBlock_workerId - The ID of the Worker to unblock.

Request Lenses

deleteWorkerBlock_reason :: Lens' DeleteWorkerBlock (Maybe Text) Source #

A message that explains the reason for unblocking the Worker. The Worker does not see this message.

deleteWorkerBlock_workerId :: Lens' DeleteWorkerBlock Text Source #

The ID of the Worker to unblock.

Destructuring the Response

data DeleteWorkerBlockResponse Source #

See: newDeleteWorkerBlockResponse smart constructor.

Constructors

DeleteWorkerBlockResponse' 

Fields

Instances

Instances details
Eq DeleteWorkerBlockResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

(==) :: DeleteWorkerBlockResponse -> DeleteWorkerBlockResponse -> Bool #

(/=) :: DeleteWorkerBlockResponse -> DeleteWorkerBlockResponse -> Bool #

Read DeleteWorkerBlockResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

readsPrec :: Int -> ReadS DeleteWorkerBlockResponse #

readList :: ReadS [DeleteWorkerBlockResponse] #

readPrec :: ReadPrec DeleteWorkerBlockResponse #

readListPrec :: ReadPrec [DeleteWorkerBlockResponse] #

Show DeleteWorkerBlockResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

showsPrec :: Int -> DeleteWorkerBlockResponse -> ShowS #

show :: DeleteWorkerBlockResponse -> String #

showList :: [DeleteWorkerBlockResponse] -> ShowS #

Generic DeleteWorkerBlockResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Associated Types

type Rep DeleteWorkerBlockResponse :: Type -> Type #

Methods

from :: DeleteWorkerBlockResponse -> Rep DeleteWorkerBlockResponse x #

to :: Rep DeleteWorkerBlockResponse x -> DeleteWorkerBlockResponse #

NFData DeleteWorkerBlockResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

Methods

rnf :: DeleteWorkerBlockResponse -> () #

type Rep DeleteWorkerBlockResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.DeleteWorkerBlock

type Rep DeleteWorkerBlockResponse = D1 ('MetaData "DeleteWorkerBlockResponse" "Amazonka.MechanicalTurk.DeleteWorkerBlock" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "DeleteWorkerBlockResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteWorkerBlockResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteWorkerBlockResponse'

-> DeleteWorkerBlockResponse 

Create a value of DeleteWorkerBlockResponse 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:DeleteWorkerBlockResponse', deleteWorkerBlockResponse_httpStatus - The response's http status code.

Response Lenses

deleteWorkerBlockResponse_httpStatus :: Lens' DeleteWorkerBlockResponse Int Source #

The response's http status code.