Struct aws_sdk_location::Client

source · [−]
pub struct Client { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_location::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_location::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_location::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AssociateTrackerConsumer operation.

Constructs a fluent builder for the BatchDeleteDevicePositionHistory operation.

Constructs a fluent builder for the BatchDeleteGeofence operation.

Constructs a fluent builder for the BatchEvaluateGeofences operation.

Constructs a fluent builder for the BatchGetDevicePosition operation.

Constructs a fluent builder for the BatchPutGeofence operation.

Constructs a fluent builder for the BatchUpdateDevicePosition operation.

Constructs a fluent builder for the CalculateRoute operation.

Constructs a fluent builder for the CalculateRouteMatrix operation.

Constructs a fluent builder for the CreateGeofenceCollection operation.

Constructs a fluent builder for the CreateMap operation.

Constructs a fluent builder for the CreatePlaceIndex operation.

Constructs a fluent builder for the CreateRouteCalculator operation.

Constructs a fluent builder for the CreateTracker operation.

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

      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>):

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

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

      A key identifier for an AWS 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>):

      This parameter is no longer used.

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

      An optional description for the tracker resource.

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

      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>):

      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.

  • On success, responds with CreateTrackerOutput with field(s):
  • On failure, responds with SdkError<CreateTrackerError>

Constructs a fluent builder for the DeleteGeofenceCollection operation.

Constructs a fluent builder for the DeleteMap operation.

Constructs a fluent builder for the DeletePlaceIndex operation.

Constructs a fluent builder for the DeleteRouteCalculator operation.

Constructs a fluent builder for the DeleteTracker operation.

Constructs a fluent builder for the DescribeGeofenceCollection operation.

Constructs a fluent builder for the DescribeMap operation.

Constructs a fluent builder for the DescribePlaceIndex operation.

Constructs a fluent builder for the DescribeRouteCalculator operation.

Constructs a fluent builder for the DescribeTracker operation.

Constructs a fluent builder for the DisassociateTrackerConsumer operation.

Constructs a fluent builder for the GetDevicePosition operation.

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

Constructs a fluent builder for the GetGeofence operation.

Constructs a fluent builder for the GetMapGlyphs operation.

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

      The map resource associated with the glyph file.

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

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

      Valid fonts 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:

      • VectorHereBerlin – Fira GO Regular | Fira GO Bold

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

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

      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.

  • On success, responds with GetMapGlyphsOutput with field(s):
  • On failure, responds with SdkError<GetMapGlyphsError>

Constructs a fluent builder for the GetMapSprites operation.

Constructs a fluent builder for the GetMapStyleDescriptor operation.

Constructs a fluent builder for the GetMapTile operation.

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

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

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

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

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

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

Constructs a fluent builder for the ListTagsForResource operation.

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

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

Constructs a fluent builder for the PutGeofence operation.

Constructs a fluent builder for the SearchPlaceIndexForPosition operation.

Constructs a fluent builder for the SearchPlaceIndexForSuggestions operation.

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

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

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

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

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

      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(Vec<f64>) / set_filter_b_box(Option<Vec<f64>>):

      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(Vec<String>) / set_filter_countries(Option<Vec<String>>):

      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>):

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

      The default: 5

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

      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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

      Used only when the partner selected is Here.

  • On success, responds with SearchPlaceIndexForSuggestionsOutput with field(s):
  • On failure, responds with SdkError<SearchPlaceIndexForSuggestionsError>
source

pub fn search_place_index_for_text(&self) -> SearchPlaceIndexForText

Constructs a fluent builder for the SearchPlaceIndexForText operation.

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

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

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

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

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

      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(Vec<f64>) / set_filter_b_box(Option<Vec<f64>>):

      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(Vec<String>) / set_filter_countries(Option<Vec<String>>):

      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(i32):

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

      The default: 50

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

      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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

  • 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(Option<Vec<SearchForTextResult>>):

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

  • On failure, responds with SdkError<SearchPlaceIndexForTextError>

Constructs a fluent builder for the TagResource operation.

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

      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(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

      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>

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateGeofenceCollection operation.

Constructs a fluent builder for the UpdateMap operation.

Constructs a fluent builder for the UpdatePlaceIndex operation.

Constructs a fluent builder for the UpdateRouteCalculator operation.

Constructs a fluent builder for the UpdateTracker operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more