Skip to content

ReportSummary

Source code in docs_src/capo_artifact/types/report_summary.py
class ReportSummary(TypedDict, closed=True):
    id: NotRequired["capo_artifact.types.report_id.ReportId"]
    """<p>Unique resource ID for the report resource.</p>"""
    name: NotRequired["capo_artifact.types.short_string_attribute.ShortStringAttribute"]
    """<p>Name for the report resource.</p>"""
    state: NotRequired["capo_artifact.types.published_state.PublishedState"]
    """<p>Current state of the report resource.</p>"""
    arn: NotRequired["capo_artifact.types.long_string_attribute.LongStringAttribute"]
    """<p>ARN for the report resource.</p>"""
    version: NotRequired["capo_artifact.types.version_attribute.VersionAttribute"]
    """<p>Version for the report resource.</p>"""
    upload_state: NotRequired["capo_artifact.types.upload_state.UploadState"]
    """<p>The current state of the document upload.</p>"""
    description: NotRequired[
        "capo_artifact.types.long_string_attribute.LongStringAttribute"
    ]
    """<p>Description for the report resource.</p>"""
    period_start: NotRequired[
        "capo_artifact.types.timestamp_attribute.TimestampAttribute"
    ]
    """<p>Timestamp indicating the report resource effective start.</p>"""
    period_end: NotRequired[
        "capo_artifact.types.timestamp_attribute.TimestampAttribute"
    ]
    """<p>Timestamp indicating the report resource effective end.</p>"""
    series: NotRequired[
        "capo_artifact.types.short_string_attribute.ShortStringAttribute"
    ]
    """<p>Series for the report resource.</p>"""
    category: NotRequired[
        "capo_artifact.types.short_string_attribute.ShortStringAttribute"
    ]
    """<p>Category for the report resource.</p>"""
    company_name: NotRequired[
        "capo_artifact.types.short_string_attribute.ShortStringAttribute"
    ]
    """<p>Associated company name for the report resource.</p>"""
    product_name: NotRequired[
        "capo_artifact.types.short_string_attribute.ShortStringAttribute"
    ]
    """<p>Associated product name for the report resource.</p>"""
    status_message: NotRequired["capo_artifact.types.status_message.StatusMessage"]
    """<p>The message associated with the current upload state.</p>"""
    acceptance_type: NotRequired["capo_artifact.types.acceptance_type.AcceptanceType"]
    """<p>Acceptance type for report.</p>"""

acceptance_type instance-attribute

acceptance_type: NotRequired[AcceptanceType]

Acceptance type for report.

arn instance-attribute

arn: NotRequired[LongStringAttribute]

ARN for the report resource.

category instance-attribute

category: NotRequired[ShortStringAttribute]

Category for the report resource.

company_name instance-attribute

company_name: NotRequired[ShortStringAttribute]

Associated company name for the report resource.

description instance-attribute

description: NotRequired[LongStringAttribute]

Description for the report resource.

id instance-attribute

id: NotRequired[ReportId]

Unique resource ID for the report resource.

name instance-attribute

name: NotRequired[ShortStringAttribute]

Name for the report resource.

period_end instance-attribute

period_end: NotRequired[TimestampAttribute]

Timestamp indicating the report resource effective end.

period_start instance-attribute

period_start: NotRequired[TimestampAttribute]

Timestamp indicating the report resource effective start.

product_name instance-attribute

product_name: NotRequired[ShortStringAttribute]

Associated product name for the report resource.

series instance-attribute

series: NotRequired[ShortStringAttribute]

Series for the report resource.

state instance-attribute

state: NotRequired[PublishedState]

Current state of the report resource.

status_message instance-attribute

status_message: NotRequired[StatusMessage]

The message associated with the current upload state.

upload_state instance-attribute

upload_state: NotRequired[UploadState]

The current state of the document upload.

version instance-attribute

version: NotRequired[VersionAttribute]

Version for the report resource.