aws_sdk_apigateway/client/
get_base_path_mapping.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 [`GetBasePathMapping`](crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder::set_domain_name):<br>required: **true**<br><p>The domain name of the BasePathMapping resource to be described.</p><br>
7    ///   - [`domain_name_id(impl Into<String>)`](crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder::domain_name_id) / [`set_domain_name_id(Option<String>)`](crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder::set_domain_name_id):<br>required: **false**<br><p>The identifier for the domain name resource. Supported only for private custom domain names.</p><br>
8    ///   - [`base_path(impl Into<String>)`](crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder::base_path) / [`set_base_path(Option<String>)`](crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder::set_base_path):<br>required: **true**<br><p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.</p><br>
9    /// - On success, responds with [`GetBasePathMappingOutput`](crate::operation::get_base_path_mapping::GetBasePathMappingOutput) with field(s):
10    ///   - [`base_path(Option<String>)`](crate::operation::get_base_path_mapping::GetBasePathMappingOutput::base_path): <p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>
11    ///   - [`rest_api_id(Option<String>)`](crate::operation::get_base_path_mapping::GetBasePathMappingOutput::rest_api_id): <p>The string identifier of the associated RestApi.</p>
12    ///   - [`stage(Option<String>)`](crate::operation::get_base_path_mapping::GetBasePathMappingOutput::stage): <p>The name of the associated stage.</p>
13    /// - On failure, responds with [`SdkError<GetBasePathMappingError>`](crate::operation::get_base_path_mapping::GetBasePathMappingError)
14    pub fn get_base_path_mapping(&self) -> crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder {
15        crate::operation::get_base_path_mapping::builders::GetBasePathMappingFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_apigateway/client/get_base_path_mapping.rs

aws_sdk_apigateway/client/
get_base_path_mapping.rs
