CodeBuild / Paginator / DescribeCodeCoverages

DescribeCodeCoverages#

class CodeBuild.Paginator.DescribeCodeCoverages#
paginator = client.get_paginator('describe_code_coverages')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CodeBuild.Client.describe_code_coverages().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    reportArn='string',
    sortOrder='ASCENDING'|'DESCENDING',
    sortBy='LINE_COVERAGE_PERCENTAGE'|'FILE_PATH',
    minLineCoveragePercentage=123.0,
    maxLineCoveragePercentage=123.0,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • reportArn (string) –

    [REQUIRED]

    The ARN of the report for which test cases are returned.

  • sortOrder (string) – Specifies if the results are sorted in ascending or descending order.

  • sortBy (string) –

    Specifies how the results are sorted. Possible values are:

    FILE_PATH

    The results are sorted by file path.

    LINE_COVERAGE_PERCENTAGE

    The results are sorted by the percentage of lines that are covered.

  • minLineCoveragePercentage (float) – The minimum line coverage percentage to report.

  • maxLineCoveragePercentage (float) – The maximum line coverage percentage to report.

  • 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

{
    'codeCoverages': [
        {
            'id': 'string',
            'reportARN': 'string',
            'filePath': 'string',
            'lineCoveragePercentage': 123.0,
            'linesCovered': 123,
            'linesMissed': 123,
            'branchCoveragePercentage': 123.0,
            'branchesCovered': 123,
            'branchesMissed': 123,
            'expired': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • codeCoverages (list) –

      An array of CodeCoverage objects that contain the results.

      • (dict) –

        Contains code coverage report information.

        Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.

        Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.

        • id (string) –

          The identifier of the code coverage report.

        • reportARN (string) –

          The ARN of the report.

        • filePath (string) –

          The path of the test report file.

        • lineCoveragePercentage (float) –

          The percentage of lines that are covered by your tests.

        • linesCovered (integer) –

          The number of lines that are covered by your tests.

        • linesMissed (integer) –

          The number of lines that are not covered by your tests.

        • branchCoveragePercentage (float) –

          The percentage of branches that are covered by your tests.

        • branchesCovered (integer) –

          The number of conditional branches that are covered by your tests.

        • branchesMissed (integer) –

          The number of conditional branches that are not covered by your tests.

        • expired (datetime) –

          The date and time that the tests were run.

    • NextToken (string) –

      A token to resume pagination.