Skip to content

DescribeCodeCoveragesInput

Source code in docs_src/capo_codebuild/types/describe_code_coverages_input.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class DescribeCodeCoveragesInput(TypedDict, closed=True):
    report_arn: "capo_codebuild.types.non_empty_string.NonEmptyString"
    """<p> The ARN of the report for which test cases are returned. </p>"""
    next_token: NotRequired["capo_codebuild.types.string.String"]
    """<p>The <code>nextToken</code> value returned from a previous call to <code>DescribeCodeCoverages</code>. This specifies the next item to return. To return the beginning of the list, exclude this parameter.</p>"""
    max_results: NotRequired["capo_codebuild.types.page_size.PageSize"]
    """<p>The maximum number of results to return.</p>"""
    sort_order: NotRequired["capo_codebuild.types.sort_order_type.SortOrderType"]
    """<p>Specifies if the results are sorted in ascending or descending order.</p>"""
    sort_by: NotRequired[
        "capo_codebuild.types.report_code_coverage_sort_by_type.ReportCodeCoverageSortByType"
    ]
    """<p>Specifies how the results are sorted. Possible values are:</p> <dl> <dt>FILE_PATH</dt> <dd> <p>The results are sorted by file path.</p> </dd> <dt>LINE_COVERAGE_PERCENTAGE</dt> <dd> <p>The results are sorted by the percentage of lines that are covered.</p> </dd> </dl>"""
    min_line_coverage_percentage: NotRequired[
        "capo_codebuild.types.percentage.Percentage"
    ]
    """<p>The minimum line coverage percentage to report.</p>"""
    max_line_coverage_percentage: NotRequired[
        "capo_codebuild.types.percentage.Percentage"
    ]
    """<p>The maximum line coverage percentage to report.</p>"""

max_line_coverage_percentage instance-attribute 

max_line_coverage_percentage: NotRequired[Percentage]

The maximum line coverage percentage to report.

max_results instance-attribute 

max_results: NotRequired[PageSize]

The maximum number of results to return.

min_line_coverage_percentage instance-attribute 

min_line_coverage_percentage: NotRequired[Percentage]

The minimum line coverage percentage to report.

next_token instance-attribute 

next_token: NotRequired[String]

The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

report_arn instance-attribute 

report_arn: NonEmptyString

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

sort_by instance-attribute 

sort_by: NotRequired[ReportCodeCoverageSortByType]

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.

sort_order instance-attribute 

sort_order: NotRequired[SortOrderType]

Specifies if the results are sorted in ascending or descending order.