Class: Aws::LocationService::Types::GetDevicePositionHistoryRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

Note:

When making an API call, you may pass GetDevicePositionHistoryRequest data as a hash:

{
  device_id: "Id", # required
  end_time_exclusive: Time.now,
  next_token: "Token",
  start_time_inclusive: Time.now,
  tracker_name: "ResourceName", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#device_idString

The device whose position history you want to retrieve.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2634

class GetDevicePositionHistoryRequest < Struct.new(
  :device_id,
  :end_time_exclusive,
  :next_token,
  :start_time_inclusive,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#end_time_exclusiveTime

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 for StartTimeInclusive.

^

Returns:

  • (Time)


2634
2635
2636
2637
2638
2639
2640
2641
2642
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2634

class GetDevicePositionHistoryRequest < Struct.new(
  :device_id,
  :end_time_exclusive,
  :next_token,
  :start_time_inclusive,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2634

class GetDevicePositionHistoryRequest < Struct.new(
  :device_id,
  :end_time_exclusive,
  :next_token,
  :start_time_inclusive,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_inclusiveTime

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 before EndTimeExclusive.

^

Returns:

  • (Time)


2634
2635
2636
2637
2638
2639
2640
2641
2642
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2634

class GetDevicePositionHistoryRequest < Struct.new(
  :device_id,
  :end_time_exclusive,
  :next_token,
  :start_time_inclusive,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#tracker_nameString

The tracker resource receiving the request for the device position history.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2634

class GetDevicePositionHistoryRequest < Struct.new(
  :device_id,
  :end_time_exclusive,
  :next_token,
  :start_time_inclusive,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end