aws_sdk_apigatewayv2/client/
export_api.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 [`ExportApi`](crate::operation::export_api::builders::ExportApiFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`api_id(impl Into<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::api_id) / [`set_api_id(Option<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::set_api_id):<br>required: **true**<br><p>The API identifier.</p><br>
7    ///   - [`export_version(impl Into<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::export_version) / [`set_export_version(Option<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::set_export_version):<br>required: **false**<br><p>The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.</p><br>
8    ///   - [`include_extensions(bool)`](crate::operation::export_api::builders::ExportApiFluentBuilder::include_extensions) / [`set_include_extensions(Option<bool>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::set_include_extensions):<br>required: **false**<br><p>Specifies whether to include <a href="https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.</p><br>
9    ///   - [`output_type(impl Into<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::output_type) / [`set_output_type(Option<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::set_output_type):<br>required: **true**<br><p>The output type of the exported definition file. Valid values are JSON and YAML.</p><br>
10    ///   - [`specification(impl Into<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::specification) / [`set_specification(Option<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::set_specification):<br>required: **true**<br><p>The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.</p><br>
11    ///   - [`stage_name(impl Into<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::stage_name) / [`set_stage_name(Option<String>)`](crate::operation::export_api::builders::ExportApiFluentBuilder::set_stage_name):<br>required: **false**<br><p>The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.</p><br>
12    /// - On success, responds with [`ExportApiOutput`](crate::operation::export_api::ExportApiOutput) with field(s):
13    ///   - [`body(Option<Blob>)`](crate::operation::export_api::ExportApiOutput::body): <p>Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.</p>
14    /// - On failure, responds with [`SdkError<ExportApiError>`](crate::operation::export_api::ExportApiError)
15    pub fn export_api(&self) -> crate::operation::export_api::builders::ExportApiFluentBuilder {
16        crate::operation::export_api::builders::ExportApiFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_apigatewayv2/client/export_api.rs

aws_sdk_apigatewayv2/client/
export_api.rs
