Skip to content

Report

Source code in docs_src/capo_codebuild/types/report.py
class Report(TypedDict, closed=True):
    arn: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p> The ARN of the report run. </p>"""
    type: NotRequired["capo_codebuild.types.report_type.ReportType"]
    """<p>The type of the report that was run.</p> <dl> <dt>CODE_COVERAGE</dt> <dd> <p>A code coverage report.</p> </dd> <dt>TEST</dt> <dd> <p>A test report.</p> </dd> </dl>"""
    name: NotRequired["capo_codebuild.types.string.String"]
    """<p> The name of the report that was run. </p>"""
    report_group_arn: NotRequired[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ]
    """<p> The ARN of the report group associated with this report. </p>"""
    execution_id: NotRequired["capo_codebuild.types.string.String"]
    """<p> The ARN of the build run that generated this report. </p>"""
    status: NotRequired["capo_codebuild.types.report_status_type.ReportStatusType"]
    """<p> The status of this report. </p>"""
    created: NotRequired["capo_codebuild.types.timestamp.Timestamp"]
    """<p> The date and time this report run occurred. </p>"""
    expired: NotRequired["capo_codebuild.types.timestamp.Timestamp"]
    """<p> The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild. </p>"""
    export_config: NotRequired[
        "capo_codebuild.types.report_export_config.ReportExportConfig"
    ]
    """<p> Information about where the raw data used to generate this report was exported. </p>"""
    truncated: NotRequired["capo_codebuild.types.wrapper_boolean.WrapperBoolean"]
    """<p> A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached. </p>"""
    test_summary: NotRequired[
        "capo_codebuild.types.test_report_summary.TestReportSummary"
    ]
    """<p> A <code>TestReportSummary</code> object that contains information about this test report. </p>"""
    code_coverage_summary: NotRequired[
        "capo_codebuild.types.code_coverage_report_summary.CodeCoverageReportSummary"
    ]
    """<p>A <code>CodeCoverageReportSummary</code> object that contains a code coverage summary for this report.</p>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

The ARN of the report run.

code_coverage_summary instance-attribute

code_coverage_summary: NotRequired[CodeCoverageReportSummary]

A CodeCoverageReportSummary object that contains a code coverage summary for this report.

created instance-attribute

created: NotRequired[Timestamp]

The date and time this report run occurred.

execution_id instance-attribute

execution_id: NotRequired[String]

The ARN of the build run that generated this report.

expired instance-attribute

expired: NotRequired[Timestamp]

The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.

export_config instance-attribute

export_config: NotRequired[ReportExportConfig]

Information about where the raw data used to generate this report was exported.

name instance-attribute

name: NotRequired[String]

The name of the report that was run.

report_group_arn instance-attribute

report_group_arn: NotRequired[NonEmptyString]

The ARN of the report group associated with this report.

status instance-attribute

status: NotRequired[ReportStatusType]

The status of this report.

test_summary instance-attribute

test_summary: NotRequired[TestReportSummary]

A TestReportSummary object that contains information about this test report.

truncated instance-attribute

truncated: NotRequired[WrapperBoolean]

A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.

type instance-attribute

type: NotRequired[ReportType]

The type of the report that was run.

CODE_COVERAGE

A code coverage report.

TEST

A test report.