:doc:`CodePipeline <../../codepipeline>` / Paginator / ListActionExecutions

********************
ListActionExecutions
********************



.. py:class:: CodePipeline.Paginator.ListActionExecutions

  ::

    
    paginator = client.get_paginator('list_action_executions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CodePipeline.Client.list_action_executions`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          pipelineName='string',
          filter={
              'pipelineExecutionId': 'string',
              'latestInPipelineExecution': {
                  'pipelineExecutionId': 'string',
                  'startTimeRange': 'Latest'|'All'
              }
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type pipelineName: string
    :param pipelineName: **[REQUIRED]** 

      The name of the pipeline for which you want to list action execution history.

      

    
    :type filter: dict
    :param filter: 

      Input information used to filter action execution history.

      

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

        The pipeline execution ID used to filter action execution history.

        

      
      - **latestInPipelineExecution** *(dict) --* 

        The latest execution in the pipeline.

         

        .. note::

          

          Filtering on the latest execution is available for executions run on or after February 08, 2024.

          

        

      
        - **pipelineExecutionId** *(string) --* **[REQUIRED]** 

          The execution ID for the latest execution in the pipeline.

          

        
        - **startTimeRange** *(string) --* **[REQUIRED]** 

          The start time to filter on for the latest execution in the pipeline. Valid options:

           

          
          * All
           
          * Latest
          

          

        
      
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'actionExecutionDetails': [
                {
                    'pipelineExecutionId': 'string',
                    'actionExecutionId': 'string',
                    'pipelineVersion': 123,
                    'stageName': 'string',
                    'actionName': 'string',
                    'startTime': datetime(2015, 1, 1),
                    'lastUpdateTime': datetime(2015, 1, 1),
                    'updatedBy': 'string',
                    'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
                    'input': {
                        'actionTypeId': {
                            'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval'|'Compute',
                            'owner': 'AWS'|'ThirdParty'|'Custom',
                            'provider': 'string',
                            'version': 'string'
                        },
                        'configuration': {
                            'string': 'string'
                        },
                        'resolvedConfiguration': {
                            'string': 'string'
                        },
                        'roleArn': 'string',
                        'region': 'string',
                        'inputArtifacts': [
                            {
                                'name': 'string',
                                's3location': {
                                    'bucket': 'string',
                                    'key': 'string'
                                }
                            },
                        ],
                        'namespace': 'string'
                    },
                    'output': {
                        'outputArtifacts': [
                            {
                                'name': 'string',
                                's3location': {
                                    'bucket': 'string',
                                    'key': 'string'
                                }
                            },
                        ],
                        'executionResult': {
                            'externalExecutionId': 'string',
                            'externalExecutionSummary': 'string',
                            'externalExecutionUrl': 'string',
                            'errorDetails': {
                                'code': 'string',
                                'message': 'string'
                            },
                            'logStreamARN': 'string'
                        },
                        'outputVariables': {
                            'string': 'string'
                        }
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **actionExecutionDetails** *(list) --* 

          The details for a list of recent executions, such as action execution ID.

          
          

          - *(dict) --* 

            Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.

            
            

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

              The pipeline execution ID for the action execution.

              
            

            - **actionExecutionId** *(string) --* 

              The action execution ID.

              
            

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

              The version of the pipeline where the action was run.

              
            

            - **stageName** *(string) --* 

              The name of the stage that contains the action.

              
            

            - **actionName** *(string) --* 

              The name of the action.

              
            

            - **startTime** *(datetime) --* 

              The start time of the action execution.

              
            

            - **lastUpdateTime** *(datetime) --* 

              The last update time of the action execution.

              
            

            - **updatedBy** *(string) --* 

              The ARN of the user who changed the pipeline execution details.

              
            

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

              The status of the action execution. Status categories are ``InProgress``, ``Succeeded``, and ``Failed``.

              
            

            - **input** *(dict) --* 

              Input details for the action execution, such as role ARN, Region, and input artifacts.

              
              

              - **actionTypeId** *(dict) --* 

                Represents information about an action type.

                
                

                - **category** *(string) --* 

                  A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.

                   

                  
                  * Source
                   
                  * Build
                   
                  * Test
                   
                  * Deploy
                   
                  * Invoke
                   
                  * Approval
                   
                  * Compute
                  

                  
                

                - **owner** *(string) --* 

                  The creator of the action being called. There are three valid values for the ``Owner`` field in the action category section within your pipeline structure: ``AWS``, ``ThirdParty``, and ``Custom``. For more information, see `Valid Action Types and Providers in CodePipeline <https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers>`__.

                  
                

                - **provider** *(string) --* 

                  The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as ``CodeDeploy``. For more information, see `Valid Action Types and Providers in CodePipeline <https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers>`__.

                  
                

                - **version** *(string) --* 

                  A string that describes the action version.

                  
            
              

              - **configuration** *(dict) --* 

                Configuration data for an action execution.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **resolvedConfiguration** *(dict) --* 

                Configuration data for an action execution with all variable references replaced with their real values for the execution.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **roleArn** *(string) --* 

                The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

                
              

              - **region** *(string) --* 

                The Amazon Web Services Region for the action, such as us-east-1.

                
              

              - **inputArtifacts** *(list) --* 

                Details of input artifacts of the action that correspond to the action execution.

                
                

                - *(dict) --* 

                  Artifact details for the action execution, such as the artifact location.

                  
                  

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

                    The artifact object name for the action execution.

                    
                  

                  - **s3location** *(dict) --* 

                    The Amazon S3 artifact location for the action execution.

                    
                    

                    - **bucket** *(string) --* 

                      The Amazon S3 artifact bucket for an action's artifacts.

                      
                    

                    - **key** *(string) --* 

                      The artifact name.

                      
                
              
            
              

              - **namespace** *(string) --* 

                The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

                
          
            

            - **output** *(dict) --* 

              Output details for the action execution, such as the action execution result.

              
              

              - **outputArtifacts** *(list) --* 

                Details of output artifacts of the action that correspond to the action execution.

                
                

                - *(dict) --* 

                  Artifact details for the action execution, such as the artifact location.

                  
                  

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

                    The artifact object name for the action execution.

                    
                  

                  - **s3location** *(dict) --* 

                    The Amazon S3 artifact location for the action execution.

                    
                    

                    - **bucket** *(string) --* 

                      The Amazon S3 artifact bucket for an action's artifacts.

                      
                    

                    - **key** *(string) --* 

                      The artifact name.

                      
                
              
            
              

              - **executionResult** *(dict) --* 

                Execution result information listed in the output details for an action execution.

                
                

                - **externalExecutionId** *(string) --* 

                  The action provider's external ID for the action execution.

                  
                

                - **externalExecutionSummary** *(string) --* 

                  The action provider's summary for the action execution.

                  
                

                - **externalExecutionUrl** *(string) --* 

                  The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.

                  
                

                - **errorDetails** *(dict) --* 

                  Represents information about an error in CodePipeline.

                  
                  

                  - **code** *(string) --* 

                    The system ID or number code of the error.

                    
                  

                  - **message** *(string) --* 

                    The text of the error message.

                    
              
                

                - **logStreamARN** *(string) --* 

                  The Amazon Resource Name (ARN) of the log stream for the action compute.

                  
            
              

              - **outputVariables** *(dict) --* 

                The outputVariables field shows the key-value pairs that were output as part of that execution.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    