aws_sdk_apigateway/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    ///   - [`rest_api_id(impl Into<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::rest_api_id) / [`set_rest_api_id(Option<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_rest_api_id):<br>required: **true**<br><p>The string identifier of the associated RestApi.</p><br>
7    ///   - [`stage_name(impl Into<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::stage_name) / [`set_stage_name(Option<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_stage_name):<br>required: **true**<br><p>The name of the Stage that will be exported.</p><br>
8    ///   - [`export_type(impl Into<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::export_type) / [`set_export_type(Option<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_export_type):<br>required: **true**<br><p>The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.</p><br>
9    ///   - [`parameters(impl Into<String>, impl Into<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::parameters) / [`set_parameters(Option<HashMap::<String, String>>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_parameters):<br>required: **false**<br><p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p><br>
10    ///   - [`accepts(impl Into<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::accepts) / [`set_accepts(Option<String>)`](crate::operation::get_export::builders::GetExportFluentBuilder::set_accepts):<br>required: **false**<br><p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p><br>
11    /// - On success, responds with [`GetExportOutput`](crate::operation::get_export::GetExportOutput) with field(s):
12    ///   - [`content_type(Option<String>)`](crate::operation::get_export::GetExportOutput::content_type): <p>The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.</p>
13    ///   - [`content_disposition(Option<String>)`](crate::operation::get_export::GetExportOutput::content_disposition): <p>The content-disposition header value in the HTTP response.</p>
14    ///   - [`body(Option<Blob>)`](crate::operation::get_export::GetExportOutput::body): <p>The binary blob response to GetExport, which contains the export.</p>
15    /// - On failure, responds with [`SdkError<GetExportError>`](crate::operation::get_export::GetExportError)
16    pub fn get_export(&self) -> crate::operation::get_export::builders::GetExportFluentBuilder {
17        crate::operation::get_export::builders::GetExportFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_apigateway/client/get_export.rs

aws_sdk_apigateway/client/
get_export.rs
