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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_tracker::_create_tracker_output::CreateTrackerOutputBuilder;
pub use crate::operation::create_tracker::_create_tracker_input::CreateTrackerInputBuilder;
impl crate::operation::create_tracker::builders::CreateTrackerInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::create_tracker::CreateTrackerOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_tracker::CreateTrackerError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.create_tracker();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `CreateTracker`.
///
/// <p>Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateTrackerFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_tracker::builders::CreateTrackerInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::create_tracker::CreateTrackerOutput,
crate::operation::create_tracker::CreateTrackerError,
> for CreateTrackerFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::create_tracker::CreateTrackerOutput,
crate::operation::create_tracker::CreateTrackerError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl CreateTrackerFluentBuilder {
/// Creates a new `CreateTrackerFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the CreateTracker as a reference.
pub fn as_input(&self) -> &crate::operation::create_tracker::builders::CreateTrackerInputBuilder {
&self.inner
}
/// 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_tracker::CreateTrackerOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_tracker::CreateTrackerError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::create_tracker::CreateTracker::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::create_tracker::CreateTracker::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::create_tracker::CreateTrackerOutput,
crate::operation::create_tracker::CreateTrackerError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name for the tracker 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 tracker resource name.</p></li>
/// <li>
/// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
/// </ul>
pub fn tracker_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.tracker_name(input.into());
self
}
/// <p>The name for the tracker 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 tracker resource name.</p></li>
/// <li>
/// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
/// </ul>
pub fn set_tracker_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_tracker_name(input);
self
}
/// <p>The name for the tracker 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 tracker resource name.</p></li>
/// <li>
/// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
/// </ul>
pub fn get_tracker_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_tracker_name()
}
/// <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>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 get_pricing_plan(&self) -> &::std::option::Option<crate::types::PricingPlan> {
self.inner.get_pricing_plan()
}
/// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.kms_key_id(input.into());
self
}
/// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_kms_key_id(input);
self
}
/// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_kms_key_id()
}
/// <p>This parameter is no longer used.</p>
#[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
pub fn pricing_plan_data_source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.pricing_plan_data_source(input.into());
self
}
/// <p>This parameter is no longer used.</p>
#[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
pub fn set_pricing_plan_data_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_pricing_plan_data_source(input);
self
}
/// <p>This parameter is no longer used.</p>
#[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
pub fn get_pricing_plan_data_source(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_pricing_plan_data_source()
}
/// <p>An optional description for the tracker resource.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>An optional description for the tracker 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>An optional description for the tracker resource.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_description()
}
///
/// 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 tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.</p>
/// <p>Format: <code>"key" : "value"</code></p>
/// <p>Restrictions:</p>
/// <ul>
/// <li>
/// <p>Maximum 50 tags per resource</p></li>
/// <li>
/// <p>Each resource tag must be unique with a maximum of one 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 ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.tags(k.into(), v.into());
self
}
/// <p>Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.</p>
/// <p>Format: <code>"key" : "value"</code></p>
/// <p>Restrictions:</p>
/// <ul>
/// <li>
/// <p>Maximum 50 tags per resource</p></li>
/// <li>
/// <p>Each resource tag must be unique with a maximum of one 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
}
/// <p>Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.</p>
/// <p>Format: <code>"key" : "value"</code></p>
/// <p>Restrictions:</p>
/// <ul>
/// <li>
/// <p>Maximum 50 tags per resource</p></li>
/// <li>
/// <p>Each resource tag must be unique with a maximum of one 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 get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.inner.get_tags()
}
/// <p>Specifies the position filtering for the tracker resource.</p>
/// <p>Valid values:</p>
/// <ul>
/// <li>
/// <p><code>TimeBased</code> - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p></li>
/// <li>
/// <p><code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.</p></li>
/// <li>
/// <p><code>AccuracyBased</code> - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.</p></li>
/// </ul>
/// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
pub fn position_filtering(mut self, input: crate::types::PositionFiltering) -> Self {
self.inner = self.inner.position_filtering(input);
self
}
/// <p>Specifies the position filtering for the tracker resource.</p>
/// <p>Valid values:</p>
/// <ul>
/// <li>
/// <p><code>TimeBased</code> - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p></li>
/// <li>
/// <p><code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.</p></li>
/// <li>
/// <p><code>AccuracyBased</code> - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.</p></li>
/// </ul>
/// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
pub fn set_position_filtering(mut self, input: ::std::option::Option<crate::types::PositionFiltering>) -> Self {
self.inner = self.inner.set_position_filtering(input);
self
}
/// <p>Specifies the position filtering for the tracker resource.</p>
/// <p>Valid values:</p>
/// <ul>
/// <li>
/// <p><code>TimeBased</code> - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p></li>
/// <li>
/// <p><code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.</p></li>
/// <li>
/// <p><code>AccuracyBased</code> - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.</p></li>
/// </ul>
/// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
pub fn get_position_filtering(&self) -> &::std::option::Option<crate::types::PositionFiltering> {
self.inner.get_position_filtering()
}
/// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
/// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
/// </note>
pub fn event_bridge_enabled(mut self, input: bool) -> Self {
self.inner = self.inner.event_bridge_enabled(input);
self
}
/// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
/// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
/// </note>
pub fn set_event_bridge_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_event_bridge_enabled(input);
self
}
/// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
/// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
/// </note>
pub fn get_event_bridge_enabled(&self) -> &::std::option::Option<bool> {
self.inner.get_event_bridge_enabled()
}
/// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
/// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
/// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
/// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
/// </note>
pub fn kms_key_enable_geospatial_queries(mut self, input: bool) -> Self {
self.inner = self.inner.kms_key_enable_geospatial_queries(input);
self
}
/// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
/// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
/// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
/// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
/// </note>
pub fn set_kms_key_enable_geospatial_queries(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_kms_key_enable_geospatial_queries(input);
self
}
/// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
/// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
/// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
/// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
/// </note>
pub fn get_kms_key_enable_geospatial_queries(&self) -> &::std::option::Option<bool> {
self.inner.get_kms_key_enable_geospatial_queries()
}
}