aws_sdk_apigateway/client/update_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 [`UpdateBasePathMapping`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain_name(impl Into<String>)`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::set_domain_name):<br>required: **true**<br><p>The domain name of the BasePathMapping resource to change.</p><br>
7 /// - [`domain_name_id(impl Into<String>)`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::domain_name_id) / [`set_domain_name_id(Option<String>)`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::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::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::base_path) / [`set_base_path(Option<String>)`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::set_base_path):<br>required: **true**<br><p>The base path of the BasePathMapping resource to change.</p> <p>To specify an empty base path, set this parameter to <code>'(none)'</code>.</p><br>
9 /// - [`patch_operations(PatchOperation)`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::patch_operations) / [`set_patch_operations(Option<Vec::<PatchOperation>>)`](crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::set_patch_operations):<br>required: **false**<br><p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p><br>
10 /// - On success, responds with [`UpdateBasePathMappingOutput`](crate::operation::update_base_path_mapping::UpdateBasePathMappingOutput) with field(s):
11 /// - [`base_path(Option<String>)`](crate::operation::update_base_path_mapping::UpdateBasePathMappingOutput::base_path): <p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>
12 /// - [`rest_api_id(Option<String>)`](crate::operation::update_base_path_mapping::UpdateBasePathMappingOutput::rest_api_id): <p>The string identifier of the associated RestApi.</p>
13 /// - [`stage(Option<String>)`](crate::operation::update_base_path_mapping::UpdateBasePathMappingOutput::stage): <p>The name of the associated stage.</p>
14 /// - On failure, responds with [`SdkError<UpdateBasePathMappingError>`](crate::operation::update_base_path_mapping::UpdateBasePathMappingError)
15 pub fn update_base_path_mapping(&self) -> crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder {
16 crate::operation::update_base_path_mapping::builders::UpdateBasePathMappingFluentBuilder::new(self.handle.clone())
17 }
18}