1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreatePlaceIndex`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_name(impl Into<String>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::set_index_name):<br>required: **true**<br><p>The name of the place index resource.</p> <p>Requirements:</p> <ul>  <li>   <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>  <li>   <p>Must be a unique place index resource name.</p></li>  <li>   <p>No spaces allowed. For example, <code>ExamplePlaceIndex</code>.</p></li> </ul><br>
    ///   - [`data_source(impl Into<String>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::data_source) / [`set_data_source(Option<String>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::set_data_source):<br>required: **true**<br><p>Specifies the geospatial data provider for the new place index.</p><note>  <p>This field is case-sensitive. Enter the valid values as shown. For example, entering <code>HERE</code> returns an error.</p> </note> <p>Valid values include:</p> <ul>  <li>   <p><code>Esri</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a>'s coverage in your region of interest, see <a href="https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm">Esri details on geocoding coverage</a>.</p></li>  <li>   <p><code>Grab</code> – Grab provides place index functionality for Southeast Asia. For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a>' coverage, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area">GrabMaps countries and areas covered</a>.</p></li>  <li>   <p><code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a>' coverage in your region of interest, see <a href="https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html">HERE details on goecoding coverage</a>.</p><important>    <p>If you specify HERE Technologies (<code>Here</code>) as the data provider, you may not <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see the <a href="http://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> for Amazon Location Service.</p>   </important></li> </ul> <p>For additional information , see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Data providers</a> on the <i>Amazon Location Service Developer Guide</i>.</p><br>
    ///   - [`pricing_plan(PricingPlan)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::pricing_plan) / [`set_pricing_plan(Option<PricingPlan>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::set_pricing_plan):<br>required: **false**<br><p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::set_description):<br>required: **false**<br><p>The optional description for the place index resource.</p><br>
    ///   - [`data_source_configuration(DataSourceConfiguration)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::data_source_configuration) / [`set_data_source_configuration(Option<DataSourceConfiguration>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::set_data_source_configuration):<br>required: **false**<br><p>Specifies the data storage option requesting Places.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::set_tags):<br>required: **false**<br><p>Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.</p> <p>Format: <code>"key" : "value"</code></p> <p>Restrictions:</p> <ul>  <li>   <p>Maximum 50 tags per resource.</p></li>  <li>   <p>Each tag key must be unique and must have exactly one associated value.</p></li>  <li>   <p>Maximum key length: 128 Unicode characters in UTF-8.</p></li>  <li>   <p>Maximum value length: 256 Unicode characters in UTF-8.</p></li>  <li>   <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @</p></li>  <li>   <p>Cannot use "aws:" as a prefix for a key.</p></li> </ul><br>
    /// - On success, responds with [`CreatePlaceIndexOutput`](crate::operation::create_place_index::CreatePlaceIndexOutput) with field(s):
    ///   - [`index_name(String)`](crate::operation::create_place_index::CreatePlaceIndexOutput::index_name): <p>The name for the place index resource.</p>
    ///   - [`index_arn(String)`](crate::operation::create_place_index::CreatePlaceIndexOutput::index_arn): <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.</p> <ul>  <li>   <p>Format example: <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code></p></li> </ul>
    ///   - [`create_time(DateTime)`](crate::operation::create_place_index::CreatePlaceIndexOutput::create_time): <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
    /// - On failure, responds with [`SdkError<CreatePlaceIndexError>`](crate::operation::create_place_index::CreatePlaceIndexError)
    pub fn create_place_index(&self) -> crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder {
        crate::operation::create_place_index::builders::CreatePlaceIndexFluentBuilder::new(self.handle.clone())
    }
}