aws_sdk_applicationdiscovery/client/start_export_task.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`StartExportTask`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`export_data_format(ExportDataFormat)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::export_data_format) / [`set_export_data_format(Option<Vec::<ExportDataFormat>>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_export_data_format):<br>required: **false**<br><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><br>
7 /// - [`filters(ExportFilter)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::filters) / [`set_filters(Option<Vec::<ExportFilter>>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_filters):<br>required: **false**<br><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><br>
8 /// - [`start_time(DateTime)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_start_time):<br>required: **false**<br><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><br>
9 /// - [`end_time(DateTime)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_end_time):<br>required: **false**<br><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><br>
10 /// - [`preferences(ExportPreferences)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::preferences) / [`set_preferences(Option<ExportPreferences>)`](crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::set_preferences):<br>required: **false**<br><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><br>
11 /// - On success, responds with [`StartExportTaskOutput`](crate::operation::start_export_task::StartExportTaskOutput) with field(s):
12 /// - [`export_id(Option<String>)`](crate::operation::start_export_task::StartExportTaskOutput::export_id): <p>A unique identifier used to query the status of an export request.</p>
13 /// - On failure, responds with [`SdkError<StartExportTaskError>`](crate::operation::start_export_task::StartExportTaskError)
14 pub fn start_export_task(&self) -> crate::operation::start_export_task::builders::StartExportTaskFluentBuilder {
15 crate::operation::start_export_task::builders::StartExportTaskFluentBuilder::new(self.handle.clone())
16 }
17}