aws_sdk_lexmodelbuilding/client/get_export.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 [`GetExport`](crate::operation::get_export::builders::GetExportFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`name(impl Into<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_name):<br>required: **true**<br><p>The name of the bot to export.</p><br>
7 /// - [`version(impl Into<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::version) / [`set_version(Option<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_version):<br>required: **true**<br><p>The version of the bot to export.</p><br>
8 /// - [`resource_type(ResourceType)`](crate::operation::get_export::builders::GetExportFluentBuilder::resource_type) / [`set_resource_type(Option<ResourceType>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_resource_type):<br>required: **true**<br><p>The type of resource to export.</p><br>
9 /// - [`export_type(ExportType)`](crate::operation::get_export::builders::GetExportFluentBuilder::export_type) / [`set_export_type(Option<ExportType>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_export_type):<br>required: **true**<br><p>The format of the exported data.</p><br>
10 /// - On success, responds with [`GetExportOutput`](crate::operation::get_export::GetExportOutput) with field(s):
11 /// - [`name(Option<String>)`](crate::operation::get_export::GetExportOutput::name): <p>The name of the bot being exported.</p>
12 /// - [`version(Option<String>)`](crate::operation::get_export::GetExportOutput::version): <p>The version of the bot being exported.</p>
13 /// - [`resource_type(Option<ResourceType>)`](crate::operation::get_export::GetExportOutput::resource_type): <p>The type of the exported resource.</p>
14 /// - [`export_type(Option<ExportType>)`](crate::operation::get_export::GetExportOutput::export_type): <p>The format of the exported data.</p>
15 /// - [`export_status(Option<ExportStatus>)`](crate::operation::get_export::GetExportOutput::export_status): <p>The status of the export.</p> <ul> <li> <p><code>IN_PROGRESS</code> - The export is in progress.</p></li> <li> <p><code>READY</code> - The export is complete.</p></li> <li> <p><code>FAILED</code> - The export could not be completed.</p></li> </ul>
16 /// - [`failure_reason(Option<String>)`](crate::operation::get_export::GetExportOutput::failure_reason): <p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to export the resource.</p>
17 /// - [`url(Option<String>)`](crate::operation::get_export::GetExportOutput::url): <p>An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.</p>
18 /// - On failure, responds with [`SdkError<GetExportError>`](crate::operation::get_export::GetExportError)
19 pub fn get_export(&self) -> crate::operation::get_export::builders::GetExportFluentBuilder {
20 crate::operation::get_export::builders::GetExportFluentBuilder::new(self.handle.clone())
21 }
22}