Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MechanicalTurk.DeleteHIT

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it.

You can only dispose of HITs that are in the Reviewable state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the Reviewable state (for example, that has not expired, or still has active assignments), or on a HIT that is Reviewable but without all of its submitted assignments already approved or rejected, the service will return an error.

HITs are automatically disposed of after 120 days.
After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
Disposed HITs are not returned in results for the ListHITs operation.
Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.

Synopsis

data DeleteHIT = DeleteHIT' {
- hITId :: Text
}
newDeleteHIT :: Text -> DeleteHIT
deleteHIT_hITId :: Lens' DeleteHIT Text
data DeleteHITResponse = DeleteHITResponse' {
- httpStatus :: Int
}
newDeleteHITResponse :: Int -> DeleteHITResponse
deleteHITResponse_httpStatus :: Lens' DeleteHITResponse Int

Creating a Request

data DeleteHIT Source #

See: newDeleteHIT smart constructor.

Constructors

DeleteHIT'
Fields hITId :: Text The ID of the HIT to be deleted.

Instances

Instances details

Eq DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods (==) :: DeleteHIT -> DeleteHIT -> Bool # (/=) :: DeleteHIT -> DeleteHIT -> Bool #
Read DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods readsPrec :: Int -> ReadS DeleteHIT # readList :: ReadS [DeleteHIT] # readPrec :: ReadPrec DeleteHIT # readListPrec :: ReadPrec [DeleteHIT] #
Show DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods showsPrec :: Int -> DeleteHIT -> ShowS # show :: DeleteHIT -> String # showList :: [DeleteHIT] -> ShowS #
Generic DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Associated Types type Rep DeleteHIT :: Type -> Type # Methods from :: DeleteHIT -> Rep DeleteHIT x # to :: Rep DeleteHIT x -> DeleteHIT #
NFData DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods rnf :: DeleteHIT -> () #
Hashable DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods hashWithSalt :: Int -> DeleteHIT -> Int # hash :: DeleteHIT -> Int #
ToJSON DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods toJSON :: DeleteHIT -> Value # toEncoding :: DeleteHIT -> Encoding # toJSONList :: [DeleteHIT] -> Value # toEncodingList :: [DeleteHIT] -> Encoding #
AWSRequest DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Associated Types type AWSResponse DeleteHIT # Methods request :: DeleteHIT -> Request DeleteHIT # response :: MonadResource m => Logger -> Service -> Proxy DeleteHIT -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteHIT))) #
ToHeaders DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods toHeaders :: DeleteHIT -> [Header] #
ToPath DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods toPath :: DeleteHIT -> ByteString #
ToQuery DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods toQuery :: DeleteHIT -> QueryString #
type Rep DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT type Rep DeleteHIT = D1 ('MetaData "DeleteHIT" "Amazonka.MechanicalTurk.DeleteHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "DeleteHIT'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hITId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteHIT Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT type AWSResponse DeleteHIT = DeleteHITResponse

newDeleteHIT Source #

Arguments

:: Text	`$sel:hITId:DeleteHIT'`
-> DeleteHIT

Create a value of DeleteHIT 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:hITId:DeleteHIT', deleteHIT_hITId - The ID of the HIT to be deleted.

Request Lenses

deleteHIT_hITId :: Lens' DeleteHIT Text Source #

The ID of the HIT to be deleted.

Destructuring the Response

data DeleteHITResponse Source #

See: newDeleteHITResponse smart constructor.

Constructors

DeleteHITResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteHITResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods (==) :: DeleteHITResponse -> DeleteHITResponse -> Bool # (/=) :: DeleteHITResponse -> DeleteHITResponse -> Bool #
Read DeleteHITResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods readsPrec :: Int -> ReadS DeleteHITResponse # readList :: ReadS [DeleteHITResponse] # readPrec :: ReadPrec DeleteHITResponse # readListPrec :: ReadPrec [DeleteHITResponse] #
Show DeleteHITResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods showsPrec :: Int -> DeleteHITResponse -> ShowS # show :: DeleteHITResponse -> String # showList :: [DeleteHITResponse] -> ShowS #
Generic DeleteHITResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Associated Types type Rep DeleteHITResponse :: Type -> Type # Methods from :: DeleteHITResponse -> Rep DeleteHITResponse x # to :: Rep DeleteHITResponse x -> DeleteHITResponse #
NFData DeleteHITResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT Methods rnf :: DeleteHITResponse -> () #
type Rep DeleteHITResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.DeleteHIT type Rep DeleteHITResponse = D1 ('MetaData "DeleteHITResponse" "Amazonka.MechanicalTurk.DeleteHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "DeleteHITResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteHITResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteHITResponse'`
-> DeleteHITResponse

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

Response Lenses

deleteHITResponse_httpStatus :: Lens' DeleteHITResponse Int Source #

The response's http status code.