// 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()
}
}