lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.2.0 vs lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.3.0

- old
+ new

@@ -329,10 +329,16 @@ # Creates an association between a geofence collection and a tracker # resource. This allows the tracker resource to communicate location # data to the linked geofence collection. # + # <note markdown="1"> Currently not supported — Cross-account configurations, such as + # creating associations between a tracker resource in one account and a + # geofence collection in another account. + # + # </note> + # # @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 AWS. # @@ -401,13 +407,20 @@ def batch_delete_geofence(params = {}, options = {}) req = build_request(:batch_delete_geofence, params) req.send_request(options) end - # Used in geofence monitoring. Evaluates device positions against the - # position of geofences in a given geofence collection. + # Evaluates device positions against the geofence geometries from a + # given geofence collection. The evaluation determines if the device has + # entered or exited a geofenced area, which publishes ENTER or EXIT + # geofence events to Amazon EventBridge. # + # <note markdown="1"> The last geofence that a device was observed within, if any, is + # tracked for 30 days after the most recent device position update + # + # </note> + # # @option params [required, String] :collection_name # The geofence collection used in evaluating the position of devices # against its geofences. # # @option params [required, Array<Types::DevicePositionUpdate>] :device_position_updates @@ -446,16 +459,12 @@ def batch_evaluate_geofences(params = {}, options = {}) req = build_request(:batch_evaluate_geofences, params) req.send_request(options) end - # A batch request to retrieve device positions. + # A batch request to retrieve all device positions. # - # <note markdown="1"> The response will return the device positions from the last 24 hours. - # - # </note> - # # @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` @@ -497,11 +506,11 @@ def batch_get_device_position(params = {}, options = {}) req = build_request(:batch_get_device_position, params) req.send_request(options) end - # A batch request for storing geofences into a given geofence + # A batch request for storing geofence geometries into a given geofence # collection. # # @option params [required, String] :collection_name # The geofence collection storing the geofences. # @@ -549,16 +558,17 @@ def batch_put_geofence(params = {}, options = {}) req = build_request(:batch_put_geofence, params) req.send_request(options) end - # Uploads a position update for one or more devices to a tracker - # resource. The data is used for API queries requesting the device - # position and position history. + # Uploads position update data for one or more devices to a tracker + # resource. Amazon Location uses the data when reporting the last known + # device position and position history. # - # <note markdown="1"> Limitation — Location data is sampled at a fixed rate of 1 position - # per 30 second interval, and retained for 1 year before it is deleted. + # <note markdown="1"> Only one position update is stored per sample time. Location data is + # sampled at a fixed rate of one position per 30-second interval, and + # retained for one year before it is deleted. # # </note> # # @option params [required, String] :tracker_name # The name of the tracker resource to update. @@ -606,37 +616,42 @@ # A custom name for the geofence collection. # # Requirements: # # * Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), - # and underscores (\_). + # periods (.), and underscores (\_). # # * 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 [required, String] :pricing_plan - # Specifies the pricing plan for your geofence collection. There's - # three pricing plan options: + # Specifies the pricing plan for your geofence collection. # - # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing - # plan. + # For additional details and restrictions on each pricing plan option, + # see the [Amazon Location Service pricing page][1]. # - # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking" - # pricing plan. # - # * `MobileAssetManagement` — Selects the "Mobile Asset Management" - # pricing plan. # - # For additional details and restrictions on each pricing plan option, - # see the [Amazon Location Service pricing page][1]. + # [1]: https://aws.amazon.com/location/pricing/ # + # @option params [String] :pricing_plan_data_source + # Specifies the plan data source. Required if the Mobile Asset Tracking + # (MAT) or the Mobile Asset Management (MAM) pricing plan is selected. # + # Billing is determined by the resource usage, the associated pricing + # plan, and the data source that was specified. For more information + # about each pricing plan option and restrictions, see the [Amazon + # Location Service pricing page][1]. # + # Valid Values: `Esri `\| `Here` + # + # + # # [1]: https://aws.amazon.com/location/pricing/ # # @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String @@ -647,10 +662,11 @@ # # resp = client.create_geofence_collection({ # collection_name: "ResourceName", # required # description: "ResourceDescription", # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # pricing_plan_data_source: "String", # }) # # @example Response structure # # resp.collection_arn #=> String @@ -690,29 +706,19 @@ # The name for the map resource. # # Requirements: # # * Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens - # (-), and underscores (\_). + # (-), periods (.), and underscores (\_). # # * Must be a unique map resource name. # # * No spaces allowed. For example, `ExampleMap`. # # @option params [required, String] :pricing_plan - # Specifies the pricing plan for your map resource. There's three - # pricing plan options: + # Specifies the pricing plan for your map resource. # - # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing - # plan. - # - # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking" - # pricing plan. - # - # * `MobileAssetManagement` — Selects the "Mobile Asset Management" - # pricing plan. - # # For additional details and restrictions on each pricing plan option, # see the [Amazon Location Service pricing page][1]. # # # @@ -769,10 +775,28 @@ # [1]: https://aws.amazon.com/service-terms/ # # @option params [required, String] :data_source # Specifies the data provider of geospatial data. # + # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For + # example, entering `HERE` will return an error. + # + # </note> + # + # Valid values include: + # + # * `Esri` + # + # * `Here` + # + # For additional details on data providers, see the [Amazon Location + # Service data providers page][1]. + # + # + # + # [1]: 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 for requesting Places. # # @option params [String] :description # The optional description for the Place index resource. @@ -780,30 +804,20 @@ # @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 (-) - # and underscores (\_) ). + # * 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] :pricing_plan - # Specifies the pricing plan for your Place index resource. There's - # three pricing plan options: + # Specifies the pricing plan for your Place index resource. # - # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing - # plan. - # - # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking" - # pricing plan. - # - # * `MobileAssetManagement` — Selects the "Mobile Asset Management" - # pricing plan. - # # For additional details and restrictions on each pricing plan option, # see the [Amazon Location Service pricing page][1]. # # # @@ -847,36 +861,41 @@ # # @option params [String] :description # An optional description for the tracker resource. # # @option params [required, String] :pricing_plan - # Specifies the pricing plan for your tracker resource. There's three - # pricing plan options: + # Specifies the pricing plan for your tracker resource. # - # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing - # plan. + # For additional details and restrictions on each pricing plan option, + # see the [Amazon Location Service pricing page][1]. # - # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking" - # pricing plan. # - # * `MobileAssetManagement` — Selects the "Mobile Asset Management" - # pricing plan. # - # For additional details and restrictions on each pricing plan option, - # see the [Amazon Location Service pricing page][1]. + # [1]: https://aws.amazon.com/location/pricing/ # + # @option params [String] :pricing_plan_data_source + # Specifies the plan data source. Required if the Mobile Asset Tracking + # (MAT) or the Mobile Asset Management (MAM) pricing plan is selected. # + # Billing is determined by the resource usage, the associated pricing + # plan, and data source that was specified. For more information about + # each pricing plan option and restrictions, see the [Amazon Location + # Service pricing page][1]. # + # Valid Values: `Esri` \| `Here` + # + # + # # [1]: https://aws.amazon.com/location/pricing/ # # @option params [required, String] :tracker_name # The name for the tracker resource. # # Requirements: # - # * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) - # and underscores (\_). + # * 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`. # @@ -889,10 +908,11 @@ # @example Request syntax with placeholder values # # resp = client.create_tracker({ # description: "ResourceDescription", # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement + # pricing_plan_data_source: "String", # tracker_name: "ResourceName", # required # }) # # @example Response structure # @@ -1030,10 +1050,12 @@ # # * {Types::DescribeGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::DescribeGeofenceCollectionResponse#collection_name #collection_name} => String # * {Types::DescribeGeofenceCollectionResponse#create_time #create_time} => Time # * {Types::DescribeGeofenceCollectionResponse#description #description} => String + # * {Types::DescribeGeofenceCollectionResponse#pricing_plan #pricing_plan} => String + # * {Types::DescribeGeofenceCollectionResponse#pricing_plan_data_source #pricing_plan_data_source} => String # * {Types::DescribeGeofenceCollectionResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_geofence_collection({ @@ -1044,10 +1066,12 @@ # # resp.collection_arn #=> String # resp.collection_name #=> String # resp.create_time #=> Time # resp.description #=> String + # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.pricing_plan_data_source #=> String # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection AWS API Documentation # # @overload describe_geofence_collection(params = {}) @@ -1068,10 +1092,11 @@ # * {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#pricing_plan #pricing_plan} => String # * {Types::DescribeMapResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_map({ @@ -1084,10 +1109,11 @@ # 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.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMap AWS API Documentation # # @overload describe_map(params = {}) @@ -1108,10 +1134,11 @@ # * {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#update_time #update_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_place_index({ @@ -1124,10 +1151,11 @@ # 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.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex AWS API Documentation # # @overload describe_place_index(params = {}) @@ -1144,10 +1172,12 @@ # # @return [Types::DescribeTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeTrackerResponse#create_time #create_time} => Time # * {Types::DescribeTrackerResponse#description #description} => String + # * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String + # * {Types::DescribeTrackerResponse#pricing_plan_data_source #pricing_plan_data_source} => String # * {Types::DescribeTrackerResponse#tracker_arn #tracker_arn} => String # * {Types::DescribeTrackerResponse#tracker_name #tracker_name} => String # * {Types::DescribeTrackerResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values @@ -1158,10 +1188,12 @@ # # @example Response structure # # resp.create_time #=> Time # resp.description #=> String + # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.pricing_plan_data_source #=> String # resp.tracker_arn #=> String # resp.tracker_name #=> String # resp.update_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeTracker AWS API Documentation @@ -1171,11 +1203,11 @@ def describe_tracker(params = {}, options = {}) req = build_request(:describe_tracker, params) req.send_request(options) end - # Removes the association bewteen a tracker resource and a geofence + # Removes the association between a tracker resource and a geofence # collection. # # <note markdown="1"> Once you unlink a tracker resource from a geofence collection, the # tracker positions will no longer be automatically evaluated against # geofences. @@ -1211,18 +1243,19 @@ def disassociate_tracker_consumer(params = {}, options = {}) req = build_request(:disassociate_tracker_consumer, params) req.send_request(options) end - # Retrieves the latest device position. + # Retrieves a device's most recent position according to its sample + # time. # - # <note markdown="1"> Limitation — Device positions are deleted after one year. + # <note markdown="1"> Device positions are deleted after one year. # # </note> # # @option params [required, String] :device_id - # The device whose position you want to retreieve. + # The device whose position you want to retrieve. # # @option params [required, String] :tracker_name # The tracker resource receiving the position update. # # @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1257,22 +1290,25 @@ end # Retrieves the device position history from a tracker resource within a # specified range of time. # - # <note markdown="1"> Limitation — Device positions are deleted after one year. + # <note markdown="1"> Device positions are deleted after 1 year. # # </note> # # @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`. + # format: `YYYY-MM-DDThh:mm:ss.sssZ`. By default, the value will be the + # time that the request is made. # - # * The given time for `EndTimeExclusive` must be after the time for + # Requirement: + # + # * The time specified for `EndTimeExclusive` must be after the time for # `StartTimeInclusive`. # # ^ # # @@ -1285,15 +1321,18 @@ # # Default value: `null` # # @option params [Time,DateTime,Date,Integer,String] :start_time_inclusive # Specify the start time for the position history in [ ISO 8601][1] - # format: `YYYY-MM-DDThh:mm:ss.sssZ`. + # format: `YYYY-MM-DDThh:mm:ss.sssZ`. By default, the value will be 24 + # hours prior to the time that the request is made. # - # * The given time for `EndTimeExclusive` must be after the time for - # `StartTimeInclusive`. + # Requirement: # + # * The time specified for `StartTimeInclusive` must be before + # `EndTimeExclusive`. + # # ^ # # # # [1]: https://www.iso.org/iso-8601-date-and-time-format.html @@ -1587,10 +1626,12 @@ # # resp.entries #=> Array # resp.entries[0].collection_name #=> String # resp.entries[0].create_time #=> Time # resp.entries[0].description #=> String + # resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.entries[0].pricing_plan_data_source #=> String # resp.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 # @@ -1681,10 +1722,11 @@ # resp.entries #=> Array # resp.entries[0].create_time #=> Time # resp.entries[0].data_source #=> String # resp.entries[0].description #=> String # resp.entries[0].map_name #=> String + # resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.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 # @@ -1728,10 +1770,11 @@ # resp.entries #=> Array # resp.entries[0].create_time #=> Time # resp.entries[0].data_source #=> String # resp.entries[0].description #=> String # resp.entries[0].index_name #=> String + # resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.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 # @@ -1822,10 +1865,12 @@ # @example Response structure # # resp.entries #=> Array # resp.entries[0].create_time #=> Time # resp.entries[0].description #=> String + # resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" + # resp.entries[0].pricing_plan_data_source #=> String # resp.entries[0].tracker_name #=> String # resp.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 @@ -1835,23 +1880,31 @@ def list_trackers(params = {}, options = {}) req = build_request(:list_trackers, params) req.send_request(options) end - # Stores a geofence to a given geofence collection, or updates the - # geometry of an existing geofence if a geofence ID is included in the - # request. + # Stores a geofence geometry in a given geofence collection, or updates + # the geometry of an existing geofence if a geofence ID is included in + # the request. # # @option params [required, String] :collection_name # 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 [required, Types::GeofenceGeometry] :geometry # Contains the polygon details to specify the position of the geofence. # + # <note markdown="1"> Each [geofence polygon][1] can have a maximum of 1,000 vertices. + # + # </note> + # + # + # + # [1]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html + # # @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#update_time #update_time} => Time @@ -2113,10 +2166,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-locationservice' - context[:gem_version] = '1.2.0' + context[:gem_version] = '1.3.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated