Skip to content

StartExportTaskRequest

Source code in docs_src/capo_application_discovery_service/types/start_export_task_request.py
class StartExportTaskRequest(TypedDict, closed=True):
    export_data_format: NotRequired[
        "capo_application_discovery_service.types.export_data_formats.ExportDataFormats"
    ]
    """<p>The file format for the returned export data. Default value is <code>CSV</code>. <b>Note:</b> <i>The</i> <code>GRAPHML</code> <i>option has been deprecated.</i> </p>"""
    filters: NotRequired[
        "capo_application_discovery_service.types.export_filters.ExportFilters"
    ]
    """<p>If a filter is present, it selects the single <code>agentId</code> of the Application Discovery Agent for which data is exported. The <code>agentId</code> can be found in the results of the <code>DescribeAgents</code> API or CLI. If no filter is present, <code>startTime</code> and <code>endTime</code> are ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents. </p>"""
    start_time: NotRequired[
        "capo_application_discovery_service.types.time_stamp.TimeStamp"
    ]
    """<p>The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.</p>"""
    end_time: NotRequired[
        "capo_application_discovery_service.types.time_stamp.TimeStamp"
    ]
    """<p>The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.</p>"""
    preferences: NotRequired[
        "capo_application_discovery_service.types.export_preferences.ExportPreferences"
    ]
    """<p> Indicates the type of data that needs to be exported. Only one <a href="https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_ExportPreferences.html">ExportPreferences</a> can be enabled at any time. </p>"""

end_time instance-attribute

end_time: NotRequired[TimeStamp]

The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

export_data_format instance-attribute

export_data_format: NotRequired[ExportDataFormats]

The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

filters instance-attribute

filters: NotRequired[ExportFilters]

If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents.

preferences instance-attribute

preferences: NotRequired[ExportPreferences]

Indicates the type of data that needs to be exported. Only one ExportPreferences can be enabled at any time.

start_time instance-attribute

start_time: NotRequired[TimeStamp]

The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.