1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_place_index::_create_place_index_output::CreatePlaceIndexOutputBuilder;
pub use crate::operation::create_place_index::_create_place_index_input::CreatePlaceIndexInputBuilder;
/// Fluent builder constructing a request to `CreatePlaceIndex`.
///
/// <p>Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p> <note>
/// <p>If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services service terms</a> for more details.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreatePlaceIndexFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_place_index::builders::CreatePlaceIndexInputBuilder,
}
impl CreatePlaceIndexFluentBuilder {
/// Creates a new `CreatePlaceIndex`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::create_place_index::CreatePlaceIndex,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::create_place_index::CreatePlaceIndexError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::create_place_index::CreatePlaceIndexOutput,
aws_smithy_http::result::SdkError<
crate::operation::create_place_index::CreatePlaceIndexError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <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>
pub fn index_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.index_name(input.into());
self
}
/// <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>
pub fn set_index_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_index_name(input);
self
}
/// <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>
pub fn data_source(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.data_source(input.into());
self
}
/// <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>
pub fn set_data_source(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_data_source(input);
self
}
/// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
#[deprecated(
note = "Deprecated. If included, the only allowed value is RequestBasedUsage.",
since = "2022-02-01"
)]
pub fn pricing_plan(mut self, input: crate::types::PricingPlan) -> Self {
self.inner = self.inner.pricing_plan(input);
self
}
/// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
#[deprecated(
note = "Deprecated. If included, the only allowed value is RequestBasedUsage.",
since = "2022-02-01"
)]
pub fn set_pricing_plan(
mut self,
input: std::option::Option<crate::types::PricingPlan>,
) -> Self {
self.inner = self.inner.set_pricing_plan(input);
self
}
/// <p>The optional description for the place index resource.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>The optional description for the place index resource.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>Specifies the data storage option requesting Places.</p>
pub fn data_source_configuration(
mut self,
input: crate::types::DataSourceConfiguration,
) -> Self {
self.inner = self.inner.data_source_configuration(input);
self
}
/// <p>Specifies the data storage option requesting Places.</p>
pub fn set_data_source_configuration(
mut self,
input: std::option::Option<crate::types::DataSourceConfiguration>,
) -> Self {
self.inner = self.inner.set_data_source_configuration(input);
self
}
/// Adds a key-value pair to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <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>
pub fn tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.tags(k.into(), v.into());
self
}
/// <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>
pub fn set_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}