AWS CodePipeline

2016/09/06 - AWS CodePipeline - 1 updated api methods

GetPipelineExecution (updated) Link ΒΆ
Changes (response)
{'pipelineExecution': {'artifactRevisions': [{'created': 'timestamp',
                                              'name': 'string',
                                              'revisionChangeIdentifier': 'string',
                                              'revisionId': 'string',
                                              'revisionSummary': 'string',
                                              'revisionUrl': 'string'}]}}

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'
)
type pipelineName

string

param pipelineName

[REQUIRED]

The name of the pipeline about which you want to get execution details.

type pipelineExecutionId

string

param pipelineExecutionId

[REQUIRED]

The ID of the pipeline execution about which you want to get execution details.

rtype

dict

returns

Response Syntax

{
    'pipelineExecution': {
        'pipelineName': 'string',
        'pipelineVersion': 123,
        'pipelineExecutionId': 'string',
        'status': 'InProgress'|'Succeeded'|'Superseded'|'Failed',
        'artifactRevisions': [
            {
                'name': 'string',
                '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.

      • artifactRevisions (list) --

        A list of ArtifactRevision objects included in a pipeline execution.

        • (dict) --

          Represents revision details of an artifact.

          • 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.

          • 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 content of a 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.