CodePipeline / Client / list_rule_executions

list_rule_executions

CodePipeline.Client.list_rule_executions(**kwargs)

Lists the rule executions that have occurred in a pipeline configured for conditions with rules.

See also: AWS API Documentation

Request Syntax

response = client.list_rule_executions(
    pipelineName='string',
    filter={
        'pipelineExecutionId': 'string',
        'latestInPipelineExecution': {
            'pipelineExecutionId': 'string',
            'startTimeRange': 'Latest'|'All'
        }
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• pipelineName (string) –

  [REQUIRED]

  The name of the pipeline for which you want to get execution summary information.

• filter (dict) –

  Input information used to filter rule execution history.

  • pipelineExecutionId (string) –

    The pipeline execution ID used to filter rule execution history.

  • latestInPipelineExecution (dict) –

    The field that specifies to filter on 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

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

• nextToken (string) – The token that was returned from the previous ListRuleExecutions call, which can be used to return the next set of rule executions in the list.

Return type:

dict

Returns:

Response Syntax

{
    'ruleExecutionDetails': [
        {
            'pipelineExecutionId': 'string',
            'ruleExecutionId': 'string',
            'pipelineVersion': 123,
            'stageName': 'string',
            'ruleName': 'string',
            'startTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'status': 'InProgress'|'Abandoned'|'Succeeded'|'Failed',
            'input': {
                'ruleTypeId': {
                    'category': 'Rule',
                    'owner': 'AWS',
                    'provider': 'string',
                    'version': 'string'
                },
                'configuration': {
                    'string': 'string'
                },
                'resolvedConfiguration': {
                    'string': 'string'
                },
                'roleArn': 'string',
                'region': 'string',
                'inputArtifacts': [
                    {
                        'name': 'string',
                        's3location': {
                            'bucket': 'string',
                            'key': 'string'
                        }
                    },
                ]
            },
            'output': {
                'executionResult': {
                    'externalExecutionId': 'string',
                    'externalExecutionSummary': 'string',
                    'externalExecutionUrl': 'string',
                    'errorDetails': {
                        'code': 'string',
                        'message': 'string'
                    }
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • ruleExecutionDetails (list) –

    Details about the output for listing rule executions.

    • (dict) –

      The details of the runs for a rule and the results produced on an artifact as it passes through stages in the pipeline.

      • pipelineExecutionId (string) –

        The ID of the pipeline execution in the stage where the rule was run. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the stage.

      • ruleExecutionId (string) –

        The ID of the run for the rule.

      • pipelineVersion (integer) –

        The version number of the pipeline with the stage where the rule was run.

      • stageName (string) –

        The name of the stage where the rule was run.

      • ruleName (string) –

        The name of the rule that was run in the stage.

      • startTime (datetime) –

        The start time of the rule execution.

      • lastUpdateTime (datetime) –

        The date and time of the last change to the rule execution, in timestamp format.

      • updatedBy (string) –

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

      • status (string) –

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

      • input (dict) –

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

        • ruleTypeId (dict) –

          The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

          • category (string) –

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

            • INVOKE

            • Approval

            • Rule

          • owner (string) –

            The creator of the rule being called. The valid value for the Owner field in the rule category is AWS.

          • provider (string) –

            The provider of the service being called by the rule. Valid providers are determined by the rulecategory. For example, a managed rule in the Rule category type has an owner of AWS, which would be specified as AWS.

          • version (string) –

            A string that describes the rule version.

        • configuration (dict) –

          Configuration data for a rule execution, such as the resolved values for that run.

          • (string) –

            • (string) –

        • resolvedConfiguration (dict) –

          Configuration data for a rule 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 rule. This is assumed through the roleArn for the pipeline.

        • region (string) –

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

        • inputArtifacts (list) –

          Details of input artifacts of the rule that correspond to the rule 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 rule execution, such as the rule execution result.

        • executionResult (dict) –

          Execution result information listed in the output details for a rule execution.

          • externalExecutionId (string) –

            The external ID for the rule execution.

          • externalExecutionSummary (string) –

            The external provider summary for the rule 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 rule.

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

  • nextToken (string) –

    A token that can be used in the next ListRuleExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

Exceptions

• CodePipeline.Client.exceptions.ValidationException

• CodePipeline.Client.exceptions.PipelineNotFoundException

• CodePipeline.Client.exceptions.InvalidNextTokenException

• CodePipeline.Client.exceptions.PipelineExecutionNotFoundException