aws_sdk_apigateway/client/
get_model.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 [`GetModel`](crate::operation::get_model::builders::GetModelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`rest_api_id(impl Into<String>)`](crate::operation::get_model::builders::GetModelFluentBuilder::rest_api_id) / [`set_rest_api_id(Option<String>)`](crate::operation::get_model::builders::GetModelFluentBuilder::set_rest_api_id):<br>required: **true**<br><p>The RestApi identifier under which the Model exists.</p><br>
7    ///   - [`model_name(impl Into<String>)`](crate::operation::get_model::builders::GetModelFluentBuilder::model_name) / [`set_model_name(Option<String>)`](crate::operation::get_model::builders::GetModelFluentBuilder::set_model_name):<br>required: **true**<br><p>The name of the model as an identifier.</p><br>
8    ///   - [`flatten(bool)`](crate::operation::get_model::builders::GetModelFluentBuilder::flatten) / [`set_flatten(Option<bool>)`](crate::operation::get_model::builders::GetModelFluentBuilder::set_flatten):<br>required: **false**<br><p>A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <code>false</code>.</p><br>
9    /// - On success, responds with [`GetModelOutput`](crate::operation::get_model::GetModelOutput) with field(s):
10    ///   - [`id(Option<String>)`](crate::operation::get_model::GetModelOutput::id): <p>The identifier for the model resource.</p>
11    ///   - [`name(Option<String>)`](crate::operation::get_model::GetModelOutput::name): <p>The name of the model. Must be an alphanumeric string.</p>
12    ///   - [`description(Option<String>)`](crate::operation::get_model::GetModelOutput::description): <p>The description of the model.</p>
13    ///   - [`schema(Option<String>)`](crate::operation::get_model::GetModelOutput::schema): <p>The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.</p>
14    ///   - [`content_type(Option<String>)`](crate::operation::get_model::GetModelOutput::content_type): <p>The content-type for the model.</p>
15    /// - On failure, responds with [`SdkError<GetModelError>`](crate::operation::get_model::GetModelError)
16    pub fn get_model(&self) -> crate::operation::get_model::builders::GetModelFluentBuilder {
17        crate::operation::get_model::builders::GetModelFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_apigateway/client/get_model.rs

aws_sdk_apigateway/client/
get_model.rs
