AWS CodePipeline

Lists the action executions that have occurred in a pipeline.

See also: AWS API Documentation

Request Syntax

client.list_action_executions(
    pipelineName='string',
    filter={
        'pipelineExecutionId': 'string'
    },
    maxResults=123,
    nextToken='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.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. The action execution history is limited to the most recent 12 months, based on action execution start times. Default value is 100.

type nextToken:

string

param nextToken:

The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.

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),
            'status': 'InProgress'|'Succeeded'|'Failed',
            'input': {
                'actionTypeId': {
                    'category': 'Source'|'Build'|'Deploy'|'Test'|'Invoke'|'Approval',
                    'owner': 'AWS'|'ThirdParty'|'Custom',
                    'provider': 'string',
                    'version': 'string'
                },
                'configuration': {
                    'string': 'string'
                },
                'roleArn': 'string',
                'region': 'string',
                'inputArtifacts': [
                    {
                        'name': 'string',
                        's3location': {
                            'bucket': 'string',
                            'key': 'string'
                        }
                    },
                ]
            },
            'output': {
                'outputArtifacts': [
                    {
                        'name': 'string',
                        's3location': {
                            'bucket': 'string',
                            'key': 'string'
                        }
                    },
                ],
                'executionResult': {
                    'externalExecutionId': 'string',
                    'externalExecutionSummary': 'string',
                    'externalExecutionUrl': '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.

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

          • owner (string) --

            The creator of the action being called.

          • 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 AWS CodeDeploy, which would be specified as CodeDeploy. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline.

          • version (string) --

            A string that describes the action version.

        • configuration (dict) --

          Configuration data for an action 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 AWS 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.

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

  • nextToken (string) --

    If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.