aws_sdk_apigateway/client/
get_base_path_mappings.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 [`GetBasePathMappings`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::set_domain_name):<br>required: **true**<br><p>The domain name of a BasePathMapping resource.</p><br>
8    ///   - [`domain_name_id(impl Into<String>)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::domain_name_id) / [`set_domain_name_id(Option<String>)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::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>
9    ///   - [`position(impl Into<String>)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::position) / [`set_position(Option<String>)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::set_position):<br>required: **false**<br><p>The current pagination position in the paged result set.</p><br>
10    ///   - [`limit(i32)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p><br>
11    /// - On success, responds with [`GetBasePathMappingsOutput`](crate::operation::get_base_path_mappings::GetBasePathMappingsOutput) with field(s):
12    ///   - [`items(Option<Vec::<BasePathMapping>>)`](crate::operation::get_base_path_mappings::GetBasePathMappingsOutput::items): <p>The current page of elements from this collection.</p>
13    ///   - [`position(Option<String>)`](crate::operation::get_base_path_mappings::GetBasePathMappingsOutput::position): <p>The current pagination position in the paged result set.</p>
14    /// - On failure, responds with [`SdkError<GetBasePathMappingsError>`](crate::operation::get_base_path_mappings::GetBasePathMappingsError)
15    pub fn get_base_path_mappings(&self) -> crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder {
16        crate::operation::get_base_path_mappings::builders::GetBasePathMappingsFluentBuilder::new(self.handle.clone())
17    }
18}