aws_sdk_location::client

Struct 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.

§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.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateTrackerConsumer operation has a Client::associate_tracker_consumer, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

ⓘ
let result = client.associate_tracker_consumer()
    .tracker_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations§

Source§

impl Client

Source

pub fn associate_tracker_consumer( &self, ) -> AssociateTrackerConsumerFluentBuilder

Constructs a fluent builder for the AssociateTrackerConsumer operation.

Source§

impl Client

Source

pub fn batch_delete_device_position_history( &self, ) -> BatchDeleteDevicePositionHistoryFluentBuilder

Constructs a fluent builder for the BatchDeleteDevicePositionHistory operation.

Source§

impl Client

Source

pub fn batch_delete_geofence(&self) -> BatchDeleteGeofenceFluentBuilder

Constructs a fluent builder for the BatchDeleteGeofence operation.

Source§

impl Client

Source

pub fn batch_evaluate_geofences(&self) -> BatchEvaluateGeofencesFluentBuilder

Constructs a fluent builder for the BatchEvaluateGeofences operation.

Source§

impl Client

Source

pub fn batch_get_device_position(&self) -> BatchGetDevicePositionFluentBuilder

Constructs a fluent builder for the BatchGetDevicePosition operation.

Source§

impl Client

Source

pub fn batch_put_geofence(&self) -> BatchPutGeofenceFluentBuilder

Constructs a fluent builder for the BatchPutGeofence operation.

Source§

impl Client

Source

pub fn batch_update_device_position( &self, ) -> BatchUpdateDevicePositionFluentBuilder

Constructs a fluent builder for the BatchUpdateDevicePosition operation.

Source§

impl Client

Source

pub fn calculate_route(&self) -> CalculateRouteFluentBuilder

Constructs a fluent builder for the CalculateRoute operation.

Source§

impl Client

Source

pub fn calculate_route_matrix(&self) -> CalculateRouteMatrixFluentBuilder

Constructs a fluent builder for the CalculateRouteMatrix operation.

Source§

impl Client

Source

pub fn create_geofence_collection( &self, ) -> CreateGeofenceCollectionFluentBuilder

Constructs a fluent builder for the CreateGeofenceCollection operation.

Source§

impl Client

Source

pub fn create_key(&self) -> CreateKeyFluentBuilder

Constructs a fluent builder for the CreateKey operation.

Source§

impl Client

Source

pub fn create_map(&self) -> CreateMapFluentBuilder

Constructs a fluent builder for the CreateMap operation.

Source§

impl Client

Source

pub fn create_place_index(&self) -> CreatePlaceIndexFluentBuilder

Constructs a fluent builder for the CreatePlaceIndex operation.

Source§

impl Client

Source

pub fn create_route_calculator(&self) -> CreateRouteCalculatorFluentBuilder

Constructs a fluent builder for the CreateRouteCalculator operation.

Source§

impl Client

Source

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>
Source§

impl Client

Source

pub fn delete_geofence_collection( &self, ) -> DeleteGeofenceCollectionFluentBuilder

Constructs a fluent builder for the DeleteGeofenceCollection operation.

Source§

impl Client

Source

pub fn delete_key(&self) -> DeleteKeyFluentBuilder

Constructs a fluent builder for the DeleteKey operation.

Source§

impl Client

Source

pub fn delete_map(&self) -> DeleteMapFluentBuilder

Constructs a fluent builder for the DeleteMap operation.

Source§

impl Client

Source

pub fn delete_place_index(&self) -> DeletePlaceIndexFluentBuilder

Constructs a fluent builder for the DeletePlaceIndex operation.

Source§

impl Client

Source

pub fn delete_route_calculator(&self) -> DeleteRouteCalculatorFluentBuilder

Constructs a fluent builder for the DeleteRouteCalculator operation.

Source§

impl Client

Source

pub fn delete_tracker(&self) -> DeleteTrackerFluentBuilder

Constructs a fluent builder for the DeleteTracker operation.

Source§

impl Client

Source

pub fn describe_geofence_collection( &self, ) -> DescribeGeofenceCollectionFluentBuilder

Constructs a fluent builder for the DescribeGeofenceCollection operation.

Source§

impl Client

Source

pub fn describe_key(&self) -> DescribeKeyFluentBuilder

Constructs a fluent builder for the DescribeKey operation.

Source§

impl Client

Source

pub fn describe_map(&self) -> DescribeMapFluentBuilder

Constructs a fluent builder for the DescribeMap operation.

Source§

impl Client

Source

pub fn describe_place_index(&self) -> DescribePlaceIndexFluentBuilder

Constructs a fluent builder for the DescribePlaceIndex operation.

Source§

impl Client

Source

pub fn describe_route_calculator(&self) -> DescribeRouteCalculatorFluentBuilder

Constructs a fluent builder for the DescribeRouteCalculator operation.

Source§

impl Client

Source

pub fn describe_tracker(&self) -> DescribeTrackerFluentBuilder

Constructs a fluent builder for the DescribeTracker operation.

Source§

impl Client

Source

pub fn disassociate_tracker_consumer( &self, ) -> DisassociateTrackerConsumerFluentBuilder

Constructs a fluent builder for the DisassociateTrackerConsumer operation.

Source§

impl Client

Source

pub fn forecast_geofence_events(&self) -> ForecastGeofenceEventsFluentBuilder

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

Source§

impl Client

Source

pub fn get_device_position(&self) -> GetDevicePositionFluentBuilder

Constructs a fluent builder for the GetDevicePosition operation.

Source§

impl Client

Source

pub fn get_device_position_history( &self, ) -> GetDevicePositionHistoryFluentBuilder

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

Source§

impl Client

Source

pub fn get_geofence(&self) -> GetGeofenceFluentBuilder

Constructs a fluent builder for the GetGeofence operation.

Source§

impl Client

Source

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):
  • On failure, responds with SdkError<GetMapGlyphsError>
Source§

impl Client

Source

pub fn get_map_sprites(&self) -> GetMapSpritesFluentBuilder

Constructs a fluent builder for the GetMapSprites operation.

Source§

impl Client

Source

pub fn get_map_style_descriptor(&self) -> GetMapStyleDescriptorFluentBuilder

Constructs a fluent builder for the GetMapStyleDescriptor operation.

Source§

impl Client

Source

pub fn get_map_tile(&self) -> GetMapTileFluentBuilder

Constructs a fluent builder for the GetMapTile operation.

Source§

impl Client

Source

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):
  • On failure, responds with SdkError<GetPlaceError>
Source§

impl Client

Source

pub fn list_device_positions(&self) -> ListDevicePositionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_geofence_collections(&self) -> ListGeofenceCollectionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_geofences(&self) -> ListGeofencesFluentBuilder

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

Source§

impl Client

Source

pub fn list_keys(&self) -> ListKeysFluentBuilder

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

Source§

impl Client

Source

pub fn list_maps(&self) -> ListMapsFluentBuilder

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

Source§

impl Client

Source

pub fn list_place_indexes(&self) -> ListPlaceIndexesFluentBuilder

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

Source§

impl Client

Source

pub fn list_route_calculators(&self) -> ListRouteCalculatorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn list_tracker_consumers(&self) -> ListTrackerConsumersFluentBuilder

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

Source§

impl Client

Source

pub fn list_trackers(&self) -> ListTrackersFluentBuilder

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

Source§

impl Client

Source

pub fn put_geofence(&self) -> PutGeofenceFluentBuilder

Constructs a fluent builder for the PutGeofence operation.

Source§

impl Client

Source

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):
  • On failure, responds with SdkError<SearchPlaceIndexForPositionError>
Source§

impl Client

Source

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):
  • On failure, responds with SdkError<SearchPlaceIndexForSuggestionsError>
Source§

impl Client

Source

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>
Source§

impl Client

Source

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>
Source§

impl Client

Source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

Source§

impl Client

Source

pub fn update_geofence_collection( &self, ) -> UpdateGeofenceCollectionFluentBuilder

Constructs a fluent builder for the UpdateGeofenceCollection operation.

Source§

impl Client

Source

pub fn update_key(&self) -> UpdateKeyFluentBuilder

Constructs a fluent builder for the UpdateKey operation.

Source§

impl Client

Source

pub fn update_map(&self) -> UpdateMapFluentBuilder

Constructs a fluent builder for the UpdateMap operation.

Source§

impl Client

Source

pub fn update_place_index(&self) -> UpdatePlaceIndexFluentBuilder

Constructs a fluent builder for the UpdatePlaceIndex operation.

Source§

impl Client

Source

pub fn update_route_calculator(&self) -> UpdateRouteCalculatorFluentBuilder

Constructs a fluent builder for the UpdateRouteCalculator operation.

Source§

impl Client

Source

pub fn update_tracker(&self) -> UpdateTrackerFluentBuilder

Constructs a fluent builder for the UpdateTracker operation.

Source§

impl Client

Source

pub fn verify_device_position(&self) -> VerifyDevicePositionFluentBuilder

Constructs a fluent builder for the VerifyDevicePosition operation.

Source§

impl Client

Source

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.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

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§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T