2016/08/30 - AWS CodePipeline - 1 new 2 updated api methods
Changes CodePiepline has introduced a new feature to return pipeline execution details. Execution details consists of source revisions that are running in the pipeline. Customers will be able to tell what source revisions that are running through the stages in pipeline by fetching execution details of each stage.
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
Request Syntax
client.get_pipeline_execution(
pipelineName='string',
pipelineExecutionId='string'
)
string
[REQUIRED]
The name of the pipeline about which you want to get execution details.
string
[REQUIRED]
The ID of the pipeline execution about which you want to get execution details.
dict
Response Syntax
{
'pipelineExecution': {
'pipelineName': 'string',
'pipelineVersion': 123,
'pipelineExecutionId': 'string',
'status': 'InProgress'|'Succeeded'|'Superseded'|'Failed',
'artifactRevisionInformations': [
{
'name': 'string',
'revision': {
'revisionId': 'string',
'revisionChangeIdentifier': 'string',
'revisionSummary': 'string',
'created': datetime(2015, 1, 1),
'revisionUrl': 'string'
}
},
]
}
}
Response Structure
(dict) --
Represents the output of a get pipeline execution action.
pipelineExecution (dict) --
Represents information about the execution of a pipeline.
pipelineName (string) --
The name of the pipeline that was executed.
pipelineVersion (integer) --
The version number of the pipeline that was executed.
pipelineExecutionId (string) --
The ID of the pipeline execution.
status (string) --
The status of the pipeline execution.
InProgress: The pipeline execution is currently running.
Succeeded: The pipeline execution completed successfully.
Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead.
Failed: The pipeline did not complete successfully.
artifactRevisionInformations (list) --
A list of ArtifactRevisionInformation objects included in a pipeline execution.
(dict) --
Represents information about an artifact revision.
name (string) --
The name of an artifact. This name might be system-generated, such as "MyApp", or might be defined by the user when an action is created.
revision (dict) --
Represents details about the ArtifactRevision object.
revisionId (string) --
The revision ID of the artifact.
revisionChangeIdentifier (string) --
An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
revisionSummary (string) --
Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided value of an x-amz-meta-codepipeline-artifact-revision-summary key specified in the object metadata.
created (datetime) --
The date and time when the most recent revision of the artifact was created, in timestamp format.
revisionUrl (string) --
The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
{'currentRevision': {'created': 'timestamp', 'revisionSummary': 'string'}}
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
Request Syntax
client.put_job_success_result(
jobId='string',
currentRevision={
'revision': 'string',
'changeIdentifier': 'string',
'created': datetime(2015, 1, 1),
'revisionSummary': 'string'
},
continuationToken='string',
executionDetails={
'summary': 'string',
'externalExecutionId': 'string',
'percentComplete': 123
}
)
string
[REQUIRED]
The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
dict
The ID of the current revision of the artifact successfully worked upon by the job.
revision (string) -- [REQUIRED]
The revision ID of the current version of an artifact.
changeIdentifier (string) -- [REQUIRED]
The change identifier for the current revision.
created (datetime) --
The date and time when the most recent revision of the artifact was created, in timestamp format.
revisionSummary (string) --
The summary of the most recent revision of the artifact.
string
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 will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
dict
The execution details of the successful job, such as the actions taken by the job worker.
summary (string) --
The summary of the current status of the actions.
externalExecutionId (string) --
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
percentComplete (integer) --
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
None
{'currentRevision': {'created': 'timestamp', 'revisionSummary': 'string'}}
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
Request Syntax
client.put_third_party_job_success_result(
jobId='string',
clientToken='string',
currentRevision={
'revision': 'string',
'changeIdentifier': 'string',
'created': datetime(2015, 1, 1),
'revisionSummary': 'string'
},
continuationToken='string',
executionDetails={
'summary': 'string',
'externalExecutionId': 'string',
'percentComplete': 123
}
)
string
[REQUIRED]
The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
string
[REQUIRED]
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
dict
Represents information about a current revision.
revision (string) -- [REQUIRED]
The revision ID of the current version of an artifact.
changeIdentifier (string) -- [REQUIRED]
The change identifier for the current revision.
created (datetime) --
The date and time when the most recent revision of the artifact was created, in timestamp format.
revisionSummary (string) --
The summary of the most recent revision of the artifact.
string
A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
dict
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
summary (string) --
The summary of the current status of the actions.
externalExecutionId (string) --
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
percentComplete (integer) --
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
None