:doc:`CodePipeline <../../codepipeline>` / Client / get_pipeline_execution

**********************
get_pipeline_execution
**********************



.. py:method:: CodePipeline.Client.get_pipeline_execution(**kwargs)

  

  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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/GetPipelineExecution>`_  


  **Request Syntax**
  ::

    response = 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': 'Cancelled'|'InProgress'|'Stopped'|'Stopping'|'Succeeded'|'Superseded'|'Failed',
              'statusSummary': 'string',
              'artifactRevisions': [
                  {
                      'name': 'string',
                      'revisionId': 'string',
                      'revisionChangeIdentifier': 'string',
                      'revisionSummary': 'string',
                      'created': datetime(2015, 1, 1),
                      'revisionUrl': 'string'
                  },
              ],
              'variables': [
                  {
                      'name': 'string',
                      'resolvedValue': 'string'
                  },
              ],
              'trigger': {
                  'triggerType': 'CreatePipeline'|'StartPipelineExecution'|'PollForSourceChanges'|'Webhook'|'CloudWatchEvent'|'PutActionRevision'|'WebhookV2'|'ManualRollback'|'AutomatedRollback',
                  'triggerDetail': 'string'
              },
              'executionMode': 'QUEUED'|'SUPERSEDED'|'PARALLEL',
              'executionType': 'STANDARD'|'ROLLBACK',
              'rollbackMetadata': {
                  'rollbackTargetPipelineExecutionId': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of a ``GetPipelineExecution`` action.

      
      

      - **pipelineExecution** *(dict) --* 

        Represents information about the execution of a pipeline.

        
        

        - **pipelineName** *(string) --* 

          The name of the pipeline with the specified pipeline execution.

          
        

        - **pipelineVersion** *(integer) --* 

          The version number of the pipeline with the specified pipeline execution.

          
        

        - **pipelineExecutionId** *(string) --* 

          The ID of the pipeline execution.

          
        

        - **status** *(string) --* 

          The status of the pipeline execution.

           

          
          * Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
           
          * InProgress: The pipeline execution is currently running.
           
          * Stopped: The pipeline execution was manually stopped. For more information, see `Stopped Executions <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped>`__.
           
          * Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see `Stopped Executions <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped>`__.
           
          * Succeeded: The pipeline execution was completed successfully.
           
          * Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see `Superseded Executions <https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded>`__.
           
          * Failed: The pipeline execution was not completed successfully.
          

          
        

        - **statusSummary** *(string) --* 

          A summary that contains a description of the pipeline execution status.

          
        

        - **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 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 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 CodeCommit repositories, the commit ID is linked to a commit details page.

              
        
      
        

        - **variables** *(list) --* 

          A list of pipeline variables used for the pipeline execution.

          
          

          - *(dict) --* 

            A pipeline-level variable used for a pipeline execution.

            
            

            - **name** *(string) --* 

              The name of a pipeline-level variable.

              
            

            - **resolvedValue** *(string) --* 

              The resolved value of a pipeline-level variable.

              
        
      
        

        - **trigger** *(dict) --* 

          The interaction or event that started a pipeline execution.

          
          

          - **triggerType** *(string) --* 

            The type of change-detection method, command, or user interaction that started a pipeline execution.

            
          

          - **triggerDetail** *(string) --* 

            Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated ``start-pipeline-execution`` CLI command.

            
      
        

        - **executionMode** *(string) --* 

          The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

          
        

        - **executionType** *(string) --* 

          The type of the pipeline execution.

          
        

        - **rollbackMetadata** *(dict) --* 

          The metadata about the execution pertaining to stage rollback.

          
          

          - **rollbackTargetPipelineExecutionId** *(string) --* 

            The pipeline execution ID to which the stage will be rolled back.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`CodePipeline.Client.exceptions.ValidationException`

  
  *   :py:class:`CodePipeline.Client.exceptions.PipelineNotFoundException`

  
  *   :py:class:`CodePipeline.Client.exceptions.PipelineExecutionNotFoundException`

  