Struct aws_sdk_location::Client

pub struct Client { /* private fields */ }

Client for Amazon Location Service

Client for invoking operations on Amazon Location Service. Each operation on Amazon Location Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_location::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The [Builder] struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_location::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Implementations

impl Client

pub fn associate_tracker_consumer( &self, ) -> AssociateTrackerConsumerFluentBuilder

Constructs a fluent builder for the AssociateTrackerConsumer operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource to be associated with a geofence collection.

    
    
  • consumer_arn(impl Into<String>) / set_consumer_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

    
    
• On success, responds with AssociateTrackerConsumerOutput
• On failure, responds with SdkError<AssociateTrackerConsumerError>

impl Client

pub fn batch_delete_device_position_history( &self, ) -> BatchDeleteDevicePositionHistoryFluentBuilder

Constructs a fluent builder for the BatchDeleteDevicePositionHistory operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource to delete the device position history from.

    
    
  • device_ids(impl Into<String>) / set_device_ids(Option<Vec::<String>>):
    required: true
    

    Devices whose position history you want to delete.

    • For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]

    
    
• On success, responds with BatchDeleteDevicePositionHistoryOutput with field(s):
  • errors(Vec::<BatchDeleteDevicePositionHistoryError>):

    Contains error details for each device history that failed to delete.

• On failure, responds with SdkError<BatchDeleteDevicePositionHistoryError>

impl Client

pub fn batch_delete_geofence(&self) -> BatchDeleteGeofenceFluentBuilder

Constructs a fluent builder for the BatchDeleteGeofence operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The geofence collection storing the geofences to be deleted.

    
    
  • geofence_ids(impl Into<String>) / set_geofence_ids(Option<Vec::<String>>):
    required: true
    

    The batch of geofences to be deleted.

    
    
• On success, responds with BatchDeleteGeofenceOutput with field(s):
  • errors(Vec::<BatchDeleteGeofenceError>):

    Contains error details for each geofence that failed to delete.

• On failure, responds with SdkError<BatchDeleteGeofenceError>

impl Client

pub fn batch_evaluate_geofences(&self) -> BatchEvaluateGeofencesFluentBuilder

Constructs a fluent builder for the BatchEvaluateGeofences operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The geofence collection used in evaluating the position of devices against its geofences.

    
    
  • device_position_updates(DevicePositionUpdate) / set_device_position_updates(Option<Vec::<DevicePositionUpdate>>):
    required: true
    

    Contains device details for each device to be evaluated against the given geofence collection.

    
    
• On success, responds with BatchEvaluateGeofencesOutput with field(s):
  • errors(Vec::<BatchEvaluateGeofencesError>):

    Contains error details for each device that failed to evaluate its position against the given geofence collection.

• On failure, responds with SdkError<BatchEvaluateGeofencesError>

impl Client

pub fn batch_get_device_position(&self) -> BatchGetDevicePositionFluentBuilder

Constructs a fluent builder for the BatchGetDevicePosition operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The tracker resource retrieving the device position.

    
    
  • device_ids(impl Into<String>) / set_device_ids(Option<Vec::<String>>):
    required: true
    

    Devices whose position you want to retrieve.

    • For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

    
    
• On success, responds with BatchGetDevicePositionOutput with field(s):
  • errors(Vec::<BatchGetDevicePositionError>):

    Contains error details for each device that failed to send its position to the tracker resource.

  • device_positions(Vec::<DevicePosition>):

    Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

• On failure, responds with SdkError<BatchGetDevicePositionError>

impl Client

pub fn batch_put_geofence(&self) -> BatchPutGeofenceFluentBuilder

Constructs a fluent builder for the BatchPutGeofence operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The geofence collection storing the geofences.

    
    
  • entries(BatchPutGeofenceRequestEntry) / set_entries(Option<Vec::<BatchPutGeofenceRequestEntry>>):
    required: true
    

    The batch of geofences to be stored in a geofence collection.

    
    
• On success, responds with BatchPutGeofenceOutput with field(s):
  • successes(Vec::<BatchPutGeofenceSuccess>):

    Contains each geofence that was successfully stored in a geofence collection.

  • errors(Vec::<BatchPutGeofenceError>):

    Contains additional error details for each geofence that failed to be stored in a geofence collection.

• On failure, responds with SdkError<BatchPutGeofenceError>

impl Client

pub fn batch_update_device_position( &self, ) -> BatchUpdateDevicePositionFluentBuilder

Constructs a fluent builder for the BatchUpdateDevicePosition operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource to update.

    
    
  • updates(DevicePositionUpdate) / set_updates(Option<Vec::<DevicePositionUpdate>>):
    required: true
    

    Contains the position update details for each device, up to 10 devices.

    
    
• On success, responds with BatchUpdateDevicePositionOutput with field(s):
  • errors(Vec::<BatchUpdateDevicePositionError>):

    Contains error details for each device that failed to update its position.

• On failure, responds with SdkError<BatchUpdateDevicePositionError>

impl Client

pub fn calculate_route(&self) -> CalculateRouteFluentBuilder

Constructs a fluent builder for the CalculateRoute operation.

• The fluent builder is configurable:
  • calculator_name(impl Into<String>) / set_calculator_name(Option<String>):
    required: true
    

    The name of the route calculator resource that you want to use to calculate the route.

    
    
  • departure_position(f64) / set_departure_position(Option<Vec::<f64>>):
    required: true
    

    The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

    • For example, [-123.115, 49.285]

    If you specify a departure that’s not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

    Valid Values: [-180 to 180,-90 to 90]

    
    
  • destination_position(f64) / set_destination_position(Option<Vec::<f64>>):
    required: true
    

    The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

    • For example, [-122.339, 47.615]

    If you specify a destination that’s not located on a road, Amazon Location moves the position to the nearest road.

    Valid Values: [-180 to 180,-90 to 90]

    
    
  • waypoint_positions(Vec::<f64>) / set_waypoint_positions(Option<Vec::<Vec::<f64>>>):
    required: false
    

    Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

    • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

    If you specify a waypoint position that’s not located on a road, Amazon Location moves the position to the nearest road.

    Specifying more than 23 waypoints returns a 400 ValidationException error.

    If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

    Valid Values: [-180 to 180,-90 to 90]

    
    
  • travel_mode(TravelMode) / set_travel_mode(Option<TravelMode>):
    required: false
    

    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.

    Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

    Truck is not available for Grab.

    For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.

    The TravelMode you specify also determines how you specify route preferences:

    • If traveling by Car use the CarModeOptions parameter.

    • If traveling by Truck use the TruckModeOptions parameter.

    Default Value: Car

    
    
  • departure_time(DateTime) / set_departure_time(Option<DateTime>):
    required: false
    

    Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

    • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

    
    
  • depart_now(bool) / set_depart_now(Option<bool>):
    required: false
    

    Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

    Default Value: false

    Valid Values: false | true

    
    
  • distance_unit(DistanceUnit) / set_distance_unit(Option<DistanceUnit>):
    required: false
    

    Set the unit system to specify the distance.

    Default Value: Kilometers

    
    
  • include_leg_geometry(bool) / set_include_leg_geometry(Option<bool>):
    required: false
    

    Set to include the geometry details in the result for each path between a pair of positions.

    Default Value: false

    Valid Values: false | true

    
    
  • car_mode_options(CalculateRouteCarModeOptions) / set_car_mode_options(Option<CalculateRouteCarModeOptions>):
    required: false
    

    Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

    Requirements: TravelMode must be specified as Car.

    
    
  • truck_mode_options(CalculateRouteTruckModeOptions) / set_truck_mode_options(Option<CalculateRouteTruckModeOptions>):
    required: false
    

    Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

    Requirements: TravelMode must be specified as Truck.

    
    
  • arrival_time(DateTime) / set_arrival_time(Option<DateTime>):
    required: false
    

    Specifies the desired time of arrival. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

    ArrivalTime is not supported Esri.

    
    
  • optimize_for(OptimizationMode) / set_optimize_for(Option<OptimizationMode>):
    required: false
    

    Specifies the distance to optimize for when calculating a route.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with CalculateRouteOutput with field(s):
  • legs(Vec::<Leg>):

    Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

    For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

    • The StartPosition is the departure position.

    • The EndPosition is the destination position.

    A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

    • Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

    • Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

  • summary(Option<CalculateRouteSummary>):

    Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

• On failure, responds with SdkError<CalculateRouteError>

impl Client

pub fn calculate_route_matrix(&self) -> CalculateRouteMatrixFluentBuilder

Constructs a fluent builder for the CalculateRouteMatrix operation.

• The fluent builder is configurable:
  • calculator_name(impl Into<String>) / set_calculator_name(Option<String>):
    required: true
    

    The name of the route calculator resource that you want to use to calculate the route matrix.

    
    
  • departure_positions(Vec::<f64>) / set_departure_positions(Option<Vec::<Vec::<f64>>>):
    required: true
    

    The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

    Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

    For route calculators that use Esri as the data provider, if you specify a departure that’s not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

    Valid Values: [-180 to 180,-90 to 90]

    
    
  • destination_positions(Vec::<f64>) / set_destination_positions(Option<Vec::<Vec::<f64>>>):
    required: true
    

    The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

    Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

    For route calculators that use Esri as the data provider, if you specify a destination that’s not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

    Valid Values: [-180 to 180,-90 to 90]

    
    
  • travel_mode(TravelMode) / set_travel_mode(Option<TravelMode>):
    required: false
    

    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

    The TravelMode you specify also determines how you specify route preferences:

    • If traveling by Car use the CarModeOptions parameter.

    • If traveling by Truck use the TruckModeOptions parameter.

    Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

    Truck is not available for Grab.

    For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

    Default Value: Car

    
    
  • departure_time(DateTime) / set_departure_time(Option<DateTime>):
    required: false
    

    Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can’t set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

    Setting a departure time in the past returns a 400 ValidationException error.

    • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

    
    
  • depart_now(bool) / set_depart_now(Option<bool>):
    required: false
    

    Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can’t set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

    Default Value: false

    Valid Values: false | true

    
    
  • distance_unit(DistanceUnit) / set_distance_unit(Option<DistanceUnit>):
    required: false
    

    Set the unit system to specify the distance.

    Default Value: Kilometers

    
    
  • car_mode_options(CalculateRouteCarModeOptions) / set_car_mode_options(Option<CalculateRouteCarModeOptions>):
    required: false
    

    Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

    Requirements: TravelMode must be specified as Car.

    
    
  • truck_mode_options(CalculateRouteTruckModeOptions) / set_truck_mode_options(Option<CalculateRouteTruckModeOptions>):
    required: false
    

    Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

    Requirements: TravelMode must be specified as Truck.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with CalculateRouteMatrixOutput with field(s):
  • route_matrix(Vec::<Vec::<RouteMatrixEntry>>):

    The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

  • snapped_departure_positions(Option<Vec::<Vec::<f64>>>):

    For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

  • snapped_destination_positions(Option<Vec::<Vec::<f64>>>):

    The list of destination positions for the route matrix used for calculation of the RouteMatrix.

  • summary(Option<CalculateRouteMatrixSummary>):

    Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

• On failure, responds with SdkError<CalculateRouteMatrixError>

impl Client

pub fn create_geofence_collection( &self, ) -> CreateGeofenceCollectionFluentBuilder

Constructs a fluent builder for the CreateGeofenceCollection operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    A custom name for the geofence collection.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

    • Must be a unique geofence collection name.

    • No spaces allowed. For example, ExampleGeofenceCollection.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • pricing_plan_data_source(impl Into<String>) / set_pricing_plan_data_source(Option<String>):
    required: false
    

    This parameter is no longer used.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the geofence collection.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

    Format: “key” : “value”

    Restrictions:

    • Maximum 50 tags per resource

    • Each resource tag must be unique with a maximum of one value.

    • Maximum key length: 128 Unicode characters in UTF-8

    • Maximum value length: 256 Unicode characters in UTF-8

    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

    • Cannot use “aws:” as a prefix for a key.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

    
    
• On success, responds with CreateGeofenceCollectionOutput with field(s):
  • collection_name(String):

    The name for the geofence collection.

  • collection_arn(String):

    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

  • create_time(DateTime):

    The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

• On failure, responds with SdkError<CreateGeofenceCollectionError>

impl Client

pub fn create_key(&self) -> CreateKeyFluentBuilder

Constructs a fluent builder for the CreateKey operation.

• The fluent builder is configurable:
  • key_name(impl Into<String>) / set_key_name(Option<String>):
    required: true
    

    A custom name for the API key resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

    • Must be a unique API key name.

    • No spaces allowed. For example, ExampleAPIKey.

    
    
  • restrictions(ApiKeyRestrictions) / set_restrictions(Option<ApiKeyRestrictions>):
    required: true
    

    The API key restrictions for the API key resource.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the API key resource.

    
    
  • expire_time(DateTime) / set_expire_time(Option<DateTime>):
    required: false
    

    The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

    
    
  • no_expiry(bool) / set_no_expiry(Option<bool>):
    required: false
    

    Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

    Format: “key” : “value”

    Restrictions:

    • Maximum 50 tags per resource

    • Each resource tag must be unique with a maximum of one value.

    • Maximum key length: 128 Unicode characters in UTF-8

    • Maximum value length: 256 Unicode characters in UTF-8

    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

    • Cannot use “aws:” as a prefix for a key.

    
    
• On success, responds with CreateKeyOutput with field(s):
  • key(String):

    The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see GetMapGlyphs.

  • key_arn(String):

    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:key/ExampleKey

  • key_name(String):

    The name of the API key resource.

  • create_time(DateTime):

    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<CreateKeyError>

impl Client

pub fn create_map(&self) -> CreateMapFluentBuilder

Constructs a fluent builder for the CreateMap operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The name for the map resource.

    Requirements:

    • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

    • Must be a unique map resource name.

    • No spaces allowed. For example, ExampleMap.

    
    
  • configuration(MapConfiguration) / set_configuration(Option<MapConfiguration>):
    required: true
    

    Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the map resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

    Format: “key” : “value”

    Restrictions:

    • Maximum 50 tags per resource

    • Each resource tag must be unique with a maximum of one value.

    • Maximum key length: 128 Unicode characters in UTF-8

    • Maximum value length: 256 Unicode characters in UTF-8

    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

    • Cannot use “aws:” as a prefix for a key.

    
    
• On success, responds with CreateMapOutput with field(s):
  • map_name(String):

    The name of the map resource.

  • map_arn(String):

    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:map/ExampleMap

  • create_time(DateTime):

    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<CreateMapError>

impl Client

pub fn create_place_index(&self) -> CreatePlaceIndexFluentBuilder

Constructs a fluent builder for the CreatePlaceIndex operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

    • Must be a unique place index resource name.

    • No spaces allowed. For example, ExamplePlaceIndex.

    
    
  • data_source(impl Into<String>) / set_data_source(Option<String>):
    required: true
    

    Specifies the geospatial data provider for the new place index.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    • Esri – For additional information about Esri‘s coverage in your region of interest, see Esri details on geocoding coverage.

    • Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps’ coverage, see GrabMaps countries and areas covered.

    • Here – For additional information about HERE Technologies’ coverage in your region of interest, see HERE details on goecoding coverage.

      If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.

    For additional information , see Data providers on the Amazon Location Service Developer Guide.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The optional description for the place index resource.

    
    
  • data_source_configuration(DataSourceConfiguration) / set_data_source_configuration(Option<DataSourceConfiguration>):
    required: false
    

    Specifies the data storage option requesting Places.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    Format: “key” : “value”

    Restrictions:

    • Maximum 50 tags per resource.

    • Each tag key must be unique and must have exactly one associated value.

    • Maximum key length: 128 Unicode characters in UTF-8.

    • Maximum value length: 256 Unicode characters in UTF-8.

    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

    • Cannot use “aws:” as a prefix for a key.

    
    
• On success, responds with CreatePlaceIndexOutput with field(s):
  • index_name(String):

    The name for the place index resource.

  • index_arn(String):

    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

  • create_time(DateTime):

    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<CreatePlaceIndexError>

impl Client

pub fn create_route_calculator(&self) -> CreateRouteCalculatorFluentBuilder

Constructs a fluent builder for the CreateRouteCalculator operation.

• The fluent builder is configurable:
  • calculator_name(impl Into<String>) / set_calculator_name(Option<String>):
    required: true
    

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).

    • Must be a unique Route calculator resource name.

    • No spaces allowed. For example, ExampleRouteCalculator.

    
    
  • data_source(impl Into<String>) / set_data_source(Option<String>):
    required: true
    

    Specifies the data provider of traffic and road network data.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    • Esri – For additional information about Esri‘s coverage in your region of interest, see Esri details on street networks and traffic coverage.

      Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

    • Grab – Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps’ coverage, see GrabMaps countries and areas covered.

    • Here – For additional information about HERE Technologies’ coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.

    For additional information , see Data providers on the Amazon Location Service Developer Guide.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The optional description for the route calculator resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

    • For example: { “tag1” : “value1”, “tag2” : “value2”}

    Format: “key” : “value”

    Restrictions:

    • Maximum 50 tags per resource

    • Each resource tag must be unique with a maximum of one value.

    • Maximum key length: 128 Unicode characters in UTF-8

    • Maximum value length: 256 Unicode characters in UTF-8

    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

    • Cannot use “aws:” as a prefix for a key.

    
    
• On success, responds with CreateRouteCalculatorOutput with field(s):
  • calculator_name(String):

    The name of the route calculator resource.

    • For example, ExampleRouteCalculator.

  • calculator_arn(String):

    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

  • create_time(DateTime):

    The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

    • For example, 2020–07-2T12:15:20.000Z+01:00

• On failure, responds with SdkError<CreateRouteCalculatorError>

impl Client

pub fn create_tracker(&self) -> CreateTrackerFluentBuilder

Constructs a fluent builder for the CreateTracker operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name for the tracker resource.

    Requirements:

    • Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).

    • Must be a unique tracker resource name.

    • No spaces allowed. For example, ExampleTracker.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

    
    
  • pricing_plan_data_source(impl Into<String>) / set_pricing_plan_data_source(Option<String>):
    required: false
    

    This parameter is no longer used.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the tracker resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    Format: “key” : “value”

    Restrictions:

    • Maximum 50 tags per resource

    • Each resource tag must be unique with a maximum of one value.

    • Maximum key length: 128 Unicode characters in UTF-8

    • Maximum value length: 256 Unicode characters in UTF-8

    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

    • Cannot use “aws:” as a prefix for a key.

    
    
  • position_filtering(PositionFiltering) / set_position_filtering(Option<PositionFiltering>):
    required: false
    

    Specifies the position filtering for the tracker resource.

    Valid values:

    • TimeBased - 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.

    • DistanceBased - 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.

    • AccuracyBased - 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.

    This field is optional. If not specified, the default value is TimeBased.

    
    
  • event_bridge_enabled(bool) / set_event_bridge_enabled(Option<bool>):
    required: false
    

    Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

    You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

    
    
  • kms_key_enable_geospatial_queries(bool) / set_kms_key_enable_geospatial_queries(Option<bool>):
    required: false
    

    Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

    This parameter is only used if you are using a KMS customer managed key.

    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.

    You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

    
    
• On success, responds with CreateTrackerOutput with field(s):
  • tracker_name(String):

    The name of the tracker resource.

  • tracker_arn(String):

    The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

  • create_time(DateTime):

    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<CreateTrackerError>

impl Client

pub fn delete_geofence_collection( &self, ) -> DeleteGeofenceCollectionFluentBuilder

Constructs a fluent builder for the DeleteGeofenceCollection operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The name of the geofence collection to be deleted.

    
    
• On success, responds with DeleteGeofenceCollectionOutput
• On failure, responds with SdkError<DeleteGeofenceCollectionError>

impl Client

pub fn delete_key(&self) -> DeleteKeyFluentBuilder

Constructs a fluent builder for the DeleteKey operation.

• The fluent builder is configurable:
  • key_name(impl Into<String>) / set_key_name(Option<String>):
    required: true
    

    The name of the API key to delete.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    ForceDelete bypasses an API key’s expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

    Valid values: true, or false.

    Required: No

    This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    
    
• On success, responds with DeleteKeyOutput
• On failure, responds with SdkError<DeleteKeyError>

impl Client

pub fn delete_map(&self) -> DeleteMapFluentBuilder

Constructs a fluent builder for the DeleteMap operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The name of the map resource to be deleted.

    
    
• On success, responds with DeleteMapOutput
• On failure, responds with SdkError<DeleteMapError>

impl Client

pub fn delete_place_index(&self) -> DeletePlaceIndexFluentBuilder

Constructs a fluent builder for the DeletePlaceIndex operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource to be deleted.

    
    
• On success, responds with DeletePlaceIndexOutput
• On failure, responds with SdkError<DeletePlaceIndexError>

impl Client

pub fn delete_route_calculator(&self) -> DeleteRouteCalculatorFluentBuilder

Constructs a fluent builder for the DeleteRouteCalculator operation.

• The fluent builder is configurable:
  • calculator_name(impl Into<String>) / set_calculator_name(Option<String>):
    required: true
    

    The name of the route calculator resource to be deleted.

    
    
• On success, responds with DeleteRouteCalculatorOutput
• On failure, responds with SdkError<DeleteRouteCalculatorError>

impl Client

pub fn delete_tracker(&self) -> DeleteTrackerFluentBuilder

Constructs a fluent builder for the DeleteTracker operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource to be deleted.

    
    
• On success, responds with DeleteTrackerOutput
• On failure, responds with SdkError<DeleteTrackerError>

impl Client

pub fn describe_geofence_collection( &self, ) -> DescribeGeofenceCollectionFluentBuilder

Constructs a fluent builder for the DescribeGeofenceCollection operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The name of the geofence collection.

    
    
• On success, responds with DescribeGeofenceCollectionOutput with field(s):
  • collection_name(String):

    The name of the geofence collection.

  • collection_arn(String):

    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

  • description(String):

    The optional description for the geofence collection.

  • pricing_plan(Option<PricingPlan>):

    No longer used. Always returns RequestBasedUsage.

  • pricing_plan_data_source(Option<String>):

    No longer used. Always returns an empty string.

  • kms_key_id(Option<String>):

    A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource

  • tags(Option<HashMap::<String, String>>):

    Displays the key, value pairs of tags associated with this resource.

  • create_time(DateTime):

    The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

  • update_time(DateTime):

    The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

  • geofence_count(Option<i32>):

    The number of geofences in the geofence collection.

• On failure, responds with SdkError<DescribeGeofenceCollectionError>

impl Client

pub fn describe_key(&self) -> DescribeKeyFluentBuilder

Constructs a fluent builder for the DescribeKey operation.

• The fluent builder is configurable:
  • key_name(impl Into<String>) / set_key_name(Option<String>):
    required: true
    

    The name of the API key resource.

    
    
• On success, responds with DescribeKeyOutput with field(s):
  • key(String):

    The key value/string of an API key.

  • key_arn(String):

    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:key/ExampleKey

  • key_name(String):

    The name of the API key resource.

  • restrictions(Option<ApiKeyRestrictions>):

    API Restrictions on the allowed actions, resources, and referers for an API key resource.

  • create_time(DateTime):

    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • expire_time(DateTime):

    The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • update_time(DateTime):

    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • description(Option<String>):

    The optional description for the API key resource.

  • tags(Option<HashMap::<String, String>>):

    Tags associated with the API key resource.

• On failure, responds with SdkError<DescribeKeyError>

impl Client

pub fn describe_map(&self) -> DescribeMapFluentBuilder

Constructs a fluent builder for the DescribeMap operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The name of the map resource.

    
    
• On success, responds with DescribeMapOutput with field(s):
  • map_name(String):

    The map style selected from an available provider.

  • map_arn(String):

    The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:map/ExampleMap

  • pricing_plan(Option<PricingPlan>):

    No longer used. Always returns RequestBasedUsage.

  • data_source(String):

    Specifies the data provider for the associated map tiles.

  • configuration(Option<MapConfiguration>):

    Specifies the map tile style selected from a partner data provider.

  • description(String):

    The optional description for the map resource.

  • tags(Option<HashMap::<String, String>>):

    Tags associated with the map resource.

  • create_time(DateTime):

    The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • update_time(DateTime):

    The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<DescribeMapError>

impl Client

pub fn describe_place_index(&self) -> DescribePlaceIndexFluentBuilder

Constructs a fluent builder for the DescribePlaceIndex operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource.

    
    
• On success, responds with DescribePlaceIndexOutput with field(s):
  • index_name(String):

    The name of the place index resource being described.

  • index_arn(String):

    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

  • pricing_plan(Option<PricingPlan>):

    No longer used. Always returns RequestBasedUsage.

  • description(String):

    The optional description for the place index resource.

  • create_time(DateTime):

    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • update_time(DateTime):

    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • data_source(String):

    The data provider of geospatial data. Values can be one of the following:

    • Esri

    • Grab

    • Here

    For more information about data providers, see Amazon Location Service data providers.

  • data_source_configuration(Option<DataSourceConfiguration>):

    The specified data storage option for requesting Places.

  • tags(Option<HashMap::<String, String>>):

    Tags associated with place index resource.

• On failure, responds with SdkError<DescribePlaceIndexError>

impl Client

pub fn describe_route_calculator(&self) -> DescribeRouteCalculatorFluentBuilder

Constructs a fluent builder for the DescribeRouteCalculator operation.

• The fluent builder is configurable:
  • calculator_name(impl Into<String>) / set_calculator_name(Option<String>):
    required: true
    

    The name of the route calculator resource.

    
    
• On success, responds with DescribeRouteCalculatorOutput with field(s):
  • calculator_name(String):

    The name of the route calculator resource being described.

  • calculator_arn(String):

    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

  • pricing_plan(Option<PricingPlan>):

    Always returns RequestBasedUsage.

  • description(String):

    The optional description of the route calculator resource.

  • create_time(DateTime):

    The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

    • For example, 2020–07-2T12:15:20.000Z+01:00

  • update_time(DateTime):

    The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

    • For example, 2020–07-2T12:15:20.000Z+01:00

  • data_source(String):

    The data provider of traffic and road network data. Indicates one of the available providers:

    • Esri

    • Grab

    • Here

    For more information about data providers, see Amazon Location Service data providers.

  • tags(Option<HashMap::<String, String>>):

    Tags associated with route calculator resource.

• On failure, responds with SdkError<DescribeRouteCalculatorError>

impl Client

pub fn describe_tracker(&self) -> DescribeTrackerFluentBuilder

Constructs a fluent builder for the DescribeTracker operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource.

    
    
• On success, responds with DescribeTrackerOutput with field(s):
  • tracker_name(String):

    The name of the tracker resource.

  • tracker_arn(String):

    The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

  • description(String):

    The optional description for the tracker resource.

  • pricing_plan(Option<PricingPlan>):

    Always returns RequestBasedUsage.

  • pricing_plan_data_source(Option<String>):

    No longer used. Always returns an empty string.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with the tracker resource.

  • create_time(DateTime):

    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • update_time(DateTime):

    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • kms_key_id(Option<String>):

    A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.

  • position_filtering(Option<PositionFiltering>):

    The position filtering method of the tracker resource.

  • event_bridge_enabled(Option<bool>):

    Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.

  • kms_key_enable_geospatial_queries(Option<bool>):

    Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

    This parameter is only used if you are using a KMS customer managed key.

    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.

    You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

• On failure, responds with SdkError<DescribeTrackerError>

impl Client

pub fn disassociate_tracker_consumer( &self, ) -> DisassociateTrackerConsumerFluentBuilder

Constructs a fluent builder for the DisassociateTrackerConsumer operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource to be dissociated from the consumer.

    
    
  • consumer_arn(impl Into<String>) / set_consumer_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

    
    
• On success, responds with DisassociateTrackerConsumerOutput
• On failure, responds with SdkError<DisassociateTrackerConsumerError>

impl Client

pub fn forecast_geofence_events(&self) -> ForecastGeofenceEventsFluentBuilder

Constructs a fluent builder for the ForecastGeofenceEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The name of the geofence collection.

    
    
  • device_state(ForecastGeofenceEventsDeviceState) / set_device_state(Option<ForecastGeofenceEventsDeviceState>):
    required: true
    

    The device’s state, including current position and speed.

    
    
  • time_horizon_minutes(f64) / set_time_horizon_minutes(Option<f64>):
    required: false
    

    Specifies the time horizon in minutes for the forecasted events.

    
    
  • distance_unit(DistanceUnit) / set_distance_unit(Option<DistanceUnit>):
    required: false
    

    The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

    Default Value: Kilometers

    
    
  • speed_unit(SpeedUnit) / set_speed_unit(Option<SpeedUnit>):
    required: false
    

    The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

    Default Value: KilometersPerHour.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of resources returned in a single call.

    Default value: 20

    
    
• On success, responds with ForecastGeofenceEventsOutput with field(s):
  • forecasted_events(Vec::<ForecastedEvent>):

    The list of forecasted events.

  • next_token(Option<String>):

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

  • distance_unit(DistanceUnit):

    The distance unit for the forecasted events.

  • speed_unit(SpeedUnit):

    The speed unit for the forecasted events.

• On failure, responds with SdkError<ForecastGeofenceEventsError>

impl Client

pub fn get_device_position(&self) -> GetDevicePositionFluentBuilder

Constructs a fluent builder for the GetDevicePosition operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The tracker resource receiving the position update.

    
    
  • device_id(impl Into<String>) / set_device_id(Option<String>):
    required: true
    

    The device whose position you want to retrieve.

    
    
• On success, responds with GetDevicePositionOutput with field(s):
  • device_id(Option<String>):

    The device whose position you retrieved.

  • sample_time(DateTime):

    The timestamp at which the device’s position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • received_time(DateTime):

    The timestamp for when the tracker resource received the device position. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • position(Vec::<f64>):

    The last known device position.

  • accuracy(Option<PositionalAccuracy>):

    The accuracy of the device position.

  • position_properties(Option<HashMap::<String, String>>):

    The properties associated with the position.

• On failure, responds with SdkError<GetDevicePositionError>

impl Client

pub fn get_device_position_history( &self, ) -> GetDevicePositionHistoryFluentBuilder

Constructs a fluent builder for the GetDevicePositionHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The tracker resource receiving the request for the device position history.

    
    
  • device_id(impl Into<String>) / set_device_id(Option<String>):
    required: true
    

    The device whose position history you want to retrieve.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
  • start_time_inclusive(DateTime) / set_start_time_inclusive(Option<DateTime>):
    required: false
    

    Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

    Requirement:

    • The time specified for StartTimeInclusive must be before EndTimeExclusive.

    
    
  • end_time_exclusive(DateTime) / set_end_time_exclusive(Option<DateTime>):
    required: false
    

    Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

    Requirement:

    • The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of device positions returned in a single call.

    Default value: 100

    
    
• On success, responds with GetDevicePositionHistoryOutput with field(s):
  • device_positions(Vec::<DevicePosition>):

    Contains the position history details for the requested device.

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<GetDevicePositionHistoryError>

impl Client

pub fn get_geofence(&self) -> GetGeofenceFluentBuilder

Constructs a fluent builder for the GetGeofence operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The geofence collection storing the target geofence.

    
    
  • geofence_id(impl Into<String>) / set_geofence_id(Option<String>):
    required: true
    

    The geofence you’re retrieving details for.

    
    
• On success, responds with GetGeofenceOutput with field(s):
  • geofence_id(String):

    The geofence identifier.

  • geometry(Option<GeofenceGeometry>):

    Contains the geofence geometry details describing a polygon or a circle.

  • status(String):

    Identifies the state of the geofence. A geofence will hold one of the following states:

    • ACTIVE — The geofence has been indexed by the system.

    • PENDING — The geofence is being processed by the system.

    • FAILED — The geofence failed to be indexed by the system.

    • DELETED — The geofence has been deleted from the system index.

    • DELETING — The geofence is being deleted from the system index.

  • create_time(DateTime):

    The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

  • update_time(DateTime):

    The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

  • geofence_properties(Option<HashMap::<String, String>>):

    User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

    Format: “key” : “value”

• On failure, responds with SdkError<GetGeofenceError>

impl Client

pub fn get_map_glyphs(&self) -> GetMapGlyphsFluentBuilder

Constructs a fluent builder for the GetMapGlyphs operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The map resource associated with the glyph file.

    
    
  • font_stack(impl Into<String>) / set_font_stack(Option<String>):
    required: true
    

    A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

    Valid font stacks for Esri styles:

    • VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold

    • VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold

    • VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic

    • VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold

    • VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

    Valid font stacks for HERE Technologies styles:

    • VectorHereContrast – Fira GO Regular | Fira GO Bold

    • VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

    Valid font stacks for GrabMaps styles:

    • VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto Sans Medium | Noto Sans Bold

    Valid font stacks for Open Data styles:

    • VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium

    The fonts used by the Open Data map styles are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

    
    
  • font_unicode_range(impl Into<String>) / set_font_unicode_range(Option<String>):
    required: true
    

    A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with GetMapGlyphsOutput with field(s):
  • blob(Option<Blob>):

    The glyph, as binary blob.

  • content_type(Option<String>):

    The map glyph content type. For example, application/octet-stream.

  • cache_control(Option<String>):

    The HTTP Cache-Control directive for the value.

• On failure, responds with SdkError<GetMapGlyphsError>

impl Client

pub fn get_map_sprites(&self) -> GetMapSpritesFluentBuilder

Constructs a fluent builder for the GetMapSprites operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The map resource associated with the sprite file.

    
    
  • file_name(impl Into<String>) / set_file_name(Option<String>):
    required: true
    

    The name of the sprite file. Use the following file names for the sprite sheet:

    • sprites.png

    • sprites@2x.png for high pixel density displays

    For the JSON document containing image offsets. Use the following file names:

    • sprites.json

    • sprites@2x.json for high pixel density displays

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with GetMapSpritesOutput with field(s):
  • blob(Option<Blob>):

    Contains the body of the sprite sheet or JSON offset file.

  • content_type(Option<String>):

    The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.

  • cache_control(Option<String>):

    The HTTP Cache-Control directive for the value.

• On failure, responds with SdkError<GetMapSpritesError>

impl Client

pub fn get_map_style_descriptor(&self) -> GetMapStyleDescriptorFluentBuilder

Constructs a fluent builder for the GetMapStyleDescriptor operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The map resource to retrieve the style descriptor from.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with GetMapStyleDescriptorOutput with field(s):
  • blob(Option<Blob>):

    Contains the body of the style descriptor.

  • content_type(Option<String>):

    The style descriptor’s content type. For example, application/json.

  • cache_control(Option<String>):

    The HTTP Cache-Control directive for the value.

• On failure, responds with SdkError<GetMapStyleDescriptorError>

impl Client

pub fn get_map_tile(&self) -> GetMapTileFluentBuilder

Constructs a fluent builder for the GetMapTile operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The map resource to retrieve the map tiles from.

    
    
  • z(impl Into<String>) / set_z(Option<String>):
    required: true
    

    The zoom value for the map tile.

    
    
  • x(impl Into<String>) / set_x(Option<String>):
    required: true
    

    The X axis value for the map tile.

    
    
  • y(impl Into<String>) / set_y(Option<String>):
    required: true
    

    The Y axis value for the map tile.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with GetMapTileOutput with field(s):
  • blob(Option<Blob>):

    Contains Mapbox Vector Tile (MVT) data.

  • content_type(Option<String>):

    The map tile’s content type. For example, application/vnd.mapbox-vector-tile.

  • cache_control(Option<String>):

    The HTTP Cache-Control directive for the value.

• On failure, responds with SdkError<GetMapTileError>

impl Client

pub fn get_place(&self) -> GetPlaceFluentBuilder

Constructs a fluent builder for the GetPlace operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource that you want to use for the search.

    
    
  • place_id(impl Into<String>) / set_place_id(Option<String>):
    required: true
    

    The identifier of the place to find.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

    For an example, we’ll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

    If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with GetPlaceOutput with field(s):
  • place(Option<Place>):

    Details about the result, such as its address and position.

• On failure, responds with SdkError<GetPlaceError>

impl Client

pub fn list_device_positions(&self) -> ListDevicePositionsFluentBuilder

Constructs a fluent builder for the ListDevicePositions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The tracker resource containing the requested devices.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of entries returned in a single call.

    Default value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
  • filter_geometry(TrackingFilterGeometry) / set_filter_geometry(Option<TrackingFilterGeometry>):
    required: false
    

    The geometry used to filter device positions.

    
    
• On success, responds with ListDevicePositionsOutput with field(s):
  • entries(Vec::<ListDevicePositionsResponseEntry>):

    Contains details about each device’s last known position.

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<ListDevicePositionsError>

impl Client

pub fn list_geofence_collections(&self) -> ListGeofenceCollectionsFluentBuilder

Constructs a fluent builder for the ListGeofenceCollections operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of resources returned in a single call.

    Default value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
• On success, responds with ListGeofenceCollectionsOutput with field(s):
  • entries(Vec::<ListGeofenceCollectionsResponseEntry>):

    Lists the geofence collections that exist in your Amazon Web Services account.

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<ListGeofenceCollectionsError>

impl Client

pub fn list_geofences(&self) -> ListGeofencesFluentBuilder

Constructs a fluent builder for the ListGeofences operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The name of the geofence collection storing the list of geofences.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of geofences returned in a single call.

    Default value: 100

    
    
• On success, responds with ListGeofencesOutput with field(s):
  • entries(Vec::<ListGeofenceResponseEntry>):

    Contains a list of geofences stored in the geofence collection.

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<ListGeofencesError>

impl Client

pub fn list_keys(&self) -> ListKeysFluentBuilder

Constructs a fluent builder for the ListKeys operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of resources returned in a single call.

    Default value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
  • filter(ApiKeyFilter) / set_filter(Option<ApiKeyFilter>):
    required: false
    

    Optionally filter the list to only Active or Expired API keys.

    
    
• On success, responds with ListKeysOutput with field(s):
  • entries(Vec::<ListKeysResponseEntry>):

    Contains API key resources in your Amazon Web Services account. Details include API key name, allowed referers and timestamp for when the API key will expire.

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<ListKeysError>

impl Client

pub fn list_maps(&self) -> ListMapsFluentBuilder

Constructs a fluent builder for the ListMaps operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of resources returned in a single call.

    Default value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
• On success, responds with ListMapsOutput with field(s):
  • entries(Vec::<ListMapsResponseEntry>):

    Contains a list of maps in your Amazon Web Services account

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<ListMapsError>

impl Client

pub fn list_place_indexes(&self) -> ListPlaceIndexesFluentBuilder

Constructs a fluent builder for the ListPlaceIndexes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the maximum number of results returned in a single call.

    Default value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
• On success, responds with ListPlaceIndexesOutput with field(s):
  • entries(Vec::<ListPlaceIndexesResponseEntry>):

    Lists the place index resources that exist in your Amazon Web Services account

  • next_token(Option<String>):

    A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.

• On failure, responds with SdkError<ListPlaceIndexesError>

impl Client

pub fn list_route_calculators(&self) -> ListRouteCalculatorsFluentBuilder

Constructs a fluent builder for the ListRouteCalculators operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional maximum number of results returned in a single call.

    Default Value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default Value: null

    
    
• On success, responds with ListRouteCalculatorsOutput with field(s):
  • entries(Vec::<ListRouteCalculatorsResponseEntry>):

    Lists the route calculator resources that exist in your Amazon Web Services account

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.

• On failure, responds with SdkError<ListRouteCalculatorsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

    • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: “TagKey” : “TagValue”.

    • Format example: {“tag1” : “value1”, “tag2” : “value2”}

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_tracker_consumers(&self) -> ListTrackerConsumersFluentBuilder

Constructs a fluent builder for the ListTrackerConsumers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The tracker resource whose associated geofence collections you want to list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of resources returned in a single call.

    Default value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
• On success, responds with ListTrackerConsumersOutput with field(s):
  • consumer_arns(Vec::<String>):

    Contains the list of geofence collection ARNs associated to the tracker resource.

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<ListTrackerConsumersError>

impl Client

pub fn list_trackers(&self) -> ListTrackersFluentBuilder

Constructs a fluent builder for the ListTrackers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of resources returned in a single call.

    Default value: 100

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    Default value: null

    
    
• On success, responds with ListTrackersOutput with field(s):
  • entries(Vec::<ListTrackersResponseEntry>):

    Contains tracker resources in your Amazon Web Services account. Details include tracker name, description and timestamps for when the tracker was created and last updated.

  • next_token(Option<String>):

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

• On failure, responds with SdkError<ListTrackersError>

impl Client

pub fn put_geofence(&self) -> PutGeofenceFluentBuilder

Constructs a fluent builder for the PutGeofence operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The geofence collection to store the geofence in.

    
    
  • geofence_id(impl Into<String>) / set_geofence_id(Option<String>):
    required: true
    

    An identifier for the geofence. For example, ExampleGeofence-1.

    
    
  • geometry(GeofenceGeometry) / set_geometry(Option<GeofenceGeometry>):
    required: true
    

    Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

    The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

    
    
  • geofence_properties(impl Into<String>, impl Into<String>) / set_geofence_properties(Option<HashMap::<String, String>>):
    required: false
    

    Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

    Format: “key” : “value”

    
    
• On success, responds with PutGeofenceOutput with field(s):
  • geofence_id(String):

    The geofence identifier entered in the request.

  • create_time(DateTime):

    The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

  • update_time(DateTime):

    The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

• On failure, responds with SdkError<PutGeofenceError>

impl Client

pub fn search_place_index_for_position( &self, ) -> SearchPlaceIndexForPositionFluentBuilder

Constructs a fluent builder for the SearchPlaceIndexForPosition operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource you want to use for the search.

    
    
  • position(f64) / set_position(Option<Vec::<f64>>):
    required: true
    

    Specifies the longitude and latitude of the position to query.

    This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

    For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter. The maximum number of results returned per request.

    Default value: 50

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

    For an example, we’ll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

    If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with SearchPlaceIndexForPositionOutput with field(s):
  • summary(Option<SearchPlaceIndexForPositionSummary>):

    Contains a summary of the request. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.

  • results(Vec::<SearchForPositionResult>):

    Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

• On failure, responds with SdkError<SearchPlaceIndexForPositionError>

impl Client

pub fn search_place_index_for_suggestions( &self, ) -> SearchPlaceIndexForSuggestionsFluentBuilder

Constructs a fluent builder for the SearchPlaceIndexForSuggestions operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource you want to use for the search.

    
    
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    The free-form partial text to use to generate place suggestions. For example, eiffel tow.

    
    
  • bias_position(f64) / set_bias_position(Option<Vec::<f64>>):
    required: false
    

    An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

    
    
  • filter_b_box(f64) / set_filter_b_box(Option<Vec::<f64>>):
    required: false
    

    An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

    
    
  • filter_countries(impl Into<String>) / set_filter_countries(Option<Vec::<String>>):
    required: false
    

    An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

    • Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter. The maximum number of results returned per request.

    The default: 5

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

    This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

    For an example, we’ll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.

    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα.

    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

    
    
  • filter_categories(impl Into<String>) / set_filter_categories(Option<Vec::<String>>):
    required: false
    

    A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

    For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with SearchPlaceIndexForSuggestionsOutput with field(s):
  • summary(Option<SearchPlaceIndexForSuggestionsSummary>):

    Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index.

  • results(Vec::<SearchForSuggestionsResult>):

    A list of place suggestions that best match the search text.

• On failure, responds with SdkError<SearchPlaceIndexForSuggestionsError>

impl Client

pub fn search_place_index_for_text( &self, ) -> SearchPlaceIndexForTextFluentBuilder

Constructs a fluent builder for the SearchPlaceIndexForText operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource you want to use for the search.

    
    
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

    
    
  • bias_position(f64) / set_bias_position(Option<Vec::<f64>>):
    required: false
    

    An optional parameter that indicates a preference for places that are closer to a specified position.

    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

    
    
  • filter_b_box(f64) / set_filter_b_box(Option<Vec::<f64>>):
    required: false
    

    An optional parameter that limits the search results by returning only places that are within the provided bounding box.

    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

    
    
  • filter_countries(impl Into<String>) / set_filter_countries(Option<Vec::<String>>):
    required: false
    

    An optional parameter that limits the search results by returning only places that are in a specified list of countries.

    • Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter. The maximum number of results returned per request.

    The default: 50

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

    For an example, we’ll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

    
    
  • filter_categories(impl Into<String>) / set_filter_categories(Option<Vec::<String>>):
    required: false
    

    A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

    For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    The optional API key to authorize the request.

    
    
• On success, responds with SearchPlaceIndexForTextOutput with field(s):
  • summary(Option<SearchPlaceIndexForTextSummary>):

    Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

  • results(Vec::<SearchForTextResult>):

    A list of Places matching the input text. Each result contains additional information about the specific point of interest.

    Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

• On failure, responds with SdkError<SearchPlaceIndexForTextError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource whose tags you want to update.

    • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

    Format: “key” : “value”

    Restrictions:

    • Maximum 50 tags per resource.

    • Each tag key must be unique and must have exactly one associated value.

    • Maximum key length: 128 Unicode characters in UTF-8.

    • Maximum value length: 256 Unicode characters in UTF-8.

    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

    • Cannot use “aws:” as a prefix for a key.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

    • Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the specified resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_geofence_collection( &self, ) -> UpdateGeofenceCollectionFluentBuilder

Constructs a fluent builder for the UpdateGeofenceCollection operation.

• The fluent builder is configurable:
  • collection_name(impl Into<String>) / set_collection_name(Option<String>):
    required: true
    

    The name of the geofence collection to update.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • pricing_plan_data_source(impl Into<String>) / set_pricing_plan_data_source(Option<String>):
    required: false
    

    This parameter is no longer used.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Updates the description for the geofence collection.

    
    
• On success, responds with UpdateGeofenceCollectionOutput with field(s):
  • collection_name(String):

    The name of the updated geofence collection.

  • collection_arn(String):

    The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

  • update_time(DateTime):

    The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

• On failure, responds with SdkError<UpdateGeofenceCollectionError>

impl Client

pub fn update_key(&self) -> UpdateKeyFluentBuilder

Constructs a fluent builder for the UpdateKey operation.

• The fluent builder is configurable:
  • key_name(impl Into<String>) / set_key_name(Option<String>):
    required: true
    

    The name of the API key resource to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Updates the description for the API key resource.

    
    
  • expire_time(DateTime) / set_expire_time(Option<DateTime>):
    required: false
    

    Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

    
    
  • no_expiry(bool) / set_no_expiry(Option<bool>):
    required: false
    

    Whether the API key should expire. Set to true to set the API key to have no expiration time.

    
    
  • force_update(bool) / set_force_update(Option<bool>):
    required: false
    

    The boolean flag to be included for updating ExpireTime or Restrictions details.

    Must be set to true to update an API key resource that has been used in the past 7 days.

    False if force update is not preferred

    Default value: False

    
    
  • restrictions(ApiKeyRestrictions) / set_restrictions(Option<ApiKeyRestrictions>):
    required: false
    

    Updates the API key restrictions for the API key resource.

    
    
• On success, responds with UpdateKeyOutput with field(s):
  • key_arn(String):

    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:key/ExampleKey

  • key_name(String):

    The name of the API key resource.

  • update_time(DateTime):

    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<UpdateKeyError>

impl Client

pub fn update_map(&self) -> UpdateMapFluentBuilder

Constructs a fluent builder for the UpdateMap operation.

• The fluent builder is configurable:
  • map_name(impl Into<String>) / set_map_name(Option<String>):
    required: true
    

    The name of the map resource to update.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Updates the description for the map resource.

    
    
  • configuration_update(MapConfigurationUpdate) / set_configuration_update(Option<MapConfigurationUpdate>):
    required: false
    

    Updates the parts of the map configuration that can be updated, including the political view.

    
    
• On success, responds with UpdateMapOutput with field(s):
  • map_name(String):

    The name of the updated map resource.

  • map_arn(String):

    The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.

    • Format example: arn:aws:geo:region:account-id:map/ExampleMap

  • update_time(DateTime):

    The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<UpdateMapError>

impl Client

pub fn update_place_index(&self) -> UpdatePlaceIndexFluentBuilder

Constructs a fluent builder for the UpdatePlaceIndex operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the place index resource to update.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Updates the description for the place index resource.

    
    
  • data_source_configuration(DataSourceConfiguration) / set_data_source_configuration(Option<DataSourceConfiguration>):
    required: false
    

    Updates the data storage option for the place index resource.

    
    
• On success, responds with UpdatePlaceIndexOutput with field(s):
  • index_name(String):

    The name of the updated place index resource.

  • index_arn(String):

    The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex

  • update_time(DateTime):

    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<UpdatePlaceIndexError>

impl Client

pub fn update_route_calculator(&self) -> UpdateRouteCalculatorFluentBuilder

Constructs a fluent builder for the UpdateRouteCalculator operation.

• The fluent builder is configurable:
  • calculator_name(impl Into<String>) / set_calculator_name(Option<String>):
    required: true
    

    The name of the route calculator resource to update.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Updates the description for the route calculator resource.

    
    
• On success, responds with UpdateRouteCalculatorOutput with field(s):
  • calculator_name(String):

    The name of the updated route calculator resource.

  • calculator_arn(String):

    The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.

    • Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator

  • update_time(DateTime):

    The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<UpdateRouteCalculatorError>

impl Client

pub fn update_tracker(&self) -> UpdateTrackerFluentBuilder

Constructs a fluent builder for the UpdateTracker operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource to update.

    
    
  • pricing_plan(PricingPlan) / set_pricing_plan(Option<PricingPlan>):
    required: false
    

    No longer used. If included, the only allowed value is RequestBasedUsage.

    
    
  • pricing_plan_data_source(impl Into<String>) / set_pricing_plan_data_source(Option<String>):
    required: false
    

    This parameter is no longer used.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Updates the description for the tracker resource.

    
    
  • position_filtering(PositionFiltering) / set_position_filtering(Option<PositionFiltering>):
    required: false
    

    Updates the position filtering for the tracker resource.

    Valid values:

    • TimeBased - 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.

    • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance 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.

    • AccuracyBased - 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 helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

    
    
  • event_bridge_enabled(bool) / set_event_bridge_enabled(Option<bool>):
    required: false
    

    Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

    You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

    
    
  • kms_key_enable_geospatial_queries(bool) / set_kms_key_enable_geospatial_queries(Option<bool>):
    required: false
    

    Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

    This parameter is only used if you are using a KMS customer managed key.

    
    
• On success, responds with UpdateTrackerOutput with field(s):
  • tracker_name(String):

    The name of the updated tracker resource.

  • tracker_arn(String):

    The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

    • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

  • update_time(DateTime):

    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• On failure, responds with SdkError<UpdateTrackerError>

impl Client

pub fn verify_device_position(&self) -> VerifyDevicePositionFluentBuilder

Constructs a fluent builder for the VerifyDevicePosition operation.

• The fluent builder is configurable:
  • tracker_name(impl Into<String>) / set_tracker_name(Option<String>):
    required: true
    

    The name of the tracker resource to be associated with verification request.

    
    
  • device_state(DeviceState) / set_device_state(Option<DeviceState>):
    required: true
    

    The device’s state, including position, IP address, cell signals and Wi-Fi access points.

    
    
  • distance_unit(DistanceUnit) / set_distance_unit(Option<DistanceUnit>):
    required: false
    

    The distance unit for the verification request.

    Default Value: Kilometers

    
    
• On success, responds with VerifyDevicePositionOutput with field(s):
  • inferred_state(Option<InferredState>):

    The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.

  • device_id(String):

    The device identifier.

  • sample_time(DateTime):

    The timestamp at which the device’s position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • received_time(DateTime):

    The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

  • distance_unit(DistanceUnit):

    The distance unit for the verification response.

• On failure, responds with SdkError<VerifyDevicePositionError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.