Skip to content

ExportSummary

Source code in docs_src/capo_securityhub/types/export_summary.py
class ExportSummary(TypedDict, closed=True):
    export_job_id: NotRequired["capo_securityhub.types.export_job_id.ExportJobId"]
    """<p>The unique identifier of the export job.</p>"""
    name: NotRequired["capo_securityhub.types.export_name.ExportName"]
    """<p>The user-provided name of the export job, if one was specified.</p>"""
    status: NotRequired["capo_securityhub.types.export_status.ExportStatus"]
    """<p>The current state of the export job.</p>"""
    data_type: NotRequired["capo_securityhub.types.export_data_type.ExportDataType"]
    """<p>The category of data that the export job produces.</p>"""
    output_configuration: NotRequired[
        "capo_securityhub.types.export_output_summary.ExportOutputSummary"
    ]
    """<p>The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.</p>"""
    scopes: NotRequired["capo_securityhub.types.export_scopes.ExportScopes"]
    """<p>The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply <code>Scopes</code>.</p>"""
    destination: NotRequired[
        "capo_securityhub.types.export_destination.ExportDestination"
    ]
    """<p>The destination that the export job writes to.</p>"""
    failure_code: NotRequired[
        "capo_securityhub.types.export_failure_code.ExportFailureCode"
    ]
    """<p>A code that classifies why the export job failed. Present only when <code>Status</code> is <code>FAILED</code>.</p>"""
    failure_message: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>A human-readable message about why the export job failed. Present only when <code>Status</code> is <code>FAILED</code>.</p>"""
    started_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
    """<p>The time when the export job was created.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    ended_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
    """<p>The time when the export job reached a terminal state. Absent while the job is <code>RUNNING</code>.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""

data_type instance-attribute

data_type: NotRequired[ExportDataType]

The category of data that the export job produces.

destination instance-attribute

destination: NotRequired[ExportDestination]

The destination that the export job writes to.

ended_at instance-attribute

ended_at: NotRequired[Timestamp]

The time when the export job reached a terminal state. Absent while the job is RUNNING.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

export_job_id instance-attribute

export_job_id: NotRequired[ExportJobId]

The unique identifier of the export job.

failure_code instance-attribute

failure_code: NotRequired[ExportFailureCode]

A code that classifies why the export job failed. Present only when Status is FAILED.

failure_message instance-attribute

failure_message: NotRequired[NonEmptyString]

A human-readable message about why the export job failed. Present only when Status is FAILED.

name instance-attribute

name: NotRequired[ExportName]

The user-provided name of the export job, if one was specified.

output_configuration instance-attribute

output_configuration: NotRequired[ExportOutputSummary]

The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.

scopes instance-attribute

scopes: NotRequired[ExportScopes]

The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply Scopes.

started_at instance-attribute

started_at: NotRequired[Timestamp]

The time when the export job was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

status instance-attribute

status: NotRequired[ExportStatus]

The current state of the export job.