/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::LocationService::GetDevicePositionHistory

NAME

Paws::LocationService::GetDevicePositionHistory - Arguments for method GetDevicePositionHistory on Paws::LocationService

DESCRIPTION

This class represents the parameters used for calling the method GetDevicePositionHistory on the Amazon Location Service service. Use the attributes of this class as arguments to method GetDevicePositionHistory.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDevicePositionHistory.

SYNOPSIS

  my $geo = Paws->service('LocationService');
  my $GetDevicePositionHistoryResponse = $geo->GetDevicePositionHistory(
    DeviceId           => 'MyId',
    TrackerName        => 'MyResourceName',
    EndTimeExclusive   => '1970-01-01T01:00:00',    # OPTIONAL
    NextToken          => 'MyToken',                # OPTIONAL
    StartTimeInclusive => '1970-01-01T01:00:00',    # OPTIONAL
  );

  # Results:
  my $DevicePositions = $GetDevicePositionHistoryResponse->DevicePositions;
  my $NextToken       = $GetDevicePositionHistoryResponse->NextToken;

# Returns a L<Paws::LocationService::GetDevicePositionHistoryResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/geo/GetDevicePositionHistory

ATTRIBUTES

REQUIRED DeviceId => Str

The device whose position history you want to retrieve.

EndTimeExclusive => Str

Specify the end time for the position history in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) 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.

NextToken => Str

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

StartTimeInclusive => Str

Specify the start time for the position history in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) 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.

REQUIRED TrackerName => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method GetDevicePositionHistory in Paws::LocationService

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues