lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.34.0 vs lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.35.0

- old
+ new

@@ -26,10 +26,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' +require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' @@ -75,10 +76,11 @@ add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) + add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::RestJson) add_plugin(Aws::LocationService::Plugins::Endpoints) @@ -188,10 +190,14 @@ # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # + # @option options [Boolean] :disable_request_compression (false) + # When set to 'true' the request body will not be compressed + # for supported operations. + # # @option options [String] :endpoint # The client endpoint is normally constructed from the `:region` # option. You should only configure an `:endpoint` when connecting # to test or custom endpoints. This should be a valid HTTP(S) URI. # @@ -228,10 +234,15 @@ # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # + # @option options [Integer] :request_min_compression_size_bytes (10240) + # The minimum size in bytes that triggers compression for request + # bodies. The value must be non-negative integer value between 0 + # and 10485780 bytes inclusive. + # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) @@ -888,10 +899,17 @@ # # Default Value: `false` # # Valid Values: `false` \| `true` # + # @option params [String] :key + # The optional [API key][1] to authorize the request. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # # @option params [String] :travel_mode # 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`. @@ -973,10 +991,11 @@ # departure_position: [1.0], # required # departure_time: Time.now, # destination_position: [1.0], # required # distance_unit: "Kilometers", # accepts Kilometers, Miles # include_leg_geometry: false, + # key: "ApiKey", # travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle # truck_mode_options: { # avoid_ferries: false, # avoid_tolls: false, # dimensions: { @@ -1170,10 +1189,17 @@ # @option params [String] :distance_unit # Set the unit system to specify the distance. # # Default Value: `Kilometers` # + # @option params [String] :key + # The optional [API key][1] to authorize the request. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # # @option params [String] :travel_mode # 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 @@ -1228,10 +1254,11 @@ # departure_time: Time.now, # destination_positions: [ # required # [1.0], # ], # distance_unit: "Kilometers", # accepts Kilometers, Miles + # key: "ApiKey", # travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle # truck_mode_options: { # avoid_ferries: false, # avoid_tolls: false, # dimensions: { @@ -1362,19 +1389,19 @@ req = build_request(:create_geofence_collection, params) req.send_request(options) end # Creates an API key resource in your Amazon Web Services account, which - # lets you grant `geo:GetMap*` actions for Amazon Location Map resources - # to the API key bearer. + # lets you grant actions for Amazon Location resources to the API key + # bearer. # - # The API keys feature is in preview. We may add, change, or remove - # features before announcing general availability. For more information, - # see [Using API keys][1]. + # <note markdown="1"> For more information, see [Using API keys][1]. # + # </note> # # + # # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html # # @option params [String] :description # An optional description for the API key resource. # @@ -1845,10 +1872,20 @@ # lets you retrieve current and historical location of devices. # # @option params [String] :description # An optional description for the tracker resource. # + # @option params [Boolean] :event_bridge_enabled + # Whether to enable position `UPDATE` events from this tracker to be + # sent to EventBridge. + # + # <note markdown="1"> 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. + # + # </note> + # # @option params [String] :kms_key_id # A key identifier for an [Amazon Web Services KMS customer managed # key][1]. Enter a key ID, key ARN, alias name, or alias ARN. # # @@ -1935,10 +1972,11 @@ # # @example Request syntax with placeholder values # # resp = client.create_tracker({ # description: "ResourceDescription", + # event_bridge_enabled: false, # kms_key_id: "KmsKeyId", # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", # tags: { @@ -2166,18 +2204,10 @@ req.send_request(options) end # Retrieves the API key resource details. # - # The API keys feature is in preview. We may add, change, or remove - # features before announcing general availability. For more information, - # see [Using API keys][1]. - # - # - # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html - # # @option params [required, String] :key_name # The name of the API key resource. # # @return [Types::DescribeKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2365,10 +2395,11 @@ # # @return [Types::DescribeTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeTrackerResponse#create_time #create_time} => Time # * {Types::DescribeTrackerResponse#description #description} => String + # * {Types::DescribeTrackerResponse#event_bridge_enabled #event_bridge_enabled} => Boolean # * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String # * {Types::DescribeTrackerResponse#position_filtering #position_filtering} => String # * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String # * {Types::DescribeTrackerResponse#pricing_plan_data_source #pricing_plan_data_source} => String # * {Types::DescribeTrackerResponse#tags #tags} => Hash&lt;String,String&gt; @@ -2384,10 +2415,11 @@ # # @example Response structure # # resp.create_time #=> Time # resp.description #=> String + # resp.event_bridge_enabled #=> Boolean # resp.kms_key_id #=> String # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased" # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.pricing_plan_data_source #=> String # resp.tags #=> Hash @@ -2937,10 +2969,17 @@ # # @option params [required, String] :index_name # The name of the place index resource that you want to use for the # search. # + # @option params [String] :key + # The optional [API key][1] to authorize the request. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # # @option params [String] :language # The preferred language used to return results. The value must be a # valid [BCP 47][1] language tag, for example, `en` for English. # # This setting affects the languages used in the results, but not the @@ -2972,10 +3011,11 @@ # # @example Request syntax with placeholder values # # resp = client.get_place({ # index_name: "ResourceName", # required + # key: "ApiKey", # language: "LanguageTag", # place_id: "PlaceId", # required # }) # # @example Response structure @@ -3169,18 +3209,10 @@ req.send_request(options) end # Lists API key resources in your Amazon Web Services account. # - # The API keys feature is in preview. We may add, change, or remove - # features before announcing general availability. For more information, - # see [Using API keys][1]. - # - # - # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html - # # @option params [Types::ApiKeyFilter] :filter # Optionally filter the list to only `Active` or `Expired` API keys. # # @option params [Integer] :max_results # An optional limit for the number of resources returned in a single @@ -3521,13 +3553,16 @@ # # @option params [required, String] :geofence_id # An identifier for the geofence. For example, `ExampleGeofence-1`. # # @option params [Hash<String,String>] :geofence_properties - # Specifies additional user-defined properties to store with the - # Geofence. An array of key-value pairs. + # 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"` + # # @option params [required, Types::GeofenceGeometry] :geometry # Contains the details to specify the position of the geofence. Can be # either a polygon or a circle. Including both will return a validation # error. # @@ -3586,10 +3621,17 @@ # position. # # @option params [required, String] :index_name # The name of the place index resource you want to use for the search. # + # @option params [String] :key + # The optional [API key][1] to authorize the request. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # # @option params [String] :language # The preferred language used to return results. The value must be a # valid [BCP 47][1] language tag, for example, `en` for English. # # This setting affects the languages used in the results, but not the @@ -3635,10 +3677,11 @@ # # @example Request syntax with placeholder values # # resp = client.search_place_index_for_position({ # index_name: "ResourceName", # required + # key: "ApiKey", # language: "LanguageTag", # max_results: 1, # position: [1.0], # required # }) # @@ -3761,10 +3804,17 @@ # [1]: https://www.iso.org/iso-3166-country-codes.html # # @option params [required, String] :index_name # The name of the place index resource you want to use for the search. # + # @option params [String] :key + # The optional [API key][1] to authorize the request. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # # @option params [String] :language # The preferred language used to return results. The value must be a # valid [BCP 47][1] language tag, for example, `en` for English. # # This setting affects the languages used in the results. If no language @@ -3806,10 +3856,11 @@ # bias_position: [1.0], # filter_b_box: [1.0], # filter_categories: ["PlaceCategory"], # filter_countries: ["CountryCode"], # index_name: "ResourceName", # required + # key: "ApiKey", # language: "LanguageTag", # max_results: 1, # text: "SearchPlaceIndexForSuggestionsRequestTextString", # required # }) # @@ -3923,10 +3974,17 @@ # [1]: https://www.iso.org/iso-3166-country-codes.html # # @option params [required, String] :index_name # The name of the place index resource you want to use for the search. # + # @option params [String] :key + # The optional [API key][1] to authorize the request. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # # @option params [String] :language # The preferred language used to return results. The value must be a # valid [BCP 47][1] language tag, for example, `en` for English. # # This setting affects the languages used in the results, but not the @@ -3969,10 +4027,11 @@ # bias_position: [1.0], # filter_b_box: [1.0], # filter_categories: ["PlaceCategory"], # filter_countries: ["CountryCode"], # index_name: "ResourceName", # required + # key: "ApiKey", # language: "LanguageTag", # max_results: 1, # text: "SearchPlaceIndexForTextRequestTextString", # required # }) # @@ -4171,18 +4230,10 @@ req.send_request(options) end # Updates the specified properties of a given API key resource. # - # The API keys feature is in preview. We may add, change, or remove - # features before announcing general availability. For more information, - # see [Using API keys][1]. - # - # - # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html - # # @option params [String] :description # Updates the description for the API key resource. # # @option params [Time,DateTime,Date,Integer,String] :expire_time # Updates the timestamp for when the API key resource will expire in [ @@ -4389,10 +4440,20 @@ # Updates the specified properties of a given tracker resource. # # @option params [String] :description # Updates the description for the tracker resource. # + # @option params [Boolean] :event_bridge_enabled + # Whether to enable position `UPDATE` events from this tracker to be + # sent to EventBridge. + # + # <note markdown="1"> 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. + # + # </note> + # # @option params [String] :position_filtering # Updates the position filtering for the tracker resource. # # Valid values: # @@ -4437,10 +4498,11 @@ # # @example Request syntax with placeholder values # # resp = client.update_tracker({ # description: "ResourceDescription", + # event_bridge_enabled: false, # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", # tracker_name: "ResourceName", # required # }) @@ -4471,10 +4533,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-locationservice' - context[:gem_version] = '1.34.0' + context[:gem_version] = '1.35.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated