CodePipeline / Paginator / ListRuleExecutions

ListRuleExecutions

class CodePipeline.Paginator.ListRuleExecutions

paginator = client.get_paginator('list_rule_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodePipeline.Client.list_rule_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    pipelineName='string',
    filter={
        'pipelineExecutionId': 'string',
        'latestInPipelineExecution': {
            'pipelineExecutionId': 'string',
            'startTimeRange': 'Latest'|'All'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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

• PaginationConfig (dict) –

  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.

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. The valid category is 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 rule provider, such as the DeploymentWindow rule.

          • 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 to resume pagination.