Class: Aws::LocationService::Types::GetDevicePositionHistoryRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::LocationService::Types::GetDevicePositionHistoryRequest
- Defined in:
- gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#device_id ⇒ String
The device whose position history you want to retrieve.
-
#end_time_exclusive ⇒ Time
Specify the end time for the position history in [ ISO 8601][1] format:
YYYY-MM-DDThh:mm:ss.sssZ
. -
#max_results ⇒ Integer
An optional limit for the number of device positions returned in a single call.
-
#next_token ⇒ String
The pagination token specifying which page of results to return in the response.
-
#start_time_inclusive ⇒ Time
Specify the start time for the position history in [ ISO 8601][1] format:
YYYY-MM-DDThh:mm:ss.sssZ
. -
#tracker_name ⇒ String
The tracker resource receiving the request for the device position history.
Instance Attribute Details
#device_id ⇒ String
The device whose position history you want to retrieve.
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3028 class GetDevicePositionHistoryRequest < Struct.new( :device_id, :end_time_exclusive, :max_results, :next_token, :start_time_inclusive, :tracker_name) SENSITIVE = [] include Aws::Structure end |
#end_time_exclusive ⇒ Time
Specify the end time for the position history in ISO 8601
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 forStartTimeInclusive
.
^
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3028 class GetDevicePositionHistoryRequest < Struct.new( :device_id, :end_time_exclusive, :max_results, :next_token, :start_time_inclusive, :tracker_name) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
An optional limit for the number of device positions returned in a single call.
Default value: 100
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3028 class GetDevicePositionHistoryRequest < Struct.new( :device_id, :end_time_exclusive, :max_results, :next_token, :start_time_inclusive, :tracker_name) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
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
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3028 class GetDevicePositionHistoryRequest < Struct.new( :device_id, :end_time_exclusive, :max_results, :next_token, :start_time_inclusive, :tracker_name) SENSITIVE = [] include Aws::Structure end |
#start_time_inclusive ⇒ Time
Specify the start time for the position history in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24
hours prior to the time that the request is made.
Requirement:
- The time specified for
StartTimeInclusive
must be beforeEndTimeExclusive
.
^
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3028 class GetDevicePositionHistoryRequest < Struct.new( :device_id, :end_time_exclusive, :max_results, :next_token, :start_time_inclusive, :tracker_name) SENSITIVE = [] include Aws::Structure end |
#tracker_name ⇒ String
The tracker resource receiving the request for the device position history.
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3028 class GetDevicePositionHistoryRequest < Struct.new( :device_id, :end_time_exclusive, :max_results, :next_token, :start_time_inclusive, :tracker_name) SENSITIVE = [] include Aws::Structure end |