Skip to content

AnalysisReport

Source code in docs_src/capo_pi/types/analysis_report.py
class AnalysisReport(TypedDict, closed=True):
    analysis_report_id: "capo_pi.types.analysis_report_id.AnalysisReportId"
    """<p>The name of the analysis report.</p>"""
    identifier: NotRequired["capo_pi.types.identifier_string.IdentifierString"]
    """<p>The unique identifier of the analysis report.</p>"""
    service_type: NotRequired["capo_pi.types.service_type.ServiceType"]
    """<p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p> <ul> <li> <p> <code>RDS</code> </p> </li> <li> <p> <code>DOCDB</code> </p> </li> </ul>"""
    create_time: NotRequired["capo_pi.types.iso_timestamp.ISOTimestamp"]
    """<p>The time you created the analysis report.</p>"""
    start_time: NotRequired["capo_pi.types.iso_timestamp.ISOTimestamp"]
    """<p>The analysis start time in the report.</p>"""
    end_time: NotRequired["capo_pi.types.iso_timestamp.ISOTimestamp"]
    """<p>The analysis end time in the report.</p>"""
    status: NotRequired["capo_pi.types.analysis_status.AnalysisStatus"]
    """<p>The status of the created analysis report.</p>"""
    insights: NotRequired["capo_pi.types.insight_list.InsightList"]
    """<p>The list of identified insights in the analysis report.</p>"""

analysis_report_id instance-attribute

analysis_report_id: AnalysisReportId

The name of the analysis report.

create_time instance-attribute

create_time: NotRequired[ISOTimestamp]

The time you created the analysis report.

end_time instance-attribute

end_time: NotRequired[ISOTimestamp]

The analysis end time in the report.

identifier instance-attribute

identifier: NotRequired[IdentifierString]

The unique identifier of the analysis report.

insights instance-attribute

insights: NotRequired[InsightList]

The list of identified insights in the analysis report.

service_type instance-attribute

service_type: NotRequired[ServiceType]

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

  • RDS

  • DOCDB

start_time instance-attribute

start_time: NotRequired[ISOTimestamp]

The analysis start time in the report.

status instance-attribute

status: NotRequired[AnalysisStatus]

The status of the created analysis report.