| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CodePipeline.AcknowledgeJob
Description
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
See: AWS API Reference for AcknowledgeJob.
- acknowledgeJob :: Text -> Text -> AcknowledgeJob
- data AcknowledgeJob
- ajJobId :: Lens' AcknowledgeJob Text
- ajNonce :: Lens' AcknowledgeJob Text
- acknowledgeJobResponse :: Int -> AcknowledgeJobResponse
- data AcknowledgeJobResponse
- ajrsStatus :: Lens' AcknowledgeJobResponse (Maybe JobStatus)
- ajrsResponseStatus :: Lens' AcknowledgeJobResponse Int
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> AcknowledgeJob |
Creates a value of AcknowledgeJob with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AcknowledgeJob Source
Represents the input of an acknowledge job action.
See: acknowledgeJob smart constructor.
Instances
Request Lenses
ajJobId :: Lens' AcknowledgeJob Text Source
The unique system-generated ID of the job for which you want to confirm receipt.
ajNonce :: Lens' AcknowledgeJob Text Source
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
Destructuring the Response
Arguments
| :: Int | |
| -> AcknowledgeJobResponse |
Creates a value of AcknowledgeJobResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AcknowledgeJobResponse Source
Represents the output of an acknowledge job action.
See: acknowledgeJobResponse smart constructor.
Response Lenses
ajrsStatus :: Lens' AcknowledgeJobResponse (Maybe JobStatus) Source
Whether the job worker has received the specified job.
ajrsResponseStatus :: Lens' AcknowledgeJobResponse Int Source
The response status code.