lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.50.0 vs lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.51.0

- old
+ new

@@ -424,31 +424,31 @@ # creating associations between a tracker resource in one account and a # geofence collection in another account. # # </note> # + # @option params [required, String] :tracker_name + # The name of the tracker resource to be associated with a geofence + # collection. + # # @option params [required, String] :consumer_arn # 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` # # ^ # - # @option params [required, String] :tracker_name - # The name of the tracker resource to be associated with a geofence - # collection. - # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.associate_tracker_consumer({ - # consumer_arn: "Arn", # required # tracker_name: "ResourceName", # required + # consumer_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/AssociateTrackerConsumer AWS API Documentation # # @overload associate_tracker_consumer(params = {}) @@ -459,30 +459,30 @@ end # Deletes the position history of one or more devices from a tracker # resource. # + # @option params [required, String] :tracker_name + # The name of the tracker resource to delete the device position history + # from. + # # @option params [required, Array<String>] :device_ids # Devices whose position history you want to delete. # # * For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]` # # ^ # - # @option params [required, String] :tracker_name - # The name of the tracker resource to delete the device position history - # from. - # # @return [Types::BatchDeleteDevicePositionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::BatchDeleteDevicePositionHistoryResponse#errors #errors} => Array&lt;Types::BatchDeleteDevicePositionHistoryError&gt; # # @example Request syntax with placeholder values # # resp = client.batch_delete_device_position_history({ - # device_ids: ["Id"], # required # tracker_name: "ResourceName", # required + # device_ids: ["Id"], # required # }) # # @example Response structure # # resp.errors #=> Array @@ -523,13 +523,13 @@ # }) # # @example Response structure # # resp.errors #=> Array + # resp.errors[0].geofence_id #=> String # resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" # resp.errors[0].error.message #=> String - # resp.errors[0].geofence_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofence AWS API Documentation # # @overload batch_delete_geofence(params = {}) # @param [Hash] params ({}) @@ -583,30 +583,30 @@ # # resp = client.batch_evaluate_geofences({ # collection_name: "ResourceName", # required # device_position_updates: [ # required # { + # device_id: "Id", # required + # sample_time: Time.now, # required + # position: [1.0], # required # accuracy: { # horizontal: 1.0, # required # }, - # device_id: "Id", # required - # position: [1.0], # required # position_properties: { # "PropertyMapKeyString" => "PropertyMapValueString", # }, - # sample_time: Time.now, # required # }, # ], # }) # # @example Response structure # # resp.errors #=> Array # resp.errors[0].device_id #=> String + # resp.errors[0].sample_time #=> Time # resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" # resp.errors[0].error.message #=> String - # resp.errors[0].sample_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchEvaluateGeofences AWS API Documentation # # @overload batch_evaluate_geofences(params = {}) # @param [Hash] params ({}) @@ -615,48 +615,48 @@ req.send_request(options) end # Lists the latest device positions for requested devices. # + # @option params [required, String] :tracker_name + # The tracker resource retrieving the device position. + # # @option params [required, Array<String>] :device_ids # Devices whose position you want to retrieve. # # * For example, for two devices: # `device-ids=DeviceId1&device-ids=DeviceId2` # # ^ # - # @option params [required, String] :tracker_name - # The tracker resource retrieving the device position. - # # @return [Types::BatchGetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::BatchGetDevicePositionResponse#device_positions #device_positions} => Array&lt;Types::DevicePosition&gt; # * {Types::BatchGetDevicePositionResponse#errors #errors} => Array&lt;Types::BatchGetDevicePositionError&gt; + # * {Types::BatchGetDevicePositionResponse#device_positions #device_positions} => Array&lt;Types::DevicePosition&gt; # # @example Request syntax with placeholder values # # resp = client.batch_get_device_position({ - # device_ids: ["Id"], # required # tracker_name: "BatchGetDevicePositionRequestTrackerNameString", # required + # device_ids: ["Id"], # required # }) # # @example Response structure # + # resp.errors #=> Array + # resp.errors[0].device_id #=> String + # resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" + # resp.errors[0].error.message #=> String # resp.device_positions #=> Array - # resp.device_positions[0].accuracy.horizontal #=> Float # resp.device_positions[0].device_id #=> String + # resp.device_positions[0].sample_time #=> Time + # resp.device_positions[0].received_time #=> Time # resp.device_positions[0].position #=> Array # resp.device_positions[0].position[0] #=> Float + # resp.device_positions[0].accuracy.horizontal #=> Float # resp.device_positions[0].position_properties #=> Hash # resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String - # resp.device_positions[0].received_time #=> Time - # resp.device_positions[0].sample_time #=> Time - # resp.errors #=> Array - # resp.errors[0].device_id #=> String - # resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" - # resp.errors[0].error.message #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchGetDevicePosition AWS API Documentation # # @overload batch_get_device_position(params = {}) # @param [Hash] params ({}) @@ -675,48 +675,49 @@ # @option params [required, Array<Types::BatchPutGeofenceRequestEntry>] :entries # The batch of geofences to be stored in a geofence collection. # # @return [Types::BatchPutGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::BatchPutGeofenceResponse#errors #errors} => Array&lt;Types::BatchPutGeofenceError&gt; # * {Types::BatchPutGeofenceResponse#successes #successes} => Array&lt;Types::BatchPutGeofenceSuccess&gt; + # * {Types::BatchPutGeofenceResponse#errors #errors} => Array&lt;Types::BatchPutGeofenceError&gt; # # @example Request syntax with placeholder values # # resp = client.batch_put_geofence({ # collection_name: "ResourceName", # required # entries: [ # required # { # geofence_id: "Id", # required - # geofence_properties: { - # "PropertyMapKeyString" => "PropertyMapValueString", - # }, # geometry: { # required - # circle: { - # center: [1.0], # required - # radius: 1.0, # required - # }, # polygon: [ # [ # [1.0], # ], # ], + # circle: { + # center: [1.0], # required + # radius: 1.0, # required + # }, + # geobuf: "data", # }, + # geofence_properties: { + # "PropertyMapKeyString" => "PropertyMapValueString", + # }, # }, # ], # }) # # @example Response structure # - # resp.errors #=> Array - # resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" - # resp.errors[0].error.message #=> String - # resp.errors[0].geofence_id #=> String # resp.successes #=> Array - # resp.successes[0].create_time #=> Time # resp.successes[0].geofence_id #=> String + # resp.successes[0].create_time #=> Time # resp.successes[0].update_time #=> Time + # resp.errors #=> Array + # resp.errors[0].geofence_id #=> String + # resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" + # resp.errors[0].error.message #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofence AWS API Documentation # # @overload batch_put_geofence(params = {}) # @param [Hash] params ({}) @@ -769,30 +770,30 @@ # # resp = client.batch_update_device_position({ # tracker_name: "ResourceName", # required # updates: [ # required # { + # device_id: "Id", # required + # sample_time: Time.now, # required + # position: [1.0], # required # accuracy: { # horizontal: 1.0, # required # }, - # device_id: "Id", # required - # position: [1.0], # required # position_properties: { # "PropertyMapKeyString" => "PropertyMapValueString", # }, - # sample_time: Time.now, # required # }, # ], # }) # # @example Response structure # # resp.errors #=> Array # resp.errors[0].device_id #=> String + # resp.errors[0].sample_time #=> Time # resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" # resp.errors[0].error.message #=> String - # resp.errors[0].sample_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchUpdateDevicePosition AWS API Documentation # # @overload batch_update_device_position(params = {}) # @param [Hash] params ({}) @@ -835,38 +836,14 @@ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html # [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html # [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html # [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html # - # @option params [Time,DateTime,Date,Integer,String] :arrival_time - # 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. - # - # <note markdown="1"> ArrivalTime is not supported Esri. - # - # </note> - # # @option params [required, String] :calculator_name # The name of the route calculator resource that you want to use to # calculate the route. # - # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options - # Specifies route preferences when traveling by `Car`, such as avoiding - # routes that use ferries or tolls. - # - # Requirements: `TravelMode` must be specified as `Car`. - # - # @option params [Boolean] :depart_now - # 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` - # # @option params [required, Array<Float>] :departure_position # The start position for the route. Defined in [World Geodetic System # (WGS 84)][1] format: `[longitude, latitude]`. # # * For example, `[-123.115, 49.285]` @@ -885,24 +862,10 @@ # # # [1]: https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84 # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html # - # @option params [Time,DateTime,Date,Integer,String] :departure_time - # 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][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, - # `2020–07-2T12:15:20.000Z+01:00` - # - # ^ - # - # - # - # [1]: https://www.iso.org/iso-8601-date-and-time-format.html - # # @option params [required, Array<Float>] :destination_position # The finish position for the route. Defined in [World Geodetic System # (WGS 84)][1] format: `[longitude, latitude]`. # # * For example, `[-122.339, 47.615]` @@ -919,33 +882,39 @@ # # # [1]: https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84 # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html # - # @option params [String] :distance_unit - # Set the unit system to specify the distance. + # @option params [Array<Array>] :waypoint_positions + # Specifies an ordered list of up to 23 intermediate positions to + # include along a route between the departure position and destination + # position. # - # Default Value: `Kilometers` + # * 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]]` # - # @option params [Boolean] :include_leg_geometry - # Set to include the geometry details in the result for each path - # between a pair of positions. + # ^ # - # Default Value: `false` + # <note markdown="1"> If you specify a waypoint position that's not located on a road, + # Amazon Location [moves the position to the nearest road][1]. # - # Valid Values: `false` \| `true` + # Specifying more than 23 waypoints returns a `400 ValidationException` + # error. # - # @option params [String] :key - # The optional [API key][1] to authorize the request. + # If Esri is the provider for your route calculator, specifying a route + # that is longer than 400 km returns a `400 RoutesValidationException` + # error. # + # </note> # + # Valid Values: `[-180 to 180,-90 to 90]` # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html # - # @option params [String] :optimize_for - # Specifies the distance to optimize for when calculating a route. # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.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`. @@ -972,114 +941,146 @@ # # # # [1]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html # + # @option params [Time,DateTime,Date,Integer,String] :departure_time + # 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][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, + # `2020–07-2T12:15:20.000Z+01:00` + # + # ^ + # + # + # + # [1]: https://www.iso.org/iso-8601-date-and-time-format.html + # + # @option params [Boolean] :depart_now + # 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` + # + # @option params [String] :distance_unit + # Set the unit system to specify the distance. + # + # Default Value: `Kilometers` + # + # @option params [Boolean] :include_leg_geometry + # Set to include the geometry details in the result for each path + # between a pair of positions. + # + # Default Value: `false` + # + # Valid Values: `false` \| `true` + # + # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options + # Specifies route preferences when traveling by `Car`, such as avoiding + # routes that use ferries or tolls. + # + # Requirements: `TravelMode` must be specified as `Car`. + # # @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options # 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`. # - # @option params [Array<Array>] :waypoint_positions - # Specifies an ordered list of up to 23 intermediate positions to - # include along a route between the departure position and destination - # position. + # @option params [Time,DateTime,Date,Integer,String] :arrival_time + # 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. # - # * 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]]` + # <note markdown="1"> ArrivalTime is not supported Esri. # - # ^ - # - # <note markdown="1"> If you specify a waypoint position that's not located on a road, - # Amazon Location [moves the position to the nearest road][1]. - # - # 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. - # # </note> # - # Valid Values: `[-180 to 180,-90 to 90]` + # @option params [String] :optimize_for + # Specifies the distance to optimize for when calculating a route. # + # @option params [String] :key + # The optional [API key][1] to authorize the request. # # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # # @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CalculateRouteResponse#legs #legs} => Array&lt;Types::Leg&gt; # * {Types::CalculateRouteResponse#summary #summary} => Types::CalculateRouteSummary # # @example Request syntax with placeholder values # # resp = client.calculate_route({ - # arrival_time: Time.now, # calculator_name: "ResourceName", # required - # car_mode_options: { - # avoid_ferries: false, - # avoid_tolls: false, - # }, - # depart_now: false, # departure_position: [1.0], # required - # departure_time: Time.now, # destination_position: [1.0], # required + # waypoint_positions: [ + # [1.0], + # ], + # travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle + # departure_time: Time.now, + # depart_now: false, # distance_unit: "Kilometers", # accepts Kilometers, Miles # include_leg_geometry: false, - # key: "ApiKey", - # optimize_for: "FastestRoute", # accepts FastestRoute, ShortestRoute - # travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle + # car_mode_options: { + # avoid_ferries: false, + # avoid_tolls: false, + # }, # truck_mode_options: { # avoid_ferries: false, # avoid_tolls: false, # dimensions: { - # height: 1.0, # length: 1.0, - # unit: "Meters", # accepts Meters, Feet + # height: 1.0, # width: 1.0, + # unit: "Meters", # accepts Meters, Feet # }, # weight: { # total: 1.0, # unit: "Kilograms", # accepts Kilograms, Pounds # }, # }, - # waypoint_positions: [ - # [1.0], - # ], + # arrival_time: Time.now, + # optimize_for: "FastestRoute", # accepts FastestRoute, ShortestRoute + # key: "ApiKey", # }) # # @example Response structure # # resp.legs #=> Array - # resp.legs[0].distance #=> Float - # resp.legs[0].duration_seconds #=> Float + # resp.legs[0].start_position #=> Array + # resp.legs[0].start_position[0] #=> Float # resp.legs[0].end_position #=> Array # resp.legs[0].end_position[0] #=> Float + # resp.legs[0].distance #=> Float + # resp.legs[0].duration_seconds #=> Float # resp.legs[0].geometry.line_string #=> Array # resp.legs[0].geometry.line_string[0] #=> Array # resp.legs[0].geometry.line_string[0][0] #=> Float - # resp.legs[0].start_position #=> Array - # resp.legs[0].start_position[0] #=> Float # resp.legs[0].steps #=> Array - # resp.legs[0].steps[0].distance #=> Float - # resp.legs[0].steps[0].duration_seconds #=> Float + # resp.legs[0].steps[0].start_position #=> Array + # resp.legs[0].steps[0].start_position[0] #=> Float # resp.legs[0].steps[0].end_position #=> Array # resp.legs[0].steps[0].end_position[0] #=> Float + # resp.legs[0].steps[0].distance #=> Float + # resp.legs[0].steps[0].duration_seconds #=> Float # resp.legs[0].steps[0].geometry_offset #=> Integer - # resp.legs[0].steps[0].start_position #=> Array - # resp.legs[0].steps[0].start_position[0] #=> Float + # resp.summary.route_b_box #=> Array + # resp.summary.route_b_box[0] #=> Float # resp.summary.data_source #=> String # resp.summary.distance #=> Float - # resp.summary.distance_unit #=> String, one of "Kilometers", "Miles" # resp.summary.duration_seconds #=> Float - # resp.summary.route_b_box #=> Array - # resp.summary.route_b_box[0] #=> Float + # resp.summary.distance_unit #=> String, one of "Kilometers", "Miles" # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRoute AWS API Documentation # # @overload calculate_route(params = {}) # @param [Hash] params ({}) @@ -1135,26 +1136,10 @@ # # @option params [required, String] :calculator_name # The name of the route calculator resource that you want to use to # calculate the route matrix. # - # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options - # Specifies route preferences when traveling by `Car`, such as avoiding - # routes that use ferries or tolls. - # - # Requirements: `TravelMode` must be specified as `Car`. - # - # @option params [Boolean] :depart_now - # 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` - # # @option params [required, Array<Array>] :departure_positions # 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][1] format: `[longitude, latitude]`. For example, `[-123.115, # 49.285]`. @@ -1177,30 +1162,10 @@ # # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html # - # @option params [Time,DateTime,Date,Integer,String] :departure_time - # 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. - # - # <note markdown="1"> Setting a departure time in the past returns a `400 - # ValidationException` error. - # - # </note> - # - # * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, - # `2020–07-2T12:15:20.000Z+01:00` - # - # ^ - # - # - # - # [1]: https://www.iso.org/iso-8601-date-and-time-format.html - # # @option params [required, Array<Array>] :destination_positions # 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][1] # format: `[longitude, latitude]`. For example, `[-122.339, 47.615]` # @@ -1222,22 +1187,10 @@ # # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html # - # @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 @@ -1261,17 +1214,65 @@ # # # # [1]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html # + # @option params [Time,DateTime,Date,Integer,String] :departure_time + # 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. + # + # <note markdown="1"> Setting a departure time in the past returns a `400 + # ValidationException` error. + # + # </note> + # + # * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, + # `2020–07-2T12:15:20.000Z+01:00` + # + # ^ + # + # + # + # [1]: https://www.iso.org/iso-8601-date-and-time-format.html + # + # @option params [Boolean] :depart_now + # 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` + # + # @option params [String] :distance_unit + # Set the unit system to specify the distance. + # + # Default Value: `Kilometers` + # + # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options + # Specifies route preferences when traveling by `Car`, such as avoiding + # routes that use ferries or tolls. + # + # Requirements: `TravelMode` must be specified as `Car`. + # # @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options # 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`. # + # @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 + # # @return [Types::CalculateRouteMatrixResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CalculateRouteMatrixResponse#route_matrix #route_matrix} => Array&lt;Array&lt;Types::RouteMatrixEntry&gt;&gt; # * {Types::CalculateRouteMatrixResponse#snapped_departure_positions #snapped_departure_positions} => Array&lt;Array&lt;Float&gt;&gt; # * {Types::CalculateRouteMatrixResponse#snapped_destination_positions #snapped_destination_positions} => Array&lt;Array&lt;Float&gt;&gt; @@ -1279,39 +1280,39 @@ # # @example Request syntax with placeholder values # # resp = client.calculate_route_matrix({ # calculator_name: "ResourceName", # required - # car_mode_options: { - # avoid_ferries: false, - # avoid_tolls: false, - # }, - # depart_now: false, # departure_positions: [ # required # [1.0], # ], - # 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 + # departure_time: Time.now, + # depart_now: false, + # distance_unit: "Kilometers", # accepts Kilometers, Miles + # car_mode_options: { + # avoid_ferries: false, + # avoid_tolls: false, + # }, # truck_mode_options: { # avoid_ferries: false, # avoid_tolls: false, # dimensions: { - # height: 1.0, # length: 1.0, - # unit: "Meters", # accepts Meters, Feet + # height: 1.0, # width: 1.0, + # unit: "Meters", # accepts Meters, Feet # }, # weight: { # total: 1.0, # unit: "Kilograms", # accepts Kilograms, Pounds # }, # }, + # key: "ApiKey", # }) # # @example Response structure # # resp.route_matrix #=> Array @@ -1325,13 +1326,13 @@ # resp.snapped_departure_positions[0][0] #=> Float # resp.snapped_destination_positions #=> Array # resp.snapped_destination_positions[0] #=> Array # resp.snapped_destination_positions[0][0] #=> Float # resp.summary.data_source #=> String - # resp.summary.distance_unit #=> String, one of "Kilometers", "Miles" - # resp.summary.error_count #=> Integer # resp.summary.route_count #=> Integer + # resp.summary.error_count #=> Integer + # resp.summary.distance_unit #=> String, one of "Kilometers", "Miles" # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix AWS API Documentation # # @overload calculate_route_matrix(params = {}) # @param [Hash] params ({}) @@ -1352,28 +1353,20 @@ # # * Must be a unique geofence collection name. # # * No spaces allowed. For example, `ExampleGeofenceCollection`. # - # @option params [String] :description - # An optional description for the geofence collection. - # - # @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. - # - # - # - # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html - # # @option params [String] :pricing_plan # No longer used. If included, the only allowed value is # `RequestBasedUsage`. # # @option params [String] :pricing_plan_data_source # This parameter is no longer used. # + # @option params [String] :description + # An optional description for the geofence collection. + # # @option params [Hash<String,String>] :tags # 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. # @@ -1392,33 +1385,41 @@ # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following # characters: + - = . \_ : / @. # # * Cannot use "aws:" as a prefix for a key. # + # @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. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html + # # @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::CreateGeofenceCollectionResponse#collection_name #collection_name} => String + # * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::CreateGeofenceCollectionResponse#create_time #create_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_geofence_collection({ # collection_name: "ResourceName", # required - # description: "ResourceDescription", - # kms_key_id: "KmsKeyId", # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", + # description: "ResourceDescription", # tags: { # "TagKey" => "TagValue", # }, + # kms_key_id: "KmsKeyId", # }) # # @example Response structure # - # resp.collection_arn #=> String # resp.collection_name #=> String + # resp.collection_arn #=> String # resp.create_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollection AWS API Documentation # # @overload create_geofence_collection(params = {}) @@ -1438,22 +1439,10 @@ # # # # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html # - # @option params [String] :description - # An optional description for the API key resource. - # - # @option params [Time,DateTime,Date,Integer,String] :expire_time - # The optional timestamp for when the API key resource will expire in [ - # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry` or - # `ExpireTime` must be set. - # - # - # - # [1]: https://www.iso.org/iso-8601-date-and-time-format.html - # # @option params [required, String] :key_name # A custom name for the API key resource. # # Requirements: # @@ -1462,17 +1451,29 @@ # # * Must be a unique API key name. # # * No spaces allowed. For example, `ExampleAPIKey`. # + # @option params [required, Types::ApiKeyRestrictions] :restrictions + # The API key restrictions for the API key resource. + # + # @option params [String] :description + # An optional description for the API key resource. + # + # @option params [Time,DateTime,Date,Integer,String] :expire_time + # The optional timestamp for when the API key resource will expire in [ + # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry` or + # `ExpireTime` must be set. + # + # + # + # [1]: https://www.iso.org/iso-8601-date-and-time-format.html + # # @option params [Boolean] :no_expiry # Optionally set to `true` to set no expiration time for the API key. # One of `NoExpiry` or `ExpireTime` must be set. # - # @option params [required, Types::ApiKeyRestrictions] :restrictions - # The API key restrictions for the API key resource. - # # @option params [Hash<String,String>] :tags # 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. # @@ -1493,38 +1494,38 @@ # # * Cannot use "aws:" as a prefix for a key. # # @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateKeyResponse#create_time #create_time} => Time # * {Types::CreateKeyResponse#key #key} => String # * {Types::CreateKeyResponse#key_arn #key_arn} => String # * {Types::CreateKeyResponse#key_name #key_name} => String + # * {Types::CreateKeyResponse#create_time #create_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_key({ - # description: "ResourceDescription", - # expire_time: Time.now, # key_name: "ResourceName", # required - # no_expiry: false, # restrictions: { # required # allow_actions: ["ApiKeyAction"], # required + # allow_resources: ["GeoArnV2"], # required # allow_referers: ["RefererPattern"], - # allow_resources: ["GeoArn"], # required # }, + # description: "ResourceDescription", + # expire_time: Time.now, + # no_expiry: false, # tags: { # "TagKey" => "TagValue", # }, # }) # # @example Response structure # - # resp.create_time #=> Time # resp.key #=> String # resp.key_arn #=> String # resp.key_name #=> String + # resp.create_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKey AWS API Documentation # # @overload create_key(params = {}) # @param [Hash] params ({}) @@ -1546,18 +1547,10 @@ # # # # [1]: http://aws.amazon.com/service-terms # - # @option params [required, Types::MapConfiguration] :configuration - # 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. - # - # @option params [String] :description - # An optional description for the map resource. - # # @option params [required, String] :map_name # The name for the map resource. # # Requirements: # @@ -1566,14 +1559,22 @@ # # * Must be a unique map resource name. # # * No spaces allowed. For example, `ExampleMap`. # + # @option params [required, Types::MapConfiguration] :configuration + # 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. + # # @option params [String] :pricing_plan # No longer used. If included, the only allowed value is # `RequestBasedUsage`. # + # @option params [String] :description + # An optional description for the map resource. + # # @option params [Hash<String,String>] :tags # 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. # @@ -1594,35 +1595,35 @@ # # * Cannot use "aws:" as a prefix for a key. # # @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateMapResponse#create_time #create_time} => Time - # * {Types::CreateMapResponse#map_arn #map_arn} => String # * {Types::CreateMapResponse#map_name #map_name} => String + # * {Types::CreateMapResponse#map_arn #map_arn} => String + # * {Types::CreateMapResponse#create_time #create_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_map({ + # map_name: "ResourceName", # required # configuration: { # required - # custom_layers: ["CustomLayer"], - # political_view: "CountryCode3", # style: "MapStyle", # required + # political_view: "CountryCode3", + # custom_layers: ["CustomLayer"], # }, - # description: "ResourceDescription", - # map_name: "ResourceName", # required # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # description: "ResourceDescription", # tags: { # "TagKey" => "TagValue", # }, # }) # # @example Response structure # - # resp.create_time #=> Time - # resp.map_arn #=> String # resp.map_name #=> String + # resp.map_arn #=> String + # resp.create_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMap AWS API Documentation # # @overload create_map(params = {}) # @param [Hash] params ({}) @@ -1647,10 +1648,22 @@ # # # # [1]: http://aws.amazon.com/service-terms # + # @option params [required, String] :index_name + # 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`. + # # @option params [required, String] :data_source # Specifies the geospatial data provider for the new place index. # # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For # example, entering `HERE` returns an error. @@ -1689,32 +1702,20 @@ # [6]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html # [7]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html # [8]: http://aws.amazon.com/service-terms/ # [9]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html # - # @option params [Types::DataSourceConfiguration] :data_source_configuration - # Specifies the data storage option requesting Places. + # @option params [String] :pricing_plan + # No longer used. If included, the only allowed value is + # `RequestBasedUsage`. # # @option params [String] :description # The optional description for the place index resource. # - # @option params [required, String] :index_name - # The name of the place index resource. + # @option params [Types::DataSourceConfiguration] :data_source_configuration + # Specifies the data storage option requesting Places. # - # 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`. - # - # @option params [String] :pricing_plan - # No longer used. If included, the only allowed value is - # `RequestBasedUsage`. - # # @option params [Hash<String,String>] :tags # 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. # @@ -1736,34 +1737,34 @@ # # * Cannot use "aws:" as a prefix for a key. # # @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreatePlaceIndexResponse#create_time #create_time} => Time - # * {Types::CreatePlaceIndexResponse#index_arn #index_arn} => String # * {Types::CreatePlaceIndexResponse#index_name #index_name} => String + # * {Types::CreatePlaceIndexResponse#index_arn #index_arn} => String + # * {Types::CreatePlaceIndexResponse#create_time #create_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_place_index({ + # index_name: "ResourceName", # required # data_source: "String", # required + # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # description: "ResourceDescription", # data_source_configuration: { # intended_use: "SingleUse", # accepts SingleUse, Storage # }, - # description: "ResourceDescription", - # index_name: "ResourceName", # required - # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # tags: { # "TagKey" => "TagValue", # }, # }) # # @example Response structure # - # resp.create_time #=> Time - # resp.index_arn #=> String # resp.index_name #=> String + # resp.index_arn #=> String + # resp.create_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndex AWS API Documentation # # @overload create_place_index(params = {}) # @param [Hash] params ({}) @@ -1839,17 +1840,17 @@ # [5]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html # [6]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html # [7]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html # [8]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html # - # @option params [String] :description - # The optional description for the route calculator resource. - # # @option params [String] :pricing_plan # No longer used. If included, the only allowed value is # `RequestBasedUsage`. # + # @option params [String] :description + # The optional description for the route calculator resource. + # # @option params [Hash<String,String>] :tags # 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. # @@ -1874,30 +1875,30 @@ # # * Cannot use "aws:" as a prefix for a key. # # @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String # * {Types::CreateRouteCalculatorResponse#calculator_name #calculator_name} => String + # * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String # * {Types::CreateRouteCalculatorResponse#create_time #create_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_route_calculator({ # calculator_name: "ResourceName", # required # data_source: "String", # required - # description: "ResourceDescription", # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # description: "ResourceDescription", # tags: { # "TagKey" => "TagValue", # }, # }) # # @example Response structure # - # resp.calculator_arn #=> String # resp.calculator_name #=> String + # resp.calculator_arn #=> String # resp.create_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculator AWS API Documentation # # @overload create_route_calculator(params = {}) @@ -1908,55 +1909,62 @@ end # Creates a tracker resource in your Amazon Web Services account, which # lets you retrieve current and historical location of devices. # - # @option params [String] :description - # An optional description for the tracker resource. + # @option params [required, String] :tracker_name + # The name for the tracker resource. # - # @option params [Boolean] :event_bridge_enabled - # Whether to enable position `UPDATE` events from this tracker to be - # sent to EventBridge. + # Requirements: # - # <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. + # * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), + # periods (.), and underscores (\_). # - # </note> + # * Must be a unique tracker resource name. # - # @option params [Boolean] :kms_key_enable_geospatial_queries - # Enables `GeospatialQueries` for a tracker that uses a [Amazon Web - # Services KMS customer managed key][1]. + # * No spaces allowed. For example, `ExampleTracker`. # - # This parameter is only used if you are using a KMS customer managed - # key. + # @option params [String] :pricing_plan + # No longer used. If included, the only allowed value is + # `RequestBasedUsage`. # - # <note markdown="1"> 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. + # @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. # - # 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. # - # </note> # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html # + # @option params [String] :pricing_plan_data_source + # This parameter is no longer used. # - # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html + # @option params [String] :description + # An optional description for the tracker resource. # - # @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. + # @option params [Hash<String,String>] :tags + # 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: # - # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html + # * 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. + # # @option params [String] :position_filtering # Specifies the position filtering for the tracker resource. # # Valid values: # @@ -1984,78 +1992,71 @@ # evaluations. # # This field is optional. If not specified, the default value is # `TimeBased`. # - # @option params [String] :pricing_plan - # No longer used. If included, the only allowed value is - # `RequestBasedUsage`. + # @option params [Boolean] :event_bridge_enabled + # Whether to enable position `UPDATE` events from this tracker to be + # sent to EventBridge. # - # @option params [String] :pricing_plan_data_source - # This parameter is no longer used. + # <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. # - # @option params [Hash<String,String>] :tags - # 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. + # </note> # - # Format: `"key" : "value"` + # @option params [Boolean] :kms_key_enable_geospatial_queries + # Enables `GeospatialQueries` for a tracker that uses a [Amazon Web + # Services KMS customer managed key][1]. # - # Restrictions: + # This parameter is only used if you are using a KMS customer managed + # key. # - # * Maximum 50 tags per resource + # <note markdown="1"> 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. # - # * Each resource tag must be unique with a maximum of one value. + # 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. # - # * Maximum key length: 128 Unicode characters in UTF-8 + # </note> # - # * 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. + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html # - # @option params [required, String] :tracker_name - # 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`. - # # @return [Types::CreateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateTrackerResponse#create_time #create_time} => Time - # * {Types::CreateTrackerResponse#tracker_arn #tracker_arn} => String # * {Types::CreateTrackerResponse#tracker_name #tracker_name} => String + # * {Types::CreateTrackerResponse#tracker_arn #tracker_arn} => String + # * {Types::CreateTrackerResponse#create_time #create_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_tracker({ - # description: "ResourceDescription", - # event_bridge_enabled: false, - # kms_key_enable_geospatial_queries: false, - # kms_key_id: "KmsKeyId", - # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased + # tracker_name: "ResourceName", # required # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # kms_key_id: "KmsKeyId", # pricing_plan_data_source: "String", + # description: "ResourceDescription", # tags: { # "TagKey" => "TagValue", # }, - # tracker_name: "ResourceName", # required + # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased + # event_bridge_enabled: false, + # kms_key_enable_geospatial_queries: false, # }) # # @example Response structure # - # resp.create_time #=> Time - # resp.tracker_arn #=> String # resp.tracker_name #=> String + # resp.tracker_arn #=> String + # resp.create_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTracker AWS API Documentation # # @overload create_tracker(params = {}) # @param [Hash] params ({}) @@ -2093,10 +2094,13 @@ end # Deletes the specified API key. The API key must have been deactivated # more than 90 days previously. # + # @option params [required, String] :key_name + # The name of the API key to delete. + # # @option params [Boolean] :force_delete # 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. # @@ -2107,20 +2111,17 @@ # <note markdown="1"> This action is irreversible. Only use ForceDelete if you are certain # the key is no longer in use. # # </note> # - # @option params [required, String] :key_name - # The name of the API key to delete. - # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_key({ - # force_delete: false, # key_name: "ResourceName", # required + # force_delete: false, # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKey AWS API Documentation # # @overload delete_key(params = {}) @@ -2243,40 +2244,40 @@ # @option params [required, String] :collection_name # The name of the geofence collection. # # @return [Types::DescribeGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::DescribeGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::DescribeGeofenceCollectionResponse#collection_name #collection_name} => String - # * {Types::DescribeGeofenceCollectionResponse#create_time #create_time} => Time + # * {Types::DescribeGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::DescribeGeofenceCollectionResponse#description #description} => String - # * {Types::DescribeGeofenceCollectionResponse#geofence_count #geofence_count} => Integer - # * {Types::DescribeGeofenceCollectionResponse#kms_key_id #kms_key_id} => String # * {Types::DescribeGeofenceCollectionResponse#pricing_plan #pricing_plan} => String # * {Types::DescribeGeofenceCollectionResponse#pricing_plan_data_source #pricing_plan_data_source} => String + # * {Types::DescribeGeofenceCollectionResponse#kms_key_id #kms_key_id} => String # * {Types::DescribeGeofenceCollectionResponse#tags #tags} => Hash&lt;String,String&gt; + # * {Types::DescribeGeofenceCollectionResponse#create_time #create_time} => Time # * {Types::DescribeGeofenceCollectionResponse#update_time #update_time} => Time + # * {Types::DescribeGeofenceCollectionResponse#geofence_count #geofence_count} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_geofence_collection({ # collection_name: "ResourceName", # required # }) # # @example Response structure # - # resp.collection_arn #=> String # resp.collection_name #=> String - # resp.create_time #=> Time + # resp.collection_arn #=> String # resp.description #=> String - # resp.geofence_count #=> Integer - # resp.kms_key_id #=> String # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.pricing_plan_data_source #=> String + # resp.kms_key_id #=> String # resp.tags #=> Hash # resp.tags["TagKey"] #=> String + # resp.create_time #=> Time # resp.update_time #=> Time + # resp.geofence_count #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection AWS API Documentation # # @overload describe_geofence_collection(params = {}) # @param [Hash] params ({}) @@ -2290,43 +2291,43 @@ # @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: # - # * {Types::DescribeKeyResponse#create_time #create_time} => Time - # * {Types::DescribeKeyResponse#description #description} => String - # * {Types::DescribeKeyResponse#expire_time #expire_time} => Time # * {Types::DescribeKeyResponse#key #key} => String # * {Types::DescribeKeyResponse#key_arn #key_arn} => String # * {Types::DescribeKeyResponse#key_name #key_name} => String # * {Types::DescribeKeyResponse#restrictions #restrictions} => Types::ApiKeyRestrictions - # * {Types::DescribeKeyResponse#tags #tags} => Hash&lt;String,String&gt; + # * {Types::DescribeKeyResponse#create_time #create_time} => Time + # * {Types::DescribeKeyResponse#expire_time #expire_time} => Time # * {Types::DescribeKeyResponse#update_time #update_time} => Time + # * {Types::DescribeKeyResponse#description #description} => String + # * {Types::DescribeKeyResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.describe_key({ # key_name: "ResourceName", # required # }) # # @example Response structure # - # resp.create_time #=> Time - # resp.description #=> String - # resp.expire_time #=> Time # resp.key #=> String # resp.key_arn #=> String # resp.key_name #=> String # resp.restrictions.allow_actions #=> Array # resp.restrictions.allow_actions[0] #=> String - # resp.restrictions.allow_referers #=> Array - # resp.restrictions.allow_referers[0] #=> String # resp.restrictions.allow_resources #=> Array # resp.restrictions.allow_resources[0] #=> String + # resp.restrictions.allow_referers #=> Array + # resp.restrictions.allow_referers[0] #=> String + # resp.create_time #=> Time + # resp.expire_time #=> Time + # resp.update_time #=> Time + # resp.description #=> String # resp.tags #=> Hash # resp.tags["TagKey"] #=> String - # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKey AWS API Documentation # # @overload describe_key(params = {}) # @param [Hash] params ({}) @@ -2340,40 +2341,40 @@ # @option params [required, String] :map_name # The name of the map resource. # # @return [Types::DescribeMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::DescribeMapResponse#configuration #configuration} => Types::MapConfiguration - # * {Types::DescribeMapResponse#create_time #create_time} => Time - # * {Types::DescribeMapResponse#data_source #data_source} => String - # * {Types::DescribeMapResponse#description #description} => String - # * {Types::DescribeMapResponse#map_arn #map_arn} => String # * {Types::DescribeMapResponse#map_name #map_name} => String + # * {Types::DescribeMapResponse#map_arn #map_arn} => String # * {Types::DescribeMapResponse#pricing_plan #pricing_plan} => String + # * {Types::DescribeMapResponse#data_source #data_source} => String + # * {Types::DescribeMapResponse#configuration #configuration} => Types::MapConfiguration + # * {Types::DescribeMapResponse#description #description} => String # * {Types::DescribeMapResponse#tags #tags} => Hash&lt;String,String&gt; + # * {Types::DescribeMapResponse#create_time #create_time} => Time # * {Types::DescribeMapResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_map({ # map_name: "ResourceName", # required # }) # # @example Response structure # + # resp.map_name #=> String + # resp.map_arn #=> String + # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.data_source #=> String + # resp.configuration.style #=> String + # resp.configuration.political_view #=> String # resp.configuration.custom_layers #=> Array # resp.configuration.custom_layers[0] #=> String - # resp.configuration.political_view #=> String - # resp.configuration.style #=> String - # resp.create_time #=> Time - # resp.data_source #=> String # resp.description #=> String - # resp.map_arn #=> String - # resp.map_name #=> String - # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.tags #=> Hash # resp.tags["TagKey"] #=> String + # resp.create_time #=> Time # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMap AWS API Documentation # # @overload describe_map(params = {}) @@ -2388,38 +2389,38 @@ # @option params [required, String] :index_name # The name of the place index resource. # # @return [Types::DescribePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # + # * {Types::DescribePlaceIndexResponse#index_name #index_name} => String + # * {Types::DescribePlaceIndexResponse#index_arn #index_arn} => String + # * {Types::DescribePlaceIndexResponse#pricing_plan #pricing_plan} => String + # * {Types::DescribePlaceIndexResponse#description #description} => String # * {Types::DescribePlaceIndexResponse#create_time #create_time} => Time + # * {Types::DescribePlaceIndexResponse#update_time #update_time} => Time # * {Types::DescribePlaceIndexResponse#data_source #data_source} => String # * {Types::DescribePlaceIndexResponse#data_source_configuration #data_source_configuration} => Types::DataSourceConfiguration - # * {Types::DescribePlaceIndexResponse#description #description} => String - # * {Types::DescribePlaceIndexResponse#index_arn #index_arn} => String - # * {Types::DescribePlaceIndexResponse#index_name #index_name} => String - # * {Types::DescribePlaceIndexResponse#pricing_plan #pricing_plan} => String # * {Types::DescribePlaceIndexResponse#tags #tags} => Hash&lt;String,String&gt; - # * {Types::DescribePlaceIndexResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_place_index({ # index_name: "ResourceName", # required # }) # # @example Response structure # + # resp.index_name #=> String + # resp.index_arn #=> String + # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.description #=> String # resp.create_time #=> Time + # resp.update_time #=> Time # resp.data_source #=> String # resp.data_source_configuration.intended_use #=> String, one of "SingleUse", "Storage" - # resp.description #=> String - # resp.index_arn #=> String - # resp.index_name #=> String - # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.tags #=> Hash # resp.tags["TagKey"] #=> String - # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex AWS API Documentation # # @overload describe_place_index(params = {}) # @param [Hash] params ({}) @@ -2433,36 +2434,36 @@ # @option params [required, String] :calculator_name # The name of the route calculator resource. # # @return [Types::DescribeRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::DescribeRouteCalculatorResponse#calculator_arn #calculator_arn} => String # * {Types::DescribeRouteCalculatorResponse#calculator_name #calculator_name} => String + # * {Types::DescribeRouteCalculatorResponse#calculator_arn #calculator_arn} => String + # * {Types::DescribeRouteCalculatorResponse#pricing_plan #pricing_plan} => String + # * {Types::DescribeRouteCalculatorResponse#description #description} => String # * {Types::DescribeRouteCalculatorResponse#create_time #create_time} => Time + # * {Types::DescribeRouteCalculatorResponse#update_time #update_time} => Time # * {Types::DescribeRouteCalculatorResponse#data_source #data_source} => String - # * {Types::DescribeRouteCalculatorResponse#description #description} => String - # * {Types::DescribeRouteCalculatorResponse#pricing_plan #pricing_plan} => String # * {Types::DescribeRouteCalculatorResponse#tags #tags} => Hash&lt;String,String&gt; - # * {Types::DescribeRouteCalculatorResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_route_calculator({ # calculator_name: "ResourceName", # required # }) # # @example Response structure # - # resp.calculator_arn #=> String # resp.calculator_name #=> String + # resp.calculator_arn #=> String + # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.description #=> String # resp.create_time #=> Time + # resp.update_time #=> Time # resp.data_source #=> String - # resp.description #=> String - # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.tags #=> Hash # resp.tags["TagKey"] #=> String - # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculator AWS API Documentation # # @overload describe_route_calculator(params = {}) # @param [Hash] params ({}) @@ -2476,44 +2477,44 @@ # @option params [required, String] :tracker_name # The name of the tracker resource. # # @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#tracker_name #tracker_name} => String + # * {Types::DescribeTrackerResponse#tracker_arn #tracker_arn} => String # * {Types::DescribeTrackerResponse#description #description} => String - # * {Types::DescribeTrackerResponse#event_bridge_enabled #event_bridge_enabled} => Boolean - # * {Types::DescribeTrackerResponse#kms_key_enable_geospatial_queries #kms_key_enable_geospatial_queries} => 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; - # * {Types::DescribeTrackerResponse#tracker_arn #tracker_arn} => String - # * {Types::DescribeTrackerResponse#tracker_name #tracker_name} => String + # * {Types::DescribeTrackerResponse#create_time #create_time} => Time # * {Types::DescribeTrackerResponse#update_time #update_time} => Time + # * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String + # * {Types::DescribeTrackerResponse#position_filtering #position_filtering} => String + # * {Types::DescribeTrackerResponse#event_bridge_enabled #event_bridge_enabled} => Boolean + # * {Types::DescribeTrackerResponse#kms_key_enable_geospatial_queries #kms_key_enable_geospatial_queries} => Boolean # # @example Request syntax with placeholder values # # resp = client.describe_tracker({ # tracker_name: "ResourceName", # required # }) # # @example Response structure # - # resp.create_time #=> Time + # resp.tracker_name #=> String + # resp.tracker_arn #=> String # resp.description #=> String - # resp.event_bridge_enabled #=> Boolean - # resp.kms_key_enable_geospatial_queries #=> 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 # resp.tags["TagKey"] #=> String - # resp.tracker_arn #=> String - # resp.tracker_name #=> String + # resp.create_time #=> Time # resp.update_time #=> Time + # resp.kms_key_id #=> String + # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased" + # resp.event_bridge_enabled #=> Boolean + # resp.kms_key_enable_geospatial_queries #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeTracker AWS API Documentation # # @overload describe_tracker(params = {}) # @param [Hash] params ({}) @@ -2529,30 +2530,30 @@ # tracker positions will no longer be automatically evaluated against # geofences. # # </note> # + # @option params [required, String] :tracker_name + # The name of the tracker resource to be dissociated from the consumer. + # # @option params [required, String] :consumer_arn # 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` # # ^ # - # @option params [required, String] :tracker_name - # The name of the tracker resource to be dissociated from the consumer. - # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.disassociate_tracker_consumer({ - # consumer_arn: "Arn", # required # tracker_name: "ResourceName", # required + # consumer_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DisassociateTrackerConsumer AWS API Documentation # # @overload disassociate_tracker_consumer(params = {}) @@ -2560,49 +2561,149 @@ def disassociate_tracker_consumer(params = {}, options = {}) req = build_request(:disassociate_tracker_consumer, params) req.send_request(options) end + # Evaluates device positions against geofence geometries from a given + # geofence collection. The event forecasts three states for which a + # device can be in relative to a geofence: + # + # `ENTER`: If a device is outside of a geofence, but would breach the + # fence if the device is moving at its current speed within time horizon + # window. + # + # `EXIT`: If a device is inside of a geofence, but would breach the + # fence if the device is moving at its current speed within time horizon + # window. + # + # `IDLE`: If a device is inside of a geofence, and the device is not + # moving. + # + # @option params [required, String] :collection_name + # The name of the geofence collection. + # + # @option params [required, Types::ForecastGeofenceEventsDeviceState] :device_state + # The device's state, including current position and speed. + # + # @option params [Float] :time_horizon_minutes + # Specifies the time horizon in minutes for the forecasted events. + # + # @option params [String] :distance_unit + # 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` + # + # @option params [String] :speed_unit + # 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`. + # + # @option params [String] :next_token + # 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` + # + # @option params [Integer] :max_results + # An optional limit for the number of resources returned in a single + # call. + # + # Default value: `20` + # + # @return [Types::ForecastGeofenceEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ForecastGeofenceEventsResponse#forecasted_events #forecasted_events} => Array&lt;Types::ForecastedEvent&gt; + # * {Types::ForecastGeofenceEventsResponse#next_token #next_token} => String + # * {Types::ForecastGeofenceEventsResponse#distance_unit #distance_unit} => String + # * {Types::ForecastGeofenceEventsResponse#speed_unit #speed_unit} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.forecast_geofence_events({ + # collection_name: "ResourceName", # required + # device_state: { # required + # position: [1.0], # required + # speed: 1.0, + # }, + # time_horizon_minutes: 1.0, + # distance_unit: "Kilometers", # accepts Kilometers, Miles + # speed_unit: "KilometersPerHour", # accepts KilometersPerHour, MilesPerHour + # next_token: "LargeToken", + # max_results: 1, + # }) + # + # @example Response structure + # + # resp.forecasted_events #=> Array + # resp.forecasted_events[0].event_id #=> String + # resp.forecasted_events[0].geofence_id #=> String + # resp.forecasted_events[0].is_device_in_geofence #=> Boolean + # resp.forecasted_events[0].nearest_distance #=> Float + # resp.forecasted_events[0].event_type #=> String, one of "ENTER", "EXIT", "IDLE" + # resp.forecasted_events[0].forecasted_breach_time #=> Time + # resp.forecasted_events[0].geofence_properties #=> Hash + # resp.forecasted_events[0].geofence_properties["PropertyMapKeyString"] #=> String + # resp.next_token #=> String + # resp.distance_unit #=> String, one of "Kilometers", "Miles" + # resp.speed_unit #=> String, one of "KilometersPerHour", "MilesPerHour" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ForecastGeofenceEvents AWS API Documentation + # + # @overload forecast_geofence_events(params = {}) + # @param [Hash] params ({}) + def forecast_geofence_events(params = {}, options = {}) + req = build_request(:forecast_geofence_events, params) + req.send_request(options) + end + # Retrieves a device's most recent position according to its sample # time. # # <note markdown="1"> Device positions are deleted after 30 days. # # </note> # - # @option params [required, String] :device_id - # The device whose position you want to retrieve. - # # @option params [required, String] :tracker_name # The tracker resource receiving the position update. # + # @option params [required, String] :device_id + # The device whose position you want to retrieve. + # # @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy # * {Types::GetDevicePositionResponse#device_id #device_id} => String + # * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time + # * {Types::GetDevicePositionResponse#received_time #received_time} => Time # * {Types::GetDevicePositionResponse#position #position} => Array&lt;Float&gt; + # * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy # * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash&lt;String,String&gt; - # * {Types::GetDevicePositionResponse#received_time #received_time} => Time - # * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time # # @example Request syntax with placeholder values # # resp = client.get_device_position({ - # device_id: "Id", # required # tracker_name: "ResourceName", # required + # device_id: "Id", # required # }) # # @example Response structure # - # resp.accuracy.horizontal #=> Float # resp.device_id #=> String + # resp.sample_time #=> Time + # resp.received_time #=> Time # resp.position #=> Array # resp.position[0] #=> Float + # resp.accuracy.horizontal #=> Float # resp.position_properties #=> Hash # resp.position_properties["PropertyMapKeyString"] #=> String - # resp.received_time #=> Time - # resp.sample_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePosition AWS API Documentation # # @overload get_device_position(params = {}) # @param [Hash] params ({}) @@ -2616,35 +2717,17 @@ # # <note markdown="1"> Device positions are deleted after 30 days. # # </note> # + # @option params [required, String] :tracker_name + # The tracker resource receiving the request for the device position + # history. + # # @option params [required, String] :device_id # The device whose position history you want to retrieve. # - # @option params [Time,DateTime,Date,Integer,String] :end_time_exclusive - # Specify the end time for the position history in [ ISO 8601][1] - # 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`. - # - # ^ - # - # - # - # [1]: https://www.iso.org/iso-8601-date-and-time-format.html - # - # @option params [Integer] :max_results - # An optional limit for the number of device positions returned in a - # single call. - # - # Default value: `100` - # # @option params [String] :next_token # 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` @@ -2663,43 +2746,61 @@ # # # # [1]: https://www.iso.org/iso-8601-date-and-time-format.html # - # @option params [required, String] :tracker_name - # The tracker resource receiving the request for the device position - # history. + # @option params [Time,DateTime,Date,Integer,String] :end_time_exclusive + # Specify the end time for the position history in [ ISO 8601][1] + # 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`. + # + # ^ + # + # + # + # [1]: https://www.iso.org/iso-8601-date-and-time-format.html + # + # @option params [Integer] :max_results + # An optional limit for the number of device positions returned in a + # single call. + # + # Default value: `100` + # # @return [Types::GetDevicePositionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDevicePositionHistoryResponse#device_positions #device_positions} => Array&lt;Types::DevicePosition&gt; # * {Types::GetDevicePositionHistoryResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.get_device_position_history({ + # tracker_name: "ResourceName", # required # device_id: "Id", # required - # end_time_exclusive: Time.now, - # max_results: 1, # next_token: "Token", # start_time_inclusive: Time.now, - # tracker_name: "ResourceName", # required + # end_time_exclusive: Time.now, + # max_results: 1, # }) # # @example Response structure # # resp.device_positions #=> Array - # resp.device_positions[0].accuracy.horizontal #=> Float # resp.device_positions[0].device_id #=> String + # resp.device_positions[0].sample_time #=> Time + # resp.device_positions[0].received_time #=> Time # resp.device_positions[0].position #=> Array # resp.device_positions[0].position[0] #=> Float + # resp.device_positions[0].accuracy.horizontal #=> Float # resp.device_positions[0].position_properties #=> Hash # resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String - # resp.device_positions[0].received_time #=> Time - # resp.device_positions[0].sample_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionHistory AWS API Documentation # # @overload get_device_position_history(params = {}) @@ -2709,47 +2810,53 @@ req.send_request(options) end # Retrieves the geofence details from a geofence collection. # + # <note markdown="1"> The returned geometry will always match the geometry format used when + # the geofence was created. + # + # </note> + # # @option params [required, String] :collection_name # The geofence collection storing the target geofence. # # @option params [required, String] :geofence_id # The geofence you're retrieving details for. # # @return [Types::GetGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::GetGeofenceResponse#create_time #create_time} => Time # * {Types::GetGeofenceResponse#geofence_id #geofence_id} => String - # * {Types::GetGeofenceResponse#geofence_properties #geofence_properties} => Hash&lt;String,String&gt; # * {Types::GetGeofenceResponse#geometry #geometry} => Types::GeofenceGeometry # * {Types::GetGeofenceResponse#status #status} => String + # * {Types::GetGeofenceResponse#create_time #create_time} => Time # * {Types::GetGeofenceResponse#update_time #update_time} => Time + # * {Types::GetGeofenceResponse#geofence_properties #geofence_properties} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.get_geofence({ # collection_name: "ResourceName", # required # geofence_id: "Id", # required # }) # # @example Response structure # - # resp.create_time #=> Time # resp.geofence_id #=> String - # resp.geofence_properties #=> Hash - # resp.geofence_properties["PropertyMapKeyString"] #=> String - # resp.geometry.circle.center #=> Array - # resp.geometry.circle.center[0] #=> Float - # resp.geometry.circle.radius #=> Float # resp.geometry.polygon #=> Array # resp.geometry.polygon[0] #=> Array # resp.geometry.polygon[0][0] #=> Array # resp.geometry.polygon[0][0][0] #=> Float + # resp.geometry.circle.center #=> Array + # resp.geometry.circle.center[0] #=> Float + # resp.geometry.circle.radius #=> Float + # resp.geometry.geobuf #=> String # resp.status #=> String + # resp.create_time #=> Time # resp.update_time #=> Time + # resp.geofence_properties #=> Hash + # resp.geofence_properties["PropertyMapKeyString"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetGeofence AWS API Documentation # # @overload get_geofence(params = {}) # @param [Hash] params ({}) @@ -2758,10 +2865,13 @@ req.send_request(options) end # Retrieves glyphs used to display labels on a map. # + # @option params [required, String] :map_name + # The map resource associated with the glyph file. + # # @option params [required, String] :font_stack # 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][1] styles: @@ -2778,11 +2888,11 @@ # # * VectorEsriStreets – `Arial Regular` \| `Arial Italic` \| `Arial # Bold` # # * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial - # Bold` \| `Arial Unicode MS Bold` \| `Arial Unicode MS Regular` + # Bold` # # Valid font stacks for [HERE Technologies][2] styles: # # * VectorHereContrast – `Fira GO Regular` \| `Fira GO Bold` # @@ -2841,33 +2951,30 @@ # # # # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html # - # @option params [required, String] :map_name - # The map resource associated with the glyph file. - # # @return [Types::GetMapGlyphsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetMapGlyphsResponse#blob #blob} => IO - # * {Types::GetMapGlyphsResponse#cache_control #cache_control} => String # * {Types::GetMapGlyphsResponse#content_type #content_type} => String + # * {Types::GetMapGlyphsResponse#cache_control #cache_control} => String # # @example Request syntax with placeholder values # # resp = client.get_map_glyphs({ + # map_name: "ResourceName", # required # font_stack: "String", # required # font_unicode_range: "GetMapGlyphsRequestFontUnicodeRangeString", # required # key: "ApiKey", - # map_name: "ResourceName", # required # }) # # @example Response structure # # resp.blob #=> IO - # resp.cache_control #=> String # resp.content_type #=> String + # resp.cache_control #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphs AWS API Documentation # # @overload get_map_glyphs(params = {}) # @param [Hash] params ({}) @@ -2878,10 +2985,13 @@ # Retrieves the sprite sheet corresponding to a map resource. The sprite # sheet is a PNG image paired with a JSON document describing the # offsets of individual icons that will be displayed on a rendered map. # + # @option params [required, String] :map_name + # The map resource associated with the sprite file. + # # @option params [required, String] :file_name # The name of the sprite file. Use the following file names for the sprite # sheet: # # * `sprites.png` @@ -2900,32 +3010,29 @@ # # # # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html # - # @option params [required, String] :map_name - # The map resource associated with the sprite file. - # # @return [Types::GetMapSpritesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetMapSpritesResponse#blob #blob} => IO - # * {Types::GetMapSpritesResponse#cache_control #cache_control} => String # * {Types::GetMapSpritesResponse#content_type #content_type} => String + # * {Types::GetMapSpritesResponse#cache_control #cache_control} => String # # @example Request syntax with placeholder values # # resp = client.get_map_sprites({ + # map_name: "ResourceName", # required # file_name: "GetMapSpritesRequestFileNameString", # required # key: "ApiKey", - # map_name: "ResourceName", # required # }) # # @example Response structure # # resp.blob #=> IO - # resp.cache_control #=> String # resp.content_type #=> String + # resp.cache_control #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSprites AWS API Documentation # # @overload get_map_sprites(params = {}) # @param [Hash] params ({}) @@ -2939,38 +3046,38 @@ # The style descriptor contains specifications on how features render on # a map. For example, what data to display, what order to display the # data in, and the style for the data. Style descriptors follow the # Mapbox Style Specification. # + # @option params [required, String] :map_name + # The map resource to retrieve the style descriptor from. + # # @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 [required, String] :map_name - # The map resource to retrieve the style descriptor from. - # # @return [Types::GetMapStyleDescriptorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetMapStyleDescriptorResponse#blob #blob} => IO - # * {Types::GetMapStyleDescriptorResponse#cache_control #cache_control} => String # * {Types::GetMapStyleDescriptorResponse#content_type #content_type} => String + # * {Types::GetMapStyleDescriptorResponse#cache_control #cache_control} => String # # @example Request syntax with placeholder values # # resp = client.get_map_style_descriptor({ - # key: "ApiKey", # map_name: "ResourceName", # required + # key: "ApiKey", # }) # # @example Response structure # # resp.blob #=> IO - # resp.cache_control #=> String # resp.content_type #=> String + # resp.cache_control #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptor AWS API Documentation # # @overload get_map_style_descriptor(params = {}) # @param [Hash] params ({}) @@ -2986,50 +3093,50 @@ # The origin (0, 0) is the top left of the map. Increasing the zoom # level by 1 doubles both the X and Y dimensions, so a tile containing # data for the entire world at (0/0/0) will be split into 4 tiles at # zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1). # - # @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 [required, String] :map_name # The map resource to retrieve the map tiles from. # + # @option params [required, String] :z + # The zoom value for the map tile. + # # @option params [required, String] :x # The X axis value for the map tile. # # @option params [required, String] :y # The Y axis value for the map tile. # - # @option params [required, String] :z - # The zoom value for the map tile. + # @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 + # # @return [Types::GetMapTileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetMapTileResponse#blob #blob} => IO - # * {Types::GetMapTileResponse#cache_control #cache_control} => String # * {Types::GetMapTileResponse#content_type #content_type} => String + # * {Types::GetMapTileResponse#cache_control #cache_control} => String # # @example Request syntax with placeholder values # # resp = client.get_map_tile({ - # key: "ApiKey", # map_name: "ResourceName", # required + # z: "GetMapTileRequestZString", # required # x: "GetMapTileRequestXString", # required # y: "GetMapTileRequestYString", # required - # z: "GetMapTileRequestZString", # required + # key: "ApiKey", # }) # # @example Response structure # # resp.blob #=> IO - # resp.cache_control #=> String # resp.content_type #=> String + # resp.cache_control #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTile AWS API Documentation # # @overload get_map_tile(params = {}) # @param [Hash] params ({}) @@ -3054,17 +3161,13 @@ # # @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. + # @option params [required, String] :place_id + # The identifier of the place to find. # - # - # - # [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 @@ -3085,82 +3188,53 @@ # # # # [1]: https://tools.ietf.org/search/bcp47 # - # @option params [required, String] :place_id - # The identifier of the place to find. + # @option params [String] :key + # The optional [API key][1] to authorize the request. # - # While you can use PlaceID in subsequent requests, PlaceID is not - # intended to be a permanent identifier and the ID can change between - # consecutive API calls. Please see the following PlaceID behaviour for - # each data provider: # - # * Esri: Place IDs will change every quarter at a minimum. The typical - # time period for these changes would be March, June, September, and - # December. Place IDs might also change between the typical quarterly - # change but that will be much less frequent. # - # * HERE: We recommend that you cache data for no longer than a week to - # keep your data data fresh. You can assume that less than 1% ID - # shifts will release over release which is approximately 1 - 2 times - # per week. + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html # - # * Grab: Place IDs can expire or become invalid in the following - # situations. - # - # * Data operations: The POI may be removed from Grab POI database by - # Grab Map Ops based on the ground-truth, such as being closed in - # the real world, being detected as a duplicate POI, or having - # incorrect information. Grab will synchronize data to the Waypoint - # environment on weekly basis. - # - # * Interpolated POI: Interpolated POI is a temporary POI generated in - # real time when serving a request, and it will be marked as derived - # in the `place.result_type` field in the response. The information - # of interpolated POIs will be retained for at least 30 days, which - # means that within 30 days, you are able to obtain POI details by - # Place ID from Place Details API. After 30 days, the interpolated - # POIs(both Place ID and details) may expire and inaccessible from - # the Places Details API. - # # @return [Types::GetPlaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetPlaceResponse#place #place} => Types::Place # # @example Request syntax with placeholder values # # resp = client.get_place({ # index_name: "ResourceName", # required - # key: "ApiKey", - # language: "LanguageTag", # place_id: "PlaceId", # required + # language: "LanguageTag", + # key: "ApiKey", # }) # # @example Response structure # - # resp.place.address_number #=> String - # resp.place.categories #=> Array - # resp.place.categories[0] #=> String - # resp.place.country #=> String + # resp.place.label #=> String # resp.place.geometry.point #=> Array # resp.place.geometry.point[0] #=> Float - # resp.place.interpolated #=> Boolean - # resp.place.label #=> String - # resp.place.municipality #=> String - # resp.place.neighborhood #=> String - # resp.place.postal_code #=> String - # resp.place.region #=> String + # resp.place.address_number #=> String # resp.place.street #=> String - # resp.place.sub_municipality #=> String + # resp.place.neighborhood #=> String + # resp.place.municipality #=> String # resp.place.sub_region #=> String - # resp.place.supplemental_categories #=> Array - # resp.place.supplemental_categories[0] #=> String + # resp.place.region #=> String + # resp.place.country #=> String + # resp.place.postal_code #=> String + # resp.place.interpolated #=> Boolean # resp.place.time_zone.name #=> String # resp.place.time_zone.offset #=> Integer - # resp.place.unit_number #=> String # resp.place.unit_type #=> String + # resp.place.unit_number #=> String + # resp.place.categories #=> Array + # resp.place.categories[0] #=> String + # resp.place.supplemental_categories #=> Array + # resp.place.supplemental_categories[0] #=> String + # resp.place.sub_municipality #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlace AWS API Documentation # # @overload get_place(params = {}) # @param [Hash] params ({}) @@ -3169,12 +3243,12 @@ req.send_request(options) end # A batch request to retrieve all device positions. # - # @option params [Types::TrackingFilterGeometry] :filter_geometry - # The geometry used to filter device positions. + # @option params [required, String] :tracker_name + # The tracker resource containing the requested devices. # # @option params [Integer] :max_results # An optional limit for the number of entries returned in a single call. # # Default value: `100` @@ -3183,12 +3257,12 @@ # 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` # - # @option params [required, String] :tracker_name - # The tracker resource containing the requested devices. + # @option params [Types::TrackingFilterGeometry] :filter_geometry + # The geometry used to filter device positions. # # @return [Types::ListDevicePositionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDevicePositionsResponse#entries #data.entries} => Array&lt;Types::ListDevicePositionsResponseEntry&gt; (This method conflicts with a method on Response, call it through the data member) # * {Types::ListDevicePositionsResponse#next_token #next_token} => String @@ -3196,32 +3270,32 @@ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_device_positions({ + # tracker_name: "ResourceName", # required + # max_results: 1, + # next_token: "Token", # filter_geometry: { # polygon: [ # [ # [1.0], # ], # ], # }, - # max_results: 1, - # next_token: "Token", - # tracker_name: "ResourceName", # required # }) # # @example Response structure # # resp.data.entries #=> Array - # resp.data.entries[0].accuracy.horizontal #=> Float # resp.data.entries[0].device_id #=> String + # resp.data.entries[0].sample_time #=> Time # resp.data.entries[0].position #=> Array # resp.data.entries[0].position[0] #=> Float + # resp.data.entries[0].accuracy.horizontal #=> Float # resp.data.entries[0].position_properties #=> Hash # resp.data.entries[0].position_properties["PropertyMapKeyString"] #=> String - # resp.data.entries[0].sample_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositions AWS API Documentation # # @overload list_device_positions(params = {}) @@ -3261,14 +3335,14 @@ # # @example Response structure # # resp.data.entries #=> Array # resp.data.entries[0].collection_name #=> String - # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].description #=> String # resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.data.entries[0].pricing_plan_data_source #=> String + # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].update_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollections AWS API Documentation # @@ -3282,22 +3356,22 @@ # Lists geofences stored in a given geofence collection. # # @option params [required, String] :collection_name # The name of the geofence collection storing the list of geofences. # - # @option params [Integer] :max_results - # An optional limit for the number of geofences returned in a single - # call. - # - # Default value: `100` - # # @option params [String] :next_token # 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` # + # @option params [Integer] :max_results + # An optional limit for the number of geofences returned in a single + # call. + # + # Default value: `100` + # # @return [Types::ListGeofencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListGeofencesResponse#entries #data.entries} => Array&lt;Types::ListGeofenceResponseEntry&gt; (This method conflicts with a method on Response, call it through the data member) # * {Types::ListGeofencesResponse#next_token #next_token} => String # @@ -3305,30 +3379,31 @@ # # @example Request syntax with placeholder values # # resp = client.list_geofences({ # collection_name: "ResourceName", # required + # next_token: "LargeToken", # max_results: 1, - # next_token: "Token", # }) # # @example Response structure # # resp.data.entries #=> Array - # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].geofence_id #=> String - # resp.data.entries[0].geofence_properties #=> Hash - # resp.data.entries[0].geofence_properties["PropertyMapKeyString"] #=> String - # resp.data.entries[0].geometry.circle.center #=> Array - # resp.data.entries[0].geometry.circle.center[0] #=> Float - # resp.data.entries[0].geometry.circle.radius #=> Float # resp.data.entries[0].geometry.polygon #=> Array # resp.data.entries[0].geometry.polygon[0] #=> Array # resp.data.entries[0].geometry.polygon[0][0] #=> Array # resp.data.entries[0].geometry.polygon[0][0][0] #=> Float + # resp.data.entries[0].geometry.circle.center #=> Array + # resp.data.entries[0].geometry.circle.center[0] #=> Float + # resp.data.entries[0].geometry.circle.radius #=> Float + # resp.data.entries[0].geometry.geobuf #=> String # resp.data.entries[0].status #=> String + # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].update_time #=> Time + # resp.data.entries[0].geofence_properties #=> Hash + # resp.data.entries[0].geofence_properties["PropertyMapKeyString"] #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofences AWS API Documentation # # @overload list_geofences(params = {}) @@ -3338,13 +3413,10 @@ req.send_request(options) end # Lists API key resources in your Amazon Web Services account. # - # @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 # call. # # Default value: `100` @@ -3353,40 +3425,43 @@ # 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` # + # @option params [Types::ApiKeyFilter] :filter + # Optionally filter the list to only `Active` or `Expired` API keys. + # # @return [Types::ListKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListKeysResponse#entries #data.entries} => Array&lt;Types::ListKeysResponseEntry&gt; (This method conflicts with a method on Response, call it through the data member) # * {Types::ListKeysResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_keys({ + # max_results: 1, + # next_token: "Token", # filter: { # key_status: "Active", # accepts Active, Expired # }, - # max_results: 1, - # next_token: "Token", # }) # # @example Response structure # # resp.data.entries #=> Array - # resp.data.entries[0].create_time #=> Time - # resp.data.entries[0].description #=> String - # resp.data.entries[0].expire_time #=> Time # resp.data.entries[0].key_name #=> String + # resp.data.entries[0].expire_time #=> Time + # resp.data.entries[0].description #=> String # resp.data.entries[0].restrictions.allow_actions #=> Array # resp.data.entries[0].restrictions.allow_actions[0] #=> String - # resp.data.entries[0].restrictions.allow_referers #=> Array - # resp.data.entries[0].restrictions.allow_referers[0] #=> String # resp.data.entries[0].restrictions.allow_resources #=> Array # resp.data.entries[0].restrictions.allow_resources[0] #=> String + # resp.data.entries[0].restrictions.allow_referers #=> Array + # resp.data.entries[0].restrictions.allow_referers[0] #=> String + # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].update_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeys AWS API Documentation # @@ -3426,15 +3501,15 @@ # }) # # @example Response structure # # resp.data.entries #=> Array - # resp.data.entries[0].create_time #=> Time - # resp.data.entries[0].data_source #=> String - # resp.data.entries[0].description #=> String # resp.data.entries[0].map_name #=> String + # resp.data.entries[0].description #=> String + # resp.data.entries[0].data_source #=> String # resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].update_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMaps AWS API Documentation # @@ -3474,15 +3549,15 @@ # }) # # @example Response structure # # resp.data.entries #=> Array - # resp.data.entries[0].create_time #=> Time - # resp.data.entries[0].data_source #=> String - # resp.data.entries[0].description #=> String # resp.data.entries[0].index_name #=> String + # resp.data.entries[0].description #=> String + # resp.data.entries[0].data_source #=> String # resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].update_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexes AWS API Documentation # @@ -3522,14 +3597,14 @@ # # @example Response structure # # resp.data.entries #=> Array # resp.data.entries[0].calculator_name #=> String - # resp.data.entries[0].create_time #=> Time - # resp.data.entries[0].data_source #=> String # resp.data.entries[0].description #=> String + # resp.data.entries[0].data_source #=> String # resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].update_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculators AWS API Documentation # @@ -3577,10 +3652,14 @@ end # Lists geofence collections currently associated to the given tracker # resource. # + # @option params [required, String] :tracker_name + # The tracker resource whose associated geofence collections you want to + # list. + # # @option params [Integer] :max_results # An optional limit for the number of resources returned in a single # call. # # Default value: `100` @@ -3589,27 +3668,23 @@ # 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` # - # @option params [required, String] :tracker_name - # The tracker resource whose associated geofence collections you want to - # list. - # # @return [Types::ListTrackerConsumersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTrackerConsumersResponse#consumer_arns #consumer_arns} => Array&lt;String&gt; # * {Types::ListTrackerConsumersResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_tracker_consumers({ + # tracker_name: "ResourceName", # required # max_results: 1, # next_token: "Token", - # tracker_name: "ResourceName", # required # }) # # @example Response structure # # resp.consumer_arns #=> Array @@ -3654,15 +3729,15 @@ # }) # # @example Response structure # # resp.data.entries #=> Array - # resp.data.entries[0].create_time #=> Time + # resp.data.entries[0].tracker_name #=> String # resp.data.entries[0].description #=> String # resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.data.entries[0].pricing_plan_data_source #=> String - # resp.data.entries[0].tracker_name #=> String + # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].update_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackers AWS API Documentation # @@ -3681,61 +3756,64 @@ # The geofence collection to store the geofence in. # # @option params [required, String] :geofence_id # An identifier for the geofence. For example, `ExampleGeofence-1`. # - # @option params [Hash<String,String>] :geofence_properties - # 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. + # 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. # - # <note markdown="1"> Each [ geofence polygon][1] can have a maximum of 1,000 vertices. + # <note markdown="1"> The [ geofence polygon][1] format supports a maximum of 1,000 + # vertices. The [Geofence Geobuf][1] format supports a maximum of + # 100,000 vertices. # # </note> # # # # [1]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html # + # @option params [Hash<String,String>] :geofence_properties + # 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"` + # # @return [Types::PutGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::PutGeofenceResponse#create_time #create_time} => Time # * {Types::PutGeofenceResponse#geofence_id #geofence_id} => String + # * {Types::PutGeofenceResponse#create_time #create_time} => Time # * {Types::PutGeofenceResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.put_geofence({ # collection_name: "ResourceName", # required # geofence_id: "Id", # required - # geofence_properties: { - # "PropertyMapKeyString" => "PropertyMapValueString", - # }, # geometry: { # required - # circle: { - # center: [1.0], # required - # radius: 1.0, # required - # }, # polygon: [ # [ # [1.0], # ], # ], + # circle: { + # center: [1.0], # required + # radius: 1.0, # required + # }, + # geobuf: "data", # }, + # geofence_properties: { + # "PropertyMapKeyString" => "PropertyMapValueString", + # }, # }) # # @example Response structure # - # resp.create_time #=> Time # resp.geofence_id #=> String + # resp.create_time #=> Time # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PutGeofence AWS API Documentation # # @overload put_geofence(params = {}) @@ -3750,17 +3828,26 @@ # 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. + # @option params [required, Array<Float>] :position + # 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`. # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html + # @option params [Integer] :max_results + # An optional parameter. The maximum number of results returned per + # request. # + # Default value: `50` + # # @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 @@ -3781,72 +3868,63 @@ # # # # [1]: https://tools.ietf.org/search/bcp47 # - # @option params [Integer] :max_results - # An optional parameter. The maximum number of results returned per - # request. + # @option params [String] :key + # The optional [API key][1] to authorize the request. # - # Default value: `50` # - # @option params [required, Array<Float>] :position - # 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. + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html # - # For example, `[-123.1174, 49.2847]` represents a position with - # longitude `-123.1174` and latitude `49.2847`. - # # @return [Types::SearchPlaceIndexForPositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::SearchPlaceIndexForPositionResponse#results #results} => Array&lt;Types::SearchForPositionResult&gt; # * {Types::SearchPlaceIndexForPositionResponse#summary #summary} => Types::SearchPlaceIndexForPositionSummary + # * {Types::SearchPlaceIndexForPositionResponse#results #results} => Array&lt;Types::SearchForPositionResult&gt; # # @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 + # max_results: 1, + # language: "LanguageTag", + # key: "ApiKey", # }) # # @example Response structure # + # resp.summary.position #=> Array + # resp.summary.position[0] #=> Float + # resp.summary.max_results #=> Integer + # resp.summary.data_source #=> String + # resp.summary.language #=> String # resp.results #=> Array - # resp.results[0].distance #=> Float - # resp.results[0].place.address_number #=> String - # resp.results[0].place.categories #=> Array - # resp.results[0].place.categories[0] #=> String - # resp.results[0].place.country #=> String + # resp.results[0].place.label #=> String # resp.results[0].place.geometry.point #=> Array # resp.results[0].place.geometry.point[0] #=> Float - # resp.results[0].place.interpolated #=> Boolean - # resp.results[0].place.label #=> String - # resp.results[0].place.municipality #=> String - # resp.results[0].place.neighborhood #=> String - # resp.results[0].place.postal_code #=> String - # resp.results[0].place.region #=> String + # resp.results[0].place.address_number #=> String # resp.results[0].place.street #=> String - # resp.results[0].place.sub_municipality #=> String + # resp.results[0].place.neighborhood #=> String + # resp.results[0].place.municipality #=> String # resp.results[0].place.sub_region #=> String - # resp.results[0].place.supplemental_categories #=> Array - # resp.results[0].place.supplemental_categories[0] #=> String + # resp.results[0].place.region #=> String + # resp.results[0].place.country #=> String + # resp.results[0].place.postal_code #=> String + # resp.results[0].place.interpolated #=> Boolean # resp.results[0].place.time_zone.name #=> String # resp.results[0].place.time_zone.offset #=> Integer - # resp.results[0].place.unit_number #=> String # resp.results[0].place.unit_type #=> String + # resp.results[0].place.unit_number #=> String + # resp.results[0].place.categories #=> Array + # resp.results[0].place.categories[0] #=> String + # resp.results[0].place.supplemental_categories #=> Array + # resp.results[0].place.supplemental_categories[0] #=> String + # resp.results[0].place.sub_municipality #=> String + # resp.results[0].distance #=> Float # resp.results[0].place_id #=> String - # resp.summary.data_source #=> String - # resp.summary.language #=> String - # resp.summary.max_results #=> Integer - # resp.summary.position #=> Array - # resp.summary.position[0] #=> Float # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPosition AWS API Documentation # # @overload search_place_index_for_position(params = {}) # @param [Hash] params ({}) @@ -3868,10 +3946,17 @@ # `FilterBBox`. These parameters are mutually exclusive; using both # `BiasPosition` and `FilterBBox` in the same command returns an error. # # </note> # + # @option params [required, String] :index_name + # The name of the place index resource you want to use for the search. + # + # @option params [required, String] :text + # The free-form partial text to use to generate place suggestions. For + # example, `eiffel tow`. + # # @option params [Array<Float>] :bias_position # 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 @@ -3905,23 +3990,10 @@ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying # both options results in an error. # # </note> # - # @option params [Array<String>] :filter_categories - # 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][1], in the - # *Amazon Location Service Developer Guide*. - # - # - # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html - # # @option params [Array<String>] :filter_countries # An optional parameter that limits the search results by returning only # suggestions within the provided list of countries. # # * Use the [ISO 3166][1] 3-digit country code. For example, Australia @@ -3931,20 +4003,16 @@ # # # # [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 [Integer] :max_results + # An optional parameter. The maximum number of results returned per + # request. # - # @option params [String] :key - # The optional [API key][1] to authorize the request. + # The default: `5` # - # - # - # [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 @@ -3963,60 +4031,70 @@ # # # # [1]: https://tools.ietf.org/search/bcp47 # - # @option params [Integer] :max_results - # An optional parameter. The maximum number of results returned per - # request. + # @option params [Array<String>] :filter_categories + # 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. # - # The default: `5` + # For more information about using categories, including a list of + # Amazon Location categories, see [Categories and filtering][1], in the + # *Amazon Location Service Developer Guide*. # - # @option params [required, String] :text - # The free-form partial text to use to generate place suggestions. For - # example, `eiffel tow`. # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html + # + # @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 + # # @return [Types::SearchPlaceIndexForSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array&lt;Types::SearchForSuggestionsResult&gt; # * {Types::SearchPlaceIndexForSuggestionsResponse#summary #summary} => Types::SearchPlaceIndexForSuggestionsSummary + # * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array&lt;Types::SearchForSuggestionsResult&gt; # # @example Request syntax with placeholder values # # resp = client.search_place_index_for_suggestions({ + # index_name: "ResourceName", # required + # text: "SearchPlaceIndexForSuggestionsRequestTextString", # required # bias_position: [1.0], # filter_b_box: [1.0], + # filter_countries: ["CountryCode3"], + # max_results: 1, + # language: "LanguageTag", # filter_categories: ["PlaceCategory"], - # filter_countries: ["CountryCode"], - # index_name: "ResourceName", # required # key: "ApiKey", - # language: "LanguageTag", - # max_results: 1, - # text: "SearchPlaceIndexForSuggestionsRequestTextString", # required # }) # # @example Response structure # - # resp.results #=> Array - # resp.results[0].categories #=> Array - # resp.results[0].categories[0] #=> String - # resp.results[0].place_id #=> String - # resp.results[0].supplemental_categories #=> Array - # resp.results[0].supplemental_categories[0] #=> String - # resp.results[0].text #=> String + # resp.summary.text #=> String # resp.summary.bias_position #=> Array # resp.summary.bias_position[0] #=> Float - # resp.summary.data_source #=> String # resp.summary.filter_b_box #=> Array # resp.summary.filter_b_box[0] #=> Float - # resp.summary.filter_categories #=> Array - # resp.summary.filter_categories[0] #=> String # resp.summary.filter_countries #=> Array # resp.summary.filter_countries[0] #=> String - # resp.summary.language #=> String # resp.summary.max_results #=> Integer - # resp.summary.text #=> String + # resp.summary.data_source #=> String + # resp.summary.language #=> String + # resp.summary.filter_categories #=> Array + # resp.summary.filter_categories[0] #=> String + # resp.results #=> Array + # resp.results[0].text #=> String + # resp.results[0].place_id #=> String + # resp.results[0].categories #=> Array + # resp.results[0].categories[0] #=> String + # resp.results[0].supplemental_categories #=> Array + # resp.results[0].supplemental_categories[0] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions AWS API Documentation # # @overload search_place_index_for_suggestions(params = {}) # @param [Hash] params ({}) @@ -4038,10 +4116,17 @@ # # </note> # # Search results are returned in order of highest to lowest relevance. # + # @option params [required, String] :index_name + # The name of the place index resource you want to use for the search. + # + # @option params [required, String] :text + # The address, name, city, or region to be used in the search in + # free-form text format. For example, `123 Any Street`. + # # @option params [Array<Float>] :bias_position # 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 @@ -4075,23 +4160,10 @@ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying # both options results in an error. # # </note> # - # @option params [Array<String>] :filter_categories - # 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][1], in the - # *Amazon Location Service Developer Guide*. - # - # - # - # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html - # # @option params [Array<String>] :filter_countries # 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][1] 3-digit country codes. For @@ -4101,20 +4173,16 @@ # # # # [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 [Integer] :max_results + # An optional parameter. The maximum number of results returned per + # request. # - # @option params [String] :key - # The optional [API key][1] to authorize the request. + # The default: `50` # - # - # - # [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 @@ -4134,80 +4202,90 @@ # # # # [1]: https://tools.ietf.org/search/bcp47 # - # @option params [Integer] :max_results - # An optional parameter. The maximum number of results returned per - # request. + # @option params [Array<String>] :filter_categories + # 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. # - # The default: `50` + # For more information about using categories, including a list of + # Amazon Location categories, see [Categories and filtering][1], in the + # *Amazon Location Service Developer Guide*. # - # @option params [required, String] :text - # The address, name, city, or region to be used in the search in - # free-form text format. For example, `123 Any Street`. # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html + # + # @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 + # # @return [Types::SearchPlaceIndexForTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::SearchPlaceIndexForTextResponse#results #results} => Array&lt;Types::SearchForTextResult&gt; # * {Types::SearchPlaceIndexForTextResponse#summary #summary} => Types::SearchPlaceIndexForTextSummary + # * {Types::SearchPlaceIndexForTextResponse#results #results} => Array&lt;Types::SearchForTextResult&gt; # # @example Request syntax with placeholder values # # resp = client.search_place_index_for_text({ + # index_name: "ResourceName", # required + # text: "SearchPlaceIndexForTextRequestTextString", # required # bias_position: [1.0], # filter_b_box: [1.0], + # filter_countries: ["CountryCode3"], + # max_results: 1, + # language: "LanguageTag", # filter_categories: ["PlaceCategory"], - # filter_countries: ["CountryCode"], - # index_name: "ResourceName", # required # key: "ApiKey", - # language: "LanguageTag", - # max_results: 1, - # text: "SearchPlaceIndexForTextRequestTextString", # required # }) # # @example Response structure # - # resp.results #=> Array - # resp.results[0].distance #=> Float - # resp.results[0].place.address_number #=> String - # resp.results[0].place.categories #=> Array - # resp.results[0].place.categories[0] #=> String - # resp.results[0].place.country #=> String - # resp.results[0].place.geometry.point #=> Array - # resp.results[0].place.geometry.point[0] #=> Float - # resp.results[0].place.interpolated #=> Boolean - # resp.results[0].place.label #=> String - # resp.results[0].place.municipality #=> String - # resp.results[0].place.neighborhood #=> String - # resp.results[0].place.postal_code #=> String - # resp.results[0].place.region #=> String - # resp.results[0].place.street #=> String - # resp.results[0].place.sub_municipality #=> String - # resp.results[0].place.sub_region #=> String - # resp.results[0].place.supplemental_categories #=> Array - # resp.results[0].place.supplemental_categories[0] #=> String - # resp.results[0].place.time_zone.name #=> String - # resp.results[0].place.time_zone.offset #=> Integer - # resp.results[0].place.unit_number #=> String - # resp.results[0].place.unit_type #=> String - # resp.results[0].place_id #=> String - # resp.results[0].relevance #=> Float + # resp.summary.text #=> String # resp.summary.bias_position #=> Array # resp.summary.bias_position[0] #=> Float - # resp.summary.data_source #=> String # resp.summary.filter_b_box #=> Array # resp.summary.filter_b_box[0] #=> Float - # resp.summary.filter_categories #=> Array - # resp.summary.filter_categories[0] #=> String # resp.summary.filter_countries #=> Array # resp.summary.filter_countries[0] #=> String - # resp.summary.language #=> String # resp.summary.max_results #=> Integer # resp.summary.result_b_box #=> Array # resp.summary.result_b_box[0] #=> Float - # resp.summary.text #=> String + # resp.summary.data_source #=> String + # resp.summary.language #=> String + # resp.summary.filter_categories #=> Array + # resp.summary.filter_categories[0] #=> String + # resp.results #=> Array + # resp.results[0].place.label #=> String + # resp.results[0].place.geometry.point #=> Array + # resp.results[0].place.geometry.point[0] #=> Float + # resp.results[0].place.address_number #=> String + # resp.results[0].place.street #=> String + # resp.results[0].place.neighborhood #=> String + # resp.results[0].place.municipality #=> String + # resp.results[0].place.sub_region #=> String + # resp.results[0].place.region #=> String + # resp.results[0].place.country #=> String + # resp.results[0].place.postal_code #=> String + # resp.results[0].place.interpolated #=> Boolean + # resp.results[0].place.time_zone.name #=> String + # resp.results[0].place.time_zone.offset #=> Integer + # resp.results[0].place.unit_type #=> String + # resp.results[0].place.unit_number #=> String + # resp.results[0].place.categories #=> Array + # resp.results[0].place.categories[0] #=> String + # resp.results[0].place.supplemental_categories #=> Array + # resp.results[0].place.supplemental_categories[0] #=> String + # resp.results[0].place.sub_municipality #=> String + # resp.results[0].distance #=> Float + # resp.results[0].relevance #=> Float + # resp.results[0].place_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForText AWS API Documentation # # @overload search_place_index_for_text(params = {}) # @param [Hash] params ({}) @@ -4319,39 +4397,39 @@ # Updates the specified properties of a given geofence collection. # # @option params [required, String] :collection_name # The name of the geofence collection to update. # - # @option params [String] :description - # Updates the description for the geofence collection. - # # @option params [String] :pricing_plan # No longer used. If included, the only allowed value is # `RequestBasedUsage`. # # @option params [String] :pricing_plan_data_source # This parameter is no longer used. # + # @option params [String] :description + # Updates the description for the geofence collection. + # # @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::UpdateGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::UpdateGeofenceCollectionResponse#collection_name #collection_name} => String + # * {Types::UpdateGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::UpdateGeofenceCollectionResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_geofence_collection({ # collection_name: "ResourceName", # required - # description: "ResourceDescription", # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", + # description: "ResourceDescription", # }) # # @example Response structure # - # resp.collection_arn #=> String # resp.collection_name #=> String + # resp.collection_arn #=> String # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollection AWS API Documentation # # @overload update_geofence_collection(params = {}) @@ -4361,10 +4439,13 @@ req.send_request(options) end # Updates the specified properties of a given API key resource. # + # @option params [required, String] :key_name + # The name of the API key resource to update. + # # @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 [ @@ -4372,10 +4453,14 @@ # # # # [1]: https://www.iso.org/iso-8601-date-and-time-format.html # + # @option params [Boolean] :no_expiry + # Whether the API key should expire. Set to `true` to set the API key to + # have no expiration time. + # # @option params [Boolean] :force_update # 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 @@ -4383,17 +4468,10 @@ # # `False` if force update is not preferred # # Default value: `False` # - # @option params [required, String] :key_name - # The name of the API key resource to update. - # - # @option params [Boolean] :no_expiry - # Whether the API key should expire. Set to `true` to set the API key to - # have no expiration time. - # # @option params [Types::ApiKeyRestrictions] :restrictions # Updates the API key restrictions for the API key resource. # # @return [Types::UpdateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -4402,19 +4480,19 @@ # * {Types::UpdateKeyResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_key({ + # key_name: "ResourceName", # required # description: "ResourceDescription", # expire_time: Time.now, - # force_update: false, - # key_name: "ResourceName", # required # no_expiry: false, + # force_update: false, # restrictions: { # allow_actions: ["ApiKeyAction"], # required + # allow_resources: ["GeoArnV2"], # required # allow_referers: ["RefererPattern"], - # allow_resources: ["GeoArn"], # required # }, # }) # # @example Response structure # @@ -4431,46 +4509,46 @@ req.send_request(options) end # Updates the specified properties of a given map resource. # - # @option params [Types::MapConfigurationUpdate] :configuration_update - # Updates the parts of the map configuration that can be updated, - # including the political view. - # - # @option params [String] :description - # Updates the description for the map resource. - # # @option params [required, String] :map_name # The name of the map resource to update. # # @option params [String] :pricing_plan # No longer used. If included, the only allowed value is # `RequestBasedUsage`. # + # @option params [String] :description + # Updates the description for the map resource. + # + # @option params [Types::MapConfigurationUpdate] :configuration_update + # Updates the parts of the map configuration that can be updated, + # including the political view. + # # @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::UpdateMapResponse#map_arn #map_arn} => String # * {Types::UpdateMapResponse#map_name #map_name} => String + # * {Types::UpdateMapResponse#map_arn #map_arn} => String # * {Types::UpdateMapResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_map({ + # map_name: "ResourceName", # required + # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # description: "ResourceDescription", # configuration_update: { - # custom_layers: ["CustomLayer"], # political_view: "CountryCode3OrEmpty", + # custom_layers: ["CustomLayer"], # }, - # description: "ResourceDescription", - # map_name: "ResourceName", # required - # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # }) # # @example Response structure # - # resp.map_arn #=> String # resp.map_name #=> String + # resp.map_arn #=> String # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMap AWS API Documentation # # @overload update_map(params = {}) @@ -4480,44 +4558,44 @@ req.send_request(options) end # Updates the specified properties of a given place index resource. # - # @option params [Types::DataSourceConfiguration] :data_source_configuration - # Updates the data storage option for the place index resource. - # - # @option params [String] :description - # Updates the description for the place index resource. - # # @option params [required, String] :index_name # The name of the place index resource to update. # # @option params [String] :pricing_plan # No longer used. If included, the only allowed value is # `RequestBasedUsage`. # + # @option params [String] :description + # Updates the description for the place index resource. + # + # @option params [Types::DataSourceConfiguration] :data_source_configuration + # Updates the data storage option for the place index resource. + # # @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::UpdatePlaceIndexResponse#index_arn #index_arn} => String # * {Types::UpdatePlaceIndexResponse#index_name #index_name} => String + # * {Types::UpdatePlaceIndexResponse#index_arn #index_arn} => String # * {Types::UpdatePlaceIndexResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_place_index({ + # index_name: "ResourceName", # required + # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # description: "ResourceDescription", # data_source_configuration: { # intended_use: "SingleUse", # accepts SingleUse, Storage # }, - # description: "ResourceDescription", - # index_name: "ResourceName", # required - # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # }) # # @example Response structure # - # resp.index_arn #=> String # resp.index_name #=> String + # resp.index_arn #=> String # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndex AWS API Documentation # # @overload update_place_index(params = {}) @@ -4531,35 +4609,35 @@ # resource. # # @option params [required, String] :calculator_name # The name of the route calculator resource to update. # - # @option params [String] :description - # Updates the description for the route calculator resource. - # # @option params [String] :pricing_plan # No longer used. If included, the only allowed value is # `RequestBasedUsage`. # + # @option params [String] :description + # Updates the description for the route calculator resource. + # # @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::UpdateRouteCalculatorResponse#calculator_arn #calculator_arn} => String # * {Types::UpdateRouteCalculatorResponse#calculator_name #calculator_name} => String + # * {Types::UpdateRouteCalculatorResponse#calculator_arn #calculator_arn} => String # * {Types::UpdateRouteCalculatorResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_route_calculator({ # calculator_name: "ResourceName", # required - # description: "ResourceDescription", # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # description: "ResourceDescription", # }) # # @example Response structure # - # resp.calculator_arn #=> String # resp.calculator_name #=> String + # resp.calculator_arn #=> String # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculator AWS API Documentation # # @overload update_route_calculator(params = {}) @@ -4569,34 +4647,23 @@ req.send_request(options) end # Updates the specified properties of a given tracker resource. # - # @option params [String] :description - # Updates the description for the tracker resource. + # @option params [required, String] :tracker_name + # The name of the tracker resource to update. # - # @option params [Boolean] :event_bridge_enabled - # Whether to enable position `UPDATE` events from this tracker to be - # sent to EventBridge. + # @option params [String] :pricing_plan + # No longer used. If included, the only allowed value is + # `RequestBasedUsage`. # - # <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. + # @option params [String] :pricing_plan_data_source + # This parameter is no longer used. # - # </note> + # @option params [String] :description + # Updates the description for the tracker resource. # - # @option params [Boolean] :kms_key_enable_geospatial_queries - # Enables `GeospatialQueries` for a tracker that uses a [Amazon Web - # Services KMS customer managed key][1]. - # - # This parameter is only used if you are using a KMS customer managed - # key. - # - # - # - # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html - # # @option params [String] :position_filtering # Updates the position filtering for the tracker resource. # # Valid values: # @@ -4621,42 +4688,53 @@ # 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. # - # @option params [String] :pricing_plan - # No longer used. If included, the only allowed value is - # `RequestBasedUsage`. + # @option params [Boolean] :event_bridge_enabled + # Whether to enable position `UPDATE` events from this tracker to be + # sent to EventBridge. # - # @option params [String] :pricing_plan_data_source - # This parameter is no longer used. + # <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. # - # @option params [required, String] :tracker_name - # The name of the tracker resource to update. + # </note> # + # @option params [Boolean] :kms_key_enable_geospatial_queries + # Enables `GeospatialQueries` for a tracker that uses a [Amazon Web + # Services KMS customer managed key][1]. + # + # This parameter is only used if you are using a KMS customer managed + # key. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html + # # @return [Types::UpdateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::UpdateTrackerResponse#tracker_arn #tracker_arn} => String # * {Types::UpdateTrackerResponse#tracker_name #tracker_name} => String + # * {Types::UpdateTrackerResponse#tracker_arn #tracker_arn} => String # * {Types::UpdateTrackerResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_tracker({ + # tracker_name: "ResourceName", # required + # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # pricing_plan_data_source: "String", # description: "ResourceDescription", + # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased # event_bridge_enabled: false, # kms_key_enable_geospatial_queries: false, - # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased - # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement - # pricing_plan_data_source: "String", - # tracker_name: "ResourceName", # required # }) # # @example Response structure # - # resp.tracker_arn #=> String # resp.tracker_name #=> String + # resp.tracker_arn #=> String # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateTracker AWS API Documentation # # @overload update_tracker(params = {}) @@ -4664,10 +4742,105 @@ def update_tracker(params = {}, options = {}) req = build_request(:update_tracker, params) req.send_request(options) end + # Verifies the integrity of the device's position by determining if it + # was reported behind a proxy, and by comparing it to an inferred + # position estimated based on the device's state. + # + # @option params [required, String] :tracker_name + # The name of the tracker resource to be associated with verification + # request. + # + # @option params [required, Types::DeviceState] :device_state + # The device's state, including position, IP address, cell signals and + # Wi-Fi access points. + # + # @option params [String] :distance_unit + # The distance unit for the verification request. + # + # Default Value: `Kilometers` + # + # @return [Types::VerifyDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::VerifyDevicePositionResponse#inferred_state #inferred_state} => Types::InferredState + # * {Types::VerifyDevicePositionResponse#device_id #device_id} => String + # * {Types::VerifyDevicePositionResponse#sample_time #sample_time} => Time + # * {Types::VerifyDevicePositionResponse#received_time #received_time} => Time + # * {Types::VerifyDevicePositionResponse#distance_unit #distance_unit} => String + # + # @example Request syntax with placeholder values + # + # resp = client.verify_device_position({ + # tracker_name: "ResourceName", # required + # device_state: { # required + # device_id: "Id", # required + # sample_time: Time.now, # required + # position: [1.0], # required + # accuracy: { + # horizontal: 1.0, # required + # }, + # ipv_4_address: "DeviceStateIpv4AddressString", + # wi_fi_access_points: [ + # { + # mac_address: "WiFiAccessPointMacAddressString", # required + # rss: 1, # required + # }, + # ], + # cell_signals: { + # lte_cell_details: [ # required + # { + # cell_id: 1, # required + # mcc: 1, # required + # mnc: 1, # required + # local_id: { + # earfcn: 1, # required + # pci: 1, # required + # }, + # network_measurements: [ + # { + # earfcn: 1, # required + # cell_id: 1, # required + # pci: 1, # required + # rsrp: 1, + # rsrq: 1.0, + # }, + # ], + # timing_advance: 1, + # nr_capable: false, + # rsrp: 1, + # rsrq: 1.0, + # tac: 1, + # }, + # ], + # }, + # }, + # distance_unit: "Kilometers", # accepts Kilometers, Miles + # }) + # + # @example Response structure + # + # resp.inferred_state.position #=> Array + # resp.inferred_state.position[0] #=> Float + # resp.inferred_state.accuracy.horizontal #=> Float + # resp.inferred_state.deviation_distance #=> Float + # resp.inferred_state.proxy_detected #=> Boolean + # resp.device_id #=> String + # resp.sample_time #=> Time + # resp.received_time #=> Time + # resp.distance_unit #=> String, one of "Kilometers", "Miles" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/VerifyDevicePosition AWS API Documentation + # + # @overload verify_device_position(params = {}) + # @param [Hash] params ({}) + def verify_device_position(params = {}, options = {}) + req = build_request(:verify_device_position, params) + req.send_request(options) + end + # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) @@ -4677,10 +4850,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-locationservice' - context[:gem_version] = '1.50.0' + context[:gem_version] = '1.51.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated