| 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.CodePipeline.PutJobSuccessResult
Description
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
Synopsis
- data PutJobSuccessResult = PutJobSuccessResult' {}
- newPutJobSuccessResult :: Text -> PutJobSuccessResult
- putJobSuccessResult_outputVariables :: Lens' PutJobSuccessResult (Maybe (HashMap Text Text))
- putJobSuccessResult_continuationToken :: Lens' PutJobSuccessResult (Maybe Text)
- putJobSuccessResult_executionDetails :: Lens' PutJobSuccessResult (Maybe ExecutionDetails)
- putJobSuccessResult_currentRevision :: Lens' PutJobSuccessResult (Maybe CurrentRevision)
- putJobSuccessResult_jobId :: Lens' PutJobSuccessResult Text
- data PutJobSuccessResultResponse = PutJobSuccessResultResponse' {
- newPutJobSuccessResultResponse :: PutJobSuccessResultResponse
Creating a Request
data PutJobSuccessResult Source #
Represents the input of a PutJobSuccessResult action.
See: newPutJobSuccessResult smart constructor.
Constructors
| PutJobSuccessResult' | |
Fields
| |
Instances
newPutJobSuccessResult Source #
Arguments
| :: Text | |
| -> PutJobSuccessResult |
Create a value of PutJobSuccessResult 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:outputVariables:PutJobSuccessResult', putJobSuccessResult_outputVariables - Key-value pairs produced as output by a job worker that can be made
available to a downstream action configuration. outputVariables can be
included only when there is no continuation token on the request.
$sel:continuationToken:PutJobSuccessResult', putJobSuccessResult_continuationToken - A token generated by a job worker, such as an AWS CodeDeploy deployment
ID, that a successful job provides to identify a custom action in
progress. Future jobs use this token to identify the running instance of
the action. It can be reused to return more information about the
progress of the custom action. When the action is complete, no
continuation token should be supplied.
$sel:executionDetails:PutJobSuccessResult', putJobSuccessResult_executionDetails - The execution details of the successful job, such as the actions taken
by the job worker.
$sel:currentRevision:PutJobSuccessResult', putJobSuccessResult_currentRevision - The ID of the current revision of the artifact successfully worked on by
the job.
$sel:jobId:PutJobSuccessResult', putJobSuccessResult_jobId - The unique system-generated ID of the job that succeeded. This is the
same ID returned from PollForJobs.
Request Lenses
putJobSuccessResult_outputVariables :: Lens' PutJobSuccessResult (Maybe (HashMap Text Text)) Source #
Key-value pairs produced as output by a job worker that can be made
available to a downstream action configuration. outputVariables can be
included only when there is no continuation token on the request.
putJobSuccessResult_continuationToken :: Lens' PutJobSuccessResult (Maybe Text) Source #
A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
putJobSuccessResult_executionDetails :: Lens' PutJobSuccessResult (Maybe ExecutionDetails) Source #
The execution details of the successful job, such as the actions taken by the job worker.
putJobSuccessResult_currentRevision :: Lens' PutJobSuccessResult (Maybe CurrentRevision) Source #
The ID of the current revision of the artifact successfully worked on by the job.
putJobSuccessResult_jobId :: Lens' PutJobSuccessResult Text Source #
The unique system-generated ID of the job that succeeded. This is the
same ID returned from PollForJobs.
Destructuring the Response
data PutJobSuccessResultResponse Source #
See: newPutJobSuccessResultResponse smart constructor.
Constructors
| PutJobSuccessResultResponse' | |
Instances
newPutJobSuccessResultResponse :: PutJobSuccessResultResponse Source #
Create a value of PutJobSuccessResultResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.